Struct zebra_state::request::ContextuallyVerifiedBlock

pub struct ContextuallyVerifiedBlock {
    pub(crate) block: Arc<Block>,
    pub(crate) hash: Hash,
    pub(crate) height: Height,
    pub(crate) new_outputs: HashMap<OutPoint, OrderedUtxo>,
    pub(crate) spent_outputs: HashMap<OutPoint, OrderedUtxo>,
    pub(crate) transaction_hashes: Arc<[Hash]>,
    pub(crate) chain_value_pool_change: ValueBalance<NegativeAllowed>,
}

A contextually verified block, ready to be committed directly to the finalized state with no checks, if it becomes the root of the best non-finalized chain.

Used by the state service and non-finalized Chain.

Note: The difference between a CheckpointVerifiedBlock and a ContextuallyVerifiedBlock is that the CheckpointVerifier doesn’t bind the transaction authorizing data to the ChainHistoryBlockTxAuthCommitmentHash, but the NonFinalizedState and FinalizedState do.

Fields

block: Arc<Block>

The block to commit to the state.

hash: Hash

The hash of the block.

height: Height

The height of the block.

new_outputs: HashMap<OutPoint, OrderedUtxo>

New transparent outputs created in this block, indexed by OutPoint.

Note: although these transparent outputs are newly created, they may not be unspent, since a later transaction in a block can spend outputs of an earlier transaction.

This field can also contain unrelated outputs, which are ignored.

spent_outputs: HashMap<OutPoint, OrderedUtxo>

The outputs spent by this block, indexed by the transparent::Input’s OutPoint.

Note: these inputs can come from earlier transactions in this block, or earlier blocks in the chain.

This field can also contain unrelated outputs, which are ignored.

transaction_hashes: Arc<[Hash]>

A precomputed list of the hashes of the transactions in this block, in the same order as block.transactions.

chain_value_pool_change: ValueBalance<NegativeAllowed>

The sum of the chain value pool changes of all transactions in this block.

Implementations

impl ContextuallyVerifiedBlock

pub fn test_with_zero_spent_utxos( block: impl Into<SemanticallyVerifiedBlock> ) -> Self

Create a block that’s ready for non-finalized Chain contextual validation, using a SemanticallyVerifiedBlock and fake zero-valued spent UTXOs.

Only for use in tests.

pub fn test_with_chain_pool_change( block: impl Into<SemanticallyVerifiedBlock>, fake_chain_value_pool_change: ValueBalance<NegativeAllowed> ) -> Self

Create a ContextuallyVerifiedBlock from a Block or SemanticallyVerifiedBlock, using a fake chain value pool change.

Only for use in tests.

pub fn test_with_zero_chain_pool_change( block: impl Into<SemanticallyVerifiedBlock> ) -> Self

Create a ContextuallyVerifiedBlock from a Block or SemanticallyVerifiedBlock, with no chain value pool change.

Only for use in tests.

impl ContextuallyVerifiedBlock

pub fn with_block_and_spent_utxos( semantically_verified: SemanticallyVerifiedBlock, spent_outputs: HashMap<OutPoint, OrderedUtxo> ) -> Result<Self, ValueBalanceError>

Create a block that’s ready for non-finalized Chain contextual validation, using a SemanticallyVerifiedBlock and the UTXOs it spends.

When combined, semantically_verified.new_outputs and spent_utxos must contain the Utxos spent by every transparent input in this block, including UTXOs created by earlier transactions in this block.

Note: a ContextuallyVerifiedBlock isn’t actually contextually valid until Chain::push() returns success.

Trait Implementations

impl Clone for ContextuallyVerifiedBlock

fn clone(&self) -> ContextuallyVerifiedBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContextuallyVerifiedBlock

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

Formats the value using the given formatter.

impl From<ContextuallyVerifiedBlock> for ChainTipBlock

fn from(contextually_valid: ContextuallyVerifiedBlock) -> Self

Converts to this type from the input type.

impl From<ContextuallyVerifiedBlock> for SemanticallyVerifiedBlock

fn from(contextually_valid: ContextuallyVerifiedBlock) -> Self

Converts to this type from the input type.

impl PartialEq for ContextuallyVerifiedBlock

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

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

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.

impl UpdateWith<ContextuallyVerifiedBlock> for Chain

fn update_chain_tip_with( &mut self, contextually_valid: &ContextuallyVerifiedBlock ) -> Result<(), ValidateContextError>

When T is added to the chain tip, update Chain cumulative data members to add data that are derived from T.

fn revert_chain_with( &mut self, contextually_valid: &ContextuallyVerifiedBlock, position: RevertPosition )

When T is removed from position in the chain, revert Chain cumulative data members to remove data that are derived from T.

impl Eq for ContextuallyVerifiedBlock

impl StructuralPartialEq for ContextuallyVerifiedBlock