package
0.38.0-preview.0
Repository: https://github.com/onflow/flow-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

CheckNodeStatusAt returns whether the node with the given ID is a valid identity at the given state snapshot, and satisfies all checks.
DefaultEpochSafetyParams returns the default epoch safety parameters for each chain ID.
DKGPhaseViews returns the DKG final phase views for an epoch.
FindGuarantors decodes the signer indices from the guarantee, and finds the guarantor identifiers from protocol state Expected Error returns during normal operations: - signature.InvalidSignerIndicesError if `signerIndices` does not encode a valid set of collection guarantors - state.ErrUnknownSnapshotReference if guarantee references an unknown block - protocol.ErrNextEpochNotCommitted if epoch has not been committed yet - protocol.ErrClusterNotFound if cluster is not found by the given chainID.
GetDKGParticipantKeys retrieves the canonically ordered list of DKG participant keys from the DKG.
No description provided by the author
No description provided by the author
No description provided by the author
IsNodeAuthorizedAt returns whether the node with the given ID is a valid un-ejected network participant as of the given state snapshot.
IsNodeAuthorizedWithRoleAt returns whether the node with the given ID is a valid un-ejected network participant with the specified role as of the given state snapshot.
IsSporkRootSnapshot returns whether the given snapshot is the state snapshot representing the initial state for a spork.
IsUnfinalizedSealingSegmentError returns true if err is of type UnfinalizedSealingSegmentError.
IsValidEpochCommit checks whether an epoch commit service event is intrinsically valid.
IsValidEpochSetup checks whether an `EpochSetup` event is syntactically correct.
IsValidExtendingEpochCommit checks whether an EpochCommit service event being added to the state is valid.
IsValidExtendingEpochSetup checks whether an EpochSetup service event being added to the state is valid.
No description provided by the author
NewInvalidServiceEventErrorf returns an invalid service event error.
No description provided by the author
OrderedSeals returns the seals in the input payload in ascending height order.
PreviousEpochExists returns whether the previous epoch exists w.r.t.
ToEpochCommit converts an Epoch interface instance to the underlying concrete epoch commit service event.
ToEpochSetup converts an Epoch interface instance to the underlying concrete epoch setup service event.

# Variables

ErrClusterNotFound is a sentinel error returns for queries for a cluster.
ErrDiscontinuousSeals indicates that an (unordered) slice of seals skips at least one block height.
ErrMultipleSealsForSameHeight indicates that an (unordered) slice of seals contains two or more seals for the same block height (possibilities include duplicated seals or seals for different blocks at the same height).
ErrNextEpochNotCommitted is a sentinel error returned when the next epoch has not been committed and information is queried that is only accessible in the EpochCommitted phase.
ErrNextEpochNotSetup is a sentinel error returned when the next epoch has not been set up yet.
ErrNoPreviousEpoch is a sentinel error returned when a previous epoch is queried from a snapshot within the first epoch after the root block.
ErrSealingSegmentBelowRootBlock is a sentinel error returned for queries for a sealing segment below the root block (local history cutoff).
ErrUnknownEpochBoundary is a sentinel returned when a query is made for an epoch boundary which is unknown to this node.

# Structs

No description provided by the author
No description provided by the author
InvalidServiceEventError indicates an invalid service event was processed.
SafetyParams contains the safety parameters for the protocol related to the epochs.
UnfinalizedSealingSegmentError indicates that including unfinalized blocks in the sealing segment is illegal.
ViewBasedActivator allows setting value that will be active from specific view.

# Interfaces

BlockTimer constructs and validates block timestamps.
Cluster represents the detailed information for a particular cluster, for a given epoch.
Consumer defines a set of events that occur within the protocol state, that can be propagated to other components via an implementation of this interface.
DKG represents the result of running the distributed key generation procedure for the random beacon.
Epoch contains the information specific to a certain Epoch (defined by the epoch Counter).
EpochProtocolState represents the subset of the Protocol State KVStore related to epochs: the Identity Table, DKG, cluster assignment, etc.
EpochQuery defines the different ways to query for epoch information given a Snapshot.
FollowerState is a mutable protocol state used by nodes following main consensus (ie.
GlobalParams represents protocol state parameters that do not vary between instances.
InstanceParams represents protocol state parameters that vary between instances.
KVStoreReader is the latest read-only interface to the Protocol State key-value store at a particular block.
MutableProtocolState is the read-write interface for protocol state.
Params are parameters of the protocol state, divided into parameters of this specific instance of the state (varies from node to node) and global parameters of the state.
ParticipantState is a mutable protocol state used by active consensus participants (consensus nodes).
ProtocolState is the read-only interface for protocol state.
Snapshot represents an immutable snapshot of the protocol state at a specific block, denoted as the Head block.
State represents the full protocol state of the local node.
VersionedEncodable defines the interface for a versioned key-value store independent of the set of keys which are supported.