initial-commits

LayerZero-Labs · Jan 24, 2024 · cb8584a · cb8584a
1 parent db9acd2
commit cb8584a
Show file tree

Hide file tree

Showing 25 changed files with 45 additions and 5 deletions.
diff --git a/contracts/token/oft/v2/BaseOFTV2.sol → contracts/token/oft/latest/BaseOFTV2.sol b/contracts/token/oft/v2/BaseOFTV2.sol → contracts/token/oft/latest/BaseOFTV2.sol
diff --git a/contracts/token/oft/v2/OFTCoreV2.sol → contracts/token/oft/latest/OFTCoreV2.sol b/contracts/token/oft/v2/OFTCoreV2.sol → contracts/token/oft/latest/OFTCoreV2.sol
diff --git a/contracts/token/oft/v2/OFTV2.sol → contracts/token/oft/latest/OFTV2.sol b/contracts/token/oft/v2/OFTV2.sol → contracts/token/oft/latest/OFTV2.sol
diff --git a/contracts/token/oft/v2/ProxyOFTV2.sol → contracts/token/oft/latest/ProxyOFTV2.sol b/contracts/token/oft/v2/ProxyOFTV2.sol → contracts/token/oft/latest/ProxyOFTV2.sol
diff --git a/contracts/token/oft/latest/README.md b/contracts/token/oft/latest/README.md
@@ -0,0 +1,45 @@
+## OFT V2
+
+> **NOTE:** This document should be read in conjunction with the <a href="https://layerzero.gitbook.io/docs/evm-guides/oft-walkthrough">LayerZero V1 OFT Docs</a>.
+
+This set of interfaces, contracts, and utilities are all related to the OFT (Omnichain Fungible Token) Endpoint V1 implementation, designed for seamless fungible token transfers across multiple blockchains.
+
+There are a few core contracts that implement the behavior specified in the OFT V2:
+
+* **{OFTV2}**: the main contract that combines `BaseOFTV2` with `ERC20`, implementing the OFT functionalities.
+* {BaseOFTV2}: the base abstract contract that provides the essential functionality for omnichain token transfer.
+* {{OFTCoreV2}}: the core contract that implements baseline logic for debiting and crediting tokens across multiple chains.
+* {{NonblockingLzApp}}: the generic message passing standard to send and receive arbitrary pieces of data between LayerZero contracts.
+* {ERC20}: the standard ERC-20 implementation from OpenZeppelin, providing basic token functionalities like transfer, balance tracking, and allowances.
+
+Additionally there are multiple custom extensions, including:
+
+* **{ProxyOFTV2}**: an implementation that allows an already deployed ERC20 to expand to any supported chain as a native token.
+* {NativeOFTV2}: support for native gas token transfers.
+* {OFTWithFee}: support for custom fees on token transfer.
+
+### Core
+
+{{OFTV2}}
+
+{{BaseOFTV2}}
+
+{{OFTCoreV2}}
+
+{{IOFTV2}}
+
+{{ERC20}}
+
+> **NOTE:** This core set of contracts is designed to be unopinionated, allowing developers to access the internal functions in `OFTV2.sol`, `BaseOFTV2.sol`, and `OFTCoreV2.sol`, and expose them as external functions in the way they prefer.
+
+### Extensions
+
+{{OFTWithFee}}
+
+{{ProxyOFTWithFee}}
+
+{{NativeOFTV2}}
+
+{{NativeOFTWithFee}}
+
+> **NOTE:** We encourage developers to explore the internal workings of the `OFTV2` contract to fully utilize its capabilities in omnichain environments.
diff --git a/contracts/token/oft/v2/NativeOFTV2.sol → ...ken/oft/latest/extensions/NativeOFTV2.sol b/contracts/token/oft/v2/NativeOFTV2.sol → ...ken/oft/latest/extensions/NativeOFTV2.sol
diff --git a/...racts/token/oft/v2/fee/BaseOFTWithFee.sol → .../latest/extensions/fee/BaseOFTWithFee.sol b/...racts/token/oft/v2/fee/BaseOFTWithFee.sol → .../latest/extensions/fee/BaseOFTWithFee.sol
diff --git a/contracts/token/oft/v2/fee/Fee.sol → ...s/token/oft/latest/extensions/fee/Fee.sol b/contracts/token/oft/v2/fee/Fee.sol → ...s/token/oft/latest/extensions/fee/Fee.sol
diff --git a/contracts/token/oft/v2/fee/IOFTWithFee.sol → ...oft/latest/extensions/fee/IOFTWithFee.sol b/contracts/token/oft/v2/fee/IOFTWithFee.sol → ...oft/latest/extensions/fee/IOFTWithFee.sol
diff --git a/...cts/token/oft/v2/fee/NativeOFTWithFee.sol → ...atest/extensions/fee/NativeOFTWithFee.sol b/...cts/token/oft/v2/fee/NativeOFTWithFee.sol → ...atest/extensions/fee/NativeOFTWithFee.sol
diff --git a/contracts/token/oft/v2/fee/OFTWithFee.sol → .../oft/latest/extensions/fee/OFTWithFee.sol b/contracts/token/oft/v2/fee/OFTWithFee.sol → .../oft/latest/extensions/fee/OFTWithFee.sol
diff --git a/...acts/token/oft/v2/fee/ProxyOFTWithFee.sol → ...latest/extensions/fee/ProxyOFTWithFee.sol b/...acts/token/oft/v2/fee/ProxyOFTWithFee.sol → ...latest/extensions/fee/ProxyOFTWithFee.sol
diff --git a/...ts/token/oft/v2/interfaces/ICommonOFT.sol → ...oken/oft/latest/interfaces/ICommonOFT.sol b/...ts/token/oft/v2/interfaces/ICommonOFT.sol → ...oken/oft/latest/interfaces/ICommonOFT.sol
diff --git a/...oken/oft/v2/interfaces/IOFTReceiverV2.sol → .../oft/latest/interfaces/IOFTReceiverV2.sol b/...oken/oft/v2/interfaces/IOFTReceiverV2.sol → .../oft/latest/interfaces/IOFTReceiverV2.sol
diff --git a/contracts/token/oft/v2/interfaces/IOFTV2.sol → ...ts/token/oft/latest/interfaces/IOFTV2.sol b/contracts/token/oft/v2/interfaces/IOFTV2.sol → ...ts/token/oft/latest/interfaces/IOFTV2.sol
diff --git a/...s/token/oft/v2/mocks/OFTStakingMockV2.sol → ...en/oft/latest/mocks/OFTReceiverMockV2.sol b/...s/token/oft/v2/mocks/OFTStakingMockV2.sol → ...en/oft/latest/mocks/OFTReceiverMockV2.sol
diff --git a/contracts/token/oft/v2/mocks/OFTV2Mock.sol → ...acts/token/oft/latest/mocks/OFTV2Mock.sol b/contracts/token/oft/v2/mocks/OFTV2Mock.sol → ...acts/token/oft/latest/mocks/OFTV2Mock.sol
diff --git a/contracts/token/oft/v1/NativeOFT.sol → contracts/token/oft/legacy/NativeOFT.sol b/contracts/token/oft/v1/NativeOFT.sol → contracts/token/oft/legacy/NativeOFT.sol
diff --git a/contracts/token/oft/v1/OFT.sol → contracts/token/oft/legacy/OFT.sol b/contracts/token/oft/v1/OFT.sol → contracts/token/oft/legacy/OFT.sol
diff --git a/contracts/token/oft/v1/OFTCore.sol → contracts/token/oft/legacy/OFTCore.sol b/contracts/token/oft/v1/OFTCore.sol → contracts/token/oft/legacy/OFTCore.sol
diff --git a/contracts/token/oft/v1/ProxyOFT.sol → contracts/token/oft/legacy/ProxyOFT.sol b/contracts/token/oft/v1/ProxyOFT.sol → contracts/token/oft/legacy/ProxyOFT.sol
diff --git a/contracts/token/oft/v1/interfaces/IOFT.sol → ...acts/token/oft/legacy/interfaces/IOFT.sol b/contracts/token/oft/v1/interfaces/IOFT.sol → ...acts/token/oft/legacy/interfaces/IOFT.sol
diff --git a/...acts/token/oft/v1/interfaces/IOFTCore.sol → .../token/oft/legacy/interfaces/IOFTCore.sol b/...acts/token/oft/v1/interfaces/IOFTCore.sol → .../token/oft/legacy/interfaces/IOFTCore.sol
diff --git a/contracts/token/oft/v1/mocks/OFTMock.sol → contracts/token/oft/legacy/mocks/OFTMock.sol b/contracts/token/oft/v1/mocks/OFTMock.sol → contracts/token/oft/legacy/mocks/OFTMock.sol
diff --git a/contracts/token/oft/v2/README.md b/contracts/token/oft/v2/README.md