Verified Action Approvals#
VAAs are Wormhole's core messaging primitive. They are packets of cross-chain data emitted whenever a cross-chain application contract interacts with the Core Contract.
The Guardians must validate messages emitted by contracts before sending them to the target chain. Once a majority of Guardians observe the message and determine finality, the Guardians sign a keccak256 hash of the message body.
The message is wrapped up in a structure called a VAA, which combines the message with the Guardian signatures to form a proof.
VAAs are uniquely indexed by the (emitter_chain
, emitter_address
, sequence
) tuple. To obtain a VAA, one can query the Wormholescan API with this information.
These VAAs are ultimately what a smart contract on a receiving chain must process to receive a Wormhole message.
VAA Format#
The basic VAA has two components: a header and a body.
Header#
The header holds metadata about the current VAA, the Guardian set that is currently active, and the list of signatures gathered so far.
version
byte - the VAA Versionguardian_set_index
u32 - indicates which Guardian set is signinglen_signatures
u8 - the number of signatures storedsignatures
[]signature - the collection of Guardian signatures
Where each signature
is:
index
u8 - the index of this Guardian in the Guardian setsignature
[65]byte - the ECDSA signature
Body#
The body is deterministically derived from an on-chain message. Any two Guardians processing the same message must derive the same resulting body. This requirement exists so that there is always a one-to-one relationship between VAAs and messages to avoid double-processing messages.
timestamp
u32 - the timestamp of the block this message was published innonce
u32emitter_chain
u16 - the id of the chain that emitted the messageemitter_address
[32]byte - the contract address (Wormhole formatted) that called the Core Contractsequence
u64 - the auto-incrementing integer that represents the number of messages published by this emitterconsistency_level
u8 - the consistency level (finality) required by this emitterpayload
[]byte - arbitrary bytes containing the data to be acted on
The body contains relevant information for entities, such as contracts, or other systems, that process or utilize VAAs. When a function like parseAndVerifyVAA
is called, the body is returned, allowing verification of the emitterAddress
to determine if the VAA originated from a trusted contract.
Note
Because VAAs have no destination, they are effectively multicast. Any Core Contract on any chain in the network will verify them as authentic. If a VAA has a specific destination, relayers are entirely responsible for completing that delivery appropriately.
Signatures#
The body of the VAA is hashed twice with keccak256
to produce the signed digest message.
// hash the bytes of the body twice
digest = keccak256(keccak256(body))
// sign the result
signature = ecdsa_sign(digest, key)
Note
Different implementations of the ECDSA signature validation may apply a keccak256 hash to the message passed, so care must be taken to pass the correct arguments.
For example, the Solana secp256k1 program will hash the message passed. In this case, the argument for the message should be a single hash of the body, not the twice-hashed body.
Payload Types#
Different applications built on Wormhole may specify a format for the payloads attached to a VAA. This payload provides information on the target chain and contract so it can take action (e.g., minting tokens to a receiver address).
Token Transfer#
Tokens are transferred between chains using a lockup/mint and burn/unlock mechanism. Many bridges use such a basic method, but the implementation described leverages the generic message-passing protocol provided by Wormhole to handle the routing of lock and burn events across chains. This approach ensures that Wormhole's Token Bridge is chain-agnostic. The bridge can be rapidly integrated into any network with a Wormhole contract. Wormhole's generic message-passing doesn't require any program to send messages to understand the specific implementation details of other chains.
To transfer tokens from Chain A to Chain B, you must lock them on A and mint them on B. The tokens on A must be proven to be locked before the minting can occur on B. To facilitate this process, Chain A first locks the tokens and emits a message indicating that the locking has been completed. This message has the following structure and is referred to as a transfer message:
payload_id
u8 - the ID of the payload. This should be set to1
for a token transferamount
u256 - amount of tokens being transferredtoken_address
u8[32] - address on the source chaintoken_chain
u16 - numeric ID for the source chainto
u8[32] - address on the destination chainto_chain
u16 - numeric ID for the destination chainfee
u256 - portion of amount paid to a relayer
This structure contains everything the receiving chain needs to learn about a lockup event. Once Chain B receives this payload, it can mint the corresponding asset.
Note that Chain B is agnostic regarding how the tokens on the sending side were locked. They could have been burned by a mint or locked in a custody account. The protocol relays the event once enough Guardians have attested to its existence.
Attestation#
The Transfer event in the preceding section needs an important detail added. While the program on Chain B can trust the message to inform it of token lockup events, it has no way of verifying the correct token is locked up. The address alone is a meaningless value to most users. To solve this, the Token Bridge supports token attestation.
For a token attestation, Chain A emits a message containing metadata about a token, which Chain B may use to preserve the name, symbol, and decimal precision of a token address.
The message format for this action is as follows:
payload_id
u8 - the ID of the payload. This should be set to2
for an attestationtoken_address
[32]byte - address of the originating token contracttoken_chain
u16 - chain ID of the originating tokendecimals
u8 - number of decimals this token should havesymbol
[32]byte - short name of assetname
[32]byte - full name of asset
Attestations use a fixed-length byte array to encode UTF8 token name and symbol data.
Note
Because the byte array is fixed length, the data contained may truncate multibyte Unicode characters.
When sending an attestation VAA, it is recommended to send the longest UTF-8 prefix that doesn't truncate a character and then right-pad it with zero bytes.
When parsing an attestation VAA, it is recommended to trim all trailing zero bytes and converting the remainder to UTF-8 via any lossy algorithm.
Note
Be mindful that different on-chain systems may have different VAA parsers, resulting in different names/symbols on different chains if the string is long or contains invalid UTF8.
Without knowing a token's decimal precision, Chain B cannot correctly mint the number of tokens when processing a transfer. For this reason, the Token Bridge requires an attestation for each token transfer.
Token Transfer with Message#
Note
This VAA type is also referred to as a payload3 message or a Contract Controlled Transfer.
The Token Transfer with Message data structure is identical to the token-only data structure with the addition of a payload
field containing arbitrary bytes. In this arbitrary byte field, an app may include additional data in the transfer to inform some application-specific behavior.
payload_id
u8 - the ID of the payload. This should be set to3
for a token transfer with messageamount
u256 - amount of tokens being transferredtoken_address
u8[32] - address on the source chaintoken_chain
u16 - numeric ID for the source chainto
u8[32] - address on the destination chainto_chain
u16 - numeric ID for the destination chainfee
u256 - portion of amount paid to a relayerpayload
[]byte - message, arbitrary bytes, app specific
Governance#
Governance VAAs don't have a payload_id
field like the preceding formats. They're used to trigger some action in the deployed contracts (for example, upgrade).
Action Structure#
Governance messages contain pre-defined actions, which can target the various Wormhole modules currently deployed on-chain. The structure contains the following fields:
module
u8[32] - contains a right-aligned module identifieraction
u8 - predefined governance action to executechain
u16 - chain the action is targeting. This should be set to0
for all chainsargs
any - arguments to the action
Below is an example message containing a governance action triggering a code upgrade to the Solana Core Contract. The module field here is a right-aligned encoding of the ASCII Core, represented as a 32-byte hex string.
module: 0x0000000000000000000000000000000000000000000000000000436f7265
action: 1
chain: 1
new_contract: 0x348567293758957162374959376192374884562522281937446234828323
Actions#
The meaning of each numeric action is pre-defined and documented in the Wormhole design documents. For each application, the relevant definitions can be found via these links:
Lifetime of a Message#
Note
Anyone can submit the VAA to the target chain. The Guardians typically don't perform this step to avoid transaction fees. Instead, applications built on top of Wormhole can acquire the VAA via the Guardian RPC and make the submission in a separate flow.
With the concepts now defined, it is possible to illustrate what a full flow for message passing between two chains looks like. The following stages demonstrate each step of processing that the Wormhole network performs to route a message.
- A message is emitted by a contract running on Chain A - any contract can emit messages, and the Guardians are programmed to observe all chains for these events. Here, the Guardians are represented as a single entity to simplify the graphics, but the observation of the message must be performed individually by each of the 19 Guardians
- Signatures are aggregated - Guardians observe and sign the message independently. Once enough Guardians have signed the message, the collection of signatures is combined with the message and metadata to produce a VAA
- VAA submitted to target chain - the VAA acts as proof that the Guardians have collectively attested the existence of the message payload; to complete the final step, the VAA itself is submitted (or relayed) to the target chain to be processed by a receiving contract