cache

Documentation

Index

• Variables
• type AttestationCache
  • func NewAttestationCache() *AttestationCache
  • func (c *AttestationCache) Get(ctx context.Context, req *ethpb.AttestationDataRequest) (*ethpb.AttestationData, error)
  • func (c *AttestationCache) MarkInProgress(req *ethpb.AttestationDataRequest) error
  • func (c *AttestationCache) MarkNotInProgress(req *ethpb.AttestationDataRequest) error
  • func (c *AttestationCache) Put(ctx context.Context, req *ethpb.AttestationDataRequest, ...) error
• type CheckpointState
• type CheckpointStateCache
  • func NewCheckpointStateCache() *CheckpointStateCache
  • func (c *CheckpointStateCache) AddCheckpointState(cp *CheckpointState) error
  • func (c *CheckpointStateCache) CheckpointStateKeys() []string
  • func (c *CheckpointStateCache) StateByCheckpoint(cp *ethpb.Checkpoint) (*pb.BeaconState, error)
• type CommitteeCache
  • func NewCommitteesCache() *CommitteeCache
  • func (c *CommitteeCache) ActiveIndices(seed [32]byte) ([]uint64, error)
  • func (c *CommitteeCache) AddCommitteeShuffledList(committees *Committees) error
  • func (c *CommitteeCache) Committee(slot uint64, seed [32]byte, index uint64) ([]uint64, error)
• type Committees
• type Eth1DataVote
• type Eth1DataVoteCache
  • func NewEth1DataVoteCache() *Eth1DataVoteCache
  • func (c *Eth1DataVoteCache) AddEth1DataVote(eth1DataVote *Eth1DataVote) error
  • func (c *Eth1DataVoteCache) Eth1DataVote(eth1DataHash [32]byte) (uint64, error)
  • func (c *Eth1DataVoteCache) IncrementEth1DataVote(eth1DataHash [32]byte) (uint64, error)

Variables

var (
	// ErrNotCommittee will be returned when a cache object is not a pointer to
	// a Committee struct.
	ErrNotCommittee = errors.New("object is not a committee struct")

	// CommitteeCacheMiss tracks the number of committee requests that aren't present in the cache.
	CommitteeCacheMiss = promauto.NewCounter(prometheus.CounterOpts{
		Name: "committee_cache_miss",
		Help: "The number of committee requests that aren't present in the cache.",
	})
	// CommitteeCacheHit tracks the number of committee requests that are in the cache.
	CommitteeCacheHit = promauto.NewCounter(prometheus.CounterOpts{
		Name: "committee_cache_hit",
		Help: "The number of committee requests that are present in the cache.",
	})
)

var ErrAlreadyInProgress = errors.New("already in progress")

ErrAlreadyInProgress appears when attempting to mark a cache as in progress while it is already in progress. The client should handle this error and wait for the in progress data to resolve via Get.

var (
	// ErrNotCheckpointState will be returned when a cache object is not a pointer to
	// a CheckpointState struct.
	ErrNotCheckpointState = errors.New("object is not a state by check point struct")
)

var (
	// ErrNotEth1DataVote will be returned when a cache object is not a pointer to
	// a Eth1DataVote struct.
	ErrNotEth1DataVote = errors.New("object is not a eth1 data vote obj")
)

Types

type AttestationCache

type AttestationCache struct {
	// contains filtered or unexported fields
}

AttestationCache is used to store the cached results of an AttestationData request.

func NewAttestationCache

func NewAttestationCache() *AttestationCache

NewAttestationCache initializes the map and underlying cache.

func (*AttestationCache) Get

func (c *AttestationCache) Get(ctx context.Context, req *ethpb.AttestationDataRequest) (*ethpb.AttestationData, error)

Get waits for any in progress calculation to complete before returning a cached response, if any.

func (*AttestationCache) MarkInProgress

func (c *AttestationCache) MarkInProgress(req *ethpb.AttestationDataRequest) error

MarkInProgress a request so that any other similar requests will block on Get until MarkNotInProgress is called.

func (*AttestationCache) MarkNotInProgress

func (c *AttestationCache) MarkNotInProgress(req *ethpb.AttestationDataRequest) error

MarkNotInProgress will release the lock on a given request. This should be called after put.

func (*AttestationCache) Put

func (c *AttestationCache) Put(ctx context.Context, req *ethpb.AttestationDataRequest, res *ethpb.AttestationData) error

Put the response in the cache.

type CheckpointState

type CheckpointState struct {
	Checkpoint *ethpb.Checkpoint
	State      *pb.BeaconState
}

CheckpointState defines the active validator indices per epoch.

type CheckpointStateCache

type CheckpointStateCache struct {
	// contains filtered or unexported fields
}

CheckpointStateCache is a struct with 1 queue for looking up state by checkpoint.

func NewCheckpointStateCache

func NewCheckpointStateCache() *CheckpointStateCache

NewCheckpointStateCache creates a new checkpoint state cache for storing/accessing processed state.

func (*CheckpointStateCache) AddCheckpointState

func (c *CheckpointStateCache) AddCheckpointState(cp *CheckpointState) error

AddCheckpointState adds CheckpointState object to the cache. This method also trims the least recently added CheckpointState object if the cache size has ready the max cache size limit.

func (*CheckpointStateCache) CheckpointStateKeys

func (c *CheckpointStateCache) CheckpointStateKeys() []string

CheckpointStateKeys returns the keys of the state in cache.

func (*CheckpointStateCache) StateByCheckpoint

func (c *CheckpointStateCache) StateByCheckpoint(cp *ethpb.Checkpoint) (*pb.BeaconState, error)

StateByCheckpoint fetches state by checkpoint. Returns true with a reference to the CheckpointState info, if exists. Otherwise returns false, nil.

type CommitteeCache

type CommitteeCache struct {
	CommitteeCache *cache.FIFO
	// contains filtered or unexported fields
}

CommitteeCache is a struct with 1 queue for looking up shuffled indices list by seed.

func NewCommitteesCache

func NewCommitteesCache() *CommitteeCache

NewCommitteesCache creates a new committee cache for storing/accessing shuffled indices of a committee.

func (*CommitteeCache) ActiveIndices

func (c *CommitteeCache) ActiveIndices(seed [32]byte) ([]uint64, error)

ActiveIndices returns the active indices of a given seed stored in cache.

func (*CommitteeCache) AddCommitteeShuffledList

func (c *CommitteeCache) AddCommitteeShuffledList(committees *Committees) error

AddCommitteeShuffledList adds Committee shuffled list object to the cache. T his method also trims the least recently list if the cache size has ready the max cache size limit.

func (*CommitteeCache) Committee

func (c *CommitteeCache) Committee(slot uint64, seed [32]byte, index uint64) ([]uint64, error)

Committee fetches the shuffled indices by slot and committee index. Every list of indices represent one committee. Returns true if the list exists with slot and committee index. Otherwise returns false, nil.

type Committees

type Committees struct {
	CommitteeCount  uint64
	Seed            [32]byte
	ShuffledIndices []uint64
	SortedIndices   []uint64
}

Committees defines the shuffled committees seed.

type Eth1DataVote

type Eth1DataVote struct {
	Eth1DataHash [32]byte
	VoteCount    uint64
}

Eth1DataVote defines the struct which keeps track of the vote count of individual deposit root.

type Eth1DataVoteCache

type Eth1DataVoteCache struct {
	// contains filtered or unexported fields
}

Eth1DataVoteCache is a struct with 1 queue for looking up eth1 data vote count by deposit root.

func NewEth1DataVoteCache

func NewEth1DataVoteCache() *Eth1DataVoteCache

NewEth1DataVoteCache creates a new eth1 data vote count cache for storing/accessing Eth1DataVote.

func (*Eth1DataVoteCache) AddEth1DataVote

func (c *Eth1DataVoteCache) AddEth1DataVote(eth1DataVote *Eth1DataVote) error

AddEth1DataVote adds eth1 data vote object to the cache. This method also trims the least recently added Eth1DataVoteByEpoch object if the cache size has ready the max cache size limit.

func (*Eth1DataVoteCache) Eth1DataVote

func (c *Eth1DataVoteCache) Eth1DataVote(eth1DataHash [32]byte) (uint64, error)

Eth1DataVote fetches eth1 data vote count by the eth1data hash. Returns vote count, if exists. Otherwise returns false, nil.

func (*Eth1DataVoteCache) IncrementEth1DataVote

func (c *Eth1DataVoteCache) IncrementEth1DataVote(eth1DataHash [32]byte) (uint64, error)

IncrementEth1DataVote increments the existing eth1 data object's vote count by 1, and returns the vote count.