Wormhole TypeScript SDK

https://github.com/wormhole-foundation/wormhole-sdk-ts
Admin
A TypeScript SDK for interacting with Wormhole-supported blockchain chains and protocols, providing...
Tokens:42,864
Snippets:499
Trust Score:8.6
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Wormhole SDK Examples

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/examples/README.md

Commands to clone the repository, install dependencies, and build the project.

```sh
git clone  https://github.com/wormhole-foundation/wormhole-sdk-ts.git
cd wormhole-sdk-ts
npm install
npm run build
cd examples
```

--------------------------------

### Install Wormhole SDK

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Install the meta package to access all Wormhole functionality.

```bash
npm install @wormhole-foundation/sdk
```

--------------------------------

### Execute Wormhole SDK Examples

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/examples/README.md

Commands to run specific example programs for Token Bridge, CCTP, or Gateway.

```sh
npm run tb
# or
npm run cctp
# or
npm run gateway
```

--------------------------------

### Install Advanced SDK Packages

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Install specific sub-packages for granular control over dependencies.

```bash
# constants
npm install @wormhole-foundation/sdk-base
# contract interfaces, basic types, vaa payload definitions
npm install @wormhole-foundation/sdk-definitions
# Evm specific utilities
npm install @wormhole-foundation/sdk-evm
# Evm TokenBridge protocol client
npm install @wormhole-foundation/sdk-evm-tokenbridge
```

--------------------------------

### Install Wormhole Icons package

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/core/icons/README.md

Use npm to install the icon library into your project.

```bash
npm install @wormhole-foundation/sdk-icons
```

--------------------------------

### Console Logging Example

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_connect.routes.checkAndCompleteTransfer.html

Demonstrates standard usage of console.log for printing messages and variables to stdout.

```typescript
const count = 5;console.log('count: %d', count);// Prints: count: 5, to stdoutconsole.log('count:', count);// Prints: count: 5, to stdout
```

--------------------------------

### getTransferChannel

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.IbcBridge.html

Gets the transfer channel details.

```APIDOC
## getTransferChannel

### Description
Retrieves the transfer channel associated with the bridge.

### Signature
`getTransferChannel(): any`
```

--------------------------------

### Publish and Verify Messages with Wormhole Core

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Demonstrates how to initialize a Wormhole instance, publish a message via the Core bridge, and retrieve the resulting VAA.

```ts
  const wh = await wormhole("Testnet", [solana, evm]);

  const chain = wh.getChain("Avalanche");
  const { signer, address } = await getSigner(chain);

  // Get a reference to the core messaging bridge
  const coreBridge = await chain.getWormholeCore();

  // Generate transactions, sign and send them
  const publishTxs = coreBridge.publishMessage(
    // Address of sender (emitter in VAA)
    address.address,
    // Message to send (payload in VAA)
    encoding.bytes.encode("lol"),
    // Nonce (user defined, no requirement for a specific value, useful to provide a unique identifier for the message)
    0,
    // ConsistencyLevel (ie finality of the message, see wormhole docs for more)
    0,
  );
  // Send the transaction(s) to publish the message
  const txids = await signSendWait(chain, publishTxs, signer);

  // Take the last txid in case multiple were sent
  // the last one should be the one containing the relevant
  // event or log info
  const txid = txids[txids.length - 1];

  // Grab the wormhole message id from the transaction logs or storage
  const [whm] = await chain.parseTransaction(txid!.txid);

  // Or pull the full message content as an Unsigned VAA
  // console.log(await coreBridge.parseMessages(txid!.txid));

  // Wait for the vaa to be signed and available with a timeout
  const vaa = await wh.getVaa(whm!, "Uint8Array", 60_000);
  console.log(vaa);

  // Also possible to search by txid but it takes longer to show up
  // console.log(await wh.getVaaByTxHash(txid!.txid, "Uint8Array"));

  // Note: calling verifyMessage manually is typically not a useful thing to do
  // as the VAA is typically submitted to the counterpart contract for
  // a given protocol and the counterpart contract will verify the VAA
  // this is simply for demo purposes
  const verifyTxs = coreBridge.verifyMessage(address.address, vaa!);
  console.log(await signSendWait(chain, verifyTxs, signer));
```

--------------------------------

### deserializePayload<T>(payloadDet, data, offset?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_definitions.deserializePayload.html

Deserializes a payload from a Uint8Array starting at an optional offset.

```APIDOC
## deserializePayload<T>(payloadDet, data, offset?)

### Description
Deserializes a payload from a Uint8Array using the provided payload literal or discriminator.

### Parameters
- **payloadDet** (T) - Required - The payload literal or discriminator to use for deserialization.
- **data** (Byteish) - Required - The data to deserialize.
- **offset** (number) - Optional - The offset to start deserializing from (defaults to 0).

### Returns
- **DeserializePayloadReturn<T>** - The deserialized payload.

### Throws
- Throws an error if the data is not a valid payload.
```

--------------------------------

### createVerifySignaturesInstructions(connection, wormholeProgramId, payer, vaa, signatureSet, commitment?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_solana_core.utils.createVerifySignaturesInstructions.html

Creates transaction instructions to verify VAA signatures. Signatures are batched in groups of 7 due to instruction data limits and passed to the Secp256k1 program for recovery.

```APIDOC
## createVerifySignaturesInstructions

### Description
Creates transaction instructions to verify VAA signatures. Signatures are batched in groups of 7 due to instruction data limits and passed to the Secp256k1 program to verify that the guardian public keys can be recovered.

### Signature
`createVerifySignaturesInstructions(connection: Connection, wormholeProgramId: PublicKeyInitData, payer: PublicKeyInitData, vaa: VAA<any>, signatureSet: PublicKeyInitData, commitment?: Commitment): Promise<TransactionInstruction[]>`

### Parameters
- **connection** (Connection) - Required - Solana web3 connection.
- **wormholeProgramId** (PublicKeyInitData) - Required - Wormhole program address.
- **payer** (PublicKeyInitData) - Required - Transaction signer address.
- **vaa** (VAA<any>) - Required - Either signed VAA bytes or parsed VAA.
- **signatureSet** (PublicKeyInitData) - Required - Address to account of verified signatures.
- **commitment** (Commitment) - Optional - The commitment level.

### Returns
- **Promise<TransactionInstruction[]>** - A promise that resolves to an array of transaction instructions.
```

--------------------------------

### Import SDK and Platforms

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/modules/_wormhole_foundation_sdk.html

Import the main wormhole entry point and the specific platform modules required for your application.

```typescript
import { wormhole } from "@wormhole-foundation/sdk";import algorand from "@wormhole-foundation/sdk/algorand";import cosmwasm from "@wormhole-foundation/sdk/cosmwasm";import evm from "@wormhole-foundation/sdk/evm";import solana from "@wormhole-foundation/sdk/solana";import sui from "@wormhole-foundation/sdk/sui";
```

--------------------------------

### Validate Parameters and Get a Quote

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Validate transfer parameters and retrieve a quote from the selected route before execution.

```ts
  console.log("This route offers the following default options", bestRoute.getDefaultOptions());
  // Specify the amount as a decimal string
  const amt = "0.001";
  // Create the transfer params for this request
  const transferParams = { amount: amt, options: { nativeGas: 0 } };

  // validate the transfer params passed, this returns a new type of ValidatedTransferParams
  // which (believe it or not) is a validated version of the input params
  // this new var must be passed to the next step, quote
  const validated = await bestRoute.validate(tr, transferParams);
  if (!validated.valid) throw validated.error;
  console.log("Validated parameters: ", validated.params);

  // get a quote for the transfer, this too returns a new type that must
  // be passed to the next step, execute (if you like the quote)
  const quote = await bestRoute.quote(tr, validated.params);
  if (!quote.success) throw quote.error;
  console.log("Best route quote: ", quote);
```

--------------------------------

### Initialize Wormhole Instance

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Initialize the Wormhole object with a network environment and a list of supported platforms.

```ts
  const wh = await wormhole("Testnet", [evm, solana, aptos, algorand, cosmwasm, sui]);
```

--------------------------------

### loadProtocols<P>(platform, protocols?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk.index.loadProtocols.html

Loads the protocols for a given platform by calling the import function for each protocol. If a list of protocols is provided, only those protocols will be loaded.

```APIDOC
## loadProtocols<P>(platform, protocols?)

### Description
Loads the protocols for a given platform by calling the import function for each protocol. If a list of protocols is provided, only those protocols will be loaded.

### Signature
`loadProtocols<P extends Platform>(platform: PlatformDefinition<P>, protocols?: ProtocolName[]): Promise<void>`

### Parameters
- **platform** (PlatformDefinition<P>) - Required - The PlatformDefinition to load the protocols for.
- **protocols** (ProtocolName[]) - Optional - The list of protocols to load.

### Returns
- **Promise<void>** - A promise that resolves when the protocols are loaded.

### Throws
- Throws an error if any of the protocols fail to load.
```

--------------------------------

### Create Token Attestation

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Shows how to retrieve a TokenBridge client and generate transactions for creating a token attestation.

```ts
import { signSendWait } from "@wormhole-foundation/sdk";

// ...

const tb = await srcChain.getTokenBridge(); // => TokenBridge<'Evm'>

const token = "0xdeadbeef...";
const txGenerator = tb.createAttestation(token); // => AsyncGenerator<UnsignedTransaction, ...>
const txids = await signSendWait(srcChain, txGenerator, src.signer); // => TxHash[]
```

--------------------------------

### createPostVaaInstruction(connection, wormholeProgramId, payer, vaa, signatureSet)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_solana_core.utils.createPostVaaInstruction.html

Creates a TransactionInstruction for the post_vaa instruction. The signatureSet must be a pre-generated keypair used for signatures and the message hash.

```APIDOC
## createPostVaaInstruction

### Description
Creates a TransactionInstruction for the `post_vaa` instruction on the Solana blockchain. This is used to submit a VAA to the Wormhole bridge program.

### Signature
`createPostVaaInstruction(connection: Connection, wormholeProgramId: PublicKeyInitData, payer: PublicKeyInitData, vaa: VAA, signatureSet: PublicKeyInitData): TransactionInstruction`

### Parameters
- **connection** (Connection) - The Solana connection instance.
- **wormholeProgramId** (PublicKeyInitData) - The address of the Wormhole program.
- **payer** (PublicKeyInitData) - The address of the transaction signer.
- **vaa** (VAA) - The signed VAA bytes or parsed VAA object.
- **signatureSet** (PublicKeyInitData) - The public key for the signature set account used to store signatures and the message hash.

### Returns
- **TransactionInstruction** - The constructed instruction to be added to a transaction.
```

--------------------------------

### Initiate Gateway Transfer out of Cosmos

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/index.html

Use this pattern when leaving Cosmos. Manual completion on the destination chain is required after fetching the VAA.

```typescript
  console.log(    `Beginning transfer out of cosmos from ${      src.chain.chain    }:${src.address.address.toString()} to ${dst.chain.chain}:${dst.address.address.toString()}`,  );  const xfer = await GatewayTransfer.from(wh, {    token: token,    amount: amount,    from: src.address,    to: dst.address,  } as GatewayTransferDetails);  console.log("Created GatewayTransfer: ", xfer.transfer);  const srcTxIds = await xfer.initiateTransfer(src.signer);  console.log("Started transfer on source chain", srcTxIds);  const attests = await xfer.fetchAttestation(600_000);  console.log("Got attests", attests);  // Since we're leaving cosmos, this is required to complete the transfer  const dstTxIds = await xfer.completeTransfer(dst.signer);  console.log("Completed transfer on destination chain", dstTxIds);
```

--------------------------------

### createPriorityFeeInstructions(connection, transaction, feePercentile?, multiple?, minPriorityFee?, maxPriorityFee?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_solana.createPriorityFeeInstructions.html

Generates an array of TransactionInstructions to set the compute budget and priority fee for a specified Solana transaction.

```APIDOC
## createPriorityFeeInstructions

### Description
Calculates the appropriate compute budget and priority fee instructions for a Solana transaction based on network conditions and provided constraints.

### Signature
`createPriorityFeeInstructions(connection: Connection, transaction: VersionedTransaction | Transaction, feePercentile?: number, multiple?: number, minPriorityFee?: number, maxPriorityFee?: number): Promise<TransactionInstruction[]>`

### Parameters
- **connection** (Connection) - Required - A Solana/web3.js Connection to the network.
- **transaction** (VersionedTransaction | Transaction) - Required - The transaction to determine the compute budget for.
- **feePercentile** (number) - Optional - The percentile of recent fees to use (default: DEFAULT_PRIORITY_FEE_PERCENTILE).
- **multiple** (number) - Optional - The multiple to apply to the percentile fee (default: DEFAULT_PERCENTILE_MULTIPLE).
- **minPriorityFee** (number) - Optional - The minimum priority fee to use (default: DEFAULT_MIN_PRIORITY_FEE).
- **maxPriorityFee** (number) - Optional - The maximum priority fee to use (default: DEFAULT_MAX_PRIORITY_FEE).

### Returns
- **Promise<TransactionInstruction[]>** - An array of TransactionInstructions to set the compute budget and priority fee for the transaction.
```

--------------------------------

### Import Wormhole SDK

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Import the main wormhole function from the meta package.

```ts
import { wormhole } from "@wormhole-foundation/sdk";
```

--------------------------------

### getProtocol

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/classes/_wormhole_foundation_sdk_definitions.ChainContext.html

Constructs a protocol client for the specified protocol name.

```APIDOC
## getProtocol(protocolName, contracts?, rpc?)

### Description
Constructs a protocol client for the given protocol. If no contracts are provided, default contracts are assumed and the client is cached.

### Parameters
- **protocolName** (PN) - Required - The name of the protocol to construct a client for.
- **contracts** (Contracts) - Optional - Custom contract definitions.
- **rpc** (any) - Optional - Custom RPC configuration.

### Returns
- **Promise<ProtocolInstance>** - An instance of the protocol client.
```

--------------------------------

### loadProtocols

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/modules/_wormhole_foundation_sdk.index.html

Loads the available protocols supported by the SDK.

```APIDOC
## loadProtocols

### Description
Loads the protocol definitions available within the current SDK configuration.

### Signature
`loadProtocols(): ProtocolDefinition[]`
```

--------------------------------

### SDK Workspace Directory Structure

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/DESIGN.md

Visual representation of the project's modular workspace organization.

```text
core/
    base/ -- Constants
    definitions/ -- VAA structures and module definitions
    connect/ -- Primary package and interface through Wormhole 

platforms/ -- Platform specific logic 
    evm/
        protocols/
            tokenBridge.ts
            cctp.ts 
        chain.ts
        platform.ts
       ...
    solana/
        protocols/
            tokenBridge.ts 
        chain.ts
        platform.ts
       ...
```

--------------------------------

### fromRpc(rpc, config)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.ProtocolInitializer.html

Creates a new instance of the Protocol client using the provided RPC connection and configuration.

```APIDOC
### fromRpc(rpc, config)

#### Description
Creates a new instance of the Protocol client given the RPC connection and the configuration. This method is used to initialize the protocol client for a specific network and chain.

#### Parameters
- **rpc** (any) - The RPC connection to the chain, used to query the chain for its native chain id.
- **config** (ChainsConfig<Network, P>) - The ChainsConfig to use to initialize the protocol client.

#### Returns
- **Promise<ProtocolInterface<PN, N, C>>** - A promise that resolves to the initialized ProtocolInterface instance.
```

--------------------------------

### loadPlatforms(loaders)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk.index.loadPlatforms.html

Loads the platforms and their protocols by first calling the import function for each platform then calling the import function for each protocol.

```APIDOC
## loadPlatforms

### Description
Loads the platforms and their protocols by first calling the import function for each platform then calling the import function for each protocol.

### Signature
`loadPlatforms(loaders: PlatformLoader<Platform>[]): Promise<PlatformDefinition<Platform>[]>`

### Parameters
- **loaders** (PlatformLoader<Platform>[]) - Required - The list of PlatformLoaders to load.

### Returns
- **Promise<PlatformDefinition<Platform>[]>** - A promise that resolves to an array of platform definitions.
```

--------------------------------

### Define and Use Custom VAA Payload Layout

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Shows how to define a custom layout schema and use serializeLayout/deserializeLayout for non-standard payloads.

```ts

  // First define a custom payload layout
  const customPayloadLayout = [
    // 2 byte integer
    { name: "bar", binary: "uint", size: 2 },
    // arbitrary bytes, note this will take the rest of the payload
    { name: "foo", binary: "bytes" },
  ] as const satisfies Layout;

  // Now serialize a VAA with the custom payload layout
  const customVaaBytes = serialize(
    createVAA("Uint8Array", {
      guardianSet: 0,
      timestamp: 0,
      nonce: 0,
      emitterChain: "Solana",
      emitterAddress: new UniversalAddress(new Uint8Array(32)),
      sequence: 0n,
      consistencyLevel: 0,
      signatures: [],
      // Using `serializeLayout` with the custom layout we created above
      payload: serializeLayout(customPayloadLayout, {
        bar: 42,
        foo: new Uint8Array([1, 2, 3]),
      }),
    }),
  );
  // Deserialize the VAA to get the custom payload
  const vaa = deserialize("Uint8Array", customVaaBytes);
  console.log(encoding.hex.encode(vaa.payload));
  console.log(deserializeLayout(customPayloadLayout, vaa.payload));
```

--------------------------------

### Query API for VAAs and Token Details

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/DESIGN.md

Fetch Verified Action Approvals (VAAs) and resolve token information across chains.

```ts
// grab a vaa with identifier
wh.getVaa(...)
// get the token details 
wh.getOriginalToken(...)
wh.getWrappedToken(orig, chain)
```

--------------------------------

### Initiate Gateway Transfer into Cosmos

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/modules/_wormhole_foundation_sdk_connect.html

Use this to transfer assets from an external chain into the Cosmos ecosystem via the Wormhole Gateway.

```typescript
  console.log(    `Beginning transfer into Cosmos from ${src.chain.chain}:${src.address.address.toString()} to ${      dst.chain.chain    }:${dst.address.address.toString()}`,  );  const xfer = await GatewayTransfer.from(wh, {    token: token,    amount: amount,    from: src.address,    to: dst.address,  } as GatewayTransferDetails);  console.log(
```

--------------------------------

### loadPlatforms

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/modules/_wormhole_foundation_sdk.index.html

Loads the available platform definitions supported by the SDK.

```APIDOC
## loadPlatforms

### Description
Loads the platform definitions available within the current SDK configuration.

### Signature
`loadPlatforms(): PlatformDefinition[]`
```

--------------------------------

### utils

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/classes/_wormhole_foundation_sdk_definitions.PlatformContext.html

Provides access to the static attributes of the PlatformContext class.

```APIDOC
## utils()

### Description
Provides access to the static attributes of the PlatformContext class.
```

--------------------------------

### Initializing the Wormhole Constructor

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/modules/_wormhole_foundation_sdk_evm_cctp.html

Pass the desired platform modules to the Wormhole constructor to enable cross-chain functionality.

```typescript
const wh = await wormhole("Testnet", [evm, solana, aptos, algorand, cosmwasm, sui]);
```

--------------------------------

### maxSwapAmount()

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.AutomaticCircleBridge-1.html

Retrieves the maximum allowed swap amount.

```APIDOC
### Method
`maxSwapAmount(): Promise<bigint>`

### Description
Returns the maximum amount that can be swapped using the Automatic Circle Bridge.
```

--------------------------------

### newAccountMeta(pubkey, isSigner)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_solana.utils.newAccountMeta.html

Creates an AccountMeta object with isWritable set to true for a given public key and signer status.

```APIDOC
## newAccountMeta(pubkey, isSigner)

### Description
Factory function to create an `AccountMeta` object with `isWritable` set to `true`.

### Signature
`newAccountMeta(pubkey: PublicKeyInitData, isSigner: boolean): AccountMeta`

### Parameters
- **pubkey** (PublicKeyInitData) - The account address.
- **isSigner** (boolean) - Whether the account is authorized to sign the transaction.

### Returns
- **AccountMeta** - Metadata for a writable account.
```

--------------------------------

### newReadOnlyAccountMeta(pubkey, isSigner)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_solana.utils.newReadOnlyAccountMeta.html

Creates an AccountMeta object for a read-only account.

```APIDOC
## newReadOnlyAccountMeta(pubkey, isSigner)

### Description
Factory function to create an `AccountMeta` object with `isWritable` set to `false`.

### Signature
`newReadOnlyAccountMeta(pubkey: PublicKeyInitData, isSigner: boolean): AccountMeta`

### Parameters
- **pubkey** (PublicKeyInitData) - The account address.
- **isSigner** (boolean) - Whether the account is authorized to sign the transaction.

### Returns
- **AccountMeta** - Metadata for a read-only account.
```

--------------------------------

### getProtocol<PN>(protocol, rpc)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/classes/_wormhole_foundation_sdk_definitions.PlatformContext.html

Creates a new Protocol Client instance by protocol name using the provided RPC connection.

```APIDOC
## getProtocol<PN>(protocol, rpc)

### Description
Creates a new Protocol Client instance based on the protocol name. It uses the provided RPC connection to determine the network context.

### Parameters
- **protocol** (PN) - Required - The name of the protocol to instantiate.
- **rpc** (any) - Required - The RPC connection used to determine the network.

### Returns
- **Promise<ProtocolInstance>** - A promise that resolves to the initialized protocol client instance.
```

--------------------------------

### Manage Native and Universal Addresses

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Convert between string, native, and universal address formats using the SDK's address abstractions.

```ts
// Its possible to convert a string address to its Native address
const ethAddr: NativeAddress<"Evm"> = toNative("Ethereum", "0xbeef...");

// A common type in the SDK is the `ChainAddress` which provides
// the additional context of the `Chain` this address is relevant for.
const senderAddress: ChainAddress = Wormhole.chainAddress("Ethereum","0xbeef...");
const receiverAddress: ChainAddress = Wormhole.chainAddress("Solana","Sol1111...");

// Convert the ChainAddress back to its canonical string address format
const strAddress = Wormhole.canonicalAddress(senderAddress); // => '0xbeef...'

// Or if the ethAddr above is for an emitter and you need the UniversalAddress
const emitterAddr = ethAddr.toUniversalAddress().toString()
```

--------------------------------

### toUniversalAddress()

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.Address.html

Converts the address to its Universal representation.

```APIDOC
## toUniversalAddress()

### Description
Return an Address that has been converted to its Universal representation.

### Returns
- **UniversalAddress** - The universal representation of the address.
```

--------------------------------

### Configure RouteResolver

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/index.html

Initialize a new RouteResolver by passing an array of supported route classes to the Wormhole instance.

```typescript
  // create new resolver, passing the set of routes to consider  const resolver = wh.resolver([    routes.TokenBridgeRoute, // manual token bridge    routes.AutomaticTokenBridgeRoute, // automatic token bridge    routes.CCTPRoute, // manual CCTP    routes.AutomaticCCTPRoute, // automatic CCTP    routes.AutomaticPorticoRoute, // Native eth transfers  ]);
```

--------------------------------

### fromBaseUnits(amount, decimals)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_base.amount.fromBaseUnits.html

Creates an Amount instance from a bigint base unit value and a decimal count.

```APIDOC
## fromBaseUnits(amount, decimals)

### Description
Directly creates an Amount object given the base units and decimal level.

### Signature
`fromBaseUnits(amount: bigint, decimals: number): Amount`

### Parameters
- **amount** (bigint) - The amount expressed as base units.
- **decimals** (number) - The number of decimals for the token.

### Returns
- **Amount** - An Amount object, expressed as base units and decimals.
```

--------------------------------

### Initiate Gateway Transfer into Cosmos

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/index.html

Use this pattern for transfers originating outside of Cosmos. The transfer is automatically delivered via IBC from the Gateway chain.

```typescript
  console.log(    `Beginning transfer into Cosmos from ${src.chain.chain}:${src.address.address.toString()} to ${      dst.chain.chain    }:${dst.address.address.toString()}`,  );  const xfer = await GatewayTransfer.from(wh, {    token: token,    amount: amount,    from: src.address,    to: dst.address,  } as GatewayTransferDetails);  console.log("Created GatewayTransfer: ", xfer.transfer);  const srcTxIds = await xfer.initiateTransfer(src.signer);  console.log("Started transfer on source chain", srcTxIds);  const attests = await xfer.fetchAttestation(600_000);  console.log("Got Attestations", attests);
```

--------------------------------

### Initiate Gateway Transfers

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/modules/_wormhole_foundation_sdk.html

Use GatewayTransfer to move assets into, within, or out of Cosmos. Note that transfers leaving Cosmos require an explicit call to completeTransfer.

```typescript
  console.log(    `Beginning transfer into Cosmos from ${src.chain.chain}:${src.address.address.toString()} to ${      dst.chain.chain    }:${dst.address.address.toString()}`,  );  const xfer = await GatewayTransfer.from(wh, {    token: token,    amount: amount,    from: src.address,    to: dst.address,  } as GatewayTransferDetails);  console.log("Created GatewayTransfer: ", xfer.transfer);  const srcTxIds = await xfer.initiateTransfer(src.signer);  console.log("Started transfer on source chain", srcTxIds);  const attests = await xfer.fetchAttestation(600_000);  console.log("Got Attestations", attests);
```

```typescript
  console.log(    `Beginning transfer within cosmos from ${      src.chain.chain    }:${src.address.address.toString()} to ${dst.chain.chain}:${dst.address.address.toString()}`,  );  const xfer = await GatewayTransfer.from(wh, {    token: token,    amount: amount,    from: src.address,    to: dst.address,  } as GatewayTransferDetails);  console.log("Created GatewayTransfer: ", xfer.transfer);  const srcTxIds = await xfer.initiateTransfer(src.signer);  console.log("Started transfer on source chain", srcTxIds);  const attests = await xfer.fetchAttestation(60_000);  console.log("Got attests: ", attests);
```

```typescript
  console.log(    `Beginning transfer out of cosmos from ${      src.chain.chain    }:${src.address.address.toString()} to ${dst.chain.chain}:${dst.address.address.toString()}`,  );  const xfer = await GatewayTransfer.from(wh, {    token: token,    amount: amount,    from: src.address,    to: dst.address,  } as GatewayTransferDetails);  console.log("Created GatewayTransfer: ", xfer.transfer);  const srcTxIds = await xfer.initiateTransfer(src.signer);  console.log("Started transfer on source chain", srcTxIds);  const attests = await xfer.fetchAttestation(600_000);  console.log("Got attests", attests);  // Since we're leaving cosmos, this is required to complete the transfer  const dstTxIds = await xfer.completeTransfer(dst.signer);  console.log("Completed transfer on destination chain", dstTxIds);
```

--------------------------------

### getProtocolInitializer

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/classes/_wormhole_foundation_sdk_definitions.PlatformContext.html

Retrieves the underlying ProtocolInitializer to construct protocols.

```APIDOC
## getProtocolInitializer<PN>(protocol)

### Description
Get the underlying ProtocolInitializer to construct yourself.

### Parameters
- **protocol** (PN) - Required - The protocol identifier to initialize.
```

--------------------------------

### fmt(amount, decimals)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_base.amount.fmt.html

Formats a bigint amount to a string with the given number of decimals.

```APIDOC
## fmt(amount, decimals)

### Description
Formats a bigint amount to a string with the given number of decimals.

### Signature
`fmt(amount: bigint, decimals: number): string`

### Parameters
- **amount** (bigint) - The bigint amount to be formatted.
- **decimals** (number) - The number of decimals to use for formatting.

### Returns
- **string** - The formatted string representation of the amount.
```

--------------------------------

### Initiate Gateway Transfer within Cosmos

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/modules/_wormhole_foundation_sdk_evm_cctp.html

Use this for transfers between Cosmos chains, which route through the Gateway chain via IBC.

```typescript
  console.log(    `Beginning transfer within cosmos from ${      src.chain.chain    }:${src.address.address.toString()} to ${dst.chain.chain}:${dst.address.address.toString()}`,  );  const xfer = await GatewayTransfer.from(wh, {    token: token,    amount: amount,    from: src.address,    to: dst.address,  } as GatewayTransferDetails);  console.log(
```

--------------------------------

### toString()

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.Address.html

Returns the address in its canonical string format.

```APIDOC
## toString()

### Description
Returns the address in its canonical string format.

### Returns
- **string** - The canonical string representation of the address.
```

--------------------------------

### getWrappedAsset

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.TokenBridge-1.html

Returns the address of the native version of a specified foreign asset.

```APIDOC
## getWrappedAsset

### Description
Returns the address of the native version of this asset.

### Parameters
- **foreignToken** (TokenId) - Required - The token to check

### Returns
- **Promise<TokenAddress>** - The address of the native version of this asset
```

--------------------------------

### display(amount, precision?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_base.amount.display.html

Formats an Amount object as a human-readable string.

```APIDOC
## display(amount, precision?)

### Description
Formats an Amount as a human-readable string.

### Signature
`display(amount: Amount, precision?: number): string`

### Parameters
- **amount** (Amount) - Required - An Amount object to be formatted.
- **precision** (number) - Optional - Number of decimal places to render.

### Returns
- **string** - A string representing the Amount as a fixed point number.
```

--------------------------------

### getSigner

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk.index.PlatformDefinition.html

Provides a local signer that implements the Signer interface for the platform.

```APIDOC
## getSigner

### Description
Provides a local signer that implements the Signer interface for the platform.

### Signature
`(rpc: RpcConnection<P>, key: string, ...args: any[]): Promise<Signer>`

### Parameters
- **rpc** (RpcConnection<P>) - Required - The RPC connection instance.
- **key** (string) - Required - The private key or identifier for the signer.
- **args** (any[]) - Optional - Additional arguments required by the platform.

### Returns
- **Promise<Signer>** - A promise that resolves to a Signer instance.
```

--------------------------------

### bytes.zpad

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/variables/_wormhole_foundation_sdk_base.encoding.bytes.html

Pads a Uint8Array to a given length.

```APIDOC
## bytes.zpad(arr, length, padStart?)

### Description
Pad a Uint8Array to a given length, optionally specifying padding direction.

### Parameters
- **arr** (Uint8Array) - Required - The array to pad.
- **length** (number) - Required - The target length.
- **padStart** (boolean) - Optional - Whether to pad at the start (default: true).

### Returns
- **Uint8Array** - The padded array.
```

--------------------------------

### getTransferWrappedWithPayloadCpiAccounts(cpiProgramId, tokenBridgeProgramId, wormholeProgramId, payer, message, fromTokenAccount, tokenChain, tokenAddress, fromTokenAccountOwner?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_solana_tokenbridge.getTransferWrappedWithPayloadCpiAccounts.html

Generates the accounts required to execute the transfer_wrapped_with_payload instruction via cross-program invocation.

```APIDOC
## getTransferWrappedWithPayloadCpiAccounts

### Description
Generates the accounts needed to perform the `transfer_wrapped_with_payload` instruction as a cross-program invocation (CPI) on the Solana platform.

### Signature
`getTransferWrappedWithPayloadCpiAccounts(cpiProgramId, tokenBridgeProgramId, wormholeProgramId, payer, message, fromTokenAccount, tokenChain, tokenAddress, fromTokenAccountOwner?)`

### Parameters
- **cpiProgramId** (PublicKeyInitData) - The program ID initiating the CPI.
- **tokenBridgeProgramId** (PublicKeyInitData) - The Token Bridge program ID.
- **wormholeProgramId** (PublicKeyInitData) - The Wormhole program ID.
- **payer** (PublicKeyInitData) - The account paying for the transaction.
- **message** (PublicKeyInitData) - The message account.
- **fromTokenAccount** (PublicKeyInitData) - The source token account.
- **tokenChain** (number) - The chain ID of the token.
- **tokenAddress** (Uint8Array | Buffer) - The address of the token.
- **fromTokenAccountOwner** (PublicKeyInitData, Optional) - The owner of the source token account.

### Returns
- **TransferWrappedWithPayloadCpiAccounts** - An object containing the accounts required for the CPI.
```

--------------------------------

### submitAttestation

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.TokenBridge-1.html

Submit a Token Attestation VAA to create a wrapped token.

```APIDOC
## submitAttestation(vaa, payer?)

### Description
Submit the Token Attestation VAA to the Token bridge to create the wrapped token represented by the data in the VAA.

### Parameters
- **vaa** (VAA<"TokenBridge:AttestMeta">) - Required - The attestation VAA to submit
- **payer** (UniversalAddress) - Optional - The payer of the transaction

### Returns
- **AsyncGenerator** - An AsyncGenerator that produces transactions to sign and send
```

--------------------------------

### Create a RouteResolver

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Initialize a new resolver by passing an array of supported route types.

```ts
  // create new resolver, passing the set of routes to consider
  const resolver = wh.resolver([
    routes.TokenBridgeRoute, // manual token bridge
    routes.CCTPRoute, // manual CCTP
    routes.AutomaticCCTPRoute, // automatic CCTP
    routes.AutomaticPorticoRoute, // Native eth transfers
  ]);
```

--------------------------------

### checkAndCompleteTransfer(route, receipt, destinationSigner?, timeout?, log?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_connect.routes.checkAndCompleteTransfer.html

Tracks the transfer until the destination is initiated.

```APIDOC
## checkAndCompleteTransfer

### Description
Tracks the transfer until the destination is initiated.

### Signature
`checkAndCompleteTransfer<N>(route, receipt, destinationSigner?, timeout?, log?): Promise<TransferReceipt>`

### Parameters
- **route** (Route) - Required - The route that can be used to track the receipt.
- **receipt** (Receipt) - Required - The receipt to track.
- **destinationSigner** (any) - Optional - The signer for the destination chain.
- **timeout** (number) - Optional - Timeout duration.
- **log** (Function) - Optional - Logging function, defaults to console.log.

### Returns
- **Promise<TransferReceipt>** - A promise that resolves to one of the various transfer receipt types (e.g., CreatedTransferReceipt, CompletedTransferReceipt, etc.).
```

--------------------------------

### Initiate the Transfer

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Execute the transfer using the validated quote and a signer.

```ts
    // Now the transfer may be initiated
    // A receipt will be returned, guess what you gotta do with that?
    const receipt = await bestRoute.initiate(tr, sender.signer, quote, receiver.address);
    console.log("Initiated transfer with receipt: ", receipt);
```

--------------------------------

### Manage Chain Addresses

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/index.html

Convert between native, chain-specific, and universal address formats using the SDK's address utilities.

```typescript
// Its possible to convert a string address to its Native addressconst ethAddr: NativeAddress<"Evm"> = toNative("Ethereum", "0xbeef...");// A common type in the SDK is the `ChainAddress` which provides// the additional context of the `Chain` this address is relevant for.const senderAddress: ChainAddress = Wormhole.chainAddress("Ethereum","0xbeef...");const receiverAddress: ChainAddress = Wormhole.chainAddress("Solana","Sol1111...");// Convert the ChainAddress back to its canonical string address formatconst strAddress = Wormhole.canonicalAddress(senderAddress); // => '0xbeef...'// Or if the ethAddr above is for an emitter and you need the UniversalAddressconst emitterAddr = ethAddr.toUniversalAddress().toString()
```

--------------------------------

### WormholeCore SDK Methods

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.WormholeCore.html

The WormholeCore interface provides methods for interacting with the Wormhole core messaging protocol.

```APIDOC
## WormholeCore Interface Methods

### getGuardianSet(index: number): Promise<GuardianSet>
Retrieves the guardian set at the specified index.

### getGuardianSetIndex(): Promise<number>
Retrieves the current guardian set index.

### getMessageFee(): Promise<bigint>
Retrieves the current message fee required by the protocol.

### parseMessages(txid: string): Promise<VAA<"Uint8Array">[]>
Parses messages from a given transaction ID and returns an array of VAAs.

### parseTransaction(txid: string): Promise<WormholeMessageId[]>
Parses a transaction ID to retrieve associated Wormhole message identifiers.

### publishMessage(sender: string, message: Uint8Array, nonce: number, consistencyLevel: number): AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
Publishes a message to the Wormhole network. Returns an async generator of unsigned transactions.

### verifyMessage(sender: string, vaa: VAA<"Uint8Array">): AsyncGenerator<UnsignedTransaction<N, C>, any, unknown>
Verifies a VAA message. Returns an async generator of unsigned transactions.
```

--------------------------------

### Implement the Signer interface

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/index.html

Define a Signer to handle transaction signing via web wallets or other mechanisms. Choose between SignOnlySigner for offline signing or SignAndSendSigner for direct broadcasting.

```typescript
// A Signer is an interface that must be provided to certain methods// in the SDK to sign transactions. It can be either a SignOnlySigner// or a SignAndSendSigner depending on circumstances.// A Signer can be implemented by wrapping an existing offline wallet// or a web walletexport type Signer = SignOnlySigner | SignAndSendSigner;// A SignOnlySender is for situations where the signer is not// connected to the network or does not wish to broadcast the// transactions themselvesexport interface SignOnlySigner {  chain(): ChainName;  address(): string;  // Accept an array of unsigned transactions and return  // an array of signed and serialized transactions.  // The transactions may be inspected or altered before  // signing.  // Note: The serialization is chain specific, if in doubt,  // see the example implementations linked below  sign(tx: UnsignedTransaction[]): Promise<SignedTx[]>;}// A SignAndSendSigner is for situations where the signer is// connected to the network and wishes to broadcast the// transactions themselvesexport interface SignAndSendSigner {  chain(): ChainName;  address(): string;  // Accept an array of unsigned transactions and return  // an array of transaction ids in the same order as the  // UnsignedTransactions array.  signAndSend(tx: UnsignedTransaction[]): Promise<TxHash[]>;}
```

--------------------------------

### supportedTokens

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.PorticoBridge-1.html

Lists all tokens supported on the current chain.

```APIDOC
## supportedTokens()

### Description
Tokens supported on this chain.
```

--------------------------------

### Initiate Cross-Chain Transfers

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/DESIGN.md

Create transfer objects for various protocols supported by the SDK.

```ts
wh.tokenTransfer(...)
wh.nftTransfer(...)
wh.cctp(...)
//...
```

--------------------------------

### Import Wormhole Modules

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/sdk/README.md

Import the main wormhole function and the specific platform modules required for the application.

```ts
import { wormhole } from "@wormhole-foundation/sdk";
import algorand from "@wormhole-foundation/sdk/algorand";
import cosmwasm from "@wormhole-foundation/sdk/cosmwasm";
import evm from "@wormhole-foundation/sdk/evm";
import solana from "@wormhole-foundation/sdk/solana";
import sui from "@wormhole-foundation/sdk/sui";
```

--------------------------------

### createVAA<PL>(payloadLiteral, vaaData)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_definitions.createVAA.html

Creates a VAA from a payload literal and a set of dynamic properties.

```APIDOC
## createVAA<PL>(payloadLiteral, vaaData)

### Description
Create a VAA from a payload literal and a set of dynamic properties.

### Parameters
- **payloadLiteral** (PL) - Required - The payload literal to create a VAA for.
- **vaaData** (LayoutToType<DynamicItemsOfLayout<[...any[], PayloadLiteralToPayloadItemLayout<PL>]>>) - Required - The dynamic properties to include in the VAA.

### Returns
- **VAA<PL>** - A VAA with the given payload literal and dynamic properties.

### Throws
- Throws an error if the dynamic properties do not match the payload literal.
```

--------------------------------

### getChain<C>(chain, rpc?)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/classes/_wormhole_foundation_sdk_definitions.PlatformContext.html

Creates a new ChainContext object for a specific chain within the platform.

```APIDOC
## getChain<C>(chain, rpc?)

### Description
Creates a new ChainContext object for the specified chain. This method is used to initialize interaction with a specific blockchain network supported by the platform.

### Parameters
- **chain** (C) - Required - The identifier of the chain to initialize.
- **rpc** (any) - Optional - An optional RPC connection object.

### Returns
- **ChainContext** - A context object configured for the specified chain and network.
```

--------------------------------

### maxSwapAmount()

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.AutomaticCircleBridge-1.html

Returns the maximum amount of sending tokens that can be swapped for native tokens.

```APIDOC
### maxSwapAmount()

#### Description
Maximum amount of sending tokens that can be swapped for native tokens.

#### Returns
- **Promise<bigint>** - The maximum swap amount.
```

--------------------------------

### TokenBridge SDK Methods

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.TokenBridge-1.html

The TokenBridge interface provides several methods for interacting with the Token Bridge protocol. These methods allow for creating attestations, transferring tokens, redeeming assets, and querying asset details.

```APIDOC
## TokenBridge Interface Methods

### createAttestation(token, payer?)
Creates an attestation for a token. Returns an AsyncGenerator of UnsignedTransaction.

### getOriginalAsset(nativeAddress)
Retrieves the original asset information for a given native address.

### getTokenUniversalAddress(token)
Returns the UniversalAddress for a given token.

### getWrappedAsset(foreignToken)
Retrieves the wrapped asset address for a given foreign token.

### hasWrappedAsset(foreignToken)
Checks if a wrapped asset exists for the specified foreign token. Returns a boolean.

### isTransferCompleted(vaa)
Checks if a specific transfer (VAA) has been completed. Returns a boolean.

### isWrappedAsset(nativeAddress)
Checks if the provided native address corresponds to a wrapped asset. Returns a boolean.

### redeem(sender, vaa, unwrapNative?)
Redeems a token transfer using a VAA. Returns an AsyncGenerator of UnsignedTransaction.

### submitAttestation(vaa, payer?)
Submits an attestation VAA. Returns an AsyncGenerator of UnsignedTransaction.

### transfer(sender, recipient, token, amount, payload?)
Initiates a token transfer. Returns an AsyncGenerator of UnsignedTransaction.
```

--------------------------------

### getCompleteTransferWrappedWithPayloadCpiAccounts(tokenBridgeProgramId, wormholeProgramId, payer, vaa, toTokenAccount)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/functions/_wormhole_foundation_sdk_solana_tokenbridge.getCompleteTransferWrappedWithPayloadCpiAccounts.html

Generates the accounts required for a cross-program invocation of the complete_wrapped_with_payload instruction.

```APIDOC
## getCompleteTransferWrappedWithPayloadCpiAccounts

### Description
Generates the accounts needed to perform `complete_wrapped_with_payload` instruction as a cross-program invocation. Note that `toFeesTokenAccount` is the same as `toTokenAccount`.

### Signature
`getCompleteTransferWrappedWithPayloadCpiAccounts(tokenBridgeProgramId: PublicKeyInitData, wormholeProgramId: PublicKeyInitData, payer: PublicKeyInitData, vaa: TransferVAA, toTokenAccount: PublicKeyInitData): CompleteTransferWrappedWithPayloadCpiAccounts`

### Parameters
- **tokenBridgeProgramId** (PublicKeyInitData) - The program ID of the Token Bridge.
- **wormholeProgramId** (PublicKeyInitData) - The program ID of the Wormhole core bridge.
- **payer** (PublicKeyInitData) - The account paying for the transaction.
- **vaa** (TransferVAA) - The verified VAA for the transfer.
- **toTokenAccount** (PublicKeyInitData) - The destination token account.

### Returns
- **CompleteTransferWrappedWithPayloadCpiAccounts** - An object containing the accounts required for the CPI.
```

--------------------------------

### List Supported Destination Tokens

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/README.md

Query the resolver to determine which tokens are supported for a given source token and chain pair.

```ts
  const sendToken = Wormhole.tokenId(sendChain.chain, "native");

  // given the send token, what can we possibly get on the destination chain?
  const destTokens = await resolver.supportedDestinationTokens(sendToken, sendChain, destChain);
  console.log(
    "For the given source token and routes configured, the following tokens may be receivable: ",
    destTokens.map((t) => canonicalAddress(t)),
  );
  //grab the first one for the example
  const destinationToken = destTokens[0]!;
```

--------------------------------

### unwrap()

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.Address.html

Returns the underlying native address type.

```APIDOC
## unwrap()

### Description
Returns the underlying native address type (e.g., Uint8Array for UniversalAddress, checksum hex string for EVM, or PublicKey for Solana).

### Returns
- **unknown** - The underlying native address object.
```

--------------------------------

### transfer

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.IbcBridge.html

Initiates a transfer.

```APIDOC
## transfer

### Description
Executes a cross-chain transfer operation.

### Signature
`transfer(params: any): Promise<any>`
```

--------------------------------

### b64.encode(input: string | Uint8Array)

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/variables/_wormhole_foundation_sdk_base.encoding.b64.html

Encodes a string or Uint8Array into a Base64 string.

```APIDOC
## b64.encode(input: string | Uint8Array)

### Description
Encodes the provided input into a Base64 string.

### Parameters
- **input** (string | Uint8Array) - The data to encode.

### Returns
- **string** - The Base64 encoded string.
```

--------------------------------

### createAttestation

Source: https://github.com/wormhole-foundation/wormhole-sdk-ts/blob/main/docs/interfaces/_wormhole_foundation_sdk_definitions.TokenBridge-1.html

Creates a Token Attestation VAA containing metadata about a token, which can be submitted to a Token Bridge on another chain to create a wrapped version.

```APIDOC
## createAttestation(token, payer?)

### Description
Creates a Token Attestation VAA containing metadata about the token that may be submitted to a Token bridge on another chain to allow it to create a wrapped version of the token.

### Parameters
- **token** (TokenAddress) - Required - The token to create an attestation for.
- **payer** (UniversalAddress) - Optional - The payer of the transaction.

### Returns
- **AsyncGenerator** - An AsyncGenerator that produces transactions to sign and send.
```
Tokens:
Raw