Struct Block 

pub struct Block<N>
where
    N: Network,
{ /* private fields */ }

Implementations

impl<N> Block<N>

where N: Network,

pub const NUM_GENESIS_TRANSACTIONS: usize = 4usize

Specifies the number of genesis transactions.

pub fn is_genesis(&self) -> Result<bool, Error>

Returns true if the block is a genesis block.

impl<N> Block<N>

where N: Network,

pub fn verify( &self, previous_block: &Block<N>, current_state_root: <N as Network>::StateRoot, previous_committee_lookback: &Committee<N>, current_committee_lookback: &Committee<N>, current_puzzle: &Puzzle<N>, current_epoch_hash: <N as Network>::BlockHash, current_timestamp: i64, ratified_finalize_operations: Vec<FinalizeOperation<N>>, ) -> Result<(Vec<SolutionID<N>>, Vec<<N as Network>::TransactionID>), Error>

Ensures the block is correct.

impl<N> Block<N>

where N: Network,

pub fn new_beacon<R>( private_key: &PrivateKey<N>, previous_hash: <N as Network>::BlockHash, header: Header<N>, ratifications: Ratifications<N>, solutions: Solutions<N>, aborted_solution_ids: Vec<SolutionID<N>>, transactions: Transactions<N>, aborted_transaction_ids: Vec<<N as Network>::TransactionID>, rng: &mut R, ) -> Result<Block<N>, Error>

where R: Rng + CryptoRng,

Initializes a new beacon block from the given previous block hash, block header, ratifications, solutions, transactions, and aborted transaction IDs.

pub fn new_quorum( previous_hash: <N as Network>::BlockHash, header: Header<N>, subdag: Subdag<N>, ratifications: Ratifications<N>, solutions: Solutions<N>, aborted_solution_ids: Vec<SolutionID<N>>, transactions: Transactions<N>, aborted_transaction_ids: Vec<<N as Network>::TransactionID>, ) -> Result<Block<N>, Error>

Initializes a new quorum block from the given previous block hash, block header, subdag, ratifications, solutions, transactions, and aborted transaction IDs.

pub fn from( previous_hash: <N as Network>::BlockHash, header: Header<N>, authority: Authority<N>, ratifications: Ratifications<N>, solutions: Solutions<N>, aborted_solution_ids: Vec<SolutionID<N>>, transactions: Transactions<N>, aborted_transaction_ids: Vec<<N as Network>::TransactionID>, ) -> Result<Block<N>, Error>

Initializes a new block from the given previous block hash, block header, authority, ratifications, solutions, aborted solution IDs, transactions, and aborted transaction IDs.

pub fn from_unchecked( block_hash: <N as Network>::BlockHash, previous_hash: <N as Network>::BlockHash, header: Header<N>, authority: Authority<N>, ratifications: Ratifications<N>, solutions: Solutions<N>, aborted_solution_ids: Vec<SolutionID<N>>, transactions: Transactions<N>, aborted_transaction_ids: Vec<<N as Network>::TransactionID>, ) -> Result<Block<N>, Error>

Initializes a new block from the given block hash, previous block hash, block header, authority, ratifications, solutions, transactions, and aborted transaction IDs.

This function does not perform any checks on the given data, and should only be called if the inputs are trusted.

impl<N> Block<N>

where N: Network,

pub const fn hash(&self) -> <N as Network>::BlockHash

Returns the block hash.

pub const fn previous_hash(&self) -> <N as Network>::BlockHash

Returns the previous block hash.

pub const fn authority(&self) -> &Authority<N>

Returns the authority.

pub const fn ratifications(&self) -> &Ratifications<N>

Returns the ratifications in this block.

pub const fn solutions(&self) -> &Solutions<N>

Returns the solutions in the block.

pub const fn aborted_solution_ids(&self) -> &Vec<SolutionID<N>>

Returns the aborted solution IDs in this block.

pub const fn transactions(&self) -> &Transactions<N>

Returns the transactions in this block.

pub const fn aborted_transaction_ids( &self, ) -> &Vec<<N as Network>::TransactionID>

Returns the aborted transaction IDs in this block.

impl<N> Block<N>

where N: Network,

pub const fn header(&self) -> &Header<N>

Returns the block header.

pub const fn previous_state_root(&self) -> <N as Network>::StateRoot

Returns the previous state root from the block header.

pub const fn transactions_root(&self) -> Field<N>

Returns the transactions root in the block header.

pub const fn finalize_root(&self) -> Field<N>

Returns the finalize root in the block header.

pub const fn ratifications_root(&self) -> Field<N>

Returns the ratifications root in the block header.

pub const fn solutions_root(&self) -> Field<N>

Returns the solutions root in the block header.

pub const fn metadata(&self) -> &Metadata<N>

Returns the metadata in the block header.

pub const fn network(&self) -> u16

Returns the network ID of this block.

pub const fn height(&self) -> u32

Returns the height of this block.

pub const fn round(&self) -> u64

Returns the round number of this block.

pub const fn epoch_number(&self) -> u32

Returns the epoch number of this block.

pub const fn cumulative_weight(&self) -> u128

Returns the cumulative weight for this block.

pub const fn cumulative_proof_target(&self) -> u128

Returns the cumulative proof target for this block.

pub const fn coinbase_target(&self) -> u64

Returns the coinbase target for this block.

pub const fn proof_target(&self) -> u64

Returns the proof target for this block.

pub const fn last_coinbase_target(&self) -> u64

Returns the coinbase target of the last coinbase.

pub const fn last_coinbase_timestamp(&self) -> i64

Returns the block timestamp of the last coinbase.

pub const fn timestamp(&self) -> i64

Returns the Unix timestamp (UTC) for this block.

impl<N> Block<N>

where N: Network,

pub fn contains_transition( &self, transition_id: &<N as Network>::TransitionID, ) -> bool

Returns true if the block contains the given transition ID.

pub fn contains_serial_number(&self, serial_number: &Field<N>) -> bool

Returns true if the block contains the given serial number.

pub fn contains_commitment(&self, commitment: &Field<N>) -> bool

Returns true if the block contains the given commitment.

impl<N> Block<N>

where N: Network,

pub fn get_solution(&self, solution_id: &SolutionID<N>) -> Option<&Solution<N>>

Returns the solution with the given solution ID, if it exists.

pub fn get_transaction( &self, transaction_id: &<N as Network>::TransactionID, ) -> Option<&Transaction<N>>

Returns the transaction with the given transaction ID, if it exists.

pub fn get_confirmed_transaction( &self, transaction_id: &<N as Network>::TransactionID, ) -> Option<&ConfirmedTransaction<N>>

Returns the confirmed transaction with the given transaction ID, if it exists.

impl<N> Block<N>

where N: Network,

pub fn find_transaction_for_transition_id( &self, transition_id: &<N as Network>::TransitionID, ) -> Option<&Transaction<N>>

Returns the transaction with the given transition ID, if it exists.

pub fn find_transaction_for_serial_number( &self, serial_number: &Field<N>, ) -> Option<&Transaction<N>>

Returns the transaction with the given serial number, if it exists.

pub fn find_transaction_for_commitment( &self, commitment: &Field<N>, ) -> Option<&Transaction<N>>

Returns the transaction with the given commitment, if it exists.

pub fn find_transition( &self, transition_id: &<N as Network>::TransitionID, ) -> Option<&Transition<N>>

Returns the transition with the corresponding transition ID, if it exists.

pub fn find_transition_for_serial_number( &self, serial_number: &Field<N>, ) -> Option<&Transition<N>>

Returns the transition for the given serial number, if it exists.

pub fn find_transition_for_commitment( &self, commitment: &Field<N>, ) -> Option<&Transition<N>>

Returns the transition for the given commitment, if it exists.

pub fn find_record( &self, commitment: &Field<N>, ) -> Option<&Record<N, Ciphertext<N>>>

Returns the record with the corresponding commitment, if it exists.

impl<N> Block<N>

where N: Network,

pub fn solution_ids(&self) -> Option<impl Iterator<Item = &SolutionID<N>>>

Returns an iterator over the solution IDs in this block.

pub fn transaction_ids( &self, ) -> impl Iterator<Item = &<N as Network>::TransactionID>

Returns an iterator over the transaction IDs, for all transactions in self.

pub fn deployments(&self) -> impl Iterator<Item = &ConfirmedTransaction<N>>

Returns an iterator over all transactions in self that are accepted deploy transactions.

pub fn executions(&self) -> impl Iterator<Item = &ConfirmedTransaction<N>>

Returns an iterator over all transactions in self that are accepted execute transactions.

pub fn transitions(&self) -> impl Iterator<Item = &Transition<N>>

Returns an iterator over all transitions.

pub fn transition_ids( &self, ) -> impl Iterator<Item = &<N as Network>::TransitionID>

Returns an iterator over the transition IDs, for all transitions.

pub fn transition_public_keys(&self) -> impl Iterator<Item = &Group<N>>

Returns an iterator over the transition public keys, for all transactions.

pub fn transition_commitments(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the transition commitments, for all transactions.

pub fn tags(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the tags, for all transition inputs that are records.

pub fn input_ids(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the input IDs, for all transition inputs that are records.

pub fn serial_numbers(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the serial numbers, for all transition inputs that are records.

pub fn output_ids(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the output IDs, for all transition inputs that are records.

pub fn commitments(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the commitments, for all transition outputs that are records.

pub fn records( &self, ) -> impl Iterator<Item = (&Field<N>, &Record<N, Ciphertext<N>>)>

Returns an iterator over the records, for all transition outputs that are records.

pub fn nonces(&self) -> impl Iterator<Item = &Group<N>>

Returns an iterator over the nonces, for all transition outputs that are records.

pub fn transaction_fee_amounts( &self, ) -> impl Iterator<Item = Result<Integer<N, u64>, Error>>

Returns an iterator over the transaction fee amounts, for all transactions.

impl<N> Block<N>

where N: Network,

pub fn into_transaction_ids( self, ) -> impl Iterator<Item = <N as Network>::TransactionID>

Returns a consuming iterator over the transaction IDs, for all transactions in self.

pub fn into_deployments(self) -> impl Iterator<Item = ConfirmedTransaction<N>>

Returns a consuming iterator over all transactions in self that are accepted deploy transactions.

pub fn into_executions(self) -> impl Iterator<Item = ConfirmedTransaction<N>>

Returns a consuming iterator over all transactions in self that are accepted execute transactions.

pub fn into_transitions(self) -> impl Iterator<Item = Transition<N>>

Returns a consuming iterator over all transitions.

pub fn into_transition_ids( self, ) -> impl Iterator<Item = <N as Network>::TransitionID>

Returns a consuming iterator over the transition IDs, for all transitions.

pub fn into_transition_public_keys(self) -> impl Iterator<Item = Group<N>>

Returns a consuming iterator over the transition public keys, for all transactions.

pub fn into_tags(self) -> impl Iterator<Item = Field<N>>

Returns a consuming iterator over the tags, for all transition inputs that are records.

pub fn into_serial_numbers(self) -> impl Iterator<Item = Field<N>>

Returns a consuming iterator over the serial numbers, for all transition inputs that are records.

pub fn into_commitments(self) -> impl Iterator<Item = Field<N>>

Returns a consuming iterator over the commitments, for all transition outputs that are records.

pub fn into_records( self, ) -> impl Iterator<Item = (Field<N>, Record<N, Ciphertext<N>>)>

Returns a consuming iterator over the records, for all transition outputs that are records.

pub fn into_nonces(self) -> impl Iterator<Item = Group<N>>

Returns a consuming iterator over the nonces, for all transition outputs that are records.

Trait Implementations

impl<N> Clone for Block<N>

where N: Clone + Network, <N as Network>::BlockHash: Clone, <N as Network>::TransactionID: Clone,

fn clone(&self) -> Block<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Block<N>

where N: Network,

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

Prints the block as a JSON-string.

impl<'de, N> Deserialize<'de> for Block<N>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<Block<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the block from a JSON-string or buffer.

impl<N> Display for Block<N>

where N: Network,

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

Displays the block as a JSON-string.

impl<N> FromBytes for Block<N>

where N: Network,

fn read_le_with_unchecked<R>( reader: R, unchecked: bool, ) -> Result<Block<N>, Error>

where R: Read,

Read the block either with or without checking the data.

fn read_le<R>(reader: R) -> Result<Block<N>, Error>

where R: Read,

Reads the block from the buffer.

fn read_le_unchecked<R>(reader: R) -> Result<Block<N>, Error>

where R: Read,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

impl<N> FromStr for Block<N>

where N: Network,

fn from_str(block: &str) -> Result<Block<N>, <Block<N> as FromStr>::Err>

Initializes the block from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> PartialEq for Block<N>

where N: PartialEq + Network, <N as Network>::BlockHash: PartialEq, <N as Network>::TransactionID: PartialEq,

fn eq(&self, other: &Block<N>) -> 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<N> Serialize for Block<N>

where N: Network,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serializes the block to a JSON-string or buffer.

impl<N> ToBytes for Block<N>

where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes the block to the buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> Eq for Block<N>

where N: Eq + Network, <N as Network>::BlockHash: Eq, <N as Network>::TransactionID: Eq,

impl<N> StructuralPartialEq for Block<N>

where N: Network,