Class RelinquishTokensParams

Transaction Parameters for relinquishing one or more tokens, returning their full balance (or specific NFT instances) to the token treasury.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

RelinquishTokensParams

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 RelinquishTokensParams : TransactionParams<TransactionReceipt>

Examples

Surrender several fungible tokens and an NFT back to their treasuries in one transaction:

// Surrender several tokens and NFTs in a single transaction. Any
// mix of Tokens[] and Nfts[] is allowed.
var receipt = await client.RelinquishAsync(new RelinquishTokensParams
{
    Tokens = new[] { token1, token2 },
    Nfts = new[] { nft1 }
});
Console.WriteLine($"Relinquish status: {receipt.Status}");

Properties

CancellationToken

Optional cancellation token to interrupt the submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Nfts

Specific NFT instances to reject. Each NFT will be returned to the token treasury.

Declaration

public IEnumerable<Nft>? Nfts { get; set; }

Property Value

Type	Description
IEnumerable<Nft>

Owner

Optional account holding the tokens to relinquish. If not set, the transaction payer is treated as the token owner. If set, this account must sign the transaction.

Declaration

public EntityId? Owner { get; set; }

Property Value

Type	Description
EntityId

Signatory

Additional private key, keys or signing callback method required to authorize the relinquishment. Typically matches the endorsement assigned to the owner account if it is not already 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.

Tokens

Fungible token types to relinquish. The full balance of each token will be returned to the token treasury.

Declaration

public IEnumerable<EntityId>? Tokens { get; set; }

Property Value

Type	Description
IEnumerable<EntityId>