package
0.2501.0
Repository: https://github.com/oasisprotocol/oasis-core.git
Documentation: pkg.go.dev

# Constants

InvalidUpgradeHeight means the upgrade epoch hasn't been reached yet.
LatestDescriptorVersion is the latest upgrade descriptor version that should be used for descriptors.
LatestPendingUpgradeVersion is the latest pending upgrade struct version.
LogEventConsensusUpgrade is a log event value that signals the consensus upgrade handler was called.
LogEventIncompatibleBinary is a log event value that signals the currently running version of the binary is incompatible with the upgrade.
LogEventStartupUpgrade is a log event value that signals the startup upgrade handler was called.
MaxDescriptorVersion is the maximum descriptor version that is allowed.
MaxUpgradeEpoch is the maximum upgrade epoch.
MaxUpgradeHandlerLength is the maximum length of upgrade handler's name.
MinDescriptorVersion is the minimum descriptor version that is allowed.
MinUpgradeEpoch is the minimum upgrade epoch.
MinUpgradeHandlerLength is the minimum length of upgrade handler's name.
ModuleName is the upgrade module name.
UpgradeStageConsensus is the upgrade stage carried out during consensus events.
UpgradeStageStartup is the startup upgrade stage, executed at the beginning of node startup.

# Variables

ErrAlreadyPending is the error returned from SubmitDescriptor when the specific upgrade is already pending.
ErrBadDescriptor is the error returned when the provided descriptor is bad.
ErrStopForUpgrade is the error returned by the consensus upgrade function when it detects that the consensus layer has reached the scheduled shutdown epoch and should be interrupted.
ErrUpgradeInProgress is the error returned from CancelUpgrade when the upgrade being cancelled is already in progress.
ErrUpgradeNotFound is the error returned when the upgrade in question cannot be found.

# Structs

Descriptor describes an upgrade.
PendingUpgrade describes a currently pending upgrade and includes the submitted upgrade descriptor.

# Interfaces

Backend defines the interface for upgrade managers.

# Type aliases

HandlerName is the name of the upgrade descriptor handler.
UpgradeStage is used in the upgrade descriptor to store completed stages.