mirror of
https://github.com/OffchainLabs/prysm.git
synced 2026-05-02 03:02:54 -04:00
774b9a7159
* Migrate Prysm repo to Offchain Labs organization ahead of Pectra upgrade v6 * Replace prysmaticlabs with OffchainLabs on general markdowns * Update mock * Gazelle and add mock.go to excluded generated mock file
65 lines
2.6 KiB
Go
65 lines
2.6 KiB
Go
package cache
|
|
|
|
import (
|
|
"context"
|
|
"math/big"
|
|
|
|
ethpb "github.com/OffchainLabs/prysm/v6/proto/prysm/v1alpha1"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
)
|
|
|
|
// DepositCache combines the interfaces for retrieving and inserting deposit information.
|
|
type DepositCache interface {
|
|
DepositFetcher
|
|
DepositInserter
|
|
DepositPruner
|
|
}
|
|
|
|
// DepositFetcher defines a struct which can retrieve deposit information from a store.
|
|
type DepositFetcher interface {
|
|
AllDeposits(ctx context.Context, untilBlk *big.Int) []*ethpb.Deposit
|
|
AllDepositContainers(ctx context.Context) []*ethpb.DepositContainer
|
|
DepositByPubkey(ctx context.Context, pubKey []byte) (*ethpb.Deposit, *big.Int)
|
|
DepositsNumberAndRootAtHeight(ctx context.Context, blockHeight *big.Int) (uint64, [32]byte)
|
|
InsertPendingDeposit(ctx context.Context, d *ethpb.Deposit, blockNum uint64, index int64, depositRoot [32]byte)
|
|
PendingDeposits(ctx context.Context, untilBlk *big.Int) []*ethpb.Deposit
|
|
PendingContainers(ctx context.Context, untilBlk *big.Int) []*ethpb.DepositContainer
|
|
FinalizedFetcher
|
|
}
|
|
|
|
// DepositInserter defines a struct which can insert deposit information from a store.
|
|
type DepositInserter interface {
|
|
InsertDeposit(ctx context.Context, d *ethpb.Deposit, blockNum uint64, index int64, depositRoot [32]byte) error
|
|
InsertDepositContainers(ctx context.Context, ctrs []*ethpb.DepositContainer)
|
|
InsertFinalizedDeposits(ctx context.Context, eth1DepositIndex int64, executionHash common.Hash, executionNumber uint64) error
|
|
}
|
|
|
|
// FinalizedFetcher is a smaller interface defined to be the bare minimum to satisfy “Service”.
|
|
// It extends the "DepositFetcher" interface with additional methods for fetching finalized deposits.
|
|
type FinalizedFetcher interface {
|
|
FinalizedDeposits(ctx context.Context) (FinalizedDeposits, error)
|
|
NonFinalizedDeposits(ctx context.Context, lastFinalizedIndex int64, untilBlk *big.Int) []*ethpb.Deposit
|
|
}
|
|
|
|
// DepositPruner is an interface for pruning deposits and proofs.
|
|
type DepositPruner interface {
|
|
PrunePendingDeposits(ctx context.Context, merkleTreeIndex int64)
|
|
PruneAllPendingDeposits(ctx context.Context)
|
|
PruneProofs(ctx context.Context, untilDepositIndex int64) error
|
|
PruneAllProofs(ctx context.Context)
|
|
}
|
|
|
|
// FinalizedDeposits defines a method to access a merkle tree containing deposits and their indexes.
|
|
type FinalizedDeposits interface {
|
|
Deposits() MerkleTree
|
|
MerkleTrieIndex() int64
|
|
}
|
|
|
|
// MerkleTree defines methods for constructing and manipulating a merkle tree.
|
|
type MerkleTree interface {
|
|
HashTreeRoot() ([32]byte, error)
|
|
NumOfItems() int
|
|
Insert(item []byte, index int) error
|
|
MerkleProof(index int) ([][]byte, error)
|
|
}
|