mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-26 05:17:22 +00:00
e1310adb4c
* docs improvements so far * all misc docs items * finalized * Merge branch 'master' into qsp-docs * fix broken test * Merge branch 'master' into qsp-docs
139 lines
7.2 KiB
Go
139 lines
7.2 KiB
Go
// Package iface defines the actual database interface used
|
|
// by a Prysm beacon node, also containing useful, scoped interfaces such as
|
|
// a ReadOnlyDatabase.
|
|
package iface
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
eth "github.com/prysmaticlabs/ethereumapis/eth/v1alpha1"
|
|
ethpb "github.com/prysmaticlabs/ethereumapis/eth/v1alpha1"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/db/filters"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/state"
|
|
"github.com/prysmaticlabs/prysm/proto/beacon/db"
|
|
ethereum_beacon_p2p_v1 "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
|
|
)
|
|
|
|
// ReadOnlyDatabase defines a struct which only has read access to database methods.
|
|
type ReadOnlyDatabase interface {
|
|
// Attestation related methods.
|
|
AttestationsByDataRoot(ctx context.Context, attDataRoot [32]byte) ([]*eth.Attestation, error)
|
|
Attestations(ctx context.Context, f *filters.QueryFilter) ([]*eth.Attestation, error)
|
|
HasAttestation(ctx context.Context, attDataRoot [32]byte) bool
|
|
// Block related methods.
|
|
Block(ctx context.Context, blockRoot [32]byte) (*eth.SignedBeaconBlock, error)
|
|
Blocks(ctx context.Context, f *filters.QueryFilter) ([]*eth.SignedBeaconBlock, error)
|
|
BlockRoots(ctx context.Context, f *filters.QueryFilter) ([][32]byte, error)
|
|
HasBlock(ctx context.Context, blockRoot [32]byte) bool
|
|
GenesisBlock(ctx context.Context) (*ethpb.SignedBeaconBlock, error)
|
|
IsFinalizedBlock(ctx context.Context, blockRoot [32]byte) bool
|
|
HighestSlotBlocks(ctx context.Context) ([]*ethpb.SignedBeaconBlock, error)
|
|
HighestSlotBlocksBelow(ctx context.Context, slot uint64) ([]*ethpb.SignedBeaconBlock, error)
|
|
// State related methods.
|
|
State(ctx context.Context, blockRoot [32]byte) (*state.BeaconState, error)
|
|
GenesisState(ctx context.Context) (*state.BeaconState, error)
|
|
HasState(ctx context.Context, blockRoot [32]byte) bool
|
|
StateSummary(ctx context.Context, blockRoot [32]byte) (*ethereum_beacon_p2p_v1.StateSummary, error)
|
|
HasStateSummary(ctx context.Context, blockRoot [32]byte) bool
|
|
HighestSlotStates(ctx context.Context) ([]*state.BeaconState, error)
|
|
HighestSlotStatesBelow(ctx context.Context, slot uint64) ([]*state.BeaconState, error)
|
|
// Slashing operations.
|
|
ProposerSlashing(ctx context.Context, slashingRoot [32]byte) (*eth.ProposerSlashing, error)
|
|
AttesterSlashing(ctx context.Context, slashingRoot [32]byte) (*eth.AttesterSlashing, error)
|
|
HasProposerSlashing(ctx context.Context, slashingRoot [32]byte) bool
|
|
HasAttesterSlashing(ctx context.Context, slashingRoot [32]byte) bool
|
|
// Block operations.
|
|
VoluntaryExit(ctx context.Context, exitRoot [32]byte) (*eth.VoluntaryExit, error)
|
|
HasVoluntaryExit(ctx context.Context, exitRoot [32]byte) bool
|
|
// Checkpoint operations.
|
|
JustifiedCheckpoint(ctx context.Context) (*eth.Checkpoint, error)
|
|
FinalizedCheckpoint(ctx context.Context) (*eth.Checkpoint, error)
|
|
// Archival data handlers for storing/retrieving historical beacon node information.
|
|
ArchivedActiveValidatorChanges(ctx context.Context, epoch uint64) (*ethereum_beacon_p2p_v1.ArchivedActiveSetChanges, error)
|
|
ArchivedCommitteeInfo(ctx context.Context, epoch uint64) (*ethereum_beacon_p2p_v1.ArchivedCommitteeInfo, error)
|
|
ArchivedBalances(ctx context.Context, epoch uint64) ([]uint64, error)
|
|
ArchivedValidatorParticipation(ctx context.Context, epoch uint64) (*eth.ValidatorParticipation, error)
|
|
ArchivedPointRoot(ctx context.Context, index uint64) [32]byte
|
|
HasArchivedPoint(ctx context.Context, index uint64) bool
|
|
LastArchivedIndexRoot(ctx context.Context) [32]byte
|
|
LastArchivedIndex(ctx context.Context) (uint64, error)
|
|
// Deposit contract related handlers.
|
|
DepositContractAddress(ctx context.Context) ([]byte, error)
|
|
// Powchain operations.
|
|
PowchainData(ctx context.Context) (*db.ETH1ChainData, error)
|
|
}
|
|
|
|
// NoHeadAccessDatabase defines a struct without access to chain head data.
|
|
type NoHeadAccessDatabase interface {
|
|
ReadOnlyDatabase
|
|
|
|
// Attestation related methods.
|
|
DeleteAttestation(ctx context.Context, attDataRoot [32]byte) error
|
|
DeleteAttestations(ctx context.Context, attDataRoots [][32]byte) error
|
|
SaveAttestation(ctx context.Context, att *eth.Attestation) error
|
|
SaveAttestations(ctx context.Context, atts []*eth.Attestation) error
|
|
// Block related methods.
|
|
DeleteBlock(ctx context.Context, blockRoot [32]byte) error
|
|
DeleteBlocks(ctx context.Context, blockRoots [][32]byte) error
|
|
SaveBlock(ctx context.Context, block *eth.SignedBeaconBlock) error
|
|
SaveBlocks(ctx context.Context, blocks []*eth.SignedBeaconBlock) error
|
|
SaveGenesisBlockRoot(ctx context.Context, blockRoot [32]byte) error
|
|
// State related methods.
|
|
SaveState(ctx context.Context, state *state.BeaconState, blockRoot [32]byte) error
|
|
SaveStates(ctx context.Context, states []*state.BeaconState, blockRoots [][32]byte) error
|
|
DeleteState(ctx context.Context, blockRoot [32]byte) error
|
|
DeleteStates(ctx context.Context, blockRoots [][32]byte) error
|
|
SaveStateSummary(ctx context.Context, summary *ethereum_beacon_p2p_v1.StateSummary) error
|
|
SaveStateSummaries(ctx context.Context, summaries []*ethereum_beacon_p2p_v1.StateSummary) error
|
|
// Slashing operations.
|
|
SaveProposerSlashing(ctx context.Context, slashing *eth.ProposerSlashing) error
|
|
SaveAttesterSlashing(ctx context.Context, slashing *eth.AttesterSlashing) error
|
|
DeleteProposerSlashing(ctx context.Context, slashingRoot [32]byte) error
|
|
DeleteAttesterSlashing(ctx context.Context, slashingRoot [32]byte) error
|
|
// Block operations.
|
|
SaveVoluntaryExit(ctx context.Context, exit *eth.VoluntaryExit) error
|
|
DeleteVoluntaryExit(ctx context.Context, exitRoot [32]byte) error
|
|
// Checkpoint operations.
|
|
SaveJustifiedCheckpoint(ctx context.Context, checkpoint *eth.Checkpoint) error
|
|
SaveFinalizedCheckpoint(ctx context.Context, checkpoint *eth.Checkpoint) error
|
|
// Archival data handlers for storing/retrieving historical beacon node information.
|
|
SaveArchivedActiveValidatorChanges(ctx context.Context, epoch uint64, changes *ethereum_beacon_p2p_v1.ArchivedActiveSetChanges) error
|
|
SaveArchivedCommitteeInfo(ctx context.Context, epoch uint64, info *ethereum_beacon_p2p_v1.ArchivedCommitteeInfo) error
|
|
SaveArchivedBalances(ctx context.Context, epoch uint64, balances []uint64) error
|
|
SaveArchivedValidatorParticipation(ctx context.Context, epoch uint64, part *eth.ValidatorParticipation) error
|
|
SaveArchivedPointRoot(ctx context.Context, blockRoot [32]byte, index uint64) error
|
|
SaveLastArchivedIndex(ctx context.Context, index uint64) error
|
|
// Deposit contract related handlers.
|
|
SaveDepositContractAddress(ctx context.Context, addr common.Address) error
|
|
// Powchain operations.
|
|
SavePowchainData(ctx context.Context, data *db.ETH1ChainData) error
|
|
}
|
|
|
|
// HeadAccessDatabase defines a struct with access to reading chain head data.
|
|
type HeadAccessDatabase interface {
|
|
NoHeadAccessDatabase
|
|
|
|
// Block related methods.
|
|
HeadBlock(ctx context.Context) (*eth.SignedBeaconBlock, error)
|
|
SaveHeadBlockRoot(ctx context.Context, blockRoot [32]byte) error
|
|
// State related methods.
|
|
HeadState(ctx context.Context) (*state.BeaconState, error)
|
|
}
|
|
|
|
// Database interface with full access.
|
|
type Database interface {
|
|
io.Closer
|
|
HeadAccessDatabase
|
|
|
|
DatabasePath() string
|
|
ClearDB() error
|
|
|
|
// Backup and restore methods
|
|
Backup(ctx context.Context) error
|
|
|
|
// HistoricalStatesDeleted verifies historical states exist in DB.
|
|
HistoricalStatesDeleted(ctx context.Context) error
|
|
}
|