+ 
- Homepage | Docs | Developers + LayerZero Docs
-OApp Example
+Omnichain Application (OApp) Example
-- Quickstart | Configuration | Message Execution Options | Endpoint Addresses -
+Template project for creating custom omnichain applications (OApp) powered by the LayerZero protocol. This example demonstrates how to build applications that can send and receive arbitrary messages across different blockchains.
+ +## Table of Contents + +- [Prerequisite Knowledge](#prerequisite-knowledge) +- [Requirements](#requirements) +- [Scaffold this example](#scaffold-this-example) +- [Helper Tasks](#helper-tasks) +- [Setup](#setup) +- [Build](#build) + - [Compiling your contracts](#compiling-your-contracts) +- [Deploy](#deploy) +- [Enable Messaging](#enable-messaging) +- [Sending Messages](#sending-messages) +- [Next Steps](#next-steps) +- [Production Deployment Checklist](#production-deployment-checklist) +- [Appendix](#appendix) + - [Running Tests](#running-tests) + - [Adding other chains](#adding-other-chains) + - [Using Multisigs](#using-multisigs) + - [LayerZero Hardhat Helper Tasks](#layerzero-hardhat-helper-tasks) + - [Contract Verification](#contract-verification) + - [Troubleshooting](#troubleshooting) -Template project for getting started with LayerZero's OApp contract development.
+ Join our community! | Follow us on X (formerly Twitter) +
+ +# Appendix + +## Running Tests + +Similar to the contract compilation, we support both `hardhat` and `forge` tests. By default, the `test` command will execute both: ```bash pnpm test @@ -65,52 +180,133 @@ pnpm test:forge pnpm test:hardhat ``` -Or adjust the `package.json` to for example remove `hardhat` tests: +## Adding other chains -```diff -- "test": "$npm_execpath test:forge && $npm_execpath test:hardhat", -- "test:forge": "forge test", -- "test:hardhat": "$npm_execpath hardhat test" -+ "test": "forge test" -``` +If you're adding another EVM chain, first, add it to the `hardhat.config.ts`. Adding non-EVM chains do not require modifying the `hardhat.config.ts`. -## 2) Deploying Contracts +Then, modify `layerzero.config.ts` with the following changes: -Set up deployer wallet/account: +- declare a new contract object (specifying the `eid` and `contractName`) +- decide whether to use an existing EVM enforced options variable or declare a new one +- create a new entry in the `connections` array +- add the new contract into the `contracts` array of the `export default` function -- Rename `.env.example` -> `.env` -- Choose your preferred means of setting up your deployer wallet/account: +After applying the desired changes, make sure you re-run the wiring task: +```bash +pnpm hardhat lz:oapp:wire --oapp-config layerzero.config.ts ``` -MNEMONIC="test test test test test test test test test test test junk" -or... -PRIVATE_KEY="0xabc...def" + +## Using Multisigs + +The wiring task supports the usage of Safe Multisigs. + +To use a Safe multisig as the signer for these transactions, add the following to each network in your `hardhat.config.ts` and add the `--safe` flag to `lz:oapp:wire --safe`: + +```typescript +// hardhat.config.ts + +networks: { + // Include configurations for other networks as needed + fuji: { + /* ... */ + // Network-specific settings + safeConfig: { + safeUrl: 'http://something', // URL of the Safe API, not the Safe itself + safeAddress: 'address' + } + } +} ``` -To deploy your contracts to your desired blockchains, run the following command in your project's folder: +## LayerZero Hardhat Helper Tasks + +LayerZero Devtools provides several helper hardhat tasks to easily deploy, verify, configure, connect, and interact with OApps cross-chain. + + pnpm hardhat lz:deploy
+
+ + +Deploys your contract to any of the available networks in your [`hardhat.config.ts`](./hardhat.config.ts) when given a deploy tag (by default contract name) and returns a list of available networks to select for the deployment. For specifics around all deployment options, please refer to the [Deploying Contracts](https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/deploying) section of the documentation. LayerZero's `lz:deploy` utilizes `hardhat-deploy`. + +More information about available CLI arguments can be found using the `--help` flag: ```bash -npx hardhat lz:deploy +pnpm hardhat lz:deploy --help ``` -More information about available CLI arguments can be found using the `--help` flag: +
pnpm hardhat lz:oapp:config:init --oapp-config YOUR_OAPP_CONFIG --contract-name CONTRACT_NAME
+
+ + +Initializes a `layerzero.config.ts` file for all available pathways between your hardhat networks with the current LayerZero default placeholder settings. This task can be incredibly useful for correctly formatting your config file. + +You can run this task by providing the `contract-name` you want to set for the config and `file-name` you want to generate: ```bash -npx hardhat lz:deploy --help +pnpm hardhat lz:oapp:config:init --contract-name CONTRACT_NAME --oapp-config FILE_NAME ``` -## 3) Connecting Contracts +
pnpm hardhat lz:oapp:config:wire --oapp-config YOUR_OAPP_CONFIG
+
+ -Wire your deployed contracts by running: +Calls the configuration functions between your deployed OApp contracts on every chain based on the provided `layerzero.config.ts`. + +Running `lz:oapp:wire` will make the following function calls per pathway connection for a fully defined config file using your specified settings and your environment variables (Private Keys and RPCs): + +-
function setPeer(uint32 \_eid, bytes32 \_peer) public virtual onlyOwner {}
+
+- function setConfig(address \_oapp, address \_lib, SetConfigParam[] calldata \_params) external onlyRegistered(\_lib) {}
+
+- function setEnforcedOptions(EnforcedOptionParam[] calldata \_enforcedOptions) public virtual onlyOwner {}
+
+- function setSendLibrary(address \_oapp, uint32 \_eid, address \_newLib) external onlyRegisteredOrDefault(\_newLib) onlySupportedEid(\_newLib, \_eid) {}
+
+- function setReceiveLibrary(address \_oapp, uint32 \_eid, address \_newLib, uint256 \_gracePeriod) external onlyRegisteredOrDefault(\_newLib) isReceiveLib(\_newLib) onlySupportedEid(\_newLib, \_eid) {}
+
+To use this task, run:
```bash
-npx hardhat lz:oapp:wire --oapp-config layerzero.config.ts
+pnpm hardhat lz:oapp:wire --oapp-config YOUR_LAYERZERO_CONFIG_FILE
```
-By following these steps, you can focus more on creating innovative omnichain solutions and less on the complexities of cross-chain communication.
+Whenever you make changes to the configuration, run `lz:oapp:wire` again. The task will check your current configuration, and only apply NEW changes.
-+
- Join our community! | Follow us on X (formerly Twitter) -
+ pnpm hardhat lz:oapp:config:get --oapp-config YOUR_OAPP_CONFIG
+
+ + +Returns your current OApp's configuration for each chain and pathway in 3 columns: + +- **Custom Configuration**: the changes that your `layerzero.config.ts` currently has set + +- **Default Configuration**: the default placeholder configuration that LayerZero provides + +- **Active Configuration**: the active configuration that applies to the message pathway (Defaults + Custom Values) + +If you do NOT explicitly set each configuration parameter, your OApp will fallback to the placeholder parameters in the default config. + +
- Homepage | Docs | Developers + LayerZero Docs
-OFTAdapter Example
+OFT Adapter Example
-- Quickstart | Configuration | Message Execution Options | Endpoint Addresses -
+Template project for converting an existing token into a cross-chain token (OFT) using the LayerZero protocol. This example's config involves EVM chains, but the same OFT can be extended to involve other VM chains such as Solana, Aptos and Hyperliquid.
-Template project for getting started with LayerZero's OFTAdapter contract development.
+ Join our community! | Follow us on X (formerly Twitter) +
+ +# Appendix -Similarly to the contract compilation, we support both `hardhat` and `forge` tests. By default, the `test` command will execute both: +## Running Tests + +Similar to the contract compilation, we support both `hardhat` and `forge` tests. By default, the `test` command will execute both: ```bash pnpm test @@ -75,46 +309,427 @@ pnpm test:forge pnpm test:hardhat ``` -Or adjust the `package.json` to for example remove `hardhat` tests: +## Adding other chains + + + +If you're adding another EVM chain, first, add it to the `hardhat.config.ts`. Adding non-EVM chains do not require modifying the `hardhat.config.ts`. + + + +Then, modify `layerzero.config.ts` with the following changes: -```diff -- "test": "$npm_execpath test:forge && $npm_execpath test:hardhat", -- "test:forge": "forge test", -- "test:hardhat": "$npm_execpath hardhat test" -+ "test": "forge test" +- declare a new contract object (specifying the `eid` and `contractName`) +- decide whether to use an existing EVM enforced options variable or declare a new one +- create a new entry in the `pathways` variable +- add the new contract into the `contracts` key of the `return` of the `export default` function + +After applying the desired changes, make sure you re-run the wiring task: + +```bash +pnpm hardhat lz:oapp:wire --oapp-config layerzero.config.ts ``` -## 2) Deploying Contracts +## Using Multisigs -Set up deployer wallet/account: +The wiring task supports the usage of Safe Multisigs. -- Rename `.env.example` -> `.env` -- Choose your preferred means of setting up your deployer wallet/account: +To use a Safe multisig as the signer for these transactions, add the following to each network in your `hardhat.config.ts` and add the `--safe` flag to `lz:oapp:wire --safe`: +```typescript +// hardhat.config.ts + +networks: { + // Include configurations for other networks as needed + fuji: { + /* ... */ + // Network-specific settings + safeConfig: { + safeUrl: 'http://something', // URL of the Safe API, not the Safe itself + safeAddress: 'address' + } + } +} ``` -MNEMONIC="test test test test test test test test test test test junk" -or... -PRIVATE_KEY="0xabc...def" + +## LayerZero Hardhat Helper Tasks + +LayerZero Devtools provides several helper hardhat tasks to easily deploy, verify, configure, connect, and send OFTs cross-chain. + + pnpm hardhat lz:deploy
+
+ + +Deploys your contract to any of the available networks in your [`hardhat.config.ts`](./hardhat.config.ts) when given a deploy tag (by default contract name) and returns a list of available networks to select for the deployment. For specifics around all deployment options, please refer to the [Deploying Contracts](https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/deploying) section of the documentation. LayerZero's `lz:deploy` utilizes `hardhat-deploy`. + +```typescript +'arbitrum-sepolia': { + eid: EndpointId.ARBSEP_V2_TESTNET, + url: process.env.RPC_URL_ARBSEP_TESTNET, + accounts, +}, +'base-sepolia': { + eid: EndpointId.BASESEP_V2_TESTNET, + url: process.env.RPC_URL_BASE_TESTNET, + accounts, +}, +``` + +More information about available CLI arguments can be found using the `--help` flag: + +```bash +pnpm hardhat lz:deploy --help ``` -- Fund this address with the corresponding chain's native tokens you want to deploy to. +
pnpm hardhat lz:oapp:config:init --oapp-config YOUR_OAPP_CONFIG --contract-name CONTRACT_NAME
+
+ -To deploy your contracts to your desired blockchains, run the following command in your project's folder: +Initializes a `layerzero.config.ts` file for all available pathways between your hardhat networks with the current LayerZero default placeholder settings. This task can be incredibly useful for correctly formatting your config file. + +You can run this task by providing the `contract-name` you want to set for the config and `file-name` you want to generate: ```bash -npx hardhat lz:deploy +pnpm hardhat lz:oapp:config:init --contract-name CONTRACT_NAME --oapp-config FILE_NAME ``` -More information about available CLI arguments can be found using the `--help` flag: +This will create a `layerzero.config.ts` in your working directory populated with your contract name and connections for every pathway possible between your hardhat networks: + +```typescript +import { EndpointId } from "@layerzerolabs/lz-definitions"; + +const arbsepContract = { + eid: EndpointId.ARBSEP_V2_TESTNET, + contractName: "MyOFT", +}; +const sepoliaContract = { + eid: EndpointId.SEPOLIA_V2_TESTNET, + contractName: "MyOFT", +}; + +export default { + contracts: [{ contract: arbsepContract }, { contract: sepoliaContract }], + connections: [ + { + from: arbsepContract, + to: sepoliaContract, + config: { + sendLibrary: "0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E", + receiveLibraryConfig: { + receiveLibrary: "0x75Db67CDab2824970131D5aa9CECfC9F69c69636", + gracePeriod: 0, + }, + sendConfig: { + executorConfig: { + maxMessageSize: 10000, + executor: "0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897", + }, + ulnConfig: { + confirmations: 1, + requiredDVNs: ["0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8"], + optionalDVNs: [], + optionalDVNThreshold: 0, + }, + }, + // receiveConfig: { + // ulnConfig: { + // confirmations: 2, + // requiredDVNs: ['0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8'], + // optionalDVNs: [], + // optionalDVNThreshold: 0, + // }, + // }, + }, + }, + { + from: sepoliaContract, + to: arbsepContract, + config: { + sendLibrary: "0xcc1ae8Cf5D3904Cef3360A9532B477529b177cCE", + receiveLibraryConfig: { + receiveLibrary: "0xdAf00F5eE2158dD58E0d3857851c432E34A3A851", + gracePeriod: 0, + }, + // sendConfig: { + // executorConfig: { maxMessageSize: 10000, executor: '0x718B92b5CB0a5552039B593faF724D182A881eDA' }, + // ulnConfig: { + // confirmations: 2, + // requiredDVNs: ['0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193'], + // optionalDVNs: [], + // optionalDVNThreshold: 0, + // }, + // }, + receiveConfig: { + ulnConfig: { + confirmations: 1, + requiredDVNs: ["0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193"], + optionalDVNs: [], + optionalDVNThreshold: 0, + }, + }, + }, + }, + ], +}; +``` + +
pnpm hardhat lz:oapp:config:wire --oapp-config YOUR_OAPP_CONFIG
+
+ + +Calls the configuration functions between your deployed OApp contracts on every chain based on the provided `layerzero.config.ts`. + +Running `lz:oapp:wire` will make the following function calls per pathway connection for a fully defined config file using your specified settings and your environment variables (Private Keys and RPCs): + +-
function setPeer(uint32 \_eid, bytes32 \_peer) public virtual onlyOwner {}
+
+- function setConfig(address \_oapp, address \_lib, SetConfigParam[] calldata \_params) external onlyRegistered(\_lib) {}
+
+- function setEnforcedOptions(EnforcedOptionParam[] calldata \_enforcedOptions) public virtual onlyOwner {}
+
+- function setSendLibrary(address \_oapp, uint32 \_eid, address \_newLib) external onlyRegisteredOrDefault(\_newLib) isSendLib(\_newLib) onlySupportedEid(\_newLib, \_eid) {}
+
+- function setReceiveLibrary(address \_oapp, uint32 \_eid, address \_newLib, uint256 \_gracePeriod) external onlyRegisteredOrDefault(\_newLib) isReceiveLib(\_newLib) onlySupportedEid(\_newLib, \_eid) {}
+
+To use this task, run:
```bash
-npx hardhat lz:deploy --help
+pnpm hardhat lz:oapp:wire --oapp-config YOUR_LAYERZERO_CONFIG_FILE
```
-By following these steps, you can focus more on creating innovative omnichain solutions and less on the complexities of cross-chain communication.
+Whenever you make changes to the configuration, run `lz:oapp:wire` again. The task will check your current configuration, and only apply NEW changes.
-+
pnpm hardhat lz:oapp:config:get --oapp-config YOUR_OAPP_CONFIG
-- Join our community! | Follow us on X (formerly Twitter) -
++ +Returns your current OApp's configuration for each chain and pathway in 3 columns: + +- **Custom Configuration**: the changes that your `layerzero.config.ts` currently has set + +- **Default Configuration**: the default placeholder configuration that LayerZero provides + +- **Active Configuration**: the active configuration that applies to the message pathway (Defaults + Custom Values) + +If you do NOT explicitly set each configuration parameter, your OApp will fallback to the placeholder parameters in the default config. + +```bash +┌────────────────────┬───────────────────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────┐ +│ │ Custom OApp Config │ Default OApp Config │ Active OApp Config │ +├────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ localNetworkName │ arbsep │ arbsep │ arbsep │ +├────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ remoteNetworkName │ sepolia │ sepolia │ sepolia │ +├────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ sendLibrary │ 0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E │ 0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E │ 0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E │ +├────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ receiveLibrary │ 0x75Db67CDab2824970131D5aa9CECfC9F69c69636 │ 0x75Db67CDab2824970131D5aa9CECfC9F69c69636 │ 0x75Db67CDab2824970131D5aa9CECfC9F69c69636 │ +├────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ sendUlnConfig │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ +│ │ │ confirmations │ 1 │ │ │ confirmations │ 1 │ │ │ confirmations │ 1 │ │ +│ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ +│ │ │ requiredDVNs │ ┌───┬────────────────────────────────────────────┐ │ │ │ requiredDVNs │ ┌───┬────────────────────────────────────────────┐ │ │ │ requiredDVNs │ ┌───┬────────────────────────────────────────────┐ │ │ +│ │ │ │ │ 0 │ 0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8 │ │ │ │ │ │ 0 │ 0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8 │ │ │ │ │ │ 0 │ 0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8 │ │ │ +│ │ │ │ └───┴────────────────────────────────────────────┘ │ │ │ │ └───┴────────────────────────────────────────────┘ │ │ │ │ └───┴────────────────────────────────────────────┘ │ +│ │ │ │ │ │ │ │ │ │ │ │ │ │ +│ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ +│ │ │ optionalDVNs │ │ │ │ optionalDVNs │ │ │ │ optionalDVNs │ │ │ +│ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ +│ │ │ optionalDVNThreshold │ 0 │ │ │ optionalDVNThreshold │ 0 │ │ │ optionalDVNThreshold │ 0 │ │ +│ │ └──────────────────────┴────────────────────────────────────────────────────┘ │ └──────────────────────┴────────────────────────────────────────────────────┘ │ └──────────────────────┴────────────────────────────────────────────────────┘ │ +│ │ │ │ │ +├────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ sendExecutorConfig │ ┌────────────────┬────────────────────────────────────────────┐ │ ┌────────────────┬────────────────────────────────────────────┐ │ ┌────────────────┬────────────────────────────────────────────┐ │ +│ │ │ executor │ 0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897 │ │ │ executor │ 0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897 │ │ │ executor │ 0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897 │ │ +│ │ ├────────────────┼────────────────────────────────────────────┤ │ ├────────────────┼────────────────────────────────────────────┤ │ ├────────────────┼────────────────────────────────────────────┤ │ +│ │ │ maxMessageSize │ 10000 │ │ │ maxMessageSize │ 10000 │ │ │ maxMessageSize │ 10000 │ │ +│ │ └────────────────┴────────────────────────────────────────────┘ │ └────────────────┴────────────────────────────────────────────┘ │ └────────────────┴────────────────────────────────────────────┘ │ +│ │ │ │ │ +├────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ receiveUlnConfig │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ +│ │ │ confirmations │ 2 │ │ │ confirmations │ 2 │ │ │ confirmations │ 2 │ │ +│ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ +│ │ │ requiredDVNs │ ┌───┬────────────────────────────────────────────┐ │ │ │ requiredDVNs │ ┌───┬────────────────────────────────────────────┐ │ │ │ requiredDVNs │ ┌───┬────────────────────────────────────────────┐ │ │ +│ │ │ │ │ 0 │ 0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8 │ │ │ │ │ │ 0 │ 0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8 │ │ │ │ │ │ 0 │ 0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8 │ │ │ +│ │ │ │ └───┴────────────────────────────────────────────┘ │ │ │ │ └───┴────────────────────────────────────────────┘ │ │ │ │ └───┴────────────────────────────────────────────┘ │ │ +│ │ │ │ │ │ │ │ │ │ │ │ │ │ +│ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ +│ │ │ optionalDVNs │ │ │ │ optionalDVNs │ │ │ │ optionalDVNs │ │ │ +│ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ +│ │ │ optionalDVNThreshold │ 0 │ │ │ optionalDVNThreshold │ 0 │ │ │ optionalDVNThreshold │ 0 │ │ +│ │ └──────────────────────┴────────────────────────────────────────────────────┘ │ └──────────────────────┴────────────────────────────────────────────────────┘ │ └──────────────────────┴────────────────────────────────────────────────────┘ │ +│ │ │ │ │ +└────────────────────┴───────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────┘ +``` + +
pnpm hardhat lz:oapp:config:get:executor --oapp-config YOUR_OAPP_CONFIG
+
+ + +Returns the LayerZero Executor config for each network in your `hardhat.config.ts`. You can use this method to see the max destination gas in wei (`nativeCap`) you can request in your [`execution options`](https://docs.layerzero.network/v2/developers/evm/gas-settings/options). + +```bash +┌───────────────────┬────────────────────────────────────────────┐ +│ localNetworkName │ mantle │ +├───────────────────┼────────────────────────────────────────────┤ +│ remoteNetworkName │ polygon │ +├───────────────────┼────────────────────────────────────────────┤ +│ executorDstConfig │ ┌────────────────┬───────────────────────┐ │ +│ │ │ baseGas │ 85000 │ │ +│ │ ├────────────────┼───────────────────────┤ │ +│ │ │ multiplierBps │ 12000 │ │ +│ │ ├────────────────┼───────────────────────┤ │ +│ │ │ floorMarginUSD │ 5000000000000000000 │ │ +│ │ ├────────────────┼───────────────────────┤ │ +│ │ │ nativeCap │ 681000000000000000000 │ │ +│ │ └────────────────┴───────────────────────┘ │ +│ │ │ +└───────────────────┴────────────────────────────────────────────┘ +``` + +
- Homepage | Docs | Developers + LayerZero Docs
-Omnichain Fungible Token (OFT) Upgradeable Example
- -- Quickstart | Configuration | Message Execution Options | Endpoint, MessageLib, & Executor Addresses | DVN Addresses -
- -Template project for getting started with LayerZero's OFT contract standard.
EVM-to-EVM Omnichain Fungible Token (OFT) Upgradeable Example
+ +Template project for an upgradeable cross-chain token (OFT) powered by the LayerZero protocol. This example's config involves EVM chains, but the same OFT can be extended to involve other VM chains such as Solana, Aptos and Hyperliquid.
+ +## Table of Contents + +- [Prerequisite Knowledge](#prerequisite-knowledge) +- [Requirements](#requirements) +- [Scaffold this example](#scaffold-this-example) +- [Helper Tasks](#helper-tasks) +- [Setup](#setup) +- [Build](#build) + - [Compiling your contracts](#compiling-your-contracts) +- [Deploy](#deploy) +- [Enable Messaging](#enable-messaging) +- [Sending OFTs](#sending-ofts) +- [Next Steps](#next-steps) +- [Production Deployment Checklist](#production-deployment-checklist) + - [Profiling `lzReceive` and `lzCompose` Gas Usage](#profiling-lzreceive-and-lzcompose-gas-usage) + - [Available Commands](#available-commands) + - [`lzReceive`](#lzreceive) + - [`lzCompose`](#lzcompose) + - [Usage Examples](#usage-examples) + - [Notes](#notes) +- [Appendix](#appendix) + - [Running Tests](#running-tests) + - [Adding other chains](#adding-other-chains) + - [Using Multisigs](#using-multisigs) + - [LayerZero Hardhat Helper Tasks](#layerzero-hardhat-helper-tasks) + - [Manual Configuration](#manual-configuration) + - [Contract Verification](#contract-verification) + - [Troubleshooting](#troubleshooting) + +## Prerequisite Knowledge + +- [What is an OFT (Omnichain Fungible Token) ?](https://docs.layerzero.network/v2/concepts/applications/oft-standard) +- [What is an OApp (Omnichain Application) ?](https://docs.layerzero.network/v2/concepts/applications/oapp-standard) + +## Introduction + +This example contains 4 OFT variations: + +- `MyOFTAdapterFeeUpgradeable` +- `MyOFTAdapterUpgradeable` +- `MyOFTFeeUpgradeable` +- `MyOFTUpgradeable` + +The walkthrough will use `MyOFTUpgradeable` but you can as easily swap out the `contractName` (in the [Deploy](#deploy) step onwards). :warning: With great power comes great responsibility. Upgradeable contracts are powerful, but they also come with risks. Please ensure you understand the risks before deploying an upgradeable contract. For more information on the @@ -23,35 +63,309 @@ limitations of upgradeable contracts, please see the [OpenZeppelin documentation](https://docs.openzeppelin.com/contracts/5.x/upgradeable). Further, consider fully testing any and all upgrades thoroughly before deploying to production. -
+
+This project supports both `hardhat` and `forge` compilation. By default, the `compile` command will execute both:
+
+```bash
+pnpm compile
+```
+
+If you prefer one over the other, you can use the tooling-specific commands:
+
+```bash
+pnpm compile:forge
+pnpm compile:hardhat
+```
+
+## Deploy
+
+To deploy the OFT contracts to your desired blockchains, run the following command:
+
+```bash
+pnpm hardhat lz:deploy --tags MyOFTUpgradeableMock
+```
+
+> :information_source: MyOFTUpgradeableMock will be used as it provides a public mint function which we require for testing
+
+> If you would like to try any of the other 3 variants (`MyOFTAdapterFeeUpgradeable`, `MyOFTAdapterUpgradeable`, `MyOFTFeeUpgradeable`), replace `MyOFTUpgradeableMock` with the name of the variant you'd like to deploy.
+
+Select all the chains you want to deploy the OFT to.
+
+## Enable Messaging
+
+The OFT standard builds on top of the OApp standard, which enables generic message-passing between chains. After deploying the OFT on the respective chains, you enable messaging by running the [wiring](https://docs.layerzero.network/v2/concepts/glossary#wire--wiring) task.
+
+> :information_source: This example uses the [Simple Config Generator](https://docs.layerzero.network/v2/developers/evm/technical-reference/simple-config), which is recommended over manual configuration.
+
+> If you are deploying a variant other than `MyOFTUpgradeableMock`, you would need to update the `layerzero.config.ts` so that the contract object uses the correct `contractName` value.
+
+Run the wiring task:
+
+```bash
+pnpm hardhat lz:oapp:wire --oapp-config layerzero.config.ts
+```
+
+Submit all the transactions to complete wiring. After all transactions confirm, your OApps are wired and can send messages to each other.
+
+## Sending OFTs
+
+With your OFTs wired, you can now send them cross chain.
+
+First, via the mock contract, let's mint on **Optimism Sepolia**:
+
+```
+cast send
+ Join our community! | Follow us on X (formerly Twitter)
- Join our community! | Follow us on X (formerly Twitter)
-
- Homepage | Docs | Developers
+ LayerZero Docs
Template project for a cross-chain token (OFT) powered by the LayerZero protocol. This example's config involves EVM chains, but the same OFT can be extended to involve other VM chains such as Solana, Aptos and Hyperliquid.
- Quickstart | Configuration | Message Execution Options | Endpoint, MessageLib, & Executor Addresses | DVN Addresses
+ Join our community! | Follow us on X (formerly Twitter)
Template project for getting started with LayerZero's
+## Running Tests
-- [So What is an Omnichain Fungible Token?](#so-what-is-an-omnichain-fungible-token)
-- [Available Helpers in this Repo](#layerzero-hardhat-helper-tasks)
+Similar to the contract compilation, we support both `hardhat` and `forge` tests. By default, the `test` command will execute both:
-
- Join our community! | Follow us on X (formerly Twitter)
-
+Then, modify `layerzero.config.ts` with the following changes:
-This standard works by combining the LayerZero OApp Contract Standard with the ERC20 [`_burn`](https://github.com/LayerZero-Labs/LayerZero-v2/blob/main/packages/layerzero-v2/evm/oapp/contracts/oft/OFT.sol#L80) method, to initiate omnichain send transfers on the source chain, sending a message via the LayerZero protocol, and delivering a function call to the destination contract to [`_mint`](https://github.com/LayerZero-Labs/LayerZero-v2/blob/main/packages/layerzero-v2/evm/oapp/contracts/oft/OFT.sol#L96) the same number of tokens burned, creating a unified supply across all networks connected.
+- declare a new contract object (specifying the `eid` and `contractName`)
+- decide whether to use an existing EVM enforced options variable or declare a new one
+- create a new entry in the `pathways` variable
+- add the new contract into the `contracts` key of the `return` of the `export default` function
-Read more about what you can do with OFTs by reading the [OFT Quickstart](https://docs.layerzero.network/v2/developers/evm/oft/quickstart) in the LayerZero Documentation.
+After applying the desired changes, make sure you re-run the wiring task:
+
+```bash
+pnpm hardhat lz:oapp:wire --oapp-config layerzero.config.ts
+```
+
+## Using Multisigs
+
+The wiring task supports the usage of Safe Multisigs.
+
+To use a Safe multisig as the signer for these transactions, add the following to each network in your `hardhat.config.ts` and add the `--safe` flag to `lz:oapp:wire --safe`:
+
+```typescript
+// hardhat.config.ts
+
+networks: {
+ // Include configurations for other networks as needed
+ fuji: {
+ /* ... */
+ // Network-specific settings
+ safeConfig: {
+ safeUrl: 'http://something', // URL of the Safe API, not the Safe itself
+ safeAddress: 'address'
+ }
+ }
+}
+```
## LayerZero Hardhat Helper Tasks
LayerZero Devtools provides several helper hardhat tasks to easily deploy, verify, configure, connect, and send OFTs cross-chain.
+npx hardhat lz:deploy
pnpm hardhat lz:deploy
Deploys your contract to any of the available networks in your [`hardhat.config.ts`](./hardhat.config.ts) when given a deploy tag (by default contract name) and returns a list of available networks to select for the deployment. For specifics around all deployment options, please refer to the [Deploying Contracts](https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/deploying) section of the documentation. LayerZero's `lz:deploy` utilizes `hardhat-deploy`.
-```yml
+```typescript
'arbitrum-sepolia': {
eid: EndpointId.ARBSEP_V2_TESTNET,
url: process.env.RPC_URL_ARBSEP_TESTNET,
@@ -64,10 +378,16 @@ Deploys your contract to any of the available networks in your [`hardhat.config.
},
```
+More information about available CLI arguments can be found using the `--help` flag:
+
+```bash
+pnpm hardhat lz:deploy --help
+```
+
+npx hardhat lz:oapp:config:init --oapp-config YOUR_OAPP_CONFIG --contract-name CONTRACT_NAME
pnpm hardhat lz:oapp:config:init --oapp-config YOUR_OAPP_CONFIG --contract-name CONTRACT_NAME
@@ -76,84 +396,93 @@ Initializes a `layerzero.config.ts` file for all available pathways between your
You can run this task by providing the `contract-name` you want to set for the config and `file-name` you want to generate:
```bash
-npx hardhat lz:oapp:config:init --contract-name CONTRACT_NAME --oapp-config FILE_NAME
+pnpm hardhat lz:oapp:config:init --contract-name CONTRACT_NAME --oapp-config FILE_NAME
```
This will create a `layerzero.config.ts` in your working directory populated with your contract name and connections for every pathway possible between your hardhat networks:
-```yml
-import { EndpointId } from '@layerzerolabs/lz-definitions'
+```typescript
+import { EndpointId } from "@layerzerolabs/lz-definitions";
const arbsepContract = {
- eid: EndpointId.ARBSEP_V2_TESTNET,
- contractName: 'MyOFT',
-}
+ eid: EndpointId.ARBSEP_V2_TESTNET,
+ contractName: "MyOFT",
+};
const sepoliaContract = {
- eid: EndpointId.SEPOLIA_V2_TESTNET,
- contractName: 'MyOFT',
-}
+ eid: EndpointId.SEPOLIA_V2_TESTNET,
+ contractName: "MyOFT",
+};
export default {
- contracts: [{ contract: arbsepContract }, { contract: sepoliaContract }],
- connections: [
- {
- from: arbsepContract,
- to: sepoliaContract,
- config: {
- sendLibrary: '0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E',
- receiveLibraryConfig: { receiveLibrary: '0x75Db67CDab2824970131D5aa9CECfC9F69c69636', gracePeriod: 0 },
- sendConfig: {
- executorConfig: { maxMessageSize: 10000, executor: '0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897' },
- ulnConfig: {
- confirmations: 1,
- requiredDVNs: ['0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8'],
- optionalDVNs: [],
- optionalDVNThreshold: 0,
- },
- },
- // receiveConfig: {
- // ulnConfig: {
- // confirmations: 2,
- // requiredDVNs: ['0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8'],
- // optionalDVNs: [],
- // optionalDVNThreshold: 0,
- // },
- // },
- },
+ contracts: [{ contract: arbsepContract }, { contract: sepoliaContract }],
+ connections: [
+ {
+ from: arbsepContract,
+ to: sepoliaContract,
+ config: {
+ sendLibrary: "0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E",
+ receiveLibraryConfig: {
+ receiveLibrary: "0x75Db67CDab2824970131D5aa9CECfC9F69c69636",
+ gracePeriod: 0,
},
- {
- from: sepoliaContract,
- to: arbsepContract,
- config: {
- sendLibrary: '0xcc1ae8Cf5D3904Cef3360A9532B477529b177cCE',
- receiveLibraryConfig: { receiveLibrary: '0xdAf00F5eE2158dD58E0d3857851c432E34A3A851', gracePeriod: 0 },
- // sendConfig: {
- // executorConfig: { maxMessageSize: 10000, executor: '0x718B92b5CB0a5552039B593faF724D182A881eDA' },
- // ulnConfig: {
- // confirmations: 2,
- // requiredDVNs: ['0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193'],
- // optionalDVNs: [],
- // optionalDVNThreshold: 0,
- // },
- // },
- receiveConfig: {
- ulnConfig: {
- confirmations: 1,
- requiredDVNs: ['0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193'],
- optionalDVNs: [],
- optionalDVNThreshold: 0,
- },
- },
- },
+ sendConfig: {
+ executorConfig: {
+ maxMessageSize: 10000,
+ executor: "0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897",
+ },
+ ulnConfig: {
+ confirmations: 1,
+ requiredDVNs: ["0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8"],
+ optionalDVNs: [],
+ optionalDVNThreshold: 0,
+ },
},
- ],
-}
+ // receiveConfig: {
+ // ulnConfig: {
+ // confirmations: 2,
+ // requiredDVNs: ['0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8'],
+ // optionalDVNs: [],
+ // optionalDVNThreshold: 0,
+ // },
+ // },
+ },
+ },
+ {
+ from: sepoliaContract,
+ to: arbsepContract,
+ config: {
+ sendLibrary: "0xcc1ae8Cf5D3904Cef3360A9532B477529b177cCE",
+ receiveLibraryConfig: {
+ receiveLibrary: "0xdAf00F5eE2158dD58E0d3857851c432E34A3A851",
+ gracePeriod: 0,
+ },
+ // sendConfig: {
+ // executorConfig: { maxMessageSize: 10000, executor: '0x718B92b5CB0a5552039B593faF724D182A881eDA' },
+ // ulnConfig: {
+ // confirmations: 2,
+ // requiredDVNs: ['0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193'],
+ // optionalDVNs: [],
+ // optionalDVNThreshold: 0,
+ // },
+ // },
+ receiveConfig: {
+ ulnConfig: {
+ confirmations: 1,
+ requiredDVNs: ["0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193"],
+ optionalDVNs: [],
+ optionalDVNThreshold: 0,
+ },
+ },
+ },
+ },
+ ],
+};
```
+npx hardhat lz:oapp:config:wire --oapp-config YOUR_OAPP_CONFIG
pnpm hardhat lz:oapp:config:wire --oapp-config YOUR_OAPP_CONFIG
@@ -174,32 +503,14 @@ Running `lz:oapp:wire` will make the following function calls per pathway connec
To use this task, run:
```bash
-npx hardhat lz:oapp:wire --oapp-config YOUR_LAYERZERO_CONFIG_FILE
+pnpm hardhat lz:oapp:wire --oapp-config YOUR_LAYERZERO_CONFIG_FILE
```
Whenever you make changes to the configuration, run `lz:oapp:wire` again. The task will check your current configuration, and only apply NEW changes.
-To use a Gnosis Safe multisig as the signer for these transactions, add the following to each network in your `hardhat.config.ts` and add the `--safe` flag to `lz:oapp:wire --safe`:
-
-```yml
-// hardhat.config.ts
-
-networks: {
- // Include configurations for other networks as needed
- fuji: {
- /* ... */
- // Network-specific settings
- safeConfig: {
- safeUrl: 'http://something', // URL of the Safe API, not the Safe itself
- safeAddress: 'address'
- }
- }
-}
-```
-
+npx hardhat lz:oapp:config:get --oapp-config YOUR_OAPP_CONFIG
pnpm hardhat lz:oapp:config:get --oapp-config YOUR_OAPP_CONFIG
@@ -264,7 +575,7 @@ If you do NOT explicitly set each configuration parameter, your OApp will fallba
+npx hardhat lz:oapp:config:get:executor --oapp-config YOUR_OAPP_CONFIG
pnpm hardhat lz:oapp:config:get:executor --oapp-config YOUR_OAPP_CONFIG
@@ -291,123 +602,13 @@ Returns the LayerZero Executor config for each network in your `hardhat.config.t
-
-## Connecting Contracts
-
-### Ethereum Configurations
+### Manual Configuration
-Fill out your `layerzero.config.ts` with the contracts you want to connect. You can generate the default config file for your declared hardhat networks by running:
+
-```bash
-npx hardhat lz:oapp:config:init --contract-name [YOUR_CONTRACT_NAME] --oapp-config [CONFIG_NAME]
-```
-
-> [!NOTE]
-> You may need to change the contract name if you're deploying multiple OApp contracts on different chains (e.g., OFT and OFT Adapter).
-
-
-
-```typescript
-const ethereumContract: OmniPointHardhat = {
- eid: EndpointId.ETHEREUM_V2_MAINNET,
- contractName: "MyOFTAdapter",
-};
-
-const arbitrumContract: OmniPointHardhat = {
- eid: EndpointId.ARBITRUM_V2_MAINNET,
- contractName: "MyOFT",
-};
-```
+This section only applies if you would like to configure manually instead of using the Simple Config Generator.
-Then define the pathway you want to create from and to each contract:
+Define the pathway you want to create from and to each contract:
```typescript
connections: [
@@ -452,7 +653,7 @@ connections: [
executor: contractsConfig.ethereum.executor,
},
ulnConfig: {
- // The number of block confirmations to wait on BSC before emitting the message from the source chain.
+ // The number of block confirmations to wait on Ethereum before emitting the message from the source chain.
confirmations: BigInt(15),
// The address of the DVNs you will pay to verify a sent message on the source chain ).
// The destination tx will wait until ALL `requiredDVNs` verify the message.
@@ -523,12 +724,14 @@ connections: [
];
```
-To set these config settings, run:
+### Contract Verification
+
+You can verify EVM chain contracts using the LayerZero helper package:
```bash
-npx hardhat lz:oapp:wire --oapp-config layerzero.config.ts
+pnpm dlx @layerzerolabs/verify-contract -n Omnichain Fungible Token (OFT) Example
+EVM-to-EVM Omnichain Fungible Token (OFT) Example
+
+OFT contract standard.
+If you're adding another EVM chain, first, add it to the `hardhat.config.ts`. Adding non-EVM chains do not require modifying the `hardhat.config.ts`.
-This standard works by combining the LayerZero OApp Contract Standard with the ERC20 [`_burn`](https://github.com/LayerZero-Labs/LayerZero-v2/blob/main/packages/layerzero-v2/evm/oapp/contracts/oft/OFT.sol#L80) method, to initiate omnichain send transfers on the source chain, sending a message via the LayerZero protocol, and delivering a function call to the destination contract to [`_mint`](https://github.com/LayerZero-Labs/LayerZero-v2/blob/main/packages/layerzero-v2/evm/oapp/contracts/oft/OFT.sol#L96) the same number of tokens burned, creating a unified supply across all networks connected.
+
-Read more about what you can do with OFTs by reading the [OFT Quickstart](https://docs.layerzero.network/v2/developers/evm/oft/quickstart) in the LayerZero Documentation.
+Then, modify `layerzero.config.ts` with the following changes:
+
+- declare a new contract object (specifying the `eid` and `contractName`)
+- decide whether to use an existing EVM enforced options variable or declare a new one
+- create a new entry in the `pathways` variable
+- add the new contract into the `contracts` key of the `return` of the `export default` function
+
+After applying the desired changes, make sure you re-run the wiring task:
+
+```bash
+pnpm hardhat lz:oapp:wire --oapp-config layerzero.config.ts
+```
+
+## Using Multisigs
+
+The wiring task supports the usage of Safe Multisigs.
+
+To use a Safe multisig as the signer for these transactions, add the following to each network in your `hardhat.config.ts` and add the `--safe` flag to `lz:oapp:wire --safe`:
+
+```typescript
+// hardhat.config.ts
+
+networks: {
+ // Include configurations for other networks as needed
+ fuji: {
+ /* ... */
+ // Network-specific settings
+ safeConfig: {
+ safeUrl: 'http://something', // URL of the Safe API, not the Safe itself
+ safeAddress: 'address'
+ }
+ }
+}
+```
## LayerZero Hardhat Helper Tasks
LayerZero Devtools provides several helper hardhat tasks to easily deploy, verify, configure, connect, and send OFTs cross-chain.
+npx hardhat lz:deploy
pnpm hardhat lz:deploy
Deploys your contract to any of the available networks in your [`hardhat.config.ts`](./hardhat.config.ts) when given a deploy tag (by default contract name) and returns a list of available networks to select for the deployment. For specifics around all deployment options, please refer to the [Deploying Contracts](https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/deploying) section of the documentation. LayerZero's `lz:deploy` utilizes `hardhat-deploy`.
-```yml
+```typescript
'arbitrum-sepolia': {
eid: EndpointId.ARBSEP_V2_TESTNET,
url: process.env.RPC_URL_ARBSEP_TESTNET,
@@ -58,10 +357,16 @@ Deploys your contract to any of the available networks in your [`hardhat.config.
},
```
+More information about available CLI arguments can be found using the `--help` flag:
+
+```bash
+pnpm hardhat lz:deploy --help
+```
+
+npx hardhat lz:oapp:config:init --oapp-config YOUR_OAPP_CONFIG --contract-name CONTRACT_NAME
pnpm hardhat lz:oapp:config:init --oapp-config YOUR_OAPP_CONFIG --contract-name CONTRACT_NAME
@@ -70,84 +375,93 @@ Initializes a `layerzero.config.ts` file for all available pathways between your
You can run this task by providing the `contract-name` you want to set for the config and `file-name` you want to generate:
```bash
-npx hardhat lz:oapp:config:init --contract-name CONTRACT_NAME --oapp-config FILE_NAME
+pnpm hardhat lz:oapp:config:init --contract-name CONTRACT_NAME --oapp-config FILE_NAME
```
This will create a `layerzero.config.ts` in your working directory populated with your contract name and connections for every pathway possible between your hardhat networks:
-```yml
-import { EndpointId } from '@layerzerolabs/lz-definitions'
+```typescript
+import { EndpointId } from "@layerzerolabs/lz-definitions";
const arbsepContract = {
- eid: EndpointId.ARBSEP_V2_TESTNET,
- contractName: 'MyOFT',
-}
+ eid: EndpointId.ARBSEP_V2_TESTNET,
+ contractName: "MyOFT",
+};
const sepoliaContract = {
- eid: EndpointId.SEPOLIA_V2_TESTNET,
- contractName: 'MyOFT',
-}
+ eid: EndpointId.SEPOLIA_V2_TESTNET,
+ contractName: "MyOFT",
+};
export default {
- contracts: [{ contract: arbsepContract }, { contract: sepoliaContract }],
- connections: [
- {
- from: arbsepContract,
- to: sepoliaContract,
- config: {
- sendLibrary: '0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E',
- receiveLibraryConfig: { receiveLibrary: '0x75Db67CDab2824970131D5aa9CECfC9F69c69636', gracePeriod: 0 },
- sendConfig: {
- executorConfig: { maxMessageSize: 10000, executor: '0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897' },
- ulnConfig: {
- confirmations: 1,
- requiredDVNs: ['0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8'],
- optionalDVNs: [],
- optionalDVNThreshold: 0,
- },
- },
- // receiveConfig: {
- // ulnConfig: {
- // confirmations: 2,
- // requiredDVNs: ['0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8'],
- // optionalDVNs: [],
- // optionalDVNThreshold: 0,
- // },
- // },
- },
+ contracts: [{ contract: arbsepContract }, { contract: sepoliaContract }],
+ connections: [
+ {
+ from: arbsepContract,
+ to: sepoliaContract,
+ config: {
+ sendLibrary: "0x4f7cd4DA19ABB31b0eC98b9066B9e857B1bf9C0E",
+ receiveLibraryConfig: {
+ receiveLibrary: "0x75Db67CDab2824970131D5aa9CECfC9F69c69636",
+ gracePeriod: 0,
},
- {
- from: sepoliaContract,
- to: arbsepContract,
- config: {
- sendLibrary: '0xcc1ae8Cf5D3904Cef3360A9532B477529b177cCE',
- receiveLibraryConfig: { receiveLibrary: '0xdAf00F5eE2158dD58E0d3857851c432E34A3A851', gracePeriod: 0 },
- // sendConfig: {
- // executorConfig: { maxMessageSize: 10000, executor: '0x718B92b5CB0a5552039B593faF724D182A881eDA' },
- // ulnConfig: {
- // confirmations: 2,
- // requiredDVNs: ['0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193'],
- // optionalDVNs: [],
- // optionalDVNThreshold: 0,
- // },
- // },
- receiveConfig: {
- ulnConfig: {
- confirmations: 1,
- requiredDVNs: ['0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193'],
- optionalDVNs: [],
- optionalDVNThreshold: 0,
- },
- },
- },
+ sendConfig: {
+ executorConfig: {
+ maxMessageSize: 10000,
+ executor: "0x5Df3a1cEbBD9c8BA7F8dF51Fd632A9aef8308897",
+ },
+ ulnConfig: {
+ confirmations: 1,
+ requiredDVNs: ["0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8"],
+ optionalDVNs: [],
+ optionalDVNThreshold: 0,
+ },
},
- ],
-}
+ // receiveConfig: {
+ // ulnConfig: {
+ // confirmations: 2,
+ // requiredDVNs: ['0x53f488E93b4f1b60E8E83aa374dBe1780A1EE8a8'],
+ // optionalDVNs: [],
+ // optionalDVNThreshold: 0,
+ // },
+ // },
+ },
+ },
+ {
+ from: sepoliaContract,
+ to: arbsepContract,
+ config: {
+ sendLibrary: "0xcc1ae8Cf5D3904Cef3360A9532B477529b177cCE",
+ receiveLibraryConfig: {
+ receiveLibrary: "0xdAf00F5eE2158dD58E0d3857851c432E34A3A851",
+ gracePeriod: 0,
+ },
+ // sendConfig: {
+ // executorConfig: { maxMessageSize: 10000, executor: '0x718B92b5CB0a5552039B593faF724D182A881eDA' },
+ // ulnConfig: {
+ // confirmations: 2,
+ // requiredDVNs: ['0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193'],
+ // optionalDVNs: [],
+ // optionalDVNThreshold: 0,
+ // },
+ // },
+ receiveConfig: {
+ ulnConfig: {
+ confirmations: 1,
+ requiredDVNs: ["0x8eebf8b423B73bFCa51a1Db4B7354AA0bFCA9193"],
+ optionalDVNs: [],
+ optionalDVNThreshold: 0,
+ },
+ },
+ },
+ },
+ ],
+};
```
+npx hardhat lz:oapp:config:wire --oapp-config YOUR_OAPP_CONFIG
pnpm hardhat lz:oapp:config:wire --oapp-config YOUR_OAPP_CONFIG
@@ -168,32 +482,14 @@ Running `lz:oapp:wire` will make the following function calls per pathway connec
To use this task, run:
```bash
-npx hardhat lz:oapp:wire --oapp-config YOUR_LAYERZERO_CONFIG_FILE
+pnpm hardhat lz:oapp:wire --oapp-config YOUR_LAYERZERO_CONFIG_FILE
```
Whenever you make changes to the configuration, run `lz:oapp:wire` again. The task will check your current configuration, and only apply NEW changes.
-To use a Gnosis Safe multisig as the signer for these transactions, add the following to each network in your `hardhat.config.ts` and add the `--safe` flag to `lz:oapp:wire --safe`:
-
-```yml
-// hardhat.config.ts
-
-networks: {
- // Include configurations for other networks as needed
- fuji: {
- /* ... */
- // Network-specific settings
- safeConfig: {
- safeUrl: 'http://something', // URL of the Safe API, not the Safe itself
- safeAddress: 'address'
- }
- }
-}
-```
-
+npx hardhat lz:oapp:config:get --oapp-config YOUR_OAPP_CONFIG
pnpm hardhat lz:oapp:config:get --oapp-config YOUR_OAPP_CONFIG
@@ -258,7 +554,7 @@ If you do NOT explicitly set each configuration parameter, your OApp will fallba
+npx hardhat lz:oapp:config:get:executor --oapp-config YOUR_OAPP_CONFIG
pnpm hardhat lz:oapp:config:get:executor --oapp-config YOUR_OAPP_CONFIG
@@ -285,231 +581,10 @@ Returns the LayerZero Executor config for each network in your `hardhat.config.t
-
-## Estimating `lzReceive` and `lzCompose` Gas Usage
-
-This guide explains how to use the `pnpm` commands to estimate gas usage for LayerZero's `lzReceive` and `lzCompose` functions. These commands wrap Foundry scripts for easier invocation and allow you to pass the required arguments dynamically.
-
-### Available Commands
-
-1. **`gas:lzReceive`**
-
- This command profiles the `lzReceive` function for estimating gas usage across multiple runs.
-
- ```json
- "gas:lzReceive": "forge script scripts/GasProfiler.s.sol:GasProfilerScript --via-ir --sig 'run_lzReceive(string,address,uint32,address,uint32,address,bytes,uint256,uint256)'"
- ```
-
-2. **`gas:lzCompose`**
-
- This command profiles the `lzCompose` function for estimating gas usage across multiple runs.
-
- ```json
- "gas:lzCompose": "forge script scripts/GasProfiler.s.sol:GasProfilerScript --via-ir --sig 'run_lzCompose(string,address,uint32,address,uint32,address,address,bytes,uint256,uint256)'"
- ```
-
-### Usage Examples
-
-#### `lzReceive`
-
-To estimate the gas for the `lzReceive` function:
-
-```bash
-pnpm gas:lzReceive
-
-
-```typescript
-const optimismContract: OmniPointHardhat = {
- eid: EndpointId.OPTSEP_V2_TESTNET,
- contractName: "MyOFTAdapter",
-};
-
-const avalancheContract: OmniPointHardhat = {
- eid: EndpointId.AVALANCHE_V2_TESTNET,
- contractName: "MyOFT",
-};
-```
-
-### Apply configurations
-
-After applying the desired settings, run:
-
-```bash
-npx hardhat lz:oapp:wire --oapp-config layerzero.config.ts
-```
-
-Congratulations! Your contracts are now wired and can begin sending messages to each other.
-
### Manual Configuration
+
+
This section only applies if you would like to configure manually instead of using the Simple Config Generator.
Define the pathway you want to create from and to each contract:
@@ -557,7 +632,7 @@ connections: [
executor: contractsConfig.ethereum.executor,
},
ulnConfig: {
- // The number of block confirmations to wait on BSC before emitting the message from the source chain.
+ // The number of block confirmations to wait on Ethereum before emitting the message from the source chain.
confirmations: BigInt(15),
// The address of the DVNs you will pay to verify a sent message on the source chain ).
// The destination tx will wait until ALL `requiredDVNs` verify the message.
@@ -628,6 +703,14 @@ connections: [
];
```
-