Class DeleteTokenExtensions

Extension methods for deleting a token from the network.

Inheritance

object

DeleteTokenExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public static class DeleteTokenExtensions

Methods

DeleteTokenAsync(ConsensusClient, DeleteTokenParams, Action<IConsensusContext>?)

Deletes a token instance from the network. Must be signed by the admin key.

Declaration

public static Task<TransactionReceipt> DeleteTokenAsync(this ConsensusClient client, DeleteTokenParams deleteParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the deletion.
DeleteTokenParams	deleteParams	The details identifying the token to delete.
Action<IConsensusContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Examples

// Permanently delete a token. Circulation stays in the treasury but
// no further operations are possible. Requires Administrator to sign.
// Immutable tokens cannot be deleted.
var receipt = await client.DeleteTokenAsync(token);
Console.WriteLine($"Delete status: {receipt.Status}");

Exceptions

Type	Condition
ArgumentException	If required arguments are missing or invalid.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node refused the transaction. Only a code about the transaction itself proves it did not execute; any other code leaves the outcome unknown, so settle it by its transaction id on a mirror node rather than resubmitting it (see PrecheckException).
ConsensusException	If the outcome could not be confirmed: the transaction may have executed, so settle it by its transaction id on a mirror node rather than resubmitting it.
TransactionException	If the network rejected the request as invalid or had missing data.

DeleteTokenAsync(ConsensusClient, EntityId, Action<IConsensusContext>?)

Deletes a token instance from the network. Must be signed by the admin key.

Declaration

public static Task<TransactionReceipt> DeleteTokenAsync(this ConsensusClient client, EntityId token, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the deletion.
EntityId	token	The identifier of the token instance that will be deleted.
Action<IConsensusContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Examples

// Permanently delete a token. Circulation stays in the treasury but
// no further operations are possible. Requires Administrator to sign.
// Immutable tokens cannot be deleted.
var receipt = await client.DeleteTokenAsync(token);
Console.WriteLine($"Delete status: {receipt.Status}");

Exceptions

Type	Condition
ArgumentException	If required arguments are missing or invalid.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node refused the transaction. Only a code about the transaction itself proves it did not execute; any other code leaves the outcome unknown, so settle it by its transaction id on a mirror node rather than resubmitting it (see PrecheckException).
ConsensusException	If the outcome could not be confirmed: the transaction may have executed, so settle it by its transaction id on a mirror node rather than resubmitting it.
TransactionException	If the network rejected the request as invalid or had missing data.