Class ConfiscateNftParams

Removes the holdings of given asset from the associated account and destroys them. Must be signed by the confiscate/wipe admin key.

Inheritance

object

TransactionParams

TransactionParams<TokenReceipt>

ConfiscateNftParams

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

Examples

Forcibly reclaim multiple NFTs from a holder in one transaction:

// Confiscate several NFTs from the same collection and holder in one
// transaction. Method name becomes plural (ConfiscateNftsAsync) for
// the params-object form.
var receipt = await client.ConfiscateNftsAsync(new ConfiscateNftParams
{
    Token = collection,
    Account = account,
    SerialNumbers = new long[] { 1, 2, 3 }
});
Console.WriteLine($"Confiscate status: {receipt.Status}");

Properties

Account

The Holder Holding the NFT(s) to confiscate and destroy.

Declaration

public EntityId Account { get; set; }

Property Value

Type	Description
EntityId

CancellationToken

Optional Cancellation token to interrupt the transaction submission process if needed.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

SerialNumbers

The Serial Numbers of the NFTs to confiscate and destroy.

Declaration

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

Property Value

Type	Description
IReadOnlyList<long>

Signatory

Optional Additional private key, keys or signing callback method required to authorize the confiscation/wipe. Useful when the wipe key is not the same as the payer key.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory

Token

The Token ID of the NFT(s) to confiscate and destroy.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId