Skip to main content
Gets the token distribution information for the token associated with this IssuerSparkWallet.
This feature is currently under development and will be available in a future release of Spark.

Method Signature

interface TokenDistribution {
  totalCirculatingSupply: bigint;
  totalIssued: bigint;
  totalBurned: bigint;
  numHoldingAddress: number;
  numConfirmedTransactions: number;
}

async function getIssuerTokenDistribution(): Promise<TokenDistribution>;

Returns

totalCirculatingSupply
bigint
required
Total circulating supply of the token
totalIssued
bigint
required
Total issued tokens
totalBurned
bigint
required
Total tokens burned
numHoldingAddress
number
required
Number of addresses holding the token
numConfirmedTransactions
number
required
Number of confirmed transactions

Example

const distribution = await issuerWallet.getIssuerTokenDistribution();
console.log("Circulating supply:", distribution.totalCirculatingSupply);
console.log("Total issued:", distribution.totalIssued);
console.log("Total burned:", distribution.totalBurned);
console.log("Holding addresses:", distribution.numHoldingAddress);
console.log("Confirmed transactions:", distribution.numConfirmedTransactions);