Class ScheduleNetworkUpgradeExtensions

Extension methods for scheduling a network upgrade.

Inheritance

object

ScheduleNetworkUpgradeExtensions

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 ScheduleNetworkUpgradeExtensions

Methods

ScheduleNetworkUpgradeAsync(ConsensusClient, ScheduleNetworkUpgradeParams, Action<IConsensusContext>?)

Executes a previously "prepared" upgrade file at the specified consensus time across the entire network. This act will suspend network services for the duration of the upgrade.

Declaration

public static Task<TransactionReceipt> ScheduleNetworkUpgradeAsync(this ConsensusClient client, ScheduleNetworkUpgradeParams scheduleParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the administrative command.
ScheduleNetworkUpgradeParams	scheduleParams	The parameters for scheduling the network upgrade.
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 TransactionId Receipt indicating success.

Remarks

This operation must be submitted by a privileged account having access rights to perform this operation.

Examples

// After a successful PrepareNetworkUpgrade, commit to a consensus
// timestamp when nodes will bounce and load the new image.
var receipt = await client.ScheduleNetworkUpgradeAsync(new ScheduleNetworkUpgradeParams
{
    Consensus = new ConsensusTimeStamp(DateTime.UtcNow.AddHours(2))
});
Console.WriteLine($"Schedule 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.