From b695c2cc930343eda2ef52f2728ec979a3a6b886 Mon Sep 17 00:00:00 2001 From: Lucas Bertrand Date: Tue, 8 Oct 2024 15:40:11 +0200 Subject: [PATCH] docs: make some reorg in the readme (#49) --- README.md | 120 +++++++++++++----------------------------------------- 1 file changed, 29 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 6867183..4d62eb1 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,20 @@ -# Introduction +**Note**: Mainnet-beta, testnet, devnet gateway program address: -Mainnet-beta, testnet, devnet gateway program address: ``` ZETAjseVjuFsxdRxo6MmTCvqFwb3ZHUx56Co3vCmGis ``` -This repository hosts the smart contracts (program) -on Solana network to support ZetaChain cross-chain -functionality. Specifically, it consists of a single -program deployed -which allows the following two actions: - -1. Users on Solana network can send SOL or selected -SPL tokens to the program to deposit into ZetaChain -and optionally invoke a ZetaChain EVM contract. -2. Allows contracts on ZetaChain EVM to withdraw -SOL and SPL tokens to users on Solana; -3. (TO DO) In the withdraw above, optionally allow -a contract on ZetaChain EVM to withdraw SOL/SPL tokens -and call a user specified contract (program) with -parameters. - -# Authentication and Authorization +# Introduction -Anyone can deposit and remote invoke ZetaChain contracts. +This repository hosts the smart contract (program) deployed on the Solana network to enable ZetaChain's cross-chain functionality. It consists of a single program that supports the following actions: -Only ZetaChain TSS account can make withdraw or withdrawAndCall -transactions on the program. The ZetaChain TSS account -is a collection of Observer/KeySigners which uses -ECDSA TSS (Threshold Signature Scheme) to sign -outbound transactions. The TSS address will appear in this program -a single ECDSA secp256k1 address; but it does -not have a single private key, rather its private -key consists of multiple key shares and they collectively -sign a message in a KeySign MPC ceremony. -The program authenticates -via verifying the TSS signature and is authorized -by ZetaChain to perform outbound transactions as -part of ZetaChain cross-chain machinery. - -The ZetaChain TSS is on ECDSA secp256k1 curve; -But Solana native digital signature scheme is -EdDSA Ed25519 curve. Therefore the program uses -custom logic to verify the TSS ECDSA signature -(like alternative authentication in smart contract wallet); -the native transaction signer (fee payer on Solana) -does not carry authorization and it's only used -to build the transaction and pay tx fees. There -are no restrictions on who the native transaction -signer/fee payer is. The following code excerpt is -for authenticating TSS signature in the contract itself, -using the [Rust secp256k1 library bundled with solana](https://docs.rs/solana-program/latest/solana_program/secp256k1_recover/index.html): -https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L116-L121 - -The function `recover_eth_address` is implemented in the gateway program: -https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L180-L196 - -The TSS signature is a ECDSA secp256k1 signature; its public key therefore address -(Ethereum compatible hashing from pubkey) is therefore verifiable using the `secp256k1_recover` -function. Alternatively, Solana runtime also provides a program to provide this verification service -via CPI; see [proposal 48](https://github.com/solana-foundation/solana-improvement-documents/blob/main/proposals/0048-native-program-for-secp256r1-sigverify.md) -which might be more cost efficient. - -In both `withdraw` and `withdrawAndCall` instructions, -the ECDSA signed message_hash must commit to the -`nonce`, `amount`, and `to` address. See the -check in these instructions like: -https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L110-L114 -The commitment of `nonce` in the signature prevents replay of the TSS ECDSA signed message. -Also (to be added in https://github.com/zeta-chain/protocol-contracts-solana/issues/6) a chain id of Solana -should be added to the commitment of the message hash, so that the signature cannot be replayed on *other blockchains* -that potentially uses similar authentication (say in TON). +1. Users on the Solana network can send SOL to the program to deposit into ZetaChain, with the option to invoke a ZetaChain EVM contract. +2. Contracts on the ZetaChain EVM can withdraw SOL to users on the Solana network. # Build and Test Instructions -Prerequisites: a recent version of `rust` compiler -and `cargo` package manger must be installed. The program -is built with the `anchor` framework so it needs to be -installed as well; see [installation](https://www.anchor-lang.com/docs/installation) +Prerequisites: a recent version of `rust` compiler and `cargo` package manger must be installed. The program is built with the `anchor` framework so it needs to be installed as well; see [installation](https://www.anchor-lang.com/docs/installation) Please install compatible Solana tools and anchor-cli before build, otherwise the program will not be built successfully ```bash @@ -108,27 +44,29 @@ To run the tests $ anchor test ``` +# Authentication and Authorization + +Anyone can deposit and remote invoke ZetaChain contracts. + +Only ZetaChain TSS account can call `withdraw` on the program. The ZetaChain TSS account is a collection of Observer/Signers which uses ECDSA TSS (Threshold Signature Scheme) to sign outbound transactions. The TSS address will appear in this program a single ECDSA secp256k1 address; but it does not have a single private key, rather its private key consists of multiple key shares and they collectively sign a message in a KeySign MPC ceremony. The program authenticates via verifying the TSS signature and is authorized by ZetaChain to perform outbound transactions as part of ZetaChain cross-chain machinery. + +The ZetaChain TSS is on ECDSA secp256k1 curve; But Solana native digital signature scheme is EdDSA Ed25519 curve. Therefore the program uses custom logic to verify the TSS ECDSA signature (like alternative authentication in smart contract wallet); the native transaction signer (fee payer on Solana) does not carry authorization and it's only used to build the transaction and pay tx fees. There are no restrictions on who the native transaction signer/fee payer is. The following code excerpt is for authenticating TSS signature in the contract itself, using the [Rust secp256k1 library bundled with solana](https://docs.rs/solana-program/latest/solana_program/secp256k1_recover/index.html): https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L116-L121 + +The function `recover_eth_address` is implemented in the gateway program: https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L180-L196 + +The TSS signature is a ECDSA secp256k1 signature; its public key therefore address (Ethereum compatible hashing from pubkey) is therefore verifiable using the `secp256k1_recover` function. Alternatively, Solana runtime also provides a program to provide this verification service via CPI; see [proposal 48](https://github.com/solana-foundation/solana-improvement-documents/blob/main/proposals/0048-native-program-for-secp256r1-sigverify.md) which might be more cost efficient. + +In the instruction, the ECDSA signed message_hash must commit to the `nonce`, `amount`, and `to` address. See the check in these instructions like: https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L110-L114 The commitment of `nonce` in the signature prevents replay of the TSS ECDSA signed message. Also (to be added in https://github.com/zeta-chain/protocol-contracts-solana/issues/6) a chain id of Solana should be added to the commitment of the message hash, so that the signature cannot be replayed on *other blockchains* that potentially uses similar authentication (say in TON). + + # Relevant Account and Addresses -The Gateway program derive a PDA (Program Derived Address) -with seeds `b"meta"` and canonical bump. -This PDA account/address actually holds the SOL -balance of the Gateway program. -For SPL tokens, the program stores the SPL token -in PDA derived ATAs. For each SPL token (different mint -account), the program creates ATA from PDA and the Mint -(standard way of deriving ATA in Solana SPL program). - -The PDA account itself is a data account that holds -Gateway program state, namely the following data types -https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L271-L275 - -The `nonce` is incremented on each successful withdraw transaction, -and it's used to prevent replay of signed ECDSA messages. -The `tss_address` is the TSS address of ZetaChain (20Bytes, -Ethereum style). `authority` is the one who can update -the TSS address stored in PDA account. +The Gateway program derive a PDA (Program Derived Address) with seeds `b"meta"` and canonical bump. This PDA account/address actually holds the SOL balance of the Gateway program. For SPL tokens, the program stores the SPL token in PDA derived ATAs. For each SPL token (different mint account), the program creates ATA from PDA and the Mint (standard way of deriving ATA in Solana SPL program). + +The PDA account itself is a data account that holds Gateway program state, namely the following data types https://github.com/zeta-chain/protocol-contracts-solana/blob/01eeb9733a00b6e972de0578b0e07ebc5837ec54/programs/protocol-contracts-solana/src/lib.rs#L271-L275 +The `nonce` is incremented on each successful withdraw transaction, and it's used to prevent replay of signed ECDSA messages. +The `tss_address` is the TSS address of ZetaChain (20Bytes, Ethereum style). `authority` is the one who can update the TSS address stored in PDA account. The `initialize` instruction sets nonce to 0. # Troubleshooting @@ -150,9 +88,9 @@ Error: failed to start validator: Failed to create ledger at test-ledger: io err This is because the BSD tar program is not compatible with the GNU tar program. -FIX: install GNU tar program using homebrew and export it's executable path in your .zshrc file. +To fix the issue: install GNU tar program using homebrew and export it's executable path in your `.zshrc` file: -## Mac with Apple Silicon +**Mac with Apple Silicon** ```bash brew install gnu-tar @@ -160,7 +98,7 @@ brew install gnu-tar export PATH="/opt/homebrew/opt/gnu-tar/libexec/gnubin:$PATH" ``` -## Intel-based Mac +**Intel-based Mac** ```bash brew install gnu-tar