Tokens

Burn tokens

Burning is a transfer to a destination nobody controls. The SDK defaults that destination to the Hive account null.

Usage

TypeScript

await hive.issuer.token.burn({
  from: hive.accounts.treasury,
  symbol: "MYTOKEN",
  quantity: "10.000",
  // account: "null" by default
});

await hive.keychainIssuer.token.burn({
  username: "alice",
  symbol: "MYTOKEN",
  quantity: "10.000",
});

Important

Burned supply cannot be recovered.

Parameters

Parameter	Type	Required	Description
from / username	AccountRef \| string	Yes	Signing account.
symbol	string	Yes	Token symbol being burned.
quantity	string	Yes	Decimal string amount.
account	string	No	Optional burn destination, default "null".
memo	string	No	Optional memo.