Class AbortNetworkUpgradeExtensions

Extension methods for aborting a scheduled network upgrade.

Inheritance

object

AbortNetworkUpgradeExtensions

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 AbortNetworkUpgradeExtensions

Methods

AbortNetworkUpgradeAsync(ConsensusClient, AbortNetworkUpgradeParams, Action<IConsensusContext>?)

Aborts any scheduled network upgrade operation.

Declaration

public static Task<TransactionReceipt> AbortNetworkUpgradeAsync(this ConsensusClient client, AbortNetworkUpgradeParams abortParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the administrative command.
AbortNetworkUpgradeParams	abortParams	The parameters for aborting the scheduled 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 transaction receipt indicating success.

Remarks

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

Examples

// Cancel a currently-prepared or scheduled upgrade. No-op if there
// is no pending upgrade. The superuser key must sign.
var receipt = await client.AbortNetworkUpgradeAsync(new AbortNetworkUpgradeParams());
Console.WriteLine($"Abort 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.