From c81c33b9406a763dc7fdaefe773c1907b9c15f38 Mon Sep 17 00:00:00 2001 From: mok-lz Date: Thu, 27 Jun 2024 11:33:01 +0800 Subject: [PATCH] doc: update readme --- README.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index feea68b..71d5970 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,25 @@ This standard works by burning tokens on the source chain whenever an omnichain [Audit Reports](https://github.com/LayerZero-Labs/Audits) +## Prepare ProgramId + +create programId keypair files if not existed + +``` +cd packages/solana/contracts + +solana-keygen new -o target/deploy/endpoint-keypair.json +solana-keygen new -o target/deploy/oft-keypair.json + +anchor keys sync +``` + ## Build & Test ```bash yarn && yarn build && yarn test ``` - ## Deploy ``` @@ -36,20 +48,22 @@ cd packages/solana/contracts ``` 1. with anchor - ```bash - anchor build -v - solana program deploy --program-id target/deploy/oft-keypair.json target/verifiable/oft.so -u mainnet-beta - ``` - or -2. with solana-verify - ```bash - solana-verify build - solana program deploy --program-id target/deploy/oft-keypair.json target/deploy/oft.so -u mainnet-beta - ``` + ```bash + anchor build -v + solana program deploy --program-id target/deploy/oft-keypair.json target/verifiable/oft.so -u mainnet-beta + ``` -please visit [Solana Verify CLI](https://github.com/Ellipsis-Labs/solana-verifiable-build) and [Deploy a Solana Program with the CLI](https://docs.solanalabs.com/cli/examples/deploy-a-program) for more detail. + or +2. with solana-verify + ```bash + solana-verify build + solana program deploy --program-id target/deploy/oft-keypair.json target/deploy/oft.so -u mainnet-beta + ``` + +please visit [Solana Verify CLI](https://github.com/Ellipsis-Labs/solana-verifiable-build) and [Deploy a Solana Program with the CLI](https://docs.solanalabs.com/cli/examples/deploy-a-program) for more detail. #### Notice -If you encounter issues during compilation and testing, it might be due to the versions of Solana and Anchor. You can switch to Solana version `1.17.31` and Anchor version `0.29.0`, as these are the versions we have tested and verified to be working. \ No newline at end of file + +If you encounter issues during compilation and testing, it might be due to the versions of Solana and Anchor. You can switch to Solana version `1.17.31` and Anchor version `0.29.0`, as these are the versions we have tested and verified to be working.