Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spark.money/llms.txt

Use this file to discover all available pages before exploring further.

Creates a new token on Spark using Spark Native Tokens for the IssuerSparkWallet.

​
Method Signature

// Returns transaction hash only
async createToken({
  tokenName,
  tokenTicker,
  decimals,
  maxSupply,
  isFreezable,
  extraMetadata,
  returnIdentifierForCreate,
}: {
  tokenName: string;
  tokenTicker: string;
  decimals: number;
  maxSupply?: bigint;        // defaults to 0n (unlimited)
  isFreezable: boolean;
  extraMetadata?: Uint8Array;
  returnIdentifierForCreate?: false;
}): Promise<string>

// Returns both transaction hash and token identifier
async createToken({
  tokenName,
  tokenTicker,
  decimals,
  maxSupply,
  isFreezable,
  extraMetadata,
  returnIdentifierForCreate,
}: {
  tokenName: string;
  tokenTicker: string;
  decimals: number;
  maxSupply?: bigint;        // defaults to 0n (unlimited)
  isFreezable: boolean;
  extraMetadata?: Uint8Array;
  returnIdentifierForCreate: true;
}): Promise<TokenCreationDetails>

​
Parameters

​
tokenName
string
required
Name of the token (eg: SparkCoin)
​
tokenTicker
string
required
Token ticker (eg: SPARKC)
​
decimals
number
required
The precision the token supports (eg: 8 for BTC)
​
maxSupply
bigint
The maximum supply for this token (defaults to 0n for unlimited supply)
​
isFreezable
boolean
required
Whether or not the Issuer can freeze this token
​
extraMetadata
Uint8Array
Optional extra metadata bytes to associate with the token (e.g., image data, JSON metadata)
​
returnIdentifierForCreate
boolean
When true, returns both the transaction hash and token identifier as TokenCreationDetails. When false or omitted, returns only the transaction hash as a string (default: false)

​
Returns

When returnIdentifierForCreate is false or omitted:
​
txId
string
required
Spark Transaction ID
When returnIdentifierForCreate is true:
​
result
TokenCreationDetails
required
Object containing:
  • tokenIdentifier: Bech32m token identifier (e.g., btkn1...)
  • transactionHash: Spark Transaction ID

​
Example

// Basic usage - returns only transaction hash
const txId = await issuerWallet.createToken({
  tokenName: "SparkCoin",
  tokenTicker: "SPARKC",
  decimals: 8,
  maxSupply: 1000000n,
  isFreezable: true,
  // Optional: add extra metadata
  extraMetadata: new TextEncoder().encode(JSON.stringify({ icon: "..." }))
});

console.log("Token created:", txId);

// Get both transaction hash and token identifier
const result = await issuerWallet.createToken({
  tokenName: "SparkCoin",
  tokenTicker: "SPARKC",
  decimals: 8,
  maxSupply: 1000000n,
  isFreezable: true,
  returnIdentifierForCreate: true
});

console.log("Token created:", result.transactionHash);
console.log("Token identifier:", result.tokenIdentifier);