Skip to content

Latest commit

 

History

History
213 lines (176 loc) · 5.88 KB

LayerZero-v2-cli-quickstart.md

File metadata and controls

213 lines (176 loc) · 5.88 KB
Raw

Simplifying things

  • The scaffolded project will have by default 3 chains: Ethereum Sepolia, Avalanche Fuji and Polygon Mumbai
  • We only need 2 chains, to demonstrate how LayerZero works, so we'll remove one. At the moment, Ethereum Sepolia test ether is annoying to get, so we'll remove Ethereum Sepolia.

Official Documentation

https://docs.layerzero.network/v2/developers/evm/create-lz-oapp/start

Prepare

  • comment out the sepolia entry in hardhat.config.ts (if you don't, when deploying, the lz cli will list fuji as an option)
  • comment out lines in layerzero.config.ts under contracts and connections that related to Ethereum Sepolia
  • add the networks involved in the scaffolded project (Avalanche Fuji, Polygon Mumbai)
  • get testnet gas tokens

Modifications

Solidity contracts

Your contracts/MyOFT.sol should remain unchanged.

Your contracts/mocks/MyOFTMock.sol should look like this:

// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.22;

import { MyOFT } from "../MyOFT.sol";

// @dev WARNING: This is for testing purposes only
contract MyOFTMock is MyOFT {
    constructor(
        string memory _name,
        string memory _symbol,
        address _lzEndpoint,
        address _delegate
    ) MyOFT(_name, _symbol, _lzEndpoint, _delegate) {
        _mint(msg.sender, 100 * 10**18);
    }

    function mint(address _to, uint256 _amount) public {
        _mint(_to, _amount);
    }
}

Config files

layerzero.config.ts

// eslint-disable-next-line @typescript-eslint/no-var-requires
import { EndpointId } from '@layerzerolabs/lz-definitions'

// const sepoliaContract = {
//     eid: EndpointId.SEPOLIA_V2_TESTNET,
//     contractName: 'MyOFT',
// }

const fujiContract = {
    eid: EndpointId.AVALANCHE_V2_TESTNET,
    contractName: 'MyOFTMock',
}

const mumbaiContract = {
    eid: EndpointId.POLYGON_V2_TESTNET,
    contractName: 'MyOFTMock',
}

export default {
    contracts: [
        {
            contract: fujiContract,
        },
        // {
        //     contract: sepoliaContract,
        // },
        {
            contract: mumbaiContract,
        },
    ],
    connections: [
        // {
        //     from: fujiContract,
        //     to: sepoliaContract,
        //     config: {},
        // },
        {
            from: fujiContract,
            to: mumbaiContract,
        },
        // {
        //     from: sepoliaContract,
        //     to: fujiContract,
        // },
        // {
        //     from: sepoliaContract,
        //     to: mumbaiContract,
        // },
        // {
        //     from: mumbaiContract,
        //     to: sepoliaContract,
        // },
        {
            from: mumbaiContract,
            to: fujiContract,
        },
    ],
}

hardhat.config.ts

// Get the environment configuration from .env file
//
// To make use of automatic environment setup:
// - Duplicate .env.example file and name it .env
// - Fill in the environment variables
import 'dotenv/config'

import 'hardhat-deploy'
import 'hardhat-contract-sizer'
import '@nomiclabs/hardhat-ethers'
import '@layerzerolabs/toolbox-hardhat'
import { HardhatUserConfig, HttpNetworkAccountsUserConfig } from 'hardhat/types'

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

// Set your preferred authentication method
//
// If you prefer using a mnemonic, set a MNEMONIC environment variable
// to a valid mnemonic
const MNEMONIC = process.env.MNEMONIC

// If you prefer to be authenticated using a private key, set a PRIVATE_KEY environment variable
const PRIVATE_KEY = process.env.PRIVATE_KEY

const accounts: HttpNetworkAccountsUserConfig | undefined = MNEMONIC
    ? { mnemonic: MNEMONIC }
    : PRIVATE_KEY
      ? [PRIVATE_KEY]
      : undefined

if (accounts == null) {
    console.warn(
        'Could not find MNEMONIC or PRIVATE_KEY environment variables. It will not be possible to execute transactions in your example.'
    )
}

const config: HardhatUserConfig = {
    solidity: {
        compilers: [
            {
                version: '0.8.22',
                settings: {
                    optimizer: {
                        enabled: true,
                        runs: 200,
                    },
                },
            },
        ],
    },
    networks: {
        // sepolia: {
        //     eid: EndpointId.SEPOLIA_V2_TESTNET,
        //     url: process.env.RPC_URL_SEPOLIA || 'https://rpc.sepolia.org/',
        //     accounts,
        // },
        fuji: {
            eid: EndpointId.AVALANCHE_V2_TESTNET,
            url: process.env.RPC_URL_FUJI || 'https://rpc.ankr.com/avalanche_fuji',
            accounts,
        },
        mumbai: {
            eid: EndpointId.POLYGON_V2_TESTNET,
            url: process.env.RPC_URL_MUMBAI || 'https://rpc.ankr.com/polygon_mumbai',
            accounts,
        },
    },
    namedAccounts: {
        deployer: {
            default: 0, // wallet address of index[0], of the mnemonic in .env
        },
    },
}

export default config

Wiring

Current, the docs tell you to run npx hardhat lz:oapp:wire, which is incomplete. You should run instead: npx hardhat lz:oapp:wire --oapp-config layerzero.config.ts

Manual Test

Endpoints IDs

  • Avalanche Fuji: 40106

  • Polygon Mumbai: 40109

Zero padding

000000000000000000000000

Options Generator

Remix: https://remix.ethereum.org/#url=https://docs.layerzero.network/LayerZero/contracts/OptionsGenerator.sol&lang=en&optimize=false&runs=200&evmVersion=null&version=soljson-v0.8.24+commit.e11b9ed9.js

Appendix On Wiring and Configurations: https://docs.layerzero.network/contracts/wiring