Struct ChainDB

pub struct ChainDB { /* private fields */ }

A database of the chain store based on the RocksDB wrapper RocksDB

Implementations

impl ChainDB

pub fn new(db: RocksDB, config: StoreConfig) -> Self

Allocate a new ChainDB instance with the given config

pub fn new_with_freezer( db: RocksDB, freezer: Freezer, config: StoreConfig, ) -> Self

Open new ChainDB with freezer instance

pub fn db(&self) -> &RocksDB

Return the inner RocksDB instance

pub fn into_inner(self) -> RocksDB

Converts self into a RocksDB

pub fn put_chain_spec_hash(&self, hash: &Byte32) -> Result<(), Error>

Store the chain spec hash

pub fn get_chain_spec_hash(&self) -> Option<Byte32>

Return the chain spec hash

pub fn get_migration_version(&self) -> Option<DBPinnableSlice<'_>>

Return the chain spec hash

pub fn begin_transaction(&self) -> StoreTransaction

Set this snapshot at start of transaction

pub fn get_snapshot(&self) -> StoreSnapshot

Return StoreSnapshot

pub fn new_write_batch(&self) -> StoreWriteBatch

Construct StoreWriteBatch with default option.

pub fn write(&self, write_batch: &StoreWriteBatch) -> Result<(), Error>

Write batch into chain db.

pub fn write_sync(&self, write_batch: &StoreWriteBatch) -> Result<(), Error>

write options set_sync = true

see RocksDB::write_sync.

pub fn compact_range( &self, col: Col, start: Option<&[u8]>, end: Option<&[u8]>, ) -> Result<(), Error>

Force the data to go through the compaction in order to consolidate it

see RocksDB::compact_range.

pub fn init(&self, consensus: &Consensus) -> Result<(), Error>

TODO(doc): @quake

Trait Implementations

impl ChainStore for ChainDB

fn cache(&self) -> Option<&StoreCache>

Return cache reference

fn freezer(&self) -> Option<&Freezer>

Return freezer reference

fn get(&self, col: Col, key: &[u8]) -> Option<DBPinnableSlice<'_>>

Return the bytes associated with a key value and the given column family.

fn get_iter(&self, col: Col, mode: IteratorMode<'_>) -> DBIter<'_>

Return an iterator over the database key-value pairs in the given column family.

fn borrow_as_data_loader(&self) -> BorrowedDataLoaderWrapper<'_, Self>

Return the borrowed data loader wrapper

fn get_block(&self, h: &Byte32) -> Option<BlockView>

Get block by block header hash

fn get_block_header(&self, hash: &Byte32) -> Option<HeaderView>

Get header by block header hash

fn get_block_body(&self, hash: &Byte32) -> Vec<TransactionView>

Get block body by block header hash

fn get_unfrozen_block(&self, hash: &Byte32) -> Option<BlockView>

Get unfrozen block from ky-store with given hash

fn get_block_txs_hashes(&self, hash: &Byte32) -> Vec<Byte32>

Get all transaction-hashes in block body by block header hash

fn get_block_proposal_txs_ids( &self, hash: &Byte32, ) -> Option<ProposalShortIdVec>

Get proposal short id by block header hash

fn get_block_uncles(&self, hash: &Byte32) -> Option<UncleBlockVecView>

Get block uncles by block header hash

fn get_block_extension(&self, hash: &Byte32) -> Option<Bytes>

Get block extension by block header hash

fn get_block_ext(&self, block_hash: &Byte32) -> Option<BlockExt>

Get block ext by block header hash

fn get_block_hash(&self, number: BlockNumber) -> Option<Byte32>

Get block header hash by block number

fn get_block_number(&self, hash: &Byte32) -> Option<BlockNumber>

Get block number by block header hash

fn is_main_chain(&self, hash: &Byte32) -> bool

TODO(doc): @quake

fn get_tip_header(&self) -> Option<HeaderView>

TODO(doc): @quake

fn transaction_exists(&self, hash: &Byte32) -> bool

Returns true if the transaction confirmed in main chain.

fn get_transaction(&self, hash: &Byte32) -> Option<(TransactionView, Byte32)>

Get commit transaction and block hash by its hash

fn get_transaction_info(&self, hash: &Byte32) -> Option<TransactionInfo>

TODO(doc): @quake

fn get_transaction_with_info( &self, hash: &Byte32, ) -> Option<(TransactionView, TransactionInfo)>

Gets transaction and associated info with correspond hash

fn have_cell(&self, out_point: &OutPoint) -> bool

Return whether cell is live

fn get_cell(&self, out_point: &OutPoint) -> Option<CellMeta>

Gets cell meta data with out_point

fn get_cell_data(&self, out_point: &OutPoint) -> Option<(Bytes, Byte32)>

TODO(doc): @quake

fn get_cell_data_hash(&self, out_point: &OutPoint) -> Option<Byte32>

TODO(doc): @quake

fn get_current_epoch_ext(&self) -> Option<EpochExt>

Gets current epoch ext

fn get_epoch_ext(&self, hash: &Byte32) -> Option<EpochExt>

Gets epoch ext by epoch index

fn get_epoch_index(&self, number: EpochNumber) -> Option<Byte32>

Gets epoch index by epoch number

fn get_block_epoch_index(&self, block_hash: &Byte32) -> Option<Byte32>

Gets epoch index by block hash

fn get_block_epoch(&self, hash: &Byte32) -> Option<EpochExt>

TODO(doc): @quake

fn is_uncle(&self, hash: &Byte32) -> bool

TODO(doc): @quake

fn get_uncle_header(&self, hash: &Byte32) -> Option<HeaderView>

Gets header by uncle header hash

fn block_exists(&self, hash: &Byte32) -> bool

TODO(doc): @quake

fn get_cellbase(&self, hash: &Byte32) -> Option<TransactionView>

Gets cellbase by block hash

fn get_latest_built_filter_data_block_hash(&self) -> Option<Byte32>

Gets latest built filter data block hash

fn get_block_filter(&self, hash: &Byte32) -> Option<Bytes>

Gets block filter data by block hash

fn get_block_filter_hash(&self, hash: &Byte32) -> Option<Byte32>

Gets block filter hash by block hash

fn get_packed_block(&self, hash: &Byte32) -> Option<Block>

Gets block bytes by block hash

fn get_packed_block_header(&self, hash: &Byte32) -> Option<Header>

Gets block header bytes by block hash

fn get_header_digest(&self, position_u64: u64) -> Option<HeaderDigest>

Gets a header digest.

fn get_ancestor(&self, base: &Byte32, number: BlockNumber) -> Option<HeaderView>

Gets ancestor block header by a base block hash and number

impl Clone for ChainDB

fn clone(&self) -> ChainDB

Returns a copy of the value.

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

Performs copy-assignment from source.

impl VersionbitsIndexer for ChainDB

fn block_epoch_index(&self, block_hash: &Byte32) -> Option<Byte32>

Gets epoch index by block hash

fn epoch_ext(&self, index: &Byte32) -> Option<EpochExt>

Gets epoch ext by index

fn block_header(&self, block_hash: &Byte32) -> Option<HeaderView>

Gets block header by block hash

fn cellbase(&self, block_hash: &Byte32) -> Option<TransactionView>

Gets cellbase by block hash

fn ancestor_epoch(&self, index: &Byte32, target: u64) -> Option<EpochExt>

Gets ancestor of specified epoch.