transferTokens

Transfers tokens to another Spark Address via the IssuerSparkWallet.

Method Signature

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

Parameters

Bech32mTokenIdentifier

required

Bech32m token identifier (eg: btkn1…) of the token to transfer

bigint

required

Amount of tokens to transfer

string

required

Recipient’s Spark Address

"SMALL_FIRST" | "LARGE_FIRST"

Strategy for selecting outputs: "SMALL_FIRST" or "LARGE_FIRST" (defaults to "SMALL_FIRST")

OutputWithPreviousTransactionData[]

Specific outputs to use for transfer (overrides selection strategy)

Date

Optional deadline for the transaction. If the transaction is not executed before this time, it will not be processed.

Returns

string

required

Transaction ID

Example

const txId = await issuerWallet.transferTokens({
  tokenIdentifier: "btkn1...",
  tokenAmount: 1000n,
  receiverSparkAddress: "spark1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx"
});

console.log("Tokens transferred:", txId);

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

transferTokens

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example