Class DeleteConsensusNodeParams

Transaction Parameters for deleting a consensus node from the network address book.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

DeleteConsensusNodeParams

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

Remarks

This is a privileged transaction: it must be signed by the node's admin key or by the treasury (0.0.2), system admin (0.0.50) or address book admin (0.0.55) key. The node enters a "pending delete" state immediately, but is fully removed from the network at the next upgrade (freeze with PREPARE_UPGRADE). Node identifiers are never reused after deletion.

Examples

Retire a node by NodeId. The node is removed from the network at the next freeze with PREPARE_UPGRADE:

// Delete a node from the address book. Effective at the next network
// stake-weight rebalance. The node's AdminKey must sign.
var receipt = await client.DeleteConsensusNodeAsync(nodeId);
Console.WriteLine($"Delete status: {receipt.Status}");

Properties

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?

NodeId

The identifier of the node to delete. This field is REQUIRED. The identified node must exist and must not already be deleted.

Declaration

public ulong NodeId { get; set; }

Property Value

Type	Description
ulong

Signatory

Additional private key, keys or signing callback method required to authorize this transaction. Must include the node's admin key or the treasury (0.0.2), system admin (0.0.50) or address book admin (0.0.55) key.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory