Struct Snapshot 

pub struct Snapshot { /* private fields */ }

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 compute_versionbits(&self, parent: &HeaderView) -> Option<u32>

Returns what version a new block should use.

pub fn versionbits_active(&self, pos: DeploymentPos) -> bool

Returns specified softfork active or not

pub fn chain_root_mmr( &self, block_number: u64, ) -> MMR<HeaderDigest, MergeHeaderDigest, &Snapshot>

Returns the chain root MMR for a provided block.

Trait Implementations

impl CellChecker for Snapshot

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

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

TODO(doc): @quake

impl ChainStore for Snapshot

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

Return cache reference

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

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

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

Return freezer reference

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

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

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

TODO(doc): @quake

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

Gets current epoch ext

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

Get block header hash by block number

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

Get block number by block header hash

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

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

Gets epoch ext by epoch index

fn get_epoch_index(&self, number: u64) -> 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: u64) -> Option<HeaderView>

Gets ancestor block header by a base block hash and number

impl ConsensusProvider for Snapshot

fn get_consensus(&self) -> &Consensus

Returns the Consensus.

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl Hash for Snapshot

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HeaderChecker for Snapshot

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

Check if header in main chain

impl HeaderFieldsProvider for Snapshot

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

Get the header fields of the given block hash

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

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

impl HeaderProvider for Snapshot

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

Get the header of the given block hash

impl MMRStore<HeaderDigest> for &Snapshot

fn get_elem(&self, pos: u64) -> Result<Option<HeaderDigest>, Error>

fn append(&mut self, _pos: u64, _elems: Vec<HeaderDigest>) -> Result<(), Error>

impl PartialEq for Snapshot

fn eq(&self, other: &Snapshot) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VersionbitsIndexer for Snapshot

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.

impl Eq for Snapshot