Class UpdateConsensusNodeExtensions

Extension methods for updating consensus nodes in the network address book.

Inheritance

object

UpdateConsensusNodeExtensions

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 UpdateConsensusNodeExtensions

Methods

UpdateConsensusNodeAsync(ConsensusClient, UpdateConsensusNodeParams, Action<IConsensusContext>?)

Updates an existing consensus node in the network address book.

Declaration

public static Task<TransactionReceipt> UpdateConsensusNodeAsync(this ConsensusClient client, UpdateConsensusNodeParams updateParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the request.
UpdateConsensusNodeParams	updateParams	The parameters specifying the node to update and the properties to change.
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.

Remarks

Only the properties set on updateParams will be changed. This transaction must be signed by the node's current admin key. Changes take effect at the next network upgrade.

Examples

// 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}");

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.