Documentation
¶
Index ¶
- func IsBootstrapped(db *pebble.DB) (bool, error)
- func IsValidRootSnapshot(snap protocol.Snapshot, verifyResultID bool) error
- func IsValidRootSnapshotQCs(snap protocol.Snapshot) error
- func SkipNetworkAddressValidation(conf *BootstrapConfig)
- func ValidRootSnapshotContainsEntityExpiryRange(snapshot protocol.Snapshot) error
- type BootstrapConfig
- type BootstrapConfigOptions
- type EpochQuery
- type FinalizedSnapshot
- type FollowerState
- type Params
- func (p Params) ChainID() (flow.ChainID, error)
- func (p Params) EpochCommitSafetyThreshold() (uint64, error)
- func (p Params) EpochFallbackTriggered() (bool, error)
- func (p Params) FinalizedRoot() (*flow.Header, error)
- func (p Params) ProtocolVersion() (uint, error)
- func (p Params) Seal() (*flow.Seal, error)
- func (p Params) SealedRoot() (*flow.Header, error)
- func (p Params) SporkID() (flow.Identifier, error)
- func (p Params) SporkRootBlockHeight() (uint64, error)
- type ParticipantState
- type Snapshot
- func (s *Snapshot) Commit() (flow.StateCommitment, error)
- func (s *Snapshot) Descendants() ([]flow.Identifier, error)
- func (s *Snapshot) Epochs() protocol.EpochQuery
- func (s *Snapshot) Head() (*flow.Header, error)
- func (s *Snapshot) Identities(selector flow.IdentityFilter) (flow.IdentityList, error)
- func (s *Snapshot) Identity(nodeID flow.Identifier) (*flow.Identity, error)
- func (s *Snapshot) Params() protocol.GlobalParams
- func (s *Snapshot) Phase() (flow.EpochPhase, error)
- func (s *Snapshot) QuorumCertificate() (*flow.QuorumCertificate, error)
- func (s *Snapshot) RandomSource() ([]byte, error)
- func (s *Snapshot) SealedResult() (*flow.ExecutionResult, *flow.Seal, error)
- func (s *Snapshot) SealingSegment() (*flow.SealingSegment, error)
- func (s *Snapshot) VersionBeacon() (*flow.SealedVersionBeacon, error)
- type State
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsBootstrapped ¶
IsBootstrapped returns whether the database contains a bootstrapped state
func IsValidRootSnapshot ¶
IsValidRootSnapshot checks internal consistency of root state snapshot if verifyResultID allows/disallows Result ID verification
func IsValidRootSnapshotQCs ¶
IsValidRootSnapshotQCs checks internal consistency of QCs that are included in the root state snapshot It verifies QCs for main consensus and for each collection cluster.
func SkipNetworkAddressValidation ¶
func SkipNetworkAddressValidation(conf *BootstrapConfig)
func ValidRootSnapshotContainsEntityExpiryRange ¶
ValidRootSnapshotContainsEntityExpiryRange performs a sanity check to make sure the root snapshot has enough history to encompass at least one full entity expiry window. Entities (in particular transactions and collections) may reference a block within the past `flow.DefaultTransactionExpiry` blocks, so a new node must begin with at least this many blocks worth of history leading up to the snapshot's root block.
Currently, Access Nodes and Consensus Nodes require root snapshots passing this validator function.
- Consensus Nodes because they process guarantees referencing past blocks
- Access Nodes because they index transactions referencing past blocks
One of the following conditions must be satisfied to pass this validation:
- This is a snapshot build from a first block of spork -> there is no earlier history which transactions/collections could reference
- This snapshot sealing segment contains at least one expiry window of blocks -> all possible reference blocks in future transactions/collections will be within the initial history.
- This snapshot sealing segment includes the spork root block -> there is no earlier history which transactions/collections could reference
Types ¶
type BootstrapConfig ¶
type BootstrapConfig struct { // SkipNetworkAddressValidation flags allows skipping all the network address related // validations not needed for an unstaked node SkipNetworkAddressValidation bool }
type BootstrapConfigOptions ¶
type BootstrapConfigOptions func(conf *BootstrapConfig)
type EpochQuery ¶
type EpochQuery struct {
// contains filtered or unexported fields
}
EpochQuery encapsulates querying epochs w.r.t. a snapshot.
func (*EpochQuery) Current ¶
func (q *EpochQuery) Current() protocol.Epoch
Current returns the current epoch.
func (*EpochQuery) Next ¶
func (q *EpochQuery) Next() protocol.Epoch
Next returns the next epoch, if it is available.
func (*EpochQuery) Previous ¶
func (q *EpochQuery) Previous() protocol.Epoch
Previous returns the previous epoch. During the first epoch after the root block, this returns a sentinel error (since there is no previous epoch). For all other epochs, returns the previous epoch.
type FinalizedSnapshot ¶
type FinalizedSnapshot struct { Snapshot // contains filtered or unexported fields }
FinalizedSnapshot represents a read-only immutable snapshot of the protocol state at a finalized block. It is guaranteed to have a header available.
func NewFinalizedSnapshot ¶
func NewFinalizedSnapshot(state *State, blockID flow.Identifier, header *flow.Header) *FinalizedSnapshot
NewFinalizedSnapshot instantiates a `FinalizedSnapshot`. CAUTION: the header's ID _must_ match `blockID` (not checked)
type FollowerState ¶
type FollowerState struct { *State // contains filtered or unexported fields }
FollowerState implements a lighter version of a mutable protocol state. When extending the state, it performs hardly any checks on the block payload. Instead, the FollowerState relies on the consensus nodes to run the full payload check and uses quorum certificates to prove validity of block payloads. Consequently, a block B should only be considered valid, if there is a certifying QC for that block QC.View == Block.View && QC.BlockID == Block.ID().
The FollowerState allows non-consensus nodes to execute fork-aware queries against the protocol state, while minimizing the amount of payload checks the non-consensus nodes have to perform.
func NewFollowerState ¶
func NewFollowerState( logger zerolog.Logger, tracer module.Tracer, consumer protocol.Consumer, state *State, index storage.Index, payloads storage.Payloads, blockTimer protocol.BlockTimer, ) (*FollowerState, error)
NewFollowerState initializes a light-weight version of a mutable protocol state. This implementation is suitable only for NON-Consensus nodes.
func (*FollowerState) ExtendCertified ¶
func (m *FollowerState) ExtendCertified(ctx context.Context, candidate *flow.Block, certifyingQC *flow.QuorumCertificate) error
ExtendCertified extends the protocol state of a CONSENSUS FOLLOWER. While it checks the validity of the header; it does _not_ check the validity of the payload. Instead, the consensus follower relies on the consensus participants to validate the full payload. Payload validity can be proved by a valid quorum certificate. Certifying QC must match candidate block:
candidate.View == certifyingQC.View && candidate.ID() == certifyingQC.BlockID
Caution:
- This function expects that `certifyingQC` has been validated.
- The parent block must already be stored.
No errors are expected during normal operations.
func (*FollowerState) Finalize ¶
func (m *FollowerState) Finalize(ctx context.Context, blockID flow.Identifier) error
Finalize marks the specified block as finalized. This method only finalizes one block at a time. Hence, the parent of `blockID` has to be the last finalized block. No errors are expected during normal operations.
type Params ¶
type Params struct {
// contains filtered or unexported fields
}
func (Params) EpochCommitSafetyThreshold ¶
func (Params) EpochFallbackTriggered ¶
func (Params) ProtocolVersion ¶
func (Params) SporkRootBlockHeight ¶
type ParticipantState ¶
type ParticipantState struct { *FollowerState // contains filtered or unexported fields }
ParticipantState implements a mutable state for consensus participant. It can extend the state with a new block, by checking the _entire_ block payload.
func NewFullConsensusState ¶
func NewFullConsensusState( logger zerolog.Logger, tracer module.Tracer, consumer protocol.Consumer, state *State, index storage.Index, payloads storage.Payloads, blockTimer protocol.BlockTimer, receiptValidator module.ReceiptValidator, sealValidator module.SealValidator, ) (*ParticipantState, error)
NewFullConsensusState initializes a new mutable protocol state backed by a badger database. When extending the state with a new block, it checks the _entire_ block payload. Consensus nodes should use the FullConsensusState, while other node roles can use the lighter FollowerState.
func (*ParticipantState) Extend ¶
Extend extends the protocol state of a CONSENSUS PARTICIPANT. It checks the validity of the _entire block_ (header and full payload). Expected errors during normal operations:
- state.OutdatedExtensionError if the candidate block is outdated (e.g. orphaned)
- state.InvalidExtensionError if the candidate block is invalid
type Snapshot ¶
type Snapshot struct {
// contains filtered or unexported fields
}
Snapshot implements the protocol.Snapshot interface. It represents a read-only immutable snapshot of the protocol state at the block it is constructed with. It allows efficient access to data associated directly with blocks at a given state (finalized, sealed), such as the related header, commit, seed or descending blocks. A block snapshot can lazily convert to an epoch snapshot in order to make data associated directly with epochs accessible through its API.
func (*Snapshot) Commit ¶
func (s *Snapshot) Commit() (flow.StateCommitment, error)
Commit retrieves the latest execution state commitment at the current block snapshot. This commitment represents the execution state as currently finalized.
func (*Snapshot) Descendants ¶
func (s *Snapshot) Descendants() ([]flow.Identifier, error)
func (*Snapshot) Epochs ¶
func (s *Snapshot) Epochs() protocol.EpochQuery
func (*Snapshot) Identities ¶
func (s *Snapshot) Identities(selector flow.IdentityFilter) (flow.IdentityList, error)
func (*Snapshot) Params ¶
func (s *Snapshot) Params() protocol.GlobalParams
func (*Snapshot) QuorumCertificate ¶
func (s *Snapshot) QuorumCertificate() (*flow.QuorumCertificate, error)
QuorumCertificate (QC) returns a valid quorum certificate pointing to the header at this snapshot. The sentinel error storage.ErrNotFound is returned if the QC is unknown.
func (*Snapshot) RandomSource ¶
RandomSource returns the seed for the current block's snapshot. Expected error returns: * storage.ErrNotFound is returned if the QC is unknown.
func (*Snapshot) SealedResult ¶
func (*Snapshot) SealingSegment ¶
func (s *Snapshot) SealingSegment() (*flow.SealingSegment, error)
SealingSegment will walk through the chain backward until we reach the block referenced by the latest seal and build a SealingSegment. As we visit each block we check each execution receipt in the block's payload to make sure we have a corresponding execution result, any execution results missing from blocks are stored in the `SealingSegment.ExecutionResults` field. See `model/flow/sealing_segment.md` for detailed technical specification of the Sealing Segment
Expected errors during normal operations:
- protocol.ErrSealingSegmentBelowRootBlock if sealing segment would stretch beyond the node's local history cut-off
- protocol.UnfinalizedSealingSegmentError if sealing segment would contain unfinalized blocks (including orphaned blocks)
func (*Snapshot) VersionBeacon ¶
func (s *Snapshot) VersionBeacon() (*flow.SealedVersionBeacon, error)
type State ¶
type State struct {
// contains filtered or unexported fields
}
func Bootstrap ¶
func Bootstrap( metrics module.ComplianceMetrics, db *pebble.DB, headers storage.Headers, seals storage.Seals, results storage.ExecutionResults, blocks storage.Blocks, qcs storage.QuorumCertificates, setups storage.EpochSetups, commits storage.EpochCommits, statuses storage.EpochStatuses, versionBeacons storage.VersionBeacons, root protocol.Snapshot, options ...BootstrapConfigOptions, ) (*State, error)
func OpenState ¶
func OpenState( metrics module.ComplianceMetrics, db *pebble.DB, headers storage.Headers, seals storage.Seals, results storage.ExecutionResults, blocks storage.Blocks, qcs storage.QuorumCertificates, setups storage.EpochSetups, commits storage.EpochCommits, statuses storage.EpochStatuses, versionBeacons storage.VersionBeacons, ) (*State, error)
func (*State) AtBlockID ¶
func (state *State) AtBlockID(blockID flow.Identifier) protocol.Snapshot
AtBlockID returns a snapshot for the block with the given ID. The block may be finalized or un-finalized. This function may return an invalid.Snapshot with:
- state.ErrUnknownSnapshotReference: -> if no block with the given ID exists in the state
- exception for critical unexpected storage errors
func (*State) AtHeight ¶
AtHeight returns a snapshot for the finalized block at the given height. This function may return an invalid.Snapshot with:
- state.ErrUnknownSnapshotReference: -> if no block with the given height has been finalized, even if it is incorporated -> if the given height is below the root height
- exception for critical unexpected storage errors