Struct ckb_shared::Snapshot

source · [−]

pub struct Snapshot { /* private fields */ }

Expand description

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

Implementations

source

impl Snapshot

source

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

source

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.

source

pub fn tip_header(&self) -> &HeaderView

Return reference of tip header

source

pub fn tip_number(&self) -> u64

Return tip header number

source

pub fn tip_hash(&self) -> Byte32

Return tip header hash

source

pub fn epoch_ext(&self) -> &EpochExt

Return current epoch information

source

pub fn consensus(&self) -> &Consensus

Return reference of Consensus

source

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

Makes a clone of the Arc<Consensus>

source

pub fn proposals(&self) -> &ProposalView

Return reference of proposals view

source

pub fn total_difficulty(&self) -> &U256

Return current best chain total_difficulty

source

pub fn compute_versionbits(&self, parent: &HeaderView) -> Option<u32>

Returns what version a new block should use.

source

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

Returns specified softfork active or not

source

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

Returns the chain root MMR for a provided block.

Trait Implementations

source

impl CellChecker for Snapshot

source

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

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

source

impl CellProvider for Snapshot

source

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

TODO(doc): @quake

source

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

type Vector = DBPinnableSlice<'a>

TODO(doc): @quake

source

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

TODO(doc): @quake

source

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.

source

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

Return freezer reference

source

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

TODO(doc): @quake

source

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

TODO(doc): @quake

source

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

Gets current epoch ext

source

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

Return the provider trait default implementation

source

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

Get block by block header hash

source

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

Get header by block header hash

source

fn get_block_body(&'a self, hash: &Byte32) -> Vec<TransactionView, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Get block body by block header hash

source

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

Get unfrozen block from ky-store with given hash

source

fn get_block_txs_hashes(&'a self, hash: &Byte32) -> Vec<Byte32, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

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

source

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

Get proposal short id by block header hash

source

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

Get block uncles by block header hash

source

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

Get block extension by block header hash

source

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

Get block ext by block header hash

source

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

Get block header hash by block number

source

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

Get block number by block header hash

source

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

TODO(doc): @quake

source

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

Returns true if the transaction confirmed in main chain. Read more

source

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

Get commit transaction and block hash by its hash

source

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

TODO(doc): @quake

source

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

Gets transaction and associated info with correspond hash

source

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

Return whether cell is live

source

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

Gets cell meta data with out_point

source

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

TODO(doc): @quake

source

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

TODO(doc): @quake

source

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

Gets epoch ext by epoch index

source

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

Gets epoch index by epoch number

source

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

Gets epoch index by block hash

source

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

TODO(doc): @quake

source

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

TODO(doc): @quake

source

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

Gets header by uncle header hash

source

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

TODO(doc): @quake

source

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

Gets cellbase by block hash

source

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

Gets latest built filter data block hash

source

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

Gets block filter data by block hash

source

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

TODO(doc): @quake

source

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

TODO(doc): @quake

source

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

Gets a header digest.

source

impl ConsensusProvider for Snapshot

source

fn get_consensus(&self) -> &Consensus

Returns the Consensus.

source

impl Debug for Snapshot

source

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

Formats the value using the given formatter. Read more

source

impl Hash for Snapshot

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl HeaderChecker for Snapshot

source

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

Check if header in main chain

source

impl HeaderProvider for Snapshot

source

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

Get the header of the given block hash

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

Get 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

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

source

impl MMRStore<HeaderDigest> for &Snapshot

source

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

source

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

source

impl PartialEq<Snapshot> for Snapshot

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl VersionbitsIndexer for Snapshot

source

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

Gets epoch index by block hash

source

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

Gets epoch ext by index

source

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

Gets block header by block hash

source

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

Gets cellbase by block hash

source

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

Gets ancestor of specified epoch.

source

impl Eq for Snapshot

Auto Trait Implementations

impl !RefUnwindSafe for Snapshot

impl Send for Snapshot

impl Sync for Snapshot

impl Unpin for Snapshot

impl !UnwindSafe for Snapshot

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsAny for Twhere
T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

TODO(doc): @quake

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for Twhere
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ckb_shared::Snapshot

Implementations

impl Snapshot

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

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

pub fn tip_header(&self) -> &HeaderView

pub fn tip_number(&self) -> u64

pub fn tip_hash(&self) -> Byte32

pub fn epoch_ext(&self) -> &EpochExt

pub fn consensus(&self) -> &Consensus

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

pub fn proposals(&self) -> &ProposalView

pub fn total_difficulty(&self) -> &U256

pub fn compute_versionbits(&self, parent: &HeaderView) -> Option<u32>

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

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

Trait Implementations

impl CellChecker for Snapshot

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

impl CellProvider for Snapshot

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

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

type Vector = DBPinnableSlice<'a>

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

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

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

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

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

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

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

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

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

fn get_block_body(&'a self, hash: &Byte32) -> Vec<TransactionView, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

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

fn get_block_txs_hashes(&'a self, hash: &Byte32) -> Vec<Byte32, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl ConsensusProvider for Snapshot

fn get_consensus(&self) -> &Consensus

impl Debug for Snapshot

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

impl Hash for Snapshot

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

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

impl HeaderChecker for Snapshot

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

impl HeaderProvider for Snapshot

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

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

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

impl MMRStore<HeaderDigest> for &Snapshot

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

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

impl PartialEq<Snapshot> for Snapshot

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

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

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

fn get_block_body(&'a self, hash: &Byte32) -> Vec<TransactionView, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

fn get_block_txs_hashes(&'a self, hash: &Byte32) -> Vec<Byte32, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

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

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

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

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> AsAny for Twhere
T: Any,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> CallHasher for Twhere
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,