diff --git a/README.md b/README.md index eefbc64..e4dcc0a 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,22 @@ This package does the following: 3. Spin up an Executor off-chain component for each specified connection ## Get started +### Repository structure +- src/ + - cardano/ + - evm/ + - solana/ + - aptos/ + ### Prerequisites +### Cardano local testing +To test Cardano LayerZero components against a local chain: +- First run the local Cardano devnet from LZeroAnalytics/cardano-package and note the Ogmios mapped port and explorer URL. +- Use Ogmios tx-submission (ws://127.0.0.1:<mapped_port>) for transaction submission and queries. +- Kupo, Yaci Store, and Yaci Viewer will index and display blocks/txs for verification. + 1. [Install Docker & start the Docker Daemon if you haven't done so already][docker-installation] 2. [Install the Kurtosis CLI, or upgrade it to the latest version if it's already installed][kurtosis-cli-installation] 3. Deploy at least two LayerZero compatible forked networks with funded accounts on each chain and reliable RPC access. These networks need to be remote networks and cannot be running on localhost. (See [Coming Soon](#coming-soon) section) @@ -96,4 +109,4 @@ For issues, feature requests, or contributions, please open an issue or submit a [docker-installation]: https://docs.docker.com/get-docker/ [kurtosis-cli-installation]: https://docs.kurtosis.com/install [kurtosis-repo]: https://github.com/kurtosis-tech/kurtosis -[package-reference]: https://docs.kurtosis.com/advanced-concepts/packages \ No newline at end of file +[package-reference]: https://docs.kurtosis.com/advanced-concepts/packages diff --git a/src/aptos/README.md b/src/aptos/README.md new file mode 100644 index 0000000..b2ec8e0 --- /dev/null +++ b/src/aptos/README.md @@ -0,0 +1,3 @@ +Aptos LayerZero components + +- Placeholder for Aptos-specific implementation and tooling. diff --git a/src/cardano/README.md b/src/cardano/README.md new file mode 100644 index 0000000..b790573 --- /dev/null +++ b/src/cardano/README.md @@ -0,0 +1,5 @@ +Cardano LayerZero (v2) components + +- Deployment scripts target the local Cardano chain from LZeroAnalytics/cardano-package (Ogmios tx-submission). +- Contracts and off-chain components (DVN/Executor) to be added here. +- Follow LayerZero-Labs/LayerZero-v2 for protocol reference. diff --git a/src/evm/README.md b/src/evm/README.md new file mode 100644 index 0000000..f94f40c --- /dev/null +++ b/src/evm/README.md @@ -0,0 +1,4 @@ +EVM LayerZero components + +- Keep existing EVM deployment flows here. +- Align tooling and docs with the per-chain structure. diff --git a/src/solana/README.md b/src/solana/README.md new file mode 100644 index 0000000..2ad2b49 --- /dev/null +++ b/src/solana/README.md @@ -0,0 +1,3 @@ +Solana LayerZero components + +- Placeholder for Solana-specific implementation and tooling.