Class DeleteAccountExtensions

Extension methods for deleting cryptocurrency accounts.

Inheritance

object

DeleteAccountExtensions

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 DeleteAccountExtensions

Methods

DeleteAccountAsync(ConsensusClient, DeleteAccountParams, Action<IConsensusContext>?)

Deletes an account from the network returning the remaining crypto balance to the specified account. Must be signed by the account being deleted.

Declaration

public static Task<TransactionReceipt> DeleteAccountAsync(this ConsensusClient client, DeleteAccountParams deleteAccountParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the delete.
DeleteAccountParams	deleteAccountParams	The account deletion parameters.
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

// Delete an account and sweep its remaining HBAR to `fundsReceiver`.
// The account being deleted must sign the transaction; supply its
// key via Signatory if it is not already in the context.
var receipt = await client.DeleteAccountAsync(new DeleteAccountParams
{
    Account = accountToDelete,
    FundsReceiver = fundsReceiver,
    Signatory = accountSignatory
});
Console.WriteLine($"Delete status: {receipt.Status}");

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the delete request as invalid or had missing data.