Documentation ¶
Index ¶
- type Epoch
- func (u *Epoch) Cluster(uint) (protocol.Cluster, error)
- func (u *Epoch) ClusterByChainID(chainID flow.ChainID) (protocol.Cluster, error)
- func (u *Epoch) Clustering() (flow.ClusterList, error)
- func (u *Epoch) Counter() (uint64, error)
- func (u *Epoch) DKG() (protocol.DKG, error)
- func (u *Epoch) DKGPhase1FinalView() (uint64, error)
- func (u *Epoch) DKGPhase2FinalView() (uint64, error)
- func (u *Epoch) DKGPhase3FinalView() (uint64, error)
- func (u *Epoch) FinalHeight() (uint64, error)
- func (u *Epoch) FinalView() (uint64, error)
- func (u *Epoch) FirstHeight() (uint64, error)
- func (u *Epoch) FirstView() (uint64, error)
- func (u *Epoch) InitialIdentities() (flow.IdentitySkeletonList, error)
- func (u *Epoch) RandomSource() ([]byte, error)
- func (u *Epoch) TargetDuration() (uint64, error)
- func (u *Epoch) TargetEndTime() (uint64, error)
- type Epochs
- type Params
- type Snapshot
- func (u *Snapshot) Commit() (flow.StateCommitment, error)
- func (u *Snapshot) Descendants() ([]flow.Identifier, error)
- func (u *Snapshot) EpochPhase() (flow.EpochPhase, error)
- func (u *Snapshot) EpochProtocolState() (protocol.EpochProtocolState, error)
- func (u *Snapshot) Epochs() protocol.EpochQuery
- func (u *Snapshot) Head() (*flow.Header, error)
- func (u *Snapshot) Identities(_ flow.IdentityFilter[flow.Identity]) (flow.IdentityList, error)
- func (u *Snapshot) Identity(_ flow.Identifier) (*flow.Identity, error)
- func (u *Snapshot) Params() protocol.GlobalParams
- func (u *Snapshot) ProtocolState() (protocol.KVStoreReader, error)
- func (u *Snapshot) QuorumCertificate() (*flow.QuorumCertificate, error)
- func (u *Snapshot) RandomSource() ([]byte, error)
- func (u *Snapshot) SealedResult() (*flow.ExecutionResult, *flow.Seal, error)
- func (u *Snapshot) SealingSegment() (*flow.SealingSegment, error)
- func (u *Snapshot) VersionBeacon() (*flow.SealedVersionBeacon, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Epoch ¶
type Epoch struct {
// contains filtered or unexported fields
}
Epoch represents an epoch that does not exist or could not be retrieved.
func NewEpoch ¶
NewEpoch returns a new invalid epoch, containing an error describing why the epoch could not be retrieved. The following are expected errors when constructing an invalid Epoch:
- protocol.ErrNoPreviousEpoch - if the epoch represents a previous epoch which does not exist. This happens when the previous epoch is queried within the first epoch of a spork.
- protocol.ErrNextEpochNotSetup - if the epoch represents a next epoch which has not been set up. This happens when the next epoch is queried within the EpochStaking phase of any epoch.
- state.ErrUnknownSnapshotReference - if the epoch is queried from an unresolvable snapshot.
- generic error in case of unexpected critical internal corruption or bugs
func (*Epoch) ClusterByChainID ¶ added in v0.26.1
func (*Epoch) Clustering ¶
func (u *Epoch) Clustering() (flow.ClusterList, error)
func (*Epoch) DKGPhase1FinalView ¶ added in v0.20.0
func (*Epoch) DKGPhase2FinalView ¶ added in v0.20.0
func (*Epoch) DKGPhase3FinalView ¶ added in v0.20.0
func (*Epoch) FinalHeight ¶ added in v0.30.0
func (*Epoch) FirstHeight ¶ added in v0.30.0
func (*Epoch) InitialIdentities ¶
func (u *Epoch) InitialIdentities() (flow.IdentitySkeletonList, error)
func (*Epoch) RandomSource ¶
func (*Epoch) TargetDuration ¶ added in v0.33.30
func (*Epoch) TargetEndTime ¶ added in v0.33.30
type Epochs ¶
type Epochs struct {
// contains filtered or unexported fields
}
Epochs is an epoch query for an invalid snapshot.
type Params ¶ added in v0.23.2
type Params struct {
// contains filtered or unexported fields
}
Params represents parameters for an invalid state snapshot query.
func (Params) ProtocolVersion ¶ added in v0.23.2
func (Params) SporkID ¶ added in v0.23.2
func (p Params) SporkID() flow.Identifier
func (Params) SporkRootBlockHeight ¶ added in v0.29.6
type Snapshot ¶
type Snapshot struct {
// contains filtered or unexported fields
}
Snapshot represents a snapshot that does not exist or could not be queried.
func NewSnapshot ¶
NewSnapshot returns a new invalid snapshot, containing an error describing why the snapshot could not be retrieved. The following are expected errors when constructing an invalid Snapshot:
- state.ErrUnknownSnapshotReference if the reference point for the snapshot (height or block ID) does not resolve to a queriable block in the state.
- generic error in case of unexpected critical internal corruption or bugs
func NewSnapshotf ¶ added in v0.28.0
NewSnapshotf is NewSnapshot with ergonomic error formatting.
func (*Snapshot) Descendants ¶ added in v0.17.6
func (u *Snapshot) Descendants() ([]flow.Identifier, error)
func (*Snapshot) EpochPhase ¶ added in v0.37.1
func (u *Snapshot) EpochPhase() (flow.EpochPhase, error)
func (*Snapshot) EpochProtocolState ¶ added in v0.33.30
func (u *Snapshot) EpochProtocolState() (protocol.EpochProtocolState, error)
func (*Snapshot) Epochs ¶
func (u *Snapshot) Epochs() protocol.EpochQuery
func (*Snapshot) Identities ¶
func (u *Snapshot) Identities(_ flow.IdentityFilter[flow.Identity]) (flow.IdentityList, error)
func (*Snapshot) Params ¶ added in v0.23.2
func (u *Snapshot) Params() protocol.GlobalParams
func (*Snapshot) ProtocolState ¶ added in v0.33.30
func (u *Snapshot) ProtocolState() (protocol.KVStoreReader, error)
func (*Snapshot) QuorumCertificate ¶
func (u *Snapshot) QuorumCertificate() (*flow.QuorumCertificate, error)
func (*Snapshot) RandomSource ¶ added in v0.25.0
func (*Snapshot) SealedResult ¶
func (*Snapshot) SealingSegment ¶
func (u *Snapshot) SealingSegment() (*flow.SealingSegment, error)
func (*Snapshot) VersionBeacon ¶ added in v0.31.0
func (u *Snapshot) VersionBeacon() (*flow.SealedVersionBeacon, error)