Documentation ¶
Index ¶
- type Cluster
- type DKG
- type EncodableCluster
- type EncodableDKG
- type EncodableEpoch
- type EncodableEpochs
- type EncodableSnapshot
- type Epoch
- func (e Epoch) Cluster(i uint) (protocol.Cluster, error)
- func (e Epoch) Clustering() (flow.ClusterList, error)
- func (e Epoch) Counter() (uint64, error)
- func (e Epoch) DKG() (protocol.DKG, error)
- func (e Epoch) FinalView() (uint64, error)
- func (e Epoch) FirstView() (uint64, error)
- func (e Epoch) InitialIdentities() (flow.IdentityList, error)
- func (e Epoch) RandomSource() ([]byte, error)
- func (e Epoch) Seed(indices ...uint32) ([]byte, error)
- type Epochs
- type Snapshot
- func (s Snapshot) Commit() (flow.StateCommitment, error)
- func (s Snapshot) Descendants() ([]flow.Identifier, error)
- func (s Snapshot) Encodable() EncodableSnapshot
- 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) 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)
- func (s Snapshot) ValidDescendants() ([]flow.Identifier, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cluster ¶
type Cluster struct {
// contains filtered or unexported fields
}
func ClusterFromEncodable ¶
func ClusterFromEncodable(enc EncodableCluster) (*Cluster, error)
ClusterFromEncodable returns a Cluster backed by the given encodable representation.
func FromCluster ¶
FromCluster converts any protocol.Cluster to a memory-backed Cluster
func (Cluster) EpochCounter ¶
func (Cluster) Members ¶
func (c Cluster) Members() flow.IdentityList
func (Cluster) RootBlock ¶
func (c Cluster) RootBlock() *clustermodel.Block
func (Cluster) RootQC ¶
func (c Cluster) RootQC() *flow.QuorumCertificate
type DKG ¶
type DKG struct {
// contains filtered or unexported fields
}
func DKGFromEncodable ¶
func DKGFromEncodable(enc EncodableDKG) (*DKG, error)
DKGFromEncodable returns a DKG backed by the given encodable representation.
type EncodableCluster ¶
type EncodableCluster struct { Index uint Counter uint64 Members flow.IdentityList RootBlock *cluster.Block RootQC *flow.QuorumCertificate }
EncodableCluster is the encoding format for protocol.Cluster
type EncodableDKG ¶
type EncodableDKG struct { GroupKey encodable.RandomBeaconPubKey Participants map[flow.Identifier]flow.DKGParticipant }
EncodableDKG is the encoding format for protocol.DKG
type EncodableEpoch ¶
type EncodableEpoch struct { Counter uint64 FirstView uint64 FinalView uint64 RandomSource []byte InitialIdentities flow.IdentityList Clustering flow.ClusterList Clusters []EncodableCluster DKG *EncodableDKG }
EncodableEpoch is the encoding format for protocol.Epoch
type EncodableEpochs ¶
type EncodableEpochs struct { Previous *EncodableEpoch Current EncodableEpoch // cannot be nil Next *EncodableEpoch }
EncodableEpochs is the encoding format for protocol.EpochQuery
type EncodableSnapshot ¶
type EncodableSnapshot struct { Head *flow.Header Identities flow.IdentityList LatestSeal *flow.Seal LatestResult *flow.ExecutionResult SealingSegment []*flow.Block QuorumCertificate *flow.QuorumCertificate Phase flow.EpochPhase Epochs EncodableEpochs }
EncodableSnapshot is the encoding format for protocol.Snapshot
type Epoch ¶
type Epoch struct {
// contains filtered or unexported fields
}
Epoch is a memory-backed implementation of protocol.Epoch.
func NewCommittedEpoch ¶
func NewCommittedEpoch(setupEvent *flow.EpochSetup, commitEvent *flow.EpochCommit) (*Epoch, error)
NewSetupEpoch returns an memory-backed epoch implementation based on an EpochSetup and EpochCommit event.
func NewSetupEpoch ¶
func NewSetupEpoch(setupEvent *flow.EpochSetup) (*Epoch, error)
NewSetupEpoch returns an memory-backed epoch implementation based on an EpochSetup event. Epoch information available after the setup phase will not be accessible in the resulting epoch instance.
func (Epoch) Clustering ¶
func (e Epoch) Clustering() (flow.ClusterList, error)
func (Epoch) InitialIdentities ¶
func (e Epoch) InitialIdentities() (flow.IdentityList, error)
func (Epoch) RandomSource ¶
type Snapshot ¶
type Snapshot struct {
// contains filtered or unexported fields
}
Snapshot is a memory-backed implementation of protocol.Snapshot. The snapshot data is stored in the embedded encodable snapshot model, which defines the canonical structure of an encoded snapshot for the purposes of serialization.
func FromSnapshot ¶
FromSnapshot generates a memory-backed snapshot from the input snapshot. Typically, this would be used to convert a database-backed snapshot to one that can easily be serialized to disk or to network.
func SnapshotFromBootstrapState ¶
func SnapshotFromBootstrapState(root *flow.Block, result *flow.ExecutionResult, seal *flow.Seal, qc *flow.QuorumCertificate) (*Snapshot, error)
SnapshotFromBootstrapState generates a protocol.Snapshot representing a root bootstrap state. This is used to bootstrap the protocol state for genesis or post-spork states.
func SnapshotFromEncodable ¶
func SnapshotFromEncodable(enc EncodableSnapshot) *Snapshot
func (Snapshot) Descendants ¶ added in v0.17.6
func (s Snapshot) Descendants() ([]flow.Identifier, error)
func (Snapshot) Encodable ¶
func (s Snapshot) Encodable() EncodableSnapshot
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 ¶
func (s Snapshot) QuorumCertificate() (*flow.QuorumCertificate, error)
func (Snapshot) SealedResult ¶
func (Snapshot) ValidDescendants ¶ added in v0.17.6
func (s Snapshot) ValidDescendants() ([]flow.Identifier, error)