Skip to main content
Transfers tokens to another SparkWallet.

Method Signature

async transferTokens({
  tokenIdentifier,
  tokenAmount,
  receiverSparkAddress,
  selectedOutputs,
}: {
  tokenIdentifier: string;
  tokenAmount: bigint;
  receiverSparkAddress: string;
  selectedOutputs?: OutputWithPreviousTransactionData[];
}): Promise<string>

Parameters

tokenIdentifier
string
required
The Bech32m token identifier (eg: btkn1…) of the token to transfer
tokenAmount
bigint
required
The amount of tokens to transfer
receiverSparkAddress
string
required
The recipient’s Spark Address
selectedOutputs
OutputWithPreviousTransactionData[]
Specific outputs to use for the transfer

Returns

txId
string
required
The transaction ID of the token transfer

Example

const txId = await wallet.transferTokens({
  tokenIdentifier: "btkn1...",
  tokenAmount: 1000n,
  receiverSparkAddress: "spark:recipient-address"
});
console.log("Token transfer completed:", txId);