Class BurnNftParams

Transaction Parameters for Burning One or More NFT instances.

Inheritance

object

TransactionParams

TransactionParams<TokenReceipt>

BurnNftParams

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 BurnNftParams : TransactionParams<TokenReceipt>

Examples

Burn several NFTs from the same collection in a single transaction. The NFTs must currently be held by the treasury account:

// Burn several NFTs from the same collection in one transaction. Pass
// the serial numbers directly; the collection Id is supplied once.
var receipt = await client.BurnNftsAsync(new BurnNftParams
{
    Token = nftCollection,
    SerialNumbers = new long[] { 1, 2, 3 }
});
Console.WriteLine($"Burn status: {receipt.Status}");
Console.WriteLine($"Remaining circulation: {receipt.Circulation}");

Properties

CancellationToken

Optional Cancellation token that can interrupt the token submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

SerialNumbers

The Serial Numbers of the NFTs to burn.

Declaration

public IReadOnlyList<long> SerialNumbers { get; set; }

Property Value

Type	Description
IReadOnlyList<long>

Signatory

Additional private key, keys or signing callback method required to authorize the burn. Typically matches the supply key endorsement assigned to the token.

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 burn the NFT.

Token

The Token ID of the NFT to burn.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId