Homepage | Docs | Developers
Quickstart | Configuration | Message Execution Options | Endpoint Addresses
Template project for getting started with LayerZero's OApp contract development.
We recommend using pnpm as a package manager (but you can of course use a package manager of your choice):
pnpm installThis project supports both hardhat and forge compilation. By default, the compile command will execute both:
pnpm compileIf you prefer one over the other, you can use the tooling-specific commands:
pnpm compile:forge
pnpm compile:hardhatOr adjust the package.json to for example remove forge build:
- "compile": "$npm_execpath run compile:forge && $npm_execpath run compile:hardhat",
- "compile:forge": "forge build",
- "compile:hardhat": "hardhat compile",
+ "compile": "hardhat compile"Similarly to the contract compilation, we support both hardhat and forge tests. By default, the test command will execute both:
pnpm testIf you prefer one over the other, you can use the tooling-specific commands:
pnpm test:forge
pnpm test:hardhatOr adjust the package.json to for example remove hardhat tests:
- "test": "$npm_execpath test:forge && $npm_execpath test:hardhat",
- "test:forge": "forge test",
- "test:hardhat": "$npm_execpath hardhat test"
+ "test": "forge test"Set up deployer wallet/account:
- Rename
.env.example->.env - Choose your preferred means of setting up your deployer wallet/account:
MNEMONIC="test test test test test test test test test test test junk"
or...
PRIVATE_KEY="0xabc...def"
To deploy your contracts to your desired blockchains, run the following command in your project's folder:
npx hardhat lz:deployMore information about available CLI arguments can be found using the --help flag:
npx hardhat lz:deploy --helpBy following these steps, you can focus more on creating innovative omnichain solutions and less on the complexities of cross-chain communication.