Struct ckb_store::ChainDB

pub struct ChainDB { /* fields omitted */ }

TODO(doc): @quake

Implementations

impl ChainDB

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

TODO(doc): @quake

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

Open new ChainDB with freezer instance

pub fn db(&self) -> &RocksDB

TODO(doc): @quake

pub fn into_inner(self) -> RocksDB

TODO(doc): @quake

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 begin_transaction(&self) -> StoreTransaction

TODO(doc): @quake

pub fn get_snapshot(&self) -> StoreSnapshot

TODO(doc): @quake

pub fn new_write_batch(&self) -> StoreWriteBatch

TODO(doc): @quake

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

TODO(doc): @quake

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<'a> ChainStore<'a> for ChainDB

type Vector = DBPinnableSlice<'a>

TODO(doc): @quake

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

TODO(doc): @quake

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

Return freezer reference

fn get(&'a self, col: Col, key: &[u8]) -> Option<Self::Vector>

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

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

TODO(doc): @quake

fn cell_provider(&self) -> CellProviderWrapper<'_, Self>

TODO(doc): @quake

fn as_data_provider(&'a self) -> DataLoaderWrapper<'a, Self>

Return the provider trait default implementation

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

Get block by block header hash

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

Get header by block header hash

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

Get block body by block header hash

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

Get unfrozen block from ky-store with given hash

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

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

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

Get proposal short id by block header hash

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

Get block uncles by block header hash

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

Get block ext by block header hash

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

Get block header hash by block number

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

Get block number by block header hash

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

TODO(doc): @quake

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

TODO(doc): @quake

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

Returns true if the transaction confirmed in main chain.

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

Get commit transaction and block hash by its hash

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

TODO(doc): @quake

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

Gets transaction and associated info with correspond hash

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

Return whether cell is live

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

Gets cell meta data with out_point

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

TODO(doc): @quake

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

Gets current epoch ext

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

Gets epoch ext by epoch index

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

Gets epoch index by epoch number

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

Gets epoch index by block hash

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

TODO(doc): @quake

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

TODO(doc): @quake

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

Gets header by uncle header hash

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

TODO(doc): @quake

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

Gets cellbase by block hash

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

TODO(doc): @quake

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

TODO(doc): @quake

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.