Documentation
¶
Index ¶
- func IsBootstrapped(db *badger.DB) (bool, error)
- type Config
- type EpochQuery
- type FollowerState
- type MutableState
- type Params
- type Snapshot
- func (s *Snapshot) Commit() (flow.StateCommitment, 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) Pending() ([]flow.Identifier, error)
- func (s *Snapshot) Phase() (flow.EpochPhase, error)
- func (s *Snapshot) QuorumCertificate() (*flow.QuorumCertificate, error)
- func (s *Snapshot) SealedResult() (*flow.ExecutionResult, *flow.Seal, error)
- func (s *Snapshot) SealingSegment() ([]*flow.Block, error)
- func (s *Snapshot) Seed(indices ...uint32) ([]byte, error)
- type State
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsBootstrapped ¶ added in v0.14.0
IsBootstrapped returns whether or not the database contains a bootstrapped state
Types ¶
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
func DefaultConfig ¶
func DefaultConfig() Config
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 ¶ added in v0.13.0
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 FollowerState ¶ added in v0.14.0
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. Consequently, a block B should only be considered valid, if a child block with a valid header is known. The child block's header includes quorum certificate, which proves that a supermajority of consensus nodes consider block B a valid. 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 ¶ added in v0.14.0
func NewFollowerState( state *State, index storage.Index, payloads storage.Payloads, tracer module.Tracer, consumer protocol.Consumer, ) (*FollowerState, error)
NewFollowerState initializes a light-weight version of a mutable protocol state. This implementation is suitable only for NON-Consensus nodes.
func (*FollowerState) Extend ¶ added in v0.14.0
func (m *FollowerState) Extend(candidate *flow.Block) error
Implementation of header extending for FollowerState, checks header validity with data what is available.
func (*FollowerState) Finalize ¶ added in v0.14.0
func (m *FollowerState) Finalize(blockID flow.Identifier) error
func (*FollowerState) MarkValid ¶ added in v0.14.0
func (m *FollowerState) MarkValid(blockID flow.Identifier) error
MarkValid marks the block as valid in protocol state, and triggers `BlockProcessable` event to notify that its parent block is processable. why the parent block is processable, not the block itself? because a block having a child block means it has been verified by the majority of consensus participants. Hence, if a block has passed the header validity check, its parent block must have passed both the header validity check and the body validity check. So that consensus followers can skip the block body validity checks and wait for its child to arrive, and if the child passes the header validity check, it means the consensus participants have done a complete check on its parent block, so consensus followers can trust consensus nodes did the right job, and start processing the parent block. NOTE: since a parent can have multiple children, `BlockProcessable` event could be triggered multiple times for the same block. NOTE: BlockProcessable should not be blocking, otherwise, it will block the follower
type MutableState ¶ added in v0.14.0
type MutableState struct {
*FollowerState
// contains filtered or unexported fields
}
MutableState implements a mutable protocol state. When extending the state with a new block, it checks the _entire_ block payload.
func NewFullConsensusState ¶ added in v0.14.0
func NewFullConsensusState( state *State, index storage.Index, payloads storage.Payloads, tracer module.Tracer, consumer protocol.Consumer, receiptValidator module.ReceiptValidator, sealValidator module.SealValidator, ) (*MutableState, 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.
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 pending children. A block snapshot can lazily convert to an epoch snapshot in order to make data associated directly with epochs accessible through its API.
func NewSnapshot ¶
func NewSnapshot(state *State, blockID flow.Identifier) *Snapshot
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) Epochs ¶
func (s *Snapshot) Epochs() protocol.EpochQuery
func (*Snapshot) Identities ¶
func (s *Snapshot) Identities(selector flow.IdentityFilter) (flow.IdentityList, error)
func (*Snapshot) QuorumCertificate ¶ added in v0.15.0
func (s *Snapshot) QuorumCertificate() (*flow.QuorumCertificate, error)
QuorumCertificate (QC) returns a valid quorum certificate pointing to the header at this snapshot. With the exception of the root block, a valid child block must be which contains the desired QC. The sentinel error state.NoValidChildBlockError is returned if the the QC is unknown.
For root block snapshots, returns the root quorum certificate. For all other blocks, generates a quorum certificate from a valid child, if one exists.
func (*Snapshot) SealedResult ¶ added in v0.15.0
func (*Snapshot) SealingSegment ¶ added in v0.15.0
type State ¶
type State struct {
// contains filtered or unexported fields
}
func Bootstrap ¶ added in v0.14.0
func Bootstrap( metrics module.ComplianceMetrics, db *badger.DB, headers storage.Headers, seals storage.Seals, results storage.ExecutionResults, blocks storage.Blocks, setups storage.EpochSetups, commits storage.EpochCommits, statuses storage.EpochStatuses, root protocol.Snapshot, ) (*State, error)
func OpenState ¶ added in v0.14.0
func OpenState( metrics module.ComplianceMetrics, db *badger.DB, headers storage.Headers, seals storage.Seals, results storage.ExecutionResults, blocks storage.Blocks, setups storage.EpochSetups, commits storage.EpochCommits, statuses storage.EpochStatuses, ) (*State, error)
Source Files