diff --git a/clients/js/README.md b/clients/js/README.md index 0749f509d..d24dfae5c 100644 --- a/clients/js/README.md +++ b/clients/js/README.md @@ -84,30 +84,6 @@ Options: edit-vaa ```sh -worm edit-vaa - -Commands: - worm edit-vaa init-token-bridge Init token bridge contract - worm edit-vaa init-wormhole Init Wormhole core contract - worm edit-vaa deploy Deploy an Aptos package - worm edit-vaa deploy-resource Deploy an Aptos package using a - resource account - worm edit-vaa send-example-message Send example message - - worm edit-vaa derive-resource-account Derive resource account address - - worm edit-vaa derive-wrapped-address Derive wrapped coin type - - worm edit-vaa hash-contracts Hash contract bytecodes for upgrade - - worm edit-vaa upgrade Perform upgrade after VAA has been - submitted - worm edit-vaa migrate Perform migration after contract - upgrade - worm edit-vaa faucet Request money from the faucet for a - given account - worm edit-vaa start-validator Start a local aptos validator - Options: --help Show help [boolean] --version Show version number [boolean] @@ -141,60 +117,22 @@ Options: worm evm Commands: - worm evm init-token-bridge Init token bridge contract - worm evm init-wormhole Init Wormhole core contract - worm evm deploy Deploy an Aptos package - worm evm deploy-resource Deploy an Aptos package using a - resource account - worm evm send-example-message Send example message - worm evm derive-resource-account Derive resource account address - - worm evm derive-wrapped-address Derive wrapped coin type - - worm evm hash-contracts Hash contract bytecodes for upgrade - worm evm upgrade Perform upgrade after VAA has been - submitted - worm evm migrate Perform migration after contract - upgrade - worm evm faucet Request money from the faucet for a - given account - worm evm start-validator Start a local aptos validator - worm evm address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm evm storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm evm chains Return all EVM chains - worm evm info Query info about the on-chain state - of the contract - worm evm hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm evm start-validator Start a local EVM validator + worm evm address-from-secret Compute a 20 byte eth address from a 32 + byte private key + worm evm storage-update Update a storage slot on an EVM fork + during testing (anvil or hardhat) + worm evm chains Return all EVM chains + worm evm info Query info about the on-chain state of + the contract + worm evm hijack Override the guardian set of the core + bridge contract during testing (anvil + or hardhat) + worm evm start-validator Start a local EVM validator Options: - --help Show help [boolean] - --version Show version number [boolean] - -v, --vaa vaa in hex format [string] [required] - -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - --guardian-secret, --gs Guardian's secret key [string] - --rpc RPC endpoint [string] + --help Show help [boolean] + --version Show version number [boolean] + --rpc RPC endpoint [string] ``` @@ -202,40 +140,9 @@ Options: generate ```sh -worm generate +worm generate [command] Commands: - worm generate init-token-bridge Init token bridge contract - worm generate init-wormhole Init Wormhole core contract - worm generate deploy Deploy an Aptos package - worm generate deploy-resource Deploy an Aptos package using a - resource account - worm generate send-example-message Send example message - - worm generate derive-resource-account Derive resource account address - - worm generate derive-wrapped-address Derive wrapped coin type - - worm generate hash-contracts Hash contract bytecodes for upgrade - - worm generate upgrade Perform upgrade after VAA has been - submitted - worm generate migrate Perform migration after contract - upgrade - worm generate faucet Request money from the faucet for a - given account - worm generate start-validator Start a local aptos validator - worm generate address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm generate storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm generate chains Return all EVM chains - worm generate info Query info about the on-chain state - of the contract - worm generate hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm generate start-validator Start a local EVM validator worm generate registration Generate registration VAA worm generate upgrade Generate contract upgrade VAA worm generate attestation Generate a token attestation VAA @@ -244,30 +151,9 @@ Commands: set-default-delivery-provider for the Wormhole Relayer contract Options: - --help Show help [boolean] - --version Show version number [boolean] - -v, --vaa vaa in hex format [string] [required] - -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - --rpc RPC endpoint [string] + --help Show help [boolean] + --version Show version number [boolean] + -g, --guardian-secret Guardians' secret keys (CSV) [string] [required] ``` @@ -275,44 +161,9 @@ Options: info ```sh -worm info +worm info [command] Commands: - worm info init-token-bridge Init token bridge contract - worm info init-wormhole Init Wormhole core contract - worm info deploy Deploy an Aptos package - worm info deploy-resource Deploy an Aptos package using a - resource account - worm info send-example-message Send example message - worm info derive-resource-account Derive resource account address - - worm info derive-wrapped-address Derive wrapped coin type - - worm info hash-contracts Hash contract bytecodes for upgrade - worm info upgrade Perform upgrade after VAA has been - submitted - worm info migrate Perform migration after contract - upgrade - worm info faucet Request money from the faucet for a - given account - worm info start-validator Start a local aptos validator - worm info address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm info storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm info chains Return all EVM chains - worm info info Query info about the on-chain state - of the contract - worm info hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm info start-validator Start a local EVM validator - worm info registration Generate registration VAA - worm info upgrade Generate contract upgrade VAA - worm info attestation Generate a token attestation VAA - worm info recover-chain-id Generate a recover chain ID VAA - worm info set-default-delivery-provider Sets the default delivery provider - for the Wormhole Relayer contract worm info chain-id Print the wormhole chain ID integer associated with the specified chain name @@ -332,30 +183,8 @@ Commands: address. Options: - --help Show help [boolean] - --version Show version number [boolean] - -v, --vaa vaa in hex format [string] [required] - -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - --rpc RPC endpoint [string] + --help Show help [boolean] + --version Show version number [boolean] ``` @@ -363,99 +192,24 @@ Options: near ```sh -worm near +worm near [command] Commands: - worm near init-token-bridge Init token bridge contract - worm near init-wormhole Init Wormhole core contract - worm near deploy Deploy an Aptos package - worm near deploy-resource Deploy an Aptos package using a - resource account - worm near send-example-message Send example message - worm near derive-resource-account Derive resource account address - - worm near derive-wrapped-address Derive wrapped coin type - - worm near hash-contracts Hash contract bytecodes for upgrade - worm near upgrade Perform upgrade after VAA has been - submitted - worm near migrate Perform migration after contract - upgrade - worm near faucet Request money from the faucet for a - given account - worm near start-validator Start a local aptos validator - worm near address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm near storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm near chains Return all EVM chains - worm near info Query info about the on-chain state - of the contract - worm near hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm near start-validator Start a local EVM validator - worm near registration Generate registration VAA - worm near upgrade Generate contract upgrade VAA - worm near attestation Generate a token attestation VAA - worm near recover-chain-id Generate a recover chain ID VAA - worm near set-default-delivery-provider Sets the default delivery provider - for the Wormhole Relayer contract - worm near chain-id Print the wormhole chain ID integer - associated with the specified chain - name - worm near contract Print contract address - - worm near emitter
Print address in emitter address - format - worm near origin
Print the origin chain and address - of the asset that corresponds to the - given chain and address. - worm near registrations Print chain registrations - - worm near rpc Print RPC address - worm near wrapped Print the wrapped address on the - target chain that corresponds with - the specified origin chain and - address. - worm near contract-update Submit a contract update using our - specific APIs - worm near deploy Submit a contract update using near - APIs + worm near contract-update Submit a contract update using our specific + APIs + worm near deploy Submit a contract update using near APIs Options: - --help Show help [boolean] - --version Show version number [boolean] - -v, --vaa vaa in hex format [string] [required] - -n, -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet", "mainnet", "testnet", - "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - -r, --rpc Override default rpc endpoint url [string] - -m, --module Module to query - [choices: "Core", "NFTBridge", "TokenBridge"] - --account Near deployment account [string] [required] - --attach Attach some near [string] - --target Near account to upgrade [string] - --mnemonic Near private keys [string] - --key Near private key [string] + --help Show help [boolean] + --version Show version number [boolean] + -m, --module Module to query [choices: "Core", "NFTBridge", "TokenBridge"] + -n, --network Network [required] [choices: "mainnet", "testnet", "devnet"] + --account Near deployment account [string] [required] + --attach Attach some near [string] + --target Near account to upgrade [string] + --mnemonic Near private keys [string] + --key Near private key [string] + -r, --rpc Override default rpc endpoint url [string] ``` @@ -463,103 +217,12 @@ Options: parse ```sh -worm parse - -Commands: - worm parse init-token-bridge Init token bridge contract - worm parse init-wormhole Init Wormhole core contract - worm parse deploy Deploy an Aptos package - worm parse deploy-resource Deploy an Aptos package using a - resource account - worm parse send-example-message Send example message - - worm parse derive-resource-account Derive resource account address - - worm parse derive-wrapped-address Derive wrapped coin type - - worm parse hash-contracts Hash contract bytecodes for upgrade - - worm parse upgrade Perform upgrade after VAA has been - submitted - worm parse migrate Perform migration after contract - upgrade - worm parse faucet Request money from the faucet for a - given account - worm parse start-validator Start a local aptos validator - worm parse address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm parse storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm parse chains Return all EVM chains - worm parse info Query info about the on-chain state - of the contract - worm parse hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm parse start-validator Start a local EVM validator - worm parse registration Generate registration VAA - worm parse upgrade Generate contract upgrade VAA - worm parse attestation Generate a token attestation VAA - worm parse recover-chain-id Generate a recover chain ID VAA - worm parse Sets the default delivery provider - set-default-delivery-provider for the Wormhole Relayer contract - worm parse chain-id Print the wormhole chain ID integer - associated with the specified chain - name - worm parse contract Print contract address - - worm parse emitter Print address in emitter address -
format - worm parse origin Print the origin chain and address -
of the asset that corresponds to the - given chain and address. - worm parse registrations Print chain registrations - - worm parse rpc Print RPC address - worm parse wrapped Print the wrapped address on the - target chain that corresponds with - the specified origin chain and - address. - worm parse contract-update Submit a contract update using our - specific APIs - worm parse deploy Submit a contract update using near - APIs - Positionals: - vaa, v vaa [string] [required] + vaa vaa [string] Options: - --help Show help [boolean] - --version Show version number [boolean] - -n, -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet", "mainnet", "testnet", - "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - -r, --rpc Override default rpc endpoint url [string] - -m, --module Module to query - [choices: "Core", "NFTBridge", "TokenBridge"] - --account Near deployment account [string] [required] - --attach Attach some near [string] - --target Near account to upgrade [string] - --mnemonic Near private keys [string] - --key Near private key [string] + --help Show help [boolean] + --version Show version number [boolean] ``` @@ -567,116 +230,13 @@ Options: recover ```sh -worm recover - -Commands: - worm recover Init token bridge contract - init-token-bridge - worm recover Init Wormhole core contract - init-wormhole - worm recover deploy Deploy an Aptos package - - worm recover Deploy an Aptos package using a - deploy-resource resource account - worm recover Send example message - send-example-message - worm recover Derive resource account address - derive-resource-account - worm recover Derive wrapped coin type - derive-wrapped-address - - worm recover Hash contract bytecodes for upgrade - hash-contracts - worm recover Perform upgrade after VAA has been - upgrade submitted - worm recover Perform migration after contract - migrate upgrade - worm recover faucet Request money from the faucet for a - given account - worm recover Start a local aptos validator - start-validator - worm recover Compute a 20 byte eth address from a - address-from-secret 32 byte private key - worm recover Update a storage slot on an EVM fork - storage-update during testing (anvil or hardhat) - worm recover chains Return all EVM chains - worm recover info Query info about the on-chain state - of the contract - worm recover hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm recover Start a local EVM validator - start-validator - worm recover Generate registration VAA - registration - worm recover Generate contract upgrade VAA - upgrade - worm recover Generate a token attestation VAA - attestation - worm recover Generate a recover chain ID VAA - recover-chain-id - worm recover Sets the default delivery provider - set-default-delivery-provider for the Wormhole Relayer contract - worm recover Print the wormhole chain ID integer - chain-id associated with the specified chain - name - worm recover Print contract address - contract - worm recover Print address in emitter address - emitter
format - worm recover origin Print the origin chain and address -
of the asset that corresponds to the - given chain and address. - worm recover Print chain registrations - registrations - worm recover rpc Print RPC address - - worm recover Print the wrapped address on the - wrapped target chain that corresponds with - the specified origin chain and - address. - worm recover Submit a contract update using our - contract-update specific APIs - worm recover deploy Submit a contract update using near - APIs - Positionals: - vaa, v vaa [string] [required] digest digest [string] signature signature [string] Options: - --help Show help [boolean] - --version Show version number [boolean] - -n, -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet", "mainnet", "testnet", - "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - -r, --rpc Override default rpc endpoint url [string] - -m, --module Module to query - [choices: "Core", "NFTBridge", "TokenBridge"] - --account Near deployment account [string] [required] - --attach Attach some near [string] - --target Near account to upgrade [string] - --mnemonic Near private keys [string] - --key Near private key [string] + --help Show help [boolean] + --version Show version number [boolean] ``` @@ -684,115 +244,24 @@ Options: submit ```sh -worm submit - -Commands: - worm submit init-token-bridge Init token bridge contract - worm submit init-wormhole Init Wormhole core contract - worm submit deploy Deploy an Aptos package - worm submit deploy-resource Deploy an Aptos package using a - resource account - worm submit send-example-message Send example message - - worm submit Derive resource account address - derive-resource-account - worm submit derive-wrapped-address Derive wrapped coin type - - worm submit hash-contracts Hash contract bytecodes for upgrade - - worm submit upgrade Perform upgrade after VAA has been - submitted - worm submit migrate Perform migration after contract - upgrade - worm submit faucet Request money from the faucet for a - given account - worm submit start-validator Start a local aptos validator - worm submit address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm submit storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm submit chains Return all EVM chains - worm submit info Query info about the on-chain state - of the contract - worm submit hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm submit start-validator Start a local EVM validator - worm submit registration Generate registration VAA - worm submit upgrade Generate contract upgrade VAA - worm submit attestation Generate a token attestation VAA - worm submit recover-chain-id Generate a recover chain ID VAA - worm submit Sets the default delivery provider - set-default-delivery-provider for the Wormhole Relayer contract - worm submit chain-id Print the wormhole chain ID integer - associated with the specified chain - name - worm submit contract Print contract address - - worm submit emitter Print address in emitter address -
format - worm submit origin Print the origin chain and address -
of the asset that corresponds to the - given chain and address. - worm submit registrations Print chain registrations - - worm submit rpc Print RPC address - worm submit wrapped Print the wrapped address on the - target chain that corresponds with - the specified origin chain and - address. - worm submit contract-update Submit a contract update using our - specific APIs - worm submit deploy Submit a contract update using near - APIs - Positionals: - vaa, v vaa [string] [required] - digest digest [string] - signature signature [string] + vaa vaa [string] Options: - --help Show help [boolean] - --version Show version number [boolean] - -n, -n, -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet", "mainnet", "testnet", - "devnet", "mainnet", "testnet", "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - -r, --rpc RPC endpoint [string] - -m, --module Module to query - [choices: "Core", "NFTBridge", "TokenBridge"] - --account Near deployment account [string] [required] - --attach Attach some near [string] - --target Near account to upgrade [string] - --mnemonic Near private keys [string] - --key Near private key [string] - -c, --chain chain name + --help Show help [boolean] + --version Show version number [boolean] + -c, --chain chain name [choices: "unset", "solana", "ethereum", "terra", "bsc", "polygon", "avalanche", "oasis", "algorand", "aurora", "fantom", "karura", "acala", "klaytn", "celo", "near", "moonbeam", "neon", "terra2", "injective", "osmosis", "sui", "aptos", "arbitrum", "optimism", "gnosis", "pythnet", "xpla", "btc", "base", "sei", "wormchain", "sepolia"] - -a, --contract-address Contract to submit VAA to (override config) - [string] - --all-chains, --ac Submit the VAA to all chains except for the - origin chain specified in the payload + -n, --network Network + [required] [choices: "mainnet", "testnet", "devnet"] + -a, --contract-address Contract to submit VAA to (override config) [string] + --rpc RPC endpoint [string] + --all-chains, --ac Submit the VAA to all chains except for the origin + chain specified in the payload [boolean] [default: false] ``` @@ -804,130 +273,28 @@ Options: worm sui Commands: - worm sui init-token-bridge Init token bridge contract - worm sui init-wormhole Init Wormhole core contract - worm sui deploy Deploy an Aptos package - worm sui deploy-resource Deploy an Aptos package using a - resource account - worm sui send-example-message Send example message - worm sui derive-resource-account Derive resource account address - - worm sui derive-wrapped-address Derive wrapped coin type - - worm sui hash-contracts Hash contract bytecodes for upgrade - worm sui upgrade Perform upgrade after VAA has been - submitted - worm sui migrate Perform migration after contract - upgrade - worm sui faucet Request money from the faucet for a - given account - worm sui start-validator Start a local aptos validator - worm sui address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm sui storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm sui chains Return all EVM chains - worm sui info Query info about the on-chain state - of the contract - worm sui hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm sui start-validator Start a local EVM validator - worm sui registration Generate registration VAA - worm sui upgrade Generate contract upgrade VAA - worm sui attestation Generate a token attestation VAA - worm sui recover-chain-id Generate a recover chain ID VAA - worm sui set-default-delivery-provider Sets the default delivery provider - for the Wormhole Relayer contract - worm sui chain-id Print the wormhole chain ID integer - associated with the specified chain - name - worm sui contract Print contract address - - worm sui emitter
Print address in emitter address - format - worm sui origin
Print the origin chain and address - of the asset that corresponds to the - given chain and address. - worm sui registrations Print chain registrations - - worm sui rpc Print RPC address - worm sui wrapped Print the wrapped address on the - target chain that corresponds with - the specified origin chain and - address. - worm sui contract-update Submit a contract update using our - specific APIs - worm sui deploy Submit a contract update using near - APIs - worm sui build-coin Build wrapped coin and dump - bytecode. + worm sui build-coin Build wrapped coin and dump bytecode. - Example: - worm sui build-coin -d 8 -v V__0_1_1 - -n testnet -r "https://fullnode.test - net.sui.io:443" - worm sui deploy Deploy a Sui package - worm sui init-example-message-app Initialize example core message app - worm sui init-token-bridge Initialize token bridge contract - worm sui init-wormhole Initialize wormhole core contract - worm sui publish-example-message Publish message from example app via - core bridge - worm sui setup-devnet Setup devnet by deploying and - initializing core and token bridges - and submitting chain registrations. - worm sui objects Get owned objects by owner - worm sui package-id Get package ID from State object ID - worm sui tx Get transaction details - -Positionals: - vaa, v vaa [string] [required] - digest digest [string] - signature signature [string] + Example: + worm sui build-coin -d 8 -v V__0_1_1 -n + testnet -r + "https://fullnode.testnet.sui.io:443" + worm sui deploy Deploy a Sui package + worm sui init-example-message-app Initialize example core message app + worm sui init-token-bridge Initialize token bridge contract + worm sui init-wormhole Initialize wormhole core contract + worm sui publish-example-message Publish message from example app via + core bridge + worm sui setup-devnet Setup devnet by deploying and + initializing core and token bridges and + submitting chain registrations. + worm sui objects Get owned objects by owner + worm sui package-id Get package ID from State object ID + worm sui tx Get transaction details Options: - --help Show help [boolean] - --version Show version number [boolean] - -n, -n, -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet", "mainnet", "testnet", - "devnet", "mainnet", "testnet", "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - -r, --rpc RPC endpoint [string] - -m, --module Module to query - [choices: "Core", "NFTBridge", "TokenBridge"] - --account Near deployment account [string] [required] - --attach Attach some near [string] - --target Near account to upgrade [string] - --mnemonic Near private keys [string] - --key Near private key [string] - -c, --chain chain name - [choices: "unset", "solana", "ethereum", "terra", "bsc", "polygon", - "avalanche", "oasis", "algorand", "aurora", "fantom", "karura", "acala", - "klaytn", "celo", "near", "moonbeam", "neon", "terra2", "injective", - "osmosis", "sui", "aptos", "arbitrum", "optimism", "gnosis", "pythnet", - "xpla", "btc", "base", "sei", "wormchain", "sepolia"] - -a, --contract-address Contract to submit VAA to (override config) - [string] - --all-chains, --ac Submit the VAA to all chains except for the - origin chain specified in the payload - [boolean] [default: false] + --help Show help [boolean] + --version Show version number [boolean] ``` @@ -935,136 +302,11 @@ Options: verify-vaa ```sh -worm verify-vaa - -Commands: - worm verify-vaa init-token-bridge Init token bridge contract - worm verify-vaa init-wormhole Init Wormhole core contract - worm verify-vaa deploy Deploy an Aptos package - worm verify-vaa deploy-resource Deploy an Aptos package using a - resource account - worm verify-vaa send-example-message Send example message - - worm verify-vaa derive-resource-account Derive resource account address - - worm verify-vaa derive-wrapped-address Derive wrapped coin type - - worm verify-vaa hash-contracts Hash contract bytecodes for upgrade - - worm verify-vaa upgrade Perform upgrade after VAA has been - submitted - worm verify-vaa migrate Perform migration after contract - upgrade - worm verify-vaa faucet Request money from the faucet for a - given account - worm verify-vaa start-validator Start a local aptos validator - worm verify-vaa address-from-secret Compute a 20 byte eth address from a - 32 byte private key - worm verify-vaa storage-update Update a storage slot on an EVM fork - during testing (anvil or hardhat) - worm verify-vaa chains Return all EVM chains - worm verify-vaa info Query info about the on-chain state - of the contract - worm verify-vaa hijack Override the guardian set of the - core bridge contract during testing - (anvil or hardhat) - worm verify-vaa start-validator Start a local EVM validator - worm verify-vaa registration Generate registration VAA - worm verify-vaa upgrade Generate contract upgrade VAA - worm verify-vaa attestation Generate a token attestation VAA - worm verify-vaa recover-chain-id Generate a recover chain ID VAA - worm verify-vaa Sets the default delivery provider - set-default-delivery-provider for the Wormhole Relayer contract - worm verify-vaa chain-id Print the wormhole chain ID integer - associated with the specified chain - name - worm verify-vaa contract Print contract address - - worm verify-vaa emitter Print address in emitter address -
format - worm verify-vaa origin
Print the origin chain and address - of the asset that corresponds to the - given chain and address. - worm verify-vaa registrations Print chain registrations - - worm verify-vaa rpc Print RPC address - worm verify-vaa wrapped Print the wrapped address on the - target chain that corresponds with - the specified origin chain and - address. - worm verify-vaa contract-update Submit a contract update using our - specific APIs - worm verify-vaa deploy Submit a contract update using near - APIs - worm verify-vaa build-coin Build wrapped coin and dump - bytecode. - - Example: - worm sui build-coin -d 8 -v V__0_1_1 - -n testnet -r "https://fullnode.test - net.sui.io:443" - worm verify-vaa deploy Deploy a Sui package - worm verify-vaa init-example-message-app Initialize example core message app - worm verify-vaa init-token-bridge Initialize token bridge contract - worm verify-vaa init-wormhole Initialize wormhole core contract - worm verify-vaa publish-example-message Publish message from example app via - core bridge - worm verify-vaa setup-devnet Setup devnet by deploying and - initializing core and token bridges - and submitting chain registrations. - worm verify-vaa objects Get owned objects by owner - worm verify-vaa package-id Get package ID from State object ID - - worm verify-vaa tx Get transaction details - -Positionals: - vaa, v, v vaa in hex format [string] [required] - digest digest [string] - signature signature [string] - Options: - --help Show help [boolean] - --version Show version number [boolean] - -n, -n, -n, -n, --network Network - [required] [choices: "mainnet", "testnet", "devnet", "mainnet", "testnet", - "devnet", "mainnet", "testnet", "devnet", "mainnet", "testnet", "devnet"] - --guardian-set-index, --gsi guardian set index [number] - --signatures, --sigs comma separated list of signatures [string] - --wormscanurl, --wsu url to wormscan entry for the vaa that - includes signatures [string] - --wormscanfile, --wsf json file containing wormscan entry for the - vaa that includes signatures [string] - --emitter-chain-id, --ec emitter chain id to be used in the vaa - [number] - --emitter-address, --ea emitter address to be used in the vaa[string] - --nonce, --no nonce to be used in the vaa [number] - --sequence, --seq sequence number to be used in the vaa[string] - --consistency-level, --cl consistency level to be used in the vaa - [number] - --timestamp, --ts timestamp to be used in the vaa in unix - seconds [number] - -p, --payload payload in hex format [string] - -g, --guardian-secret, --gs Guardians' secret keys (CSV) - [string] [required] - -r, --rpc RPC endpoint [string] - -m, --module Module to query - [choices: "Core", "NFTBridge", "TokenBridge"] - --account Near deployment account [string] [required] - --attach Attach some near [string] - --target Near account to upgrade [string] - --mnemonic Near private keys [string] - --key Near private key [string] - -c, --chain chain name - [choices: "unset", "solana", "ethereum", "terra", "bsc", "polygon", - "avalanche", "oasis", "algorand", "aurora", "fantom", "karura", "acala", - "klaytn", "celo", "near", "moonbeam", "neon", "terra2", "injective", - "osmosis", "sui", "aptos", "arbitrum", "optimism", "gnosis", "pythnet", - "xpla", "btc", "base", "sei", "wormchain", "sepolia"] - -a, --contract-address Contract to submit VAA to (override config) - [string] - --all-chains, --ac Submit the VAA to all chains except for the - origin chain specified in the payload - [boolean] [default: false] + --help Show help [boolean] + --version Show version number [boolean] + -v, --vaa vaa in hex format [string] [required] + -n, --network Network [required] [choices: "mainnet", "testnet", "devnet"] ``` diff --git a/clients/js/src/doc.ts b/clients/js/src/doc.ts index e06ead1f3..70a3d0d09 100644 --- a/clients/js/src/doc.ts +++ b/clients/js/src/doc.ts @@ -17,10 +17,14 @@ import * as submit from "./cmds/submit"; import * as sui from "./cmds/sui"; import * as verifyVaa from "./cmds/verifyVaa"; + const MD_TAG = ""; -async function getHelpText(name: string, cmd: any): Promise { - return await cmd.builder(yargs).scriptName(`worm ${cmd.command}`).getHelp(); +async function getHelpText(cmd: any): Promise { + // Note that `yargs` is called as a function to produce a fresh copy. + // Otherwise the imported module is effectively a singleton where state from + // other commands is accumulated from repeat calls. + return await cmd.builder(yargs()).scriptName(`worm ${cmd.command}`).getHelp(); } (async function () { @@ -39,8 +43,8 @@ async function getHelpText(name: string, cmd: any): Promise { ]; const helpOutputs: Buffer[] = []; - for (const [name, cmd] of Object.entries(cmds)) { - const helpText = await getHelpText(name, cmd); + for (const cmd of cmds) { + const helpText = await getHelpText(cmd); helpOutputs.push(Buffer.from(`
diff --git a/clients/js/src/main.ts b/clients/js/src/main.ts index 082c37d4b..61d0a1129 100644 --- a/clients/js/src/main.ts +++ b/clients/js/src/main.ts @@ -18,6 +18,8 @@ import * as sui from "./cmds/sui"; import * as transfer from "./cmds/transfer"; import * as verifyVaa from "./cmds/verifyVaa"; +// Note: When adding another subcommand here, please be sure to also include it +// in the `cmds` array in `docs.ts` so it is properly documented. yargs(hideBin(process.argv)) // https://github.com/yargs/yargs/blob/main/docs/advanced.md#commanddirdirectory-opts // can't use `.commandDir` because bundling + tree-shaking