Class UpdateConsensusNodeParams

Transaction Parameters for updating an existing consensus node in the network address book.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

UpdateConsensusNodeParams

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

Remarks

Any property left as null will remain unchanged on the node. This transaction must be signed by the node's current admin_key. Changes take effect at the next network upgrade (freeze with PREPARE_UPGRADE).

Examples

Rotate a node's description and opt out of rewards. Target by NodeId (ulong, assigned by AddConsensusNodeAsync), not EntityId:

// Update mutable fields on an existing consensus node. Null fields
// are preserved. The node's AdminKey (set at add time) must sign.
// Note: the target is identified by NodeId (ulong), not EntityId.
var receipt = await client.UpdateConsensusNodeAsync(new UpdateConsensusNodeParams
{
    NodeId = nodeId,
    Description = "Renamed operator",
    DeclineReward = true
});
Console.WriteLine($"Update status: {receipt.Status}");

Properties

Account

If set, replaces the node's associated account identifier. Both the current and new account keys must sign this transaction.

Declaration

public EntityId? Account { get; set; }

Property Value

Type	Description
EntityId

AdminKey

If set, replaces the node's administrative key. Both the current and new admin keys must sign this transaction.

Declaration

public Endorsement? AdminKey { get; set; }

Property Value

Type	Description
Endorsement

CancellationToken

Optional cancellation token to interrupt the submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

DeclineReward

If set, updates whether the node operator declines to receive node rewards.

Declaration

public bool? DeclineReward { get; set; }

Property Value

Type	Description
bool?

Description

If set, replaces the node's description. Must not exceed 100 bytes when encoded as UTF-8.

Declaration

public string? Description { get; set; }

Property Value

Type	Description
string

GossipCaCertificate

If set, replaces the DER-encoded gossip CA certificate.

Declaration

public ReadOnlyMemory<byte>? GossipCaCertificate { get; set; }

Property Value

Type	Description
ReadOnlyMemory<byte>?

GossipEndpoints

If set, replaces the entire list of gossip endpoints. Must contain between 1 and 10 entries.

Declaration

public IEnumerable<Uri>? GossipEndpoints { get; set; }

Property Value

Type	Description
IEnumerable<Uri>

GrpcCertificateHash

If set, replaces the SHA-384 hash of the node's gRPC TLS certificate.

Declaration

public ReadOnlyMemory<byte>? GrpcCertificateHash { get; set; }

Property Value

Type	Description
ReadOnlyMemory<byte>?

GrpcProxyEndpoint

If set, replaces the gRPC-Web proxy endpoint for non-gRPC clients.

Declaration

public Uri? GrpcProxyEndpoint { get; set; }

Property Value

Type	Description
Uri

NodeId

The identifier of the node to update. This field is REQUIRED.

Declaration

public ulong NodeId { get; set; }

Property Value

Type	Description
ulong

ServiceEndpoints

If set, replaces the entire list of gRPC service endpoints. Must contain between 1 and 8 entries.

Declaration

public IEnumerable<Uri>? ServiceEndpoints { get; set; }

Property Value

Type	Description
IEnumerable<Uri>

Signatory

Additional private key, keys or signing callback method required to authorize this transaction. Must include the current node admin key.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory