Skip to main content

ConsensusProof

Struct ConsensusProof 

Source
pub struct ConsensusProof;
Expand description

Consensus Proof - wrapper struct for consensus validation functions

This struct provides a convenient API for accessing all consensus validation functions. All methods delegate to the corresponding module functions.

Implementations§

Source§

impl ConsensusProof

Source

pub fn new() -> Self

Create a new ConsensusProof instance

Source

pub fn validate_transaction(&self, tx: &Transaction) -> Result<ValidationResult>

Spec-locked to Orange Paper Section 5.1: ValidateTransaction

Function ‘ValidateTransaction’ referenced but not yet in spec section 5.1 (Migration mode). Available: CheckTransaction, CheckTxInputs Validate a transaction according to consensus rules

Source

pub fn validate_tx_inputs( &self, tx: &Transaction, utxo_set: &UtxoSet, height: Natural, ) -> Result<(ValidationResult, Integer)>

Spec-locked to Orange Paper Section 5.1: ValidateTxInputs

Function ‘ValidateTxInputs’ referenced but not yet in spec section 5.1 (Migration mode). Available: CheckTransaction, CheckTxInputs Validate transaction inputs against UTXO set

Source

pub fn validate_block( &self, block: &Block, utxo_set: UtxoSet, height: Natural, ) -> Result<(ValidationResult, UtxoSet)>

Spec-locked to Orange Paper Section 5.3: ValidateBlock

Function ‘ValidateBlock’ referenced but not yet in spec section 5.3 (Migration mode). Available: ConnectBlock Validate a complete block

Source

pub fn validate_block_with_time_context( &self, block: &Block, witnesses: &[Vec<Witness>], utxo_set: UtxoSet, height: Natural, time_context: Option<TimeContext>, network: Network, ) -> Result<(ValidationResult, UtxoSet)>

Spec-locked to Orange Paper Section 5.3: ValidateBlockWithTimeContext

Function ‘ValidateBlockWithTimeContext’ referenced but not yet in spec section 5.3 (Migration mode). Available: ConnectBlock Validate a complete block with witness data and time context

Source

pub fn verify_script( &self, script_sig: &ByteString, script_pubkey: &ByteString, witness: Option<&ByteString>, flags: u32, ) -> Result<bool>

Spec-locked to Orange Paper Section 5.2: VerifyScript

Verify script execution

Source

pub fn check_proof_of_work(&self, header: &BlockHeader) -> Result<bool>

Spec-locked to Orange Paper Section 7.2: CheckProofOfWork

Check proof of work

Source

pub fn get_block_subsidy(&self, height: Natural) -> Integer

Spec-locked to Orange Paper Section 6.1: GetBlockSubsidy

Get block subsidy for height

Source

pub fn total_supply(&self, height: Natural) -> Integer

Spec-locked to Orange Paper Section 6.2: TotalSupply

Calculate total supply at height

Source

pub fn get_next_work_required( &self, current_header: &BlockHeader, prev_headers: &[BlockHeader], ) -> Result<Natural>

Spec-locked to Orange Paper Section 7.1: GetNextWorkRequired

Get next work required for difficulty adjustment

Source

pub fn accept_to_memory_pool( &self, tx: &Transaction, utxo_set: &UtxoSet, mempool: &Mempool, height: Natural, time_context: Option<TimeContext>, ) -> Result<MempoolResult>

Spec-locked to Orange Paper Section 9.1: AcceptToMemoryPool

Accept transaction to memory pool

Source

pub fn is_standard_tx(&self, tx: &Transaction) -> Result<bool>

Spec-locked to Orange Paper Section 9.2: IsStandardTx

Check if transaction is standard

Source

pub fn replacement_checks( &self, new_tx: &Transaction, existing_tx: &Transaction, utxo_set: &UtxoSet, mempool: &Mempool, ) -> Result<bool>

Spec-locked to Orange Paper Section 9.3: ReplacementChecks

Check if transaction can replace existing one (RBF)

Source

pub fn create_new_block( &self, utxo_set: &UtxoSet, mempool_txs: &[Transaction], height: Natural, prev_header: &BlockHeader, prev_headers: &[BlockHeader], coinbase_script: &ByteString, coinbase_address: &ByteString, ) -> Result<Block>

Spec-locked to Orange Paper Section 12.1: CreateNewBlock

Create new block from mempool transactions

Source

pub fn mine_block( &self, block: Block, max_attempts: Natural, ) -> Result<(Block, MiningResult)>

Spec-locked to Orange Paper Section 12.3: MineBlock

Mine a block by finding valid nonce

Source

pub fn create_block_template( &self, utxo_set: &UtxoSet, mempool_txs: &[Transaction], height: Natural, prev_header: &BlockHeader, prev_headers: &[BlockHeader], coinbase_script: &ByteString, coinbase_address: &ByteString, ) -> Result<BlockTemplate>

Spec-locked to Orange Paper Section 12.1: CreateBlockTemplate

Function ‘CreateBlockTemplate’ referenced but not yet in spec section 12.1 (Migration mode). Available: CreateNewBlock Create block template for mining

Source

pub fn reorganize_chain( &self, new_chain: &[Block], current_chain: &[Block], current_utxo_set: UtxoSet, current_height: Natural, network: Network, ) -> Result<ReorganizationResult>

Spec-locked to Orange Paper Section 11.3: ReorganizeChain

Function ‘ReorganizeChain’ referenced but not yet in spec section 11.3 (Migration mode). Available: Reorganization Reorganize chain when longer chain is found

Source

pub fn should_reorganize( &self, new_chain: &[Block], current_chain: &[Block], ) -> Result<bool>

Spec-locked to Orange Paper Section 11.3: ShouldReorganize

Function ‘ShouldReorganize’ referenced but not yet in spec section 11.3 (Migration mode). Available: Reorganization Check if reorganization is beneficial

Source

pub fn calculate_transaction_weight( &self, tx: &Transaction, witness: Option<&Witness>, ) -> Result<Natural>

Spec-locked to Orange Paper Section 11.1.1: CalculateTransactionWeight

Calculate transaction weight for SegWit

Source

pub fn validate_segwit_block( &self, block: &Block, witnesses: &[Witness], max_block_weight: Natural, ) -> Result<bool>

Spec-locked to Orange Paper Section 11.1.7: ValidateSegWitBlock

Validate SegWit block

Source

pub fn validate_taproot_transaction( &self, tx: &Transaction, witness: Option<&Witness>, ) -> Result<bool>

Spec-locked to Orange Paper Section 11.2.5: ValidateTaprootTransaction

Validate Taproot transaction

Source

pub fn is_taproot_output(&self, output: &TransactionOutput) -> bool

Spec-locked to Orange Paper Section 11.2.1: IsTaprootOutput

Check if transaction output is Taproot

Trait Implementations§

Source§

impl Clone for ConsensusProof

Source§

fn clone(&self) -> ConsensusProof

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConsensusProof

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ConsensusProof

Source§

fn default() -> ConsensusProof

Returns the “default value” for a type. Read more
Source§

impl Copy for ConsensusProof

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V