Skip to main content
Version: Endpoint V2 Docs

Project Configuration

When working with a LayerZero project, it searches for the closest hardhat.config.ts and layerzero.config.ts files starting from the Current Working Directory. This file normally lives in the root of your project.

Modifying Hardhat Config​

After initializing the repo, you will need to modify your hardhat.config.ts with the expected networks you will be working with:

// hardhat.config.ts
networks: {
  sepolia: {
    // the LayerZero Endpoint ID
    eid: EndpointId.SEPOLIA_V2_TESTNET,
    url: 'https://rpc.sepolia.org/',
    accounts,
  },
  ethereum: {
    // the LayerZero Endpoint ID
    eid: EndpointId.ETHEREUM_V2_MAINNET,
    url: 'https://eth.llamarpc.com',
    accounts,
  },
  bsc_testnet: {
    // the LayerZero Endpoint ID
    eid: EndpointId.BSC_V2_TESTNET,
    url: 'https://bsc-testnet.publicnode.com',
    accounts,
  },
},
info

The only notable change from a standard hardhat.config.ts setup is the inclusion of a LayerZero Endpoint ID.

For hardhat specific questions, refer to the Hardhat Configuration documentation.

tip

The npx package uses @layerzerolabs/lz-definitions to enable you to reference both V1 and V2 Endpoints. Make sure if your project uses LayerZero V2 to select the V2 Endpoint (i.e., eid: EXAMPLE_V2_MAINNET).

Modifying LayerZero Config​

The layerzero.config.ts first defines what contracts you expect to deploy on each network, using the @layerzerolabs/lz-definitions package as a mapping for each network:

// layerzero.config.ts

import {EndpointId} from '@layerzerolabs/lz-definitions';

// Define the Ethereum contract
// eid specifies the network (LZ V2 Ethereum Sepolia Testnet)
// contractName is the name of the contract.
const sepoliaContract = {
  eid: EndpointId.SEPOLIA_V2_TESTNET,
  contractName: 'MyOFT',
};

// Define the Binance contract
// eid specifies the network (LZ V2 BNB Chain Testnet)
// contractName is the name of the contract.
const bscContract = {
  eid: EndpointId.BSC_V2_TESTNET,
  contractName: 'MyOFT',
};

// Define the Amoy (Polygon) contract
// eid specifies the network (LZ V2 Polygon Amoy Testnet)
// contractName is the name of the contract.
const amoyContract = {
  eid: EndpointId.AMOY_V2_TESTNET,
  contractName: 'MyOFT',
};

After defining what contracts to use on each network, you can specify which contracts should be connected on a per pathway basis:

// layerzero.config.ts

module.exports = {
  // Define the contracts to be deployed on each network
  // Each contract is associated with a specific blockchain.
  contracts: [
    {
      contract: sepoliaContract,
    },
    {
      contract: bscContract,
    },
    {
      contract: amoyContract,
    },
  ],
  // Define the pathway between each contract.
  // This allows for cross-chain communication using LayerZero.
  connections: [
    {
      from: bscContract,
      to: sepoliaContract,
    },
    {
      from: bscContract,
      to: amoyContract,
    },
    {
      from: sepoliaContract,
      to: bscContract,
    },
    {
      from: sepoliaContract,
      to: amoyContract,
    },
    {
      from: amoyContract,
      to: sepoliaContract,
    },
    {
      from: amoyContract,
      to: bscContract,
    },
  ],
};

Checking Pathway Configurations​

To check your OApp's current configuration, you can run:

npx hardhat lz:oapp:config:get --oapp-config layerzero.config.ts

This command will output a table with 3 columns:

  1. Custom OApp Config: your layerzero.config.ts configuration changes, with null values for unchanged parameters.

  2. Default OApp Config: the default LayerZero configuration for the pathway.

  3. Active OApp Config: the combination of your customized and default parameters, i.e., the active configuration.

┌────────────────────┬─────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────┐
│                    │ Custom OApp Config                                              │ Default OApp Config                                                           │ Active OApp Config                                                            │
├────────────────────┼─────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤
│ localNetworkName   │ bsc_testnet                                                     │ bsc_testnet                                                                   │ bsc_testnet                                                                   │
├────────────────────┼─────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤
│ remoteNetworkName  │ sepolia                                                         │ sepolia                                                                       │ sepolia                                                                       │
├────────────────────┼─────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤
│ sendLibrary        │ 0x0000000000000000000000000000000000000000                      │ 0x55f16c442907e86D764AFdc2a07C2de3BdAc8BB7                                    │ 0x55f16c442907e86D764AFdc2a07C2de3BdAc8BB7                                    │
├────────────────────┼─────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤
│ receiveLibrary     │ 0x0000000000000000000000000000000000000000                      │ 0x188d4bbCeD671A7aA2b5055937F79510A32e9683                                    │ 0x188d4bbCeD671A7aA2b5055937F79510A32e9683                                    │
├────────────────────┼─────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤
│ sendUlnConfig      │ ┌──────────────────────┬───┐                                    │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │
│                    │ │ confirmations        │ 0 │                                    │ │ confirmations        │ 5                                                  │ │ │ confirmations        │ 5                                                  │ │
│                    │ ├──────────────────────┼───┤                                    │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │
│                    │ │ requiredDVNs         │   │                                    │ │ requiredDVNs         │ ┌───┬────────────────────────────────────────────┐ │ │ │ requiredDVNs         │ ┌───┬────────────────────────────────────────────┐ │ │
│                    │ ├──────────────────────┼───┤                                    │ │                      │ │ 0 │ 0x0eE552262f7B562eFcED6DD4A7e2878AB897d405 │ │ │ │                      │ │ 0 │ 0x0eE552262f7B562eFcED6DD4A7e2878AB897d405 │ │ │
│                    │ │ optionalDVNs         │   │                                    │ │                      │ └───┴────────────────────────────────────────────┘ │ │ │                      │ └───┴────────────────────────────────────────────┘ │ │
│                    │ ├──────────────────────┼───┤                                    │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │
│                    │ │ optionalDVNThreshold │ 0 │                                    │ │ optionalDVNs         │                                                    │ │ │ optionalDVNs         │                                                    │ │
│                    │ └──────────────────────┴───┘                                    │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │
│                    │                                                                 │ │ optionalDVNThreshold │ 0                                                  │ │ │ optionalDVNThreshold │ 0                                                  │ │
│                    │                                                                 │ └──────────────────────┴────────────────────────────────────────────────────┘ │ └──────────────────────┴────────────────────────────────────────────────────┘ │
├────────────────────┼─────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤
│ sendExecutorConfig │ ┌────────────────┬────────────────────────────────────────────┐ │ ┌────────────────┬────────────────────────────────────────────┐               │ ┌────────────────┬────────────────────────────────────────────┐               │
│                    │ │ executor       │ 0x0000000000000000000000000000000000000000 │ │ │ executor       │ 0x31894b190a8bAbd9A067Ce59fde0BfCFD2B18470 │               │ │ executor       │ 0x31894b190a8bAbd9A067Ce59fde0BfCFD2B18470 │               │
│                    │ ├────────────────┼────────────────────────────────────────────┤ │ ├────────────────┼────────────────────────────────────────────┤               │ ├────────────────┼────────────────────────────────────────────┤               │
│                    │ │ maxMessageSize │ 0                                          │ │ │ maxMessageSize │ 10000                                      │               │ │ maxMessageSize │ 10000                                      │               │
│                    │ └────────────────┴────────────────────────────────────────────┘ │ └────────────────┴────────────────────────────────────────────┘               │ └────────────────┴────────────────────────────────────────────┘               │
├────────────────────┼─────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────┤
│ receiveUlnConfig   │ ┌──────────────────────┬───┐                                    │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │ ┌──────────────────────┬────────────────────────────────────────────────────┐ │
│                    │ │ confirmations        │ 0 │                                    │ │ confirmations        │ 2                                                  │ │ │ confirmations        │ 2                                                  │ │
│                    │ ├──────────────────────┼───┤                                    │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │
│                    │ │ requiredDVNs         │   │                                    │ │ requiredDVNs         │ ┌───┬────────────────────────────────────────────┐ │ │ │ requiredDVNs         │ ┌───┬────────────────────────────────────────────┐ │ │
│                    │ ├──────────────────────┼───┤                                    │ │                      │ │ 0 │ 0x0eE552262f7B562eFcED6DD4A7e2878AB897d405 │ │ │ │                      │ │ 0 │ 0x0eE552262f7B562eFcED6DD4A7e2878AB897d405 │ │ │
│                    │ │ optionalDVNs         │   │                                    │ │                      │ └───┴────────────────────────────────────────────┘ │ │ │                      │ └───┴────────────────────────────────────────────┘ │ │
│                    │ ├──────────────────────┼───┤                                    │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │
│                    │ │ optionalDVNThreshold │ 0 │                                    │ │ optionalDVNs         │                                                    │ │ │ optionalDVNs         │                                                    │ │
│                    │ └──────────────────────┴───┘                                    │ ├──────────────────────┼────────────────────────────────────────────────────┤ │ ├──────────────────────┼────────────────────────────────────────────────────┤ │
│                    │                                                                 │ │ optionalDVNThreshold │ 0                                                  │ │ │ optionalDVNThreshold │ 0                                                  │ │
│                    │                                                                 │ └──────────────────────┴────────────────────────────────────────────────────┘ │ └──────────────────────┴────────────────────────────────────────────────────┘ │
└────────────────────┴─────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────┘

Adding Pathway Configurations​

To add specific configurations on a per pathway basis, review the Configuring Pathways section.