Optional
conf: WormholeConfigProtected
_chainsProtected
Readonly
_networkProtected
_platformsReadonly
confthe amount to transfer
the address to transfer from
the address to transfer to
whether to use automatic delivery
Optional
payload: Uint8Arraythe payload to send with the transfer
Optional
nativeGas: bigintthe amount of native gas to send with the transfer
the CCTPTransfer object
Errors if the chain or protocol is not supported
Fetches the balance of a given token for a wallet
The chain name or id
The wallet address
The token balance of the wormhole asset as a BigNumber
Returns the chain "context", i.e. the class with chain-specific logic and methods
the chain name
the chain context class
Errors if context is not found
Gets the contract addresses for a given chain
the chain name or chain id
the contract addresses
Gets the number of decimals for a token on a given chain
The chain name or id of the token/representation
The number of decimals
Returns the platform object, i.e. the class with platform-specific logic and methods
the chain name or platform name
the platform context class
Errors if platform is not found
Gets the associated token account for chains that require it (only Solana currently).
the chain name of the source token
the TokenId or address of the source token
the address of the recipient
Get the status of a transaction, identified by the chain, emitter address, and sequence number
the chain name
the emitter address
the sequence number
the TransactionStatus
Gets a VAA from the API or Guardian RPC, finality must be met before the VAA will be available.
The chain name
The emitter address
The sequence number
The total amount of time to wait for the VAA to be available
The VAA if available
Errors if the VAA is not available after the retries
Gets the Raw VAA Bytes from the API or Guardian RPC, finality must be met before the VAA will be available.
The chain name
The emitter address
The sequence number
The VAA bytes if available
Errors if the VAA is not available after the retries
Gets the TokenId for a token representation on any chain These are the Wormhole wrapped token addresses, not necessarily the cannonical version of that token
The chain name or id
The TokenId on the given chain, null if it does not exist
Errors if the chain is not supported or the token does not exist
Converts a human friendly decimal number to base units for the token passed
The chain name
The decimal number as a string to convert into base units
The amount converted to base units as a BigNumber
Parse an address to a universal address
The native address
The address in the universal format
Parses all relevant information from a transaction given the sending tx hash and sending chain
The sending chain name or id
Optional
timeout: numberThe parsed WormholeMessageId
Creates a TokenTransfer object to move a token from one chain to another
the token to transfer
the amount to transfer
the address to transfer from
the address to transfer to
whether to use automatic delivery
Optional
payload: Uint8Arraythe payload to send with the transfer
Optional
nativeGas: bigintthe amount of native gas to send with the transfer
the TokenTransfer object
Errors if the chain or protocol is not supported
Generated using TypeDoc
Creates a CCTPTransfer object to move Native USDC from one chain to another