### Scaffold OFT Example Project Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-solana/README.md Use this command to create a new local copy of the OFT example project. It guides you through selecting the 'OFT (Solana)' option and automatically installs dependencies. ```bash pnpm dlx create-lz-oapp@latest ``` -------------------------------- ### Scaffold OFT Adapter Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-adapter/README.md Use this command to create a local copy of the OFT Adapter example project. It scaffolds the project and automatically installs dependencies. ```bash pnpm dlx create-lz-oapp@latest --example oft-adapter ``` -------------------------------- ### Scaffold OFT Example Project Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft/README.md Use this command to create a local copy of the OFT example project. It automatically installs dependencies. ```bash pnpm dlx create-lz-oapp@latest --example oft ``` -------------------------------- ### Scaffold OApp Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp/README.md Create a local copy of the OApp example project. This command also automatically installs dependencies. ```bash pnpm dlx create-lz-oapp@latest --example oapp ``` -------------------------------- ### CLI Setup for EVM with Hardhat Source: https://github.com/layerzero-labs/devtools/blob/main/packages/devtools-cli/README.md An example setup file for the devtools CLI that integrates with Hardhat for EVM functionality. It defines how to create SDKs and signers. ```typescript import { createConnectedContractFactory, createSignerFactory, createDefaultContext, } from "@layerzerolabs/devtools-evm-hardhat"; import { createOAppFactory } from "@layerzerolabs/ua-devtools-evm"; import type { CLISetup } from "@layerzerolabs/devtools-cli"; /** * Since we are not in hardhat CLI, we'll need to create the context first */ createDefaultContext(); /** * This is a setup file for @layerzerolabs/devtools-cli. * * At the moment, @layerzerolabs/devtools-cli is in development * and will be available */ const setup: CLISetup = { createSdk: createOAppFactory(createConnectedContractFactory()), createSigner: createSignerFactory(), }; export default setup; ``` -------------------------------- ### OFT Aptos Move Example Configuration Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-aptos-move/README.md Example configuration for the OFT Aptos Move Example, setting up contract details and deployer addresses. ```typescript const movementContract: OmniPointHardhat = { eid: EndpointId.MOVEMENT_V2_TESTNET, contractName: 'MyOFT', } ... contracts: [ { contract: movementContract, config: { delegate: 'YOUR_ACCOUNT_ADDRESS', owner: 'YOUR_ACCOUNT_ADDRESS', }, }, ], ``` -------------------------------- ### Scaffold Example Project Source: https://github.com/layerzero-labs/devtools/blob/main/docs/EXAMPLES_SPECS.md Use this command to initialize a new LayerZero OApp example project. Some examples may require specific feature flags, consult the create-lz-oapp package for details. ```bash pnpm dlx create-lz-oapp@latest --example ``` -------------------------------- ### Setup Node.js Environment with NVM Source: https://github.com/layerzero-labs/devtools/blob/main/DEVELOPMENT.md Use nvm to switch to the required Node.js version for the project. Ensure pnpm is installed using corepack. ```bash # or nvm install if nvm use fails nvm use # If pnpm is not installed on your local machine, you can install it using corepack corepack enable ``` -------------------------------- ### Install @layerzerolabs/toolbox-hardhat Source: https://github.com/layerzero-labs/devtools/blob/main/packages/toolbox-hardhat/README.md Install the toolbox using yarn, pnpm, or npm. ```bash yarn add @layerzerolabs/toolbox-hardhat pnpm add @layerzerolabs/toolbox-hardhat npm install @layerzerolabs/toolbox-hardhat ``` -------------------------------- ### Scaffold OVault EVM Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/ovault-evm/README.md Use this command to scaffold the OVault EVM example project. Ensure LZ_ENABLE_OVAULT_EXAMPLE is set to 1. ```bash LZ_ENABLE_OVAULT_EXAMPLE=1 npx create-lz-oapp@latest --example ovault-evm ``` -------------------------------- ### Install Solana CLI Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/README.md Installs the Solana CLI version 2.2.20. This command fetches and executes the installation script. ```bash sh -c "$(curl -sSfL https://release.anza.xyz/v2.2.20/install)" ``` -------------------------------- ### Aptos Example Directory Structure Source: https://github.com/layerzero-labs/devtools/blob/main/examples/AGENTS.md Standard directory structure for Aptos-based LayerZero examples using Move. ```plaintext example-name/ ├── sources/ ← Move source code │ ├── example.move ← Main contract file │ └── [modules]/ ← Additional modules ├── tasks/ ← Hardhat tasks │ ├── deploy.ts ← Deployment task │ ├── verify.ts ← Verification task │ └── [other-tasks].ts ← Additional tasks ├── deploy/ ← Deployment scripts ├── test/ ← Integration tests ├── build/ ← Compiled artifacts ├── Move.toml ← Move configuration ├── package.json ← Project configuration └── README.md ← Documentation ``` -------------------------------- ### Install @layerzerolabs/metadata-tools Source: https://github.com/layerzero-labs/devtools/blob/main/packages/metadata-tools/README.md Install the metadata-tools package using yarn, pnpm, or npm. ```bash yarn add @layerzerolabs/metadata-tools pnpm add @layerzerolabs/metadata-tools npm install @layerzerolabs/metadata-tools ``` -------------------------------- ### Install @layerzerolabs/test-devtools Source: https://github.com/layerzero-labs/devtools/blob/main/packages/test-devtools/README.md Install the @layerzerolabs/test-devtools package using npm. ```sh $ npm install @layerzerolabs/test-devtools ``` -------------------------------- ### Copy Example .env File Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/README.md Copy the example .env file to your project directory to configure environment variables. ```bash cp .env.example .env ``` -------------------------------- ### Install @layerzerolabs/script-devtools-evm-foundry Source: https://github.com/layerzero-labs/devtools/blob/main/packages/script-devtools-evm-foundry/README.md Install the package using npm. ```sh npm install @layerzerolabs/script-devtools-evm-foundry ``` -------------------------------- ### Install @layerzerolabs/export-deployments Source: https://github.com/layerzero-labs/devtools/blob/main/packages/export-deployments/README.md Install the package using your preferred package manager. ```bash yarn add @layerzerolabs/export-deployments pnpm add @layerzerolabs/export-deployments npm install @layerzerolabs/export-deployments ``` -------------------------------- ### Install ovault-evm with npm Source: https://github.com/layerzero-labs/devtools/blob/main/packages/ovault-evm/README.md Install the ovault-evm package using npm. ```bash npm install @layerzerolabs/ovault-evm ``` -------------------------------- ### Install ovault-evm with pnpm Source: https://github.com/layerzero-labs/devtools/blob/main/packages/ovault-evm/README.md Install the ovault-evm package using pnpm. ```bash pnpm install @layerzerolabs/ovault-evm ``` -------------------------------- ### Install with npm Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-alt-evm/README.md Install the @layerzerolabs/oapp-alt-evm package using the npm package manager. ```bash npm install @layerzerolabs/oapp-alt-evm ``` -------------------------------- ### Check Make Installation Source: https://github.com/layerzero-labs/devtools/blob/main/packages/toolbox-foundry/DEVELOPMENT.md Verify that the 'make' utility is installed on your system. This is a prerequisite for building the package. ```bash make --help ``` -------------------------------- ### OApp Configuration Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-read/README.md Example configuration object for an OApp, specifying libraries, executor, and ULN configurations for send and receive pathways. ```javascript { 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, }, }, } ``` -------------------------------- ### Install and Run Devtools CLI Source: https://github.com/layerzero-labs/devtools/blob/main/packages/devtools-cli/README.md Demonstrates various ways to install and execute the LayerZero devtools CLI using different package managers. ```bash npx @layerzerolabs/devtools-cli@latest # or yarn @layerzerolabs/devtools-cli # or pnpm @layerzerolabs/devtools-cli # or bunx @layerzerolabs/devtools-cli ``` -------------------------------- ### Install with NPM Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-evm-upgradeable/README.md Install the package using the NPM package manager. ```bash npm install @layerzerolabs/oapp-evm-upgradeable ``` -------------------------------- ### Install @layerzerolabs/devtools-evm-hardhat Source: https://github.com/layerzero-labs/devtools/blob/main/packages/devtools-evm-hardhat/README.md Install the package using yarn, pnpm, or npm. ```bash yarn add @layerzerolabs/devtools-evm-hardhat pnpm add @layerzerolabs/devtools-evm-hardhat npm install @layerzerolabs/devtools-evm-hardhat ``` -------------------------------- ### Install with pnpm Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-alt-evm/README.md Install the @layerzerolabs/oapp-alt-evm package using the pnpm package manager. ```bash pnpm install @layerzerolabs/oapp-alt-evm ``` -------------------------------- ### Install @layerzerolabs/toolbox-foundry Source: https://github.com/layerzero-labs/devtools/blob/main/packages/toolbox-foundry/README.md Install the toolbox-foundry package using your preferred package manager. ```bash yarn add @layerzerolabs/toolbox-foundry pnpm add @layerzerolabs/toolbox-foundry npm install @layerzerolabs/toolbox-foundry ``` -------------------------------- ### EVM Example Directory Structure Source: https://github.com/layerzero-labs/devtools/blob/main/examples/AGENTS.md Standard directory structure for EVM-based LayerZero examples using Solidity. ```plaintext example-name/ ├── contracts/ ← Smart contracts │ ├── mocks/ ← Contract mocks │ │ └── ExampleOAppMock.sol ← Mock contract for testing │ └── ExampleOApp.sol ← Contract solidity file ├── tasks/ ← Hardhat tasks │ ├── verify.ts ← Verification task │ └── [other-tasks].ts ← Additional tasks ├── deploy/ ← Deployment scripts ├── test/ ← Integration tests ├── cache/ ← Hardhat cache ├── artifacts/ ← Compiled artifacts ├── hardhat.config.ts ← Hardhat configuration ├── layerzero.config.ts ← LayerZero configuration ├── package.json ← Project configuration └── README.md ← Documentation ``` -------------------------------- ### Expose Test Networks on Localhost Source: https://github.com/layerzero-labs/devtools/blob/main/DEVELOPMENT.md Start test network containers using 'pnpm start'. These networks can then be accessed on your host machine. ```bash pnpm start ``` -------------------------------- ### Install with yarn Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-alt-evm/README.md Install the @layerzerolabs/oapp-alt-evm package using the yarn package manager. ```bash yarn install @layerzerolabs/oapp-alt-evm ``` -------------------------------- ### Install with PNPM Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-evm/README.md Install the @layerzerolabs/oapp-evm package using the PNPM package manager. ```bash pnpm install @layerzerolabs/oapp-evm ``` -------------------------------- ### Install @layerzerolabs/devtools Source: https://github.com/layerzero-labs/devtools/blob/main/packages/devtools/README.md Install the devtools package using yarn, pnpm, or npm. ```bash yarn add @layerzerolabs/devtools pnpm add @layerzerolabs/devtools npm install @layerzerolabs/devtools ``` -------------------------------- ### Install Dependencies and Build Source: https://github.com/layerzero-labs/devtools/blob/main/packages/script-devtools-evm-foundry/scripts/SimulateReceive/README.md Before running the script, install project dependencies using yarn and build the project with forge. ```shell yarn forge build ``` -------------------------------- ### Install Make Package (Alpine) Source: https://github.com/layerzero-labs/devtools/blob/main/packages/toolbox-foundry/DEVELOPMENT.md Install the 'make' utility on Alpine Linux using the apk package manager. ```bash # On Apline apk add --no-cache make ``` -------------------------------- ### Install Local Packages Source: https://github.com/layerzero-labs/devtools/blob/main/DEVELOPMENT.md Install packages from the configured local NPM registry into your project by running 'pnpm i'. ```bash pnpm i ``` -------------------------------- ### Install OFT Alt EVM with npm Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oft-alt-evm/README.md Use this command to install the package using npm. ```bash npm install @layerzerolabs.oft-alt-evm ``` -------------------------------- ### Solana Example Directory Structure Source: https://github.com/layerzero-labs/devtools/blob/main/examples/AGENTS.md Standard directory structure for Solana-based LayerZero examples using Rust and Anchor. ```plaintext example-name/ ├── programs/ ← Solana programs │ ├── src/ ← Program source code │ │ ├── lib.rs ← Program entry point │ │ └── [modules]/ ← Program modules │ └── tests/ ← Program tests ├── tasks/ ← Hardhat tasks │ ├── deploy.ts ← Deployment task │ ├── verify.ts ← Verification task │ └── [other-tasks].ts ← Additional tasks ├── deploy/ ← Deployment scripts ├── test/ ← Integration tests ├── target/ ← Compiled artifacts ├── Anchor.toml ← Anchor configuration ├── package.json ← Project configuration └── README.md ← Documentation ``` -------------------------------- ### Install Build Essential Package (Debian) Source: https://github.com/layerzero-labs/devtools/blob/main/packages/toolbox-foundry/DEVELOPMENT.md Install the 'build-essential' package on Debian-based systems to get the 'make' utility. ```bash # On Debian apt-get install build-essential ``` -------------------------------- ### Create Solana OApp Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/docs/wiring-to-aptos.md Use this command to create a new Solana OApp example project. Ensure LZ_ENABLE_SOLANA_OAPP_EXAMPLE is set to 1. ```bash LZ_ENABLE_SOLANA_OAPP_EXAMPLE=1 npx create-lz-oapp@latest ``` -------------------------------- ### OFT Adapter Configuration Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-adapter-aptos-move/README.md Example configuration for the OFT Adapter contract in move.layerzero.config.ts, setting delegate and owner addresses. ```typescript // Create contract entries for all contracts you would like to deploy. // This is an example entry for Movement testnet. const movementContract: OmniPointHardhat = { eid: EndpointId.MOVEMENT_V2_TESTNET, contractName: 'MyOFTAdapter', } ... contracts: [ { contract: movementContract, config: { delegate: 'YOUR_ACCOUNT_ADDRESS', owner: 'YOUR_ACCOUNT_ADDRESS', }, }, ], ``` -------------------------------- ### Install and Run Specific Test Package Source: https://github.com/layerzero-labs/devtools/blob/main/tests/AGENTS.md Commands to install all dependencies and run a specific test package using pnpm. ```bash pnpm install # Run specific test package pnpm test --filter devtools-evm-hardhat-test ``` -------------------------------- ### Example .env File Configuration Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-aptos-move/README.md Configure environment variables for EVM, Movement, and Aptos chain deployments. ```bash EVM_PRIVATE_KEY= EVM_MNEMONIC= # If you are deploying to Movement chain MOVEMENT_INDEXER_URL= MOVEMENT_FULLNODE_URL= MOVEMENT_ACCOUNT_ADDRESS= MOVEMENT_PRIVATE_KEY= # If you are deploying to Aptos chain APTOS_ACCOUNT_ADDRESS= APTOS_PRIVATE_KEY= ``` -------------------------------- ### OApp Configuration Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-aptos-move/README.md Example configuration for an OApp contract in move.layerzero.config.ts, specifying endpoint ID and contract details. ```typescript // Create contract entries for all contracts you would like to deploy. // This is an example entry for Movement testnet. const movementContract: OmniPointHardhat = { eid: EndpointId.MOVEMENT_V2_TESTNET, contractName: 'MyOApp', } ... contracts: [ { contract: movementContract, config: { delegate: 'YOUR_ACCOUNT_ADDRESS', owner: 'YOUR_ACCOUNT_ADDRESS', }, }, ], ``` -------------------------------- ### List Example Projects Source: https://github.com/layerzero-labs/devtools/blob/main/README.md Lists the available example projects in the 'examples/' directory. These serve as templates and learning resources for building with LayerZero standards. ```bash ls examples ``` -------------------------------- ### Scaffold OFT Upgradeable Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-upgradeable/README.md Use this command to create a local copy of the upgradeable OFT example project. It prompts for a directory and selects the UpgradeableOFT template. ```bash LZ_ENABLE_UPGRADEABLE_EXAMPLE=1 pnpm dlx create-lz-oapp@latest --example oft-upgradeable ``` -------------------------------- ### Clone LayerZero Devtools Repository Source: https://github.com/layerzero-labs/devtools/blob/main/README.md Clones the LayerZero Developer Tools repository from GitHub. This is the first step to get started with the tools. ```bash git clone https://github.com/LayerZero-Labs/devtools.git cd devtools ``` -------------------------------- ### Create Aptos Move VM OApp Example Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/docs/wiring-to-aptos.md Use this command to create a new Aptos Move VM OApp example project. Ensure LZ_ENABLE_EXPERIMENTAL_MOVE_VM_EXAMPLES is set to 1. ```bash LZ_ENABLE_EXPERIMENTAL_MOVE_VM_EXAMPLES=1 npx create-lz-oapp@latest ``` -------------------------------- ### Install Rust Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/README.md Installs Rust using the official installation script. Ensure you have curl installed. ```bash curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y ``` -------------------------------- ### Create LZ OApp Example Project Source: https://github.com/layerzero-labs/devtools/blob/main/examples/lzapp-migration/README.md Initializes a new LayerZero OApp project with migration example enabled. Uses npx to run the create-lz-oapp script. ```bash LZ_ENABLE_MIGRATION_EXAMPLE=1 npx create-lz-oapp@latest ``` -------------------------------- ### Display create-lz-oapp Help Information Source: https://github.com/layerzero-labs/devtools/blob/main/packages/create-lz-oapp/README.md View all available options and their descriptions for the create-lz-oapp CLI tool by running the --help command. ```bash npx create-lz-oapp@latest --help ``` -------------------------------- ### Install ua-devtools-evm-hardhat Source: https://github.com/layerzero-labs/devtools/blob/main/packages/ua-devtools-evm-hardhat/README.md Install the ua-devtools-evm-hardhat package using npm. ```sh $ npm install @layerzerolabs/ua-devtools-evm-hardhat ``` -------------------------------- ### Install @layerzerolabs/verify-contract Source: https://github.com/layerzero-labs/devtools/blob/main/packages/verify-contract/README.md Install the package using your preferred package manager. ```bash npm install @layerzerolabs/verify-contract # or yarn add @layerzerolabs/verify-contract # or pnpm add @layerzerolabs/verify-contract ``` -------------------------------- ### Configure Deployer Wallet Source: https://github.com/layerzero-labs/devtools/blob/main/examples/native-oft-adapter/README.md Set up your deployer wallet by renaming the example environment file and providing either a mnemonic or a private key. ```bash MNEMONIC="test test test test test test test test test test test junk" or... PRIVATE_KEY="0xabc...def" ``` -------------------------------- ### Application Configuration Example Source: https://github.com/layerzero-labs/devtools/blob/main/packages/ua-devtools-evm-hardhat/README.md An example JSON structure for application configuration, detailing settings for 'ethereum' and 'bsc' networks, including remote configurations. ```json { "ethereum": { "address": "", "name": "ProxyOFT", "sendVersion": 2, "receiveVersion": 2, "remoteConfigs": [ { "remoteChain": "bsc", "inboundProofLibraryVersion": 1, "inboundBlockConfirmations": 20, "relayer": "0x902F09715B6303d4173037652FA7377e5b98089E", "outboundProofType": 1, "outboundBlockConfirmations": 15, "oracle": "0x5a54fe5234E811466D5366846283323c954310B2" }, { "remoteChain": "avalanche", "inboundProofLibraryVersion": 1, "inboundBlockConfirmations": 12, "relayer": "0x902F09715B6303d4173037652FA7377e5b98089E", "outboundProofType": 1, "outboundBlockConfirmations": 15, "oracle": "0x5a54fe5234E811466D5366846283323c954310B2" } ] }, "bsc": { "address": "0x0702c7B1b18E5EBf022e17182b52F0AC262A8062", "name": "", "sendVersion": 2, "receiveVersion": 2, "remoteConfigs": [ { "remoteChain": "ethereum", "inboundProofLibraryVersion": 1, "inboundBlockConfirmations": 15, "relayer": "0xA27A2cA24DD28Ce14Fb5f5844b59851F03DCf182", "outboundProofType": 1, "outboundBlockConfirmations": 20, "oracle": "0x5a54fe5234E811466D5366846283323c954310B2" } ] } } ``` -------------------------------- ### Install OmniCounter Devtools Source: https://github.com/layerzero-labs/devtools/blob/main/packages/omnicounter-devtools-evm/README.md Install the @layerzerolabs/omnicounter-devtools-evm package using npm. ```bash $ npm install @layerzerolabs/omnicounter-devtools-evm ``` -------------------------------- ### Install OmniCounter Devtools Source: https://github.com/layerzero-labs/devtools/blob/main/packages/omnicounter-devtools/README.md Install the @layerzerolabs/omnicounter-devtools package using npm. ```sh $ npm install @layerzerolabs/omnicounter-devtools ``` -------------------------------- ### Install with Yarn Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-evm-upgradeable/README.md Install the package using the Yarn package manager. ```bash yarn install @layerzerolabs/oapp-evm-upgradeable ``` -------------------------------- ### Wire Solana OApp to Move VM Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/docs/wiring-to-aptos.md Execute this command in the Solana example directory to wire the Solana OApp contract to the Aptos Move VM contract using the provided configuration file. ```bash npx hardhat lz:oapp:wire --oapp-config move.layerzero.config.ts ``` -------------------------------- ### create-lz-oapp CLI Help Output Source: https://github.com/layerzero-labs/devtools/blob/main/packages/create-lz-oapp/README.md This output details the available options for the create-lz-oapp CLI, including flags for CI mode, destination path, example selection, log level, and package manager. ```bash Create LayerZero OApp with one command Options: -V, --version output the version number --ci Run in CI (non-interactive) mode (default: false) -d,--destination Project directory -e,--example Example project (choices: "oft", "oapp") --log-level Log level (choices: "error", "warn", "info", "http", "verbose", "debug", "silly", default: "info") -p,--package-manager Node package manager to use (choices: "npm", "pnpm", "bun") -h, --help display help for command ``` -------------------------------- ### Install with PNPM Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-evm-upgradeable/README.md Install the package using the PNPM package manager. ```bash pnpm install @layerzerolabs/oapp-evm-upgradeable ``` -------------------------------- ### Install and Run decode-lz-options Source: https://github.com/layerzero-labs/devtools/blob/main/packages/decode-lz-options/README.md Demonstrates how to install and run the decode-lz-options package using different package managers like npx, yarn, pnpm, and bunx. ```bash npx decode-lz-options@latest # or yarn decode-lz-options # or pnpm decode-lz-options # or bunx decode-lz-options ``` -------------------------------- ### Create Core Spot Deployment File Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-hyperliquid/HYPERLIQUID.README.md Generate a configuration file for your Core Spot deployment. Specify the token index, network, and optionally a log level. ```bash npx @layerzerolabs/hyperliquid-composer core-spot \ --action create \ --token-index \ --network {testnet | mainnet} \ [--log-level {info | verbose}] ``` -------------------------------- ### Start Local NPM Registry and Publish Packages Source: https://github.com/layerzero-labs/devtools/blob/main/DEVELOPMENT.md Initiate the local NPM registry and publish local packages using 'pnpm registry:publish'. This is the first step in simulating user flows. ```bash pnpm registry:publish ``` -------------------------------- ### Initialize Aptos CLI for Testnet Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-aptos-move/README.md Initialize the Aptos CLI to connect to the Aptos testnet using your private key. ```bash aptos init --network=testnet --private-key= ``` -------------------------------- ### Configure Environment Variables Source: https://github.com/layerzero-labs/devtools/blob/main/examples/ovault-evm/README.md Fill in your .env file with your private key. Replace YOUR_PRIVATE_KEY_HERE with your actual private key. ```bash PRIVATE_KEY="YOUR_PRIVATE_KEY_HERE" ``` -------------------------------- ### Install with NPM Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-evm/README.md Install the @layerzerolabs/oapp-evm package using the NPM package manager. ```bash npm install @layerzerolabs/oapp-evm ``` -------------------------------- ### Set Up Deployer Wallet with Private Key Source: https://github.com/layerzero-labs/devtools/blob/main/examples/mint-burn-oft-adapter/README.md Configure your deployer wallet using a private key. Ensure the private key is kept secure. ```bash PRIVATE_KEY="0xabc...def" ``` -------------------------------- ### Initialize Solana OApp Configuration for Move VM Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/docs/wiring-to-aptos.md This command initializes the configuration for wiring a Solana OApp to a Move VM chain using a specified configuration file. ```bash npx hardhat lz:oapp:solana:init-config --oapp-config move.layerzero.config.ts ``` -------------------------------- ### Install with Yarn Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oapp-evm/README.md Install the @layerzerolabs/oapp-evm package using the Yarn package manager. ```bash yarn install @layerzerolabs/oapp-evm ``` -------------------------------- ### Initia Environment Variables Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-initia/README.md Configuration for Initia deployment, including account address, private key, and network details. Ensure addresses are in bech32 format for account address and hex for private key. ```bash # You only need to set one of these values based on your preference EVM_MNEMONIC= EVM_PRIVATE_KEY= # All Initia values below are required - testnet values can be found in the .env.example file INITIA_ACCOUNT_ADDRESS= INITIA_PRIVATE_KEY= INITIA_KEY_NAME= INITIA_REST_URL= INITIA_RPC_URL= INITIA_CHAIN_ID= ``` -------------------------------- ### Install @layerzerolabs/devtools-evm Source: https://github.com/layerzero-labs/devtools/blob/main/packages/devtools-evm/README.md Install the devtools-evm package using your preferred package manager. ```bash yarn add @layerzerolabs/devtools-evm pnpm add @layerzerolabs/devtools-evm npm install @layerzerolabs/devtools-evm ``` -------------------------------- ### Create Core Spot Deployment Configuration Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oft-hyperliquid/HYPERLIQUID.README.md Create a deployment configuration for a core spot, with options for freeze and quote features. Requires token index and network. ```bash # Create deployment configuration with optional freeze/quote features npx @layerzerolabs/hyperliquid-composer core-spot \ --action create \ --token-index \ --network {testnet | mainnet} \ [--log-level {info | verbose}] ``` -------------------------------- ### Install Package with Filter Source: https://github.com/layerzero-labs/devtools/blob/main/packages/AGENTS.md Installs a specific package and its dependencies using pnpm. ```bash pnpm install --filter ... ``` -------------------------------- ### Install oft-evm with npm Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oft-evm/README.md Install the @layerzerolabs/oft-evm package using the npm package manager. ```bash npm install @layerzerolabs.oft-evm ``` -------------------------------- ### Install oft-evm with yarn Source: https://github.com/layerzero-labs/devtools/blob/main/packages/oft-evm/README.md Install the @layerzerolabs/oft-evm package using the yarn package manager. ```bash yarn install @layerzerolabs.oft-evm ``` -------------------------------- ### Initialize Solana OApp Configuration Source: https://github.com/layerzero-labs/devtools/blob/main/examples/oapp-solana/README.md Run this task to initialize the OApp's SendConfig and ReceiveConfig Accounts on Solana. This is a one-time setup for new OApps or when adding new Solana pathways. ```bash npx hardhat lz:oapp:solana:init-config --oapp-config layerzero.config.ts ```