package
5.2.0
Repository: https://github.com/prysmaticlabs/prysm.git
Documentation: pkg.go.dev

# Packages

Package depositsnapshot implements the EIP-4881 standard for minimal sparse Merkle tree.

# Functions

NewAttestationCache creates a new instance of AttestationCache.
NewCheckpointStateCache creates a new checkpoint state cache for storing/accessing processed state.
NewCommitteesCache creates a new committee cache for storing/accessing shuffled indices of a committee.
NewEffectiveBalanceCache creates a new effective balance cache for storing/accessing total balance by epoch.
NewPayloadIDCache returns a new payload ID cache.
NewProposerIndicesCache returns a newly created cache.
NewRegistrationCache initializes the map and underlying cache.
NewSkipSlotCache initializes the map and underlying cache.
NewSyncCommittee initializes and returns a new SyncCommitteeCache.
NewSyncCommitteeHeadState initializes a LRU cache for `SyncCommitteeHeadState` with size of 1.

# Variables

CommitteeCacheHit tracks the number of committee requests that are in the cache.
CommitteeCacheMiss tracks the number of committee requests that aren't present in the cache.
ErrAlreadyInProgress appears when attempting to mark a cache as in progress while it is already in progress.
ErrIncorrectType for when the state is of the incorrect type.
ErrNilValueProvided for when we try to put a nil value in a cache.
ErrNonExistingSyncCommitteeKey when sync committee key (root) does not exist in cache.
ErrNotCommittee will be returned when a cache object is not a pointer to a Committee struct.
ErrNotFound for cache fetches that return a nil value.
ErrNotFoundRegistration when validator registration does not exist in cache.
ProposerIndicesCacheHit tracks the number of proposerIndices requests that are in the cache.
ProposerIndicesCacheMiss tracks the number of proposerIndices requests that aren't present in the cache.
SubnetIDs for attester and aggregator.
SyncCommitteeCacheHit tracks the number of committee requests that are in the cache.
SyncCommitteeCacheMiss tracks the number of committee requests that aren't present in the cache.
SyncSubnetIDs for sync committee participant.

# Structs

AttestationCache stores cached results of AttestationData requests.
BalanceCache is a struct with 1 LRU cache for looking up balance by epoch.
CheckpointStateCache is a struct with 1 queue for looking up state by checkpoint.
CommitteeCache is a struct with 1 queue for looking up shuffled indices list by seed.
Committees defines the shuffled committees seed.
PayloadIDCache is a cache that keeps track of the prepared payload ID for the given slot and with the given head root.
ProposerIndices defines the cached struct for proposer indices.
ProposerIndicesCache keeps track of the proposer indices in the next two epochs.
RegistrationCache is used to store the cached results of an Validator Registration request.
SkipSlotCache is used to store the cached results of processing skip slots in transition.ProcessSlots.
SyncCommitteeCache utilizes a FIFO cache to sufficiently cache validator position within sync committee.
SyncCommitteeHeadStateCache for the latest head state requested by a sync committee participant.

# Interfaces

DepositCache combines the interfaces for retrieving and inserting deposit information.
DepositFetcher defines a struct which can retrieve deposit information from a store.
DepositInserter defines a struct which can insert deposit information from a store.
FinalizedDeposits defines a method to access a merkle tree containing deposits and their indexes.
FinalizedFetcher is a smaller interface defined to be the bare minimum to satisfy “Service”.
MerkleTree defines methods for constructing and manipulating a merkle tree.

# Type aliases

RootToPayloadIDMap is a map with keys the head root and values the corresponding PayloadID.