69 KiB
69 KiB
Wormhole CLI
This tool is a command line interface to Wormhole.
Installation
Pull down the repo if you dont already have it and cd to the appropriate directory:
git clone https://github.com/wormhole-foundation/wormhole
cd wormhole/clients/js
Build and install the cli tool:
make install
This installs two binaries, worm-fetch-governance and worm on your $PATH.
To use worm, set up $HOME/.wormhole/.env with your
private keys, based on .env.sample in this folder.
Usage
worm <command>
Commands:
worm aptos Aptos utilities
worm edit-vaa Edits or generates a VAA
worm evm EVM utilities
worm generate generate VAAs (devnet and testnet only)
worm info Contract, chain, rpc and address informatio
n utilities
worm near NEAR utilities
worm parse <vaa> Parse a VAA (can be in either hex or base64
format)
worm recover <digest> <signature> Recover an address from a signature
worm submit <vaa> Execute a VAA
worm sui Sui utilities
worm verify-vaa Verifies a VAA by querying the core contrac
t on Ethereum
Options:
--help Show help [boolean]
--version Show version number [boolean]
Subcommands
aptos
worm aptos <command>
Commands:
worm aptos init-token-bridge Init token bridge contract
worm aptos init-wormhole Init Wormhole core contract
worm aptos deploy <package-dir> Deploy an Aptos package
worm aptos deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm aptos send-example-message Send example message
<message>
worm aptos derive-resource-account Derive resource account address
<account> <seed>
worm aptos derive-wrapped-address Derive wrapped coin type
<chain> <origin-address>
worm aptos hash-contracts <package-dir> Hash contract bytecodes for upgrade
worm aptos upgrade <package-dir> Perform upgrade after VAA has been
submitted
worm aptos migrate Perform migration after contract
upgrade
worm aptos faucet Request money from the faucet for a
given account
worm aptos start-validator Start a local aptos validator
Options:
--help Show help [boolean]
--version Show version number [boolean]
edit-vaa
worm edit-vaa <command>
Commands:
worm edit-vaa init-token-bridge Init token bridge contract
worm edit-vaa init-wormhole Init Wormhole core contract
worm edit-vaa deploy <package-dir> Deploy an Aptos package
worm edit-vaa deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm edit-vaa send-example-message Send example message
<message>
worm edit-vaa derive-resource-account Derive resource account address
<account> <seed>
worm edit-vaa derive-wrapped-address Derive wrapped coin type
<chain> <origin-address>
worm edit-vaa hash-contracts Hash contract bytecodes for upgrade
<package-dir>
worm edit-vaa upgrade <package-dir> 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]
-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]
evm
worm evm <command>
Commands:
worm evm init-token-bridge Init token bridge contract
worm evm init-wormhole Init Wormhole core contract
worm evm deploy <package-dir> Deploy an Aptos package
worm evm deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm evm send-example-message <message> Send example message
worm evm derive-resource-account Derive resource account address
<account> <seed>
worm evm derive-wrapped-address <chain> Derive wrapped coin type
<origin-address>
worm evm hash-contracts <package-dir> Hash contract bytecodes for upgrade
worm evm upgrade <package-dir> 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 <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]
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 <package-dir> Deploy an Aptos package
worm generate deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm generate send-example-message Send example message
<message>
worm generate derive-resource-account Derive resource account address
<account> <seed>
worm generate derive-wrapped-address Derive wrapped coin type
<chain> <origin-address>
worm generate hash-contracts Hash contract bytecodes for upgrade
<package-dir>
worm generate upgrade <package-dir> 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
<secret> 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
worm generate recover-chain-id Generate a recover chain ID VAA
worm generate Sets the default delivery provider
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]
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 <package-dir> Deploy an Aptos package
worm info deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm info send-example-message <message> Send example message
worm info derive-resource-account Derive resource account address
<account> <seed>
worm info derive-wrapped-address <chain> Derive wrapped coin type
<origin-address>
worm info hash-contracts <package-dir> Hash contract bytecodes for upgrade
worm info upgrade <package-dir> 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 <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 <chain> Print the wormhole chain ID integer
associated with the specified chain
name
worm info contract <network> <chain> Print contract address
<module>
worm info emitter <chain> <address> Print address in emitter address
format
worm info origin <chain> <address> Print the origin chain and address
of the asset that corresponds to the
given chain and address.
worm info registrations <network> Print chain registrations
<chain> <module>
worm info rpc <network> <chain> Print RPC address
worm info wrapped <origin-chain> Print the wrapped address on the
<origin-address> <target-chain> target chain that corresponds with
the specified origin chain and
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]
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 <package-dir> Deploy an Aptos package
worm near deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm near send-example-message <message> Send example message
worm near derive-resource-account Derive resource account address
<account> <seed>
worm near derive-wrapped-address <chain> Derive wrapped coin type
<origin-address>
worm near hash-contracts <package-dir> Hash contract bytecodes for upgrade
worm near upgrade <package-dir> 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 <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 <chain> Print the wormhole chain ID integer
associated with the specified chain
name
worm near contract <network> <chain> Print contract address
<module>
worm near emitter <chain> <address> Print address in emitter address
format
worm near origin <chain> <address> Print the origin chain and address
of the asset that corresponds to the
given chain and address.
worm near registrations <network> Print chain registrations
<chain> <module>
worm near rpc <network> <chain> Print RPC address
worm near wrapped <origin-chain> Print the wrapped address on the
<origin-address> <target-chain> target chain that corresponds with
the specified origin chain and
address.
worm near contract-update <file> Submit a contract update using our
specific APIs
worm near deploy <file> 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]
parse
worm parse <vaa> <command>
Commands:
worm parse <vaa> init-token-bridge Init token bridge contract
worm parse <vaa> init-wormhole Init Wormhole core contract
worm parse <vaa> deploy <package-dir> Deploy an Aptos package
worm parse <vaa> deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm parse <vaa> send-example-message Send example message
<message>
worm parse <vaa> derive-resource-account Derive resource account address
<account> <seed>
worm parse <vaa> derive-wrapped-address Derive wrapped coin type
<chain> <origin-address>
worm parse <vaa> hash-contracts Hash contract bytecodes for upgrade
<package-dir>
worm parse <vaa> upgrade <package-dir> Perform upgrade after VAA has been
submitted
worm parse <vaa> migrate Perform migration after contract
upgrade
worm parse <vaa> faucet Request money from the faucet for a
given account
worm parse <vaa> start-validator Start a local aptos validator
worm parse <vaa> address-from-secret Compute a 20 byte eth address from a
<secret> 32 byte private key
worm parse <vaa> storage-update Update a storage slot on an EVM fork
during testing (anvil or hardhat)
worm parse <vaa> chains Return all EVM chains
worm parse <vaa> info Query info about the on-chain state
of the contract
worm parse <vaa> hijack Override the guardian set of the
core bridge contract during testing
(anvil or hardhat)
worm parse <vaa> start-validator Start a local EVM validator
worm parse <vaa> registration Generate registration VAA
worm parse <vaa> upgrade Generate contract upgrade VAA
worm parse <vaa> attestation Generate a token attestation VAA
worm parse <vaa> recover-chain-id Generate a recover chain ID VAA
worm parse <vaa> Sets the default delivery provider
set-default-delivery-provider for the Wormhole Relayer contract
worm parse <vaa> chain-id <chain> Print the wormhole chain ID integer
associated with the specified chain
name
worm parse <vaa> contract <network> Print contract address
<chain> <module>
worm parse <vaa> emitter <chain> Print address in emitter address
<address> format
worm parse <vaa> origin <chain> Print the origin chain and address
<address> of the asset that corresponds to the
given chain and address.
worm parse <vaa> registrations <network> Print chain registrations
<chain> <module>
worm parse <vaa> rpc <network> <chain> Print RPC address
worm parse <vaa> wrapped <origin-chain> Print the wrapped address on the
<origin-address> <target-chain> target chain that corresponds with
the specified origin chain and
address.
worm parse <vaa> contract-update <file> Submit a contract update using our
specific APIs
worm parse <vaa> deploy <file> Submit a contract update using near
APIs
Positionals:
vaa, v vaa [string] [required]
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]
recover
worm recover <digest> <signature> <command>
Commands:
worm recover <digest> <signature> Init token bridge contract
init-token-bridge
worm recover <digest> <signature> Init Wormhole core contract
init-wormhole
worm recover <digest> <signature> deploy Deploy an Aptos package
<package-dir>
worm recover <digest> <signature> Deploy an Aptos package using a
deploy-resource <seed> <package-dir> resource account
worm recover <digest> <signature> Send example message
send-example-message <message>
worm recover <digest> <signature> Derive resource account address
derive-resource-account <account> <seed>
worm recover <digest> <signature> Derive wrapped coin type
derive-wrapped-address <chain>
<origin-address>
worm recover <digest> <signature> Hash contract bytecodes for upgrade
hash-contracts <package-dir>
worm recover <digest> <signature> Perform upgrade after VAA has been
upgrade <package-dir> submitted
worm recover <digest> <signature> Perform migration after contract
migrate upgrade
worm recover <digest> <signature> faucet Request money from the faucet for a
given account
worm recover <digest> <signature> Start a local aptos validator
start-validator
worm recover <digest> <signature> Compute a 20 byte eth address from a
address-from-secret <secret> 32 byte private key
worm recover <digest> <signature> Update a storage slot on an EVM fork
storage-update during testing (anvil or hardhat)
worm recover <digest> <signature> chains Return all EVM chains
worm recover <digest> <signature> info Query info about the on-chain state
of the contract
worm recover <digest> <signature> hijack Override the guardian set of the
core bridge contract during testing
(anvil or hardhat)
worm recover <digest> <signature> Start a local EVM validator
start-validator
worm recover <digest> <signature> Generate registration VAA
registration
worm recover <digest> <signature> Generate contract upgrade VAA
upgrade
worm recover <digest> <signature> Generate a token attestation VAA
attestation
worm recover <digest> <signature> Generate a recover chain ID VAA
recover-chain-id
worm recover <digest> <signature> Sets the default delivery provider
set-default-delivery-provider for the Wormhole Relayer contract
worm recover <digest> <signature> Print the wormhole chain ID integer
chain-id <chain> associated with the specified chain
name
worm recover <digest> <signature> Print contract address
contract <network> <chain> <module>
worm recover <digest> <signature> Print address in emitter address
emitter <chain> <address> format
worm recover <digest> <signature> origin Print the origin chain and address
<chain> <address> of the asset that corresponds to the
given chain and address.
worm recover <digest> <signature> Print chain registrations
registrations <network> <chain> <module>
worm recover <digest> <signature> rpc Print RPC address
<network> <chain>
worm recover <digest> <signature> Print the wrapped address on the
wrapped <origin-chain> <origin-address> target chain that corresponds with
<target-chain> the specified origin chain and
address.
worm recover <digest> <signature> Submit a contract update using our
contract-update <file> specific APIs
worm recover <digest> <signature> deploy Submit a contract update using near
<file> 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]
submit
worm submit <vaa> <command>
Commands:
worm submit <vaa> init-token-bridge Init token bridge contract
worm submit <vaa> init-wormhole Init Wormhole core contract
worm submit <vaa> deploy <package-dir> Deploy an Aptos package
worm submit <vaa> deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm submit <vaa> send-example-message Send example message
<message>
worm submit <vaa> Derive resource account address
derive-resource-account <account> <seed>
worm submit <vaa> derive-wrapped-address Derive wrapped coin type
<chain> <origin-address>
worm submit <vaa> hash-contracts Hash contract bytecodes for upgrade
<package-dir>
worm submit <vaa> upgrade <package-dir> Perform upgrade after VAA has been
submitted
worm submit <vaa> migrate Perform migration after contract
upgrade
worm submit <vaa> faucet Request money from the faucet for a
given account
worm submit <vaa> start-validator Start a local aptos validator
worm submit <vaa> address-from-secret Compute a 20 byte eth address from a
<secret> 32 byte private key
worm submit <vaa> storage-update Update a storage slot on an EVM fork
during testing (anvil or hardhat)
worm submit <vaa> chains Return all EVM chains
worm submit <vaa> info Query info about the on-chain state
of the contract
worm submit <vaa> hijack Override the guardian set of the
core bridge contract during testing
(anvil or hardhat)
worm submit <vaa> start-validator Start a local EVM validator
worm submit <vaa> registration Generate registration VAA
worm submit <vaa> upgrade Generate contract upgrade VAA
worm submit <vaa> attestation Generate a token attestation VAA
worm submit <vaa> recover-chain-id Generate a recover chain ID VAA
worm submit <vaa> Sets the default delivery provider
set-default-delivery-provider for the Wormhole Relayer contract
worm submit <vaa> chain-id <chain> Print the wormhole chain ID integer
associated with the specified chain
name
worm submit <vaa> contract <network> Print contract address
<chain> <module>
worm submit <vaa> emitter <chain> Print address in emitter address
<address> format
worm submit <vaa> origin <chain> Print the origin chain and address
<address> of the asset that corresponds to the
given chain and address.
worm submit <vaa> registrations Print chain registrations
<network> <chain> <module>
worm submit <vaa> rpc <network> <chain> Print RPC address
worm submit <vaa> wrapped <origin-chain> Print the wrapped address on the
<origin-address> <target-chain> target chain that corresponds with
the specified origin chain and
address.
worm submit <vaa> contract-update <file> Submit a contract update using our
specific APIs
worm submit <vaa> deploy <file> 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, -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]
sui
worm sui <command>
Commands:
worm sui init-token-bridge Init token bridge contract
worm sui init-wormhole Init Wormhole core contract
worm sui deploy <package-dir> Deploy an Aptos package
worm sui deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm sui send-example-message <message> Send example message
worm sui derive-resource-account Derive resource account address
<account> <seed>
worm sui derive-wrapped-address <chain> Derive wrapped coin type
<origin-address>
worm sui hash-contracts <package-dir> Hash contract bytecodes for upgrade
worm sui upgrade <package-dir> 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 <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 <chain> Print the wormhole chain ID integer
associated with the specified chain
name
worm sui contract <network> <chain> Print contract address
<module>
worm sui emitter <chain> <address> Print address in emitter address
format
worm sui origin <chain> <address> Print the origin chain and address
of the asset that corresponds to the
given chain and address.
worm sui registrations <network> <chain> Print chain registrations
<module>
worm sui rpc <network> <chain> Print RPC address
worm sui wrapped <origin-chain> Print the wrapped address on the
<origin-address> <target-chain> target chain that corresponds with
the specified origin chain and
address.
worm sui contract-update <file> Submit a contract update using our
specific APIs
worm sui deploy <file> Submit a contract update using near
APIs
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 <package-dir> 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 <owner> Get owned objects by owner
worm sui package-id <state-object-id> Get package ID from State object ID
worm sui tx <transaction-digest> Get transaction details
Positionals:
vaa, v vaa [string] [required]
digest digest [string]
signature signature [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
[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]
verify-vaa
worm verify-vaa <command>
Commands:
worm verify-vaa init-token-bridge Init token bridge contract
worm verify-vaa init-wormhole Init Wormhole core contract
worm verify-vaa deploy <package-dir> Deploy an Aptos package
worm verify-vaa deploy-resource <seed> Deploy an Aptos package using a
<package-dir> resource account
worm verify-vaa send-example-message Send example message
<message>
worm verify-vaa derive-resource-account Derive resource account address
<account> <seed>
worm verify-vaa derive-wrapped-address Derive wrapped coin type
<chain> <origin-address>
worm verify-vaa hash-contracts Hash contract bytecodes for upgrade
<package-dir>
worm verify-vaa upgrade <package-dir> 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
<secret> 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 <chain> Print the wormhole chain ID integer
associated with the specified chain
name
worm verify-vaa contract <network> Print contract address
<chain> <module>
worm verify-vaa emitter <chain> Print address in emitter address
<address> format
worm verify-vaa origin <chain> <address> Print the origin chain and address
of the asset that corresponds to the
given chain and address.
worm verify-vaa registrations <network> Print chain registrations
<chain> <module>
worm verify-vaa rpc <network> <chain> Print RPC address
worm verify-vaa wrapped <origin-chain> Print the wrapped address on the
<origin-address> <target-chain> target chain that corresponds with
the specified origin chain and
address.
worm verify-vaa contract-update <file> Submit a contract update using our
specific APIs
worm verify-vaa deploy <file> 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 <package-dir> 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 <owner> Get owned objects by owner
worm verify-vaa package-id Get package ID from State object ID
<state-object-id>
worm verify-vaa tx <transaction-digest> 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]
Examples
VAA generation
Use generate to create VAAs for testing. For example, to create an NFT bridge registration VAA:
$ worm generate registration --module NFTBridge \
--chain bsc \
--contract-address 0x706abc4E45D419950511e474C7B9Ed348A4a716c \
--guardian-secret cfb12303a19cde580bb4dd771639b0d26bc68353645571a8cff516ab2ee113a0
Example creating a token attestation VAA:
$ worm generate attestation --emitter-chain ethereum \
--emitter-address 11111111111111111111111111111115 \
--chain ethereum \
--token-address 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 \
--decimals 6 \
--symbol USDC \
--name USDC \
--guardian-secret cfb12303a19cde580bb4dd771639b0d26bc68353645571a8cff516ab2ee113a0
VAA parsing
Use parse to parse a VAA into JSON. For example,
worm parse $(worm-fetch-governance 13940208096455381020)
will fetch governance VAA 13940208096455381020 and print it as JSON.
# ...signatures elided
timestamp: 1651416474,
nonce: 1570649151,
emitterChain: 1,
emitterAddress: '0000000000000000000000000000000000000000000000000000000000000004',
sequence: 13940208096455381020n,
consistencyLevel: 32,
payload: {
module: 'Core',
type: 'GuardianSetUpgrade',
chain: 0,
newGuardianSetIndex: 2,
newGuardianSetLength: 19,
newGuardianSet: [
'58cc3ae5c097b213ce3c81979e1b9f9570746aa5',
'ff6cb952589bde862c25ef4392132fb9d4a42157',
'114de8460193bdf3a2fcf81f86a09765f4762fd1',
'107a0086b32d7a0977926a205131d8731d39cbeb',
'8c82b2fd82faed2711d59af0f2499d16e726f6b2',
'11b39756c042441be6d8650b69b54ebe715e2343',
'54ce5b4d348fb74b958e8966e2ec3dbd4958a7cd',
'66b9590e1c41e0b226937bf9217d1d67fd4e91f5',
'74a3bf913953d695260d88bc1aa25a4eee363ef0',
'000ac0076727b35fbea2dac28fee5ccb0fea768e',
'af45ced136b9d9e24903464ae889f5c8a723fc14',
'f93124b7c738843cbb89e864c862c38cddcccf95',
'd2cc37a4dc036a8d232b48f62cdd4731412f4890',
'da798f6896a3331f64b48c12d1d57fd9cbe70811',
'71aa1be1d36cafe3867910f99c09e347899c19c3',
'8192b6e7387ccd768277c17dab1b7a5027c0b3cf',
'178e21ad2e77ae06711549cfbb1f9c7a9d8096e8',
'5e1487f35515d02a92753504a8d75471b9f49edb',
'6fbebc898f403e4773e95feb15e80c9a99c8348d'
]
}
Submitting VAAs
Use submit to submit a VAA to a chain. It first parses the VAA and figures out
what's the destination chain and module. For example, a contract upgrade contains both the target chain and module, so the only required argument is the network moniker (mainnet or testnet):
worm submit $(cat my-nft-registration.txt) --network mainnet
For VAAs that don't have a specific target chain (like registrations or guardian set upgrades), the script will ask you to specify the target chain. For example, to submit a guardian set upgrade on all chains, simply run:
$ worm-fetch-governance 13940208096455381020 > guardian-upgrade.txt
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain oasis
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain aurora
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain fantom
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain karura
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain acala
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain klaytn
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain avalanche
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain polygon
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain bsc
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain solana
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain terra
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain ethereum
$ worm submit $(cat guardian-upgrade.txt) --network mainnet --chain celo
The VAA payload type (guardian set upgrade) specifies that this VAA should go to the core bridge, and the tool directs it there.
info
To get info about a contract (only EVM supported at this time)
$ worm evm info -c bsc -n mainnet -m TokenBridge
{
"address": "0xB6F6D86a8f9879A9c87f643768d9efc38c1Da6E7",
"wormhole": "0x98f3c9e6E3fAce36bAAd05FE09d375Ef1464288B",
"implementation": "0xEe91C335eab126dF5fDB3797EA9d6aD93aeC9722",
"isInitialized": true,
"tokenImplementation": "0xb6D7bbdE7c46a8B784F4a19C7FDA0De34b9577DB",
"chainId": 4,
"governanceChainId": 1,
"governanceContract": "0x0000000000000000000000000000000000000000000000000000000000000004",
"WETH": "0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c",
"registrations": {
"solana": "0xec7372995d5cc8732397fb0ad35c0121e0eaa90d26f828a534cab54391b3a4f5",
"ethereum": "0x0000000000000000000000003ee18b2214aff97000d974cf647e7c347e8fa585",
"terra": "0x0000000000000000000000007cf7b764e38a0a5e967972c1df77d432510564e2",
"polygon": "0x0000000000000000000000005a58505a96d1dbf8df91cb21b54419fc36e93fde",
"avalanche": "0x0000000000000000000000000e082f06ff657d94310cb8ce8b0d9a04541d8052",
"oasis": "0x0000000000000000000000005848c791e09901b40a9ef749f2a6735b418d7564",
"algorand": "0x0000000000000000000000000000000000000000000000000000000000000000",
"aurora": "0x00000000000000000000000051b5123a7b0f9b2ba265f9c4c8de7d78d52f510f",
"fantom": "0x0000000000000000000000007c9fc5741288cdfdd83ceb07f3ea7e22618d79d2",
"karura": "0x000000000000000000000000ae9d7fe007b3327aa64a32824aaac52c42a6e624",
"acala": "0x000000000000000000000000ae9d7fe007b3327aa64a32824aaac52c42a6e624",
"klaytn": "0x0000000000000000000000005b08ac39eaed75c0439fc750d9fe7e1f9dd0193f",
"celo": "0x000000000000000000000000796dff6d74f3e27060b71255fe517bfb23c93eed",
"near": "0x0000000000000000000000000000000000000000000000000000000000000000",
"injective": "0x0000000000000000000000000000000000000000000000000000000000000000",
"osmosis": "0x0000000000000000000000000000000000000000000000000000000000000000",
"sui": "0x0000000000000000000000000000000000000000000000000000000000000000",
"aptos": "0x0000000000000000000000000000000000000000000000000000000000000000",
"moonbeam": "0x0000000000000000000000000000000000000000000000000000000000000000",
"neon": "0x0000000000000000000000000000000000000000000000000000000000000000",
"terra2": "0xa463ad028fb79679cfc8ce1efba35ac0e77b35080a1abe9bebe83461f176b0a3",
"arbitrum": "0x0000000000000000000000000000000000000000000000000000000000000000",
"optimism": "0x0000000000000000000000000000000000000000000000000000000000000000",
"gnosis": "0x0000000000000000000000000000000000000000000000000000000000000000",
}
}
Misc
To get the contract address for a module:
$ worm info contract mainnet bsc NFTBridge
To get the RPC address for a chain
$ worm info rpc mainnet bsc