Struct ClientDatabase 

pub struct ClientDatabase<Block, StorageBackend>
where
    Block: GenericOwnedBlock,
{ /* private fields */ }

Client database

Implementations

impl<Block, StorageBackend> ClientDatabase<Block, StorageBackend>

where Block: GenericOwnedBlock, StorageBackend: ClientDatabaseStorageBackend,

pub async fn open<GBB>( options: ClientDatabaseOptions<GBB, StorageBackend>, ) -> Result<Self, ClientDatabaseError>

where GBB: FnOnce() -> GenesisBlockBuilderResult<Block>,

Open the existing database.

NOTE: The database needs to be formatted with Self::format() before it can be used.

Opening replays storage items in the order they were written. Every block read at a new highest block number is handled like a new best block: forks are adjusted towards it, other blocks at block offset block_confirmation_depth - 1 are pruned, then the block at block offset block_confirmation_depth is confirmed (see the block lifecycle in ClientDatabaseOptions). The best block after opening is the last block written at the highest stored block number. It may be behind or on a different fork than the best block before shutdown, the node re-syncs from there.

pub async fn format( storage_backend: &StorageBackend, options: ClientDatabaseFormatOptions, ) -> Result<(), ClientDatabaseFormatError>

Format a new database

Trait Implementations

impl<StorageBackend> BeaconChainInfo for ClientDatabase<OwnedBeaconChainBlock, StorageBackend>

where StorageBackend: ClientDatabaseStorageBackend,

fn shard_segment_roots( &self, block_number: BlockNumber, ) -> Result<Arc<[ShardSegmentRoot]>, ShardSegmentRootsError>

Returns intermediate and leaf shard segment roots included in the specified block number.

fn last_super_segment_header(&self) -> Option<SuperSegmentHeader>

Returns the last observed super segment header

fn previous_super_segment_header( &self, block_number: BlockNumber, ) -> Option<SuperSegmentHeader>

Returns the previous super segment header for the block built with the specified target block number.

fn get_super_segment_header( &self, super_segment_index: SuperSegmentIndex, ) -> Option<SuperSegmentHeader>

Get a single super segment header

fn get_super_segment_header_for_segment_index( &self, segment_index: SegmentIndex, ) -> Option<SuperSegmentHeader>

Get a single super segment header for a segment index

impl<StorageBackend> BeaconChainInfoWrite for ClientDatabase<OwnedBeaconChainBlock, StorageBackend>

where StorageBackend: ClientDatabaseStorageBackend,

async fn persist_super_segment_header( &self, super_segment_header: SuperSegmentHeader, ) -> Result<bool, PersistSuperSegmentHeadersError>

Persist a new super segment header.

async fn persist_super_segment_headers( &self, super_segment_headers: Vec<SuperSegmentHeader>, ) -> Result<(), PersistSuperSegmentHeadersError>

Persist super segment headers.

impl<Block, StorageBackend> ChainInfo<Block> for ClientDatabase<Block, StorageBackend>

where Block: GenericOwnedBlock, StorageBackend: ClientDatabaseStorageBackend,

fn best_root(&self) -> BlockRoot

Best block root

fn best_header(&self) -> Block::Header

Best block header

fn best_header_with_details(&self) -> (Block::Header, BlockDetails)

Returns the best block header like [Self::best_header()] with additional block details

fn ancestor_header( &self, ancestor_block_number: BlockNumber, descendant_block_root: &BlockRoot, ) -> Option<Block::Header>

Get the header of the block at ancestor_block_number on the chain ending at descendant_block_root.

fn header(&self, block_root: &BlockRoot) -> Option<Block::Header>

Block header

fn header_with_details( &self, block_root: &BlockRoot, ) -> Option<(Block::Header, BlockDetails)>

Returns a block header like [Self::header()] with additional block details

async fn block(&self, block_root: &BlockRoot) -> Result<Block, ReadBlockError>

fn last_segment_header(&self) -> Option<SegmentHeader>

Returns the last observed local segment header of this shard

fn get_segment_header( &self, segment_index: LocalSegmentIndex, ) -> Option<SegmentHeader>

Get a single segment header

fn segment_headers_for_block( &self, block_number: BlockNumber, ) -> Vec<SegmentHeader>

Get segment headers that are expected to be included at specified block number

impl<Block, StorageBackend> ChainInfoWrite<Block> for ClientDatabase<Block, StorageBackend>

where Block: GenericOwnedBlock, StorageBackend: ClientDatabaseStorageBackend,

async fn persist_block( &self, block: Block, block_details: BlockDetails, ) -> Result<(), PersistBlockError>

Persist newly imported block

async fn persist_segment_headers( &self, segment_headers: Vec<SegmentHeader>, ) -> Result<(), PersistSegmentHeadersError>

Persist segment headers.

impl<Block, StorageBackend> Clone for ClientDatabase<Block, StorageBackend>

where Block: GenericOwnedBlock,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Block, StorageBackend: Debug> Debug for ClientDatabase<Block, StorageBackend>

where Block: GenericOwnedBlock + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Block, StorageBackend> Drop for ClientDatabase<Block, StorageBackend>

where Block: GenericOwnedBlock,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.