Class ConfiscateTokenParams

Transaction Parameters for Confiscating/Wiping Tokens from an arbitrary account.

Inheritance

object

TransactionParams

TransactionParams<TokenReceipt>

ConfiscateTokenParams

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

Examples

Forcibly remove tokens from a holder, reducing total circulation:

// Forcibly remove tokens from a holder's balance and send them to
// nowhere (reduces total circulation). Requires the ConfiscateEndorsement.
var receipt = await client.ConfiscateTokenAsync(token, holder, amount);
Console.WriteLine($"Confiscate status: {receipt.Status}");
Console.WriteLine($"Remaining circulation: {receipt.Circulation}");

Properties

Amount

The Amount of fungible tokens to confiscate and remove from circulation, specified in the smallest denomination.

Declaration

public ulong Amount { get; set; }

Property Value

Type	Description
ulong

CancellationToken

Optional cancellation token. Cancelling stops the client waiting; it cannot recall a transaction already sent. Cancelled after the send, the outcome is unknown: settle it by its transaction id on a mirror node rather than resubmitting it.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Holder

The identifier of the account holding the tokens to confiscate (wipe).

Declaration

public EntityId Holder { get; set; }

Property Value

Type	Description
EntityId

Signatory

Additional private key, keys or signing callback method required to authorize the confiscation. Typically matches the Endorsement assigned to the wipe 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 confiscate the tokens.

Token

The identifier of the fungible token to confiscate (wipe) and remove from circulation.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId