From a838e3610ebca998d82fcdd5e4a8da08bb639fea Mon Sep 17 00:00:00 2001 From: Matthew Krak Date: Tue, 23 Jan 2024 16:45:56 -0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=B9=20Update=20README.md=20(#238)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 51 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d039b33b1..16c182e94 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- LayerZero + LayerZero

@@ -14,16 +14,61 @@ Development | Cheatsheet | Examples

-## Getting started +## Introduction -Visit our developer docs to get started with LayerZero. +This toolkit is designed to streamline the process of building, testing, and deploying omnichain applications (OApps) using LayerZero. This tool is meant to support you through the end-to-end development lifecycle of a cross-chain project. -## Bootstrapping an example project +Visit our developer docs to get started building omnichain applications. -Start developing in no time using our `create-lz-oapp` CLI utility: +## Bootstrapping an Example Cross-Chain Project + +Kick-start your development with our `create-lz-oapp` CLI utility. This command-line tool facilitates the creation of a new omnichain application project, setting up the necessary environment and dependencies: ```bash npx create-lz-oapp@latest ``` -This will walk you through a project setup and will bootstrap a project based on one of the examples we provide in this repository. +Following this, you will be guided through setting up a project template. Choose from a variety of examples to match your project needs. + +## Writing Smart Contracts + +Our example project offers templates for both the Omnichain Application (OApp) and Omnichain Fungible Token (OFT) contracts. Select the template that suits your project: + +## Writing Unit Tests + +Testing your contracts is crucial. We support both Hardhat and Foundry frameworks for writing and running unit tests for your LayerZero contracts. + +Use `npx hardhat compile` or `forge build` to compile your smart contracts. + +Test your contract using `npx hardhat test` or `forge test`. + +## Deploying Contracts + +To deploy your contracts to your desired blockchains, run the following command in your project's folder: + +```bash +# TODO: Specify the exact command for deployment +``` + +## Configuring Contracts + +After deploying your contracts across multiple chains, it's time to configure your application's Security Stack and Executor. Initialize your OApp configuration file with: + +```bash +npx hardhat lz:oapp:config:init +``` + +## Wiring Contracts + +Finally, pair your deployed contracts using: + +```bash +npx hardhat lz:oapp:wire +``` + +By following these steps, you can focus more on creating innovative omnichain solutions and less on the complexities of cross-chain communication. + +

+

+ Join our community on Discord | Follow us on Twitter +