batchTransferTokens

Transfers tokens to multiple recipients in a single transaction.

Method Signature

async batchTransferTokens(
  receiverOutputs: {
    tokenIdentifier: Bech32mTokenIdentifier;
    tokenAmount: bigint;
    receiverSparkAddress: string;
  }[],
  outputSelectionStrategy: "SMALL_FIRST" | "LARGE_FIRST" = "SMALL_FIRST",
  selectedOutputs?: OutputWithPreviousTransactionData[]
): Promise<string>

Parameters

{ tokenIdentifier: Bech32mTokenIdentifier; tokenAmount: bigint; receiverSparkAddress: string; }[]

required

Array of transfer outputs, each containing:

tokenIdentifier: Bech32m token identifier for this output. Outputs may include multiple token identifiers.
tokenAmount: Amount of tokens to send
receiverSparkAddress: Recipient’s Spark address

"SMALL_FIRST" | "LARGE_FIRST"

Strategy for selecting outputs: "SMALL_FIRST" or "LARGE_FIRST" (default: "SMALL_FIRST")

OutputWithPreviousTransactionData[]

Specific outputs to use (overrides selection strategy)

Returns

string

required

The transaction ID of the batch token transfer

Example

const txId = await wallet.batchTransferTokens([
  {
    tokenIdentifier: "btkn1...",
    tokenAmount: 500n,
    receiverSparkAddress: "spark1abc..."
  },
  {
    tokenIdentifier: "btkn1...",
    tokenAmount: 300n,
    receiverSparkAddress: "spark1def..."
  }
]);
console.log("Batch transfer completed:", txId);

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

batchTransferTokens

Method Signature

Parameters

Returns

Example