Class BurnTokenParams

Transaction Parameters for Burning Tokens from the treasury account.

Inheritance

object

TransactionParams

TransactionParams<TokenReceipt>

BurnTokenParams

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public sealed class BurnTokenParams : TransactionParams<TokenReceipt>

Examples

Burn units of a fungible token from its treasury, reducing circulation. Requires the supply key to sign:

// Burn 250,000 tokens from the treasury account. Like minting, burning
// requires the supply key signature. The method name is plural:
// BurnTokensAsync (not BurnTokenAsync).
var receipt = await client.BurnTokensAsync(token, 250_000);
Console.WriteLine($"Burn status: {receipt.Status}");
Console.WriteLine($"New circulation: {receipt.Circulation}");

Properties

Amount

The Amount of fungible tokens to burn, specified in the smallest denomination.

Declaration

public ulong Amount { get; set; }

Property Value

Type	Description
ulong

CancellationToken

Optional cancellation token to interrupt the token burn submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Signatory

Additional private key, keys or signing callback method required to authorize the transfers. Typically matches the Endorsement assigned to the supply key for the token if it is not already set as the payer for the transaction.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory

Remarks

Keys/callbacks added here will be combined with those already identified in the client object's context when signing this transaction to change the state of this account.

Token

The identifier of the fungible token to burn.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId