Struct ckb_shared::Snapshot

pub struct Snapshot { /* fields omitted */ }

A snapshot captures a point-in-time view of the DB at the time it’s created

Implementations

impl Snapshot

pub fn new(
    tip_header: HeaderView,
    total_difficulty: U256,
    epoch_ext: EpochExt,
    store: StoreSnapshot,
    proposals: ProposalView,
    consensus: Arc<Consensus>
) -> Snapshot

New snapshot created after tip change

pub fn refresh(&self, store: StoreSnapshot) -> Snapshot

Refreshing on block commit is necessary operation, even tip remains unchanged. when node relayed compact block,if some uncles were not available from receiver’s local sources, in GetBlockTransactions/BlockTransactions roundtrip, node will need access block data of uncles.

pub fn tip_header(&self) -> &HeaderView

Return reference of tip header

pub fn tip_number(&self) -> u64

Return tip header number

pub fn tip_hash(&self) -> Byte32

Return tip header hash

pub fn epoch_ext(&self) -> &EpochExt

Return current epoch information

pub fn consensus(&self) -> &Consensus

Return reference of Consensus

pub fn cloned_consensus(&self) -> Arc<Consensus>

Makes a clone of the Arc<Consensus>

pub fn proposals(&self) -> &ProposalView

Return reference of proposals view

pub fn total_difficulty(&self) -> &U256

Return current best chain total_difficulty

pub fn finalize_block_reward(
    &self,
    parent: &HeaderView
) -> Result<(Script, BlockReward), Error>

Shortcuts for calculate block reward, invoke RewardCalculator

Trait Implementations

impl CellChecker for Snapshot

pub fn is_live(&self, out_point: &OutPoint) -> Option<bool>

Returns true if the cell is live corresponding to specified out_point.

impl CellProvider for Snapshot

pub fn cell(&self, out_point: &OutPoint, with_data: bool) -> CellStatus

TODO(doc): @quake

impl<'a> ChainStore<'a> for Snapshot

type Vector = DBPinnableSlice<'a>

TODO(doc): @quake

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

TODO(doc): @quake

pub fn get(
    &'a self,
    col: &'static str,
    key: &[u8]
) -> Option<<Snapshot as ChainStore<'a>>::Vector>

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

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

Return freezer reference

pub fn get_iter(
    &self,
    col: &'static str,
    mode: IteratorMode<'_>
) -> DBIterator<'_>

TODO(doc): @quake

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

TODO(doc): @quake

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

Gets current epoch ext

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, Global>

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, Global>

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: u64) -> Option<Byte32>

Get block header hash by block number

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

Get block number by block header hash

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

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_epoch_ext(&'a self, hash: &Byte32) -> Option<EpochExt>

Gets epoch ext by epoch index

fn get_epoch_index(&'a self, number: u64) -> 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 HeaderChecker for Snapshot

pub fn check_valid(&self, block_hash: &Byte32) -> Result<(), OutPointError>

Check if header in main chain

impl HeaderProvider for Snapshot

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

TODO(doc): @quake

fn timestamp_and_parent(&self, block_hash: &Byte32) -> (u64, u64, Byte32)

Return timestamp and block_number of the corresponding block_hash, and hash of parent block

fn block_median_time(
    &self,
    block_hash: &Byte32,
    median_block_count: usize
) -> u64

Return past block median time, including the timestamp of the given one