Struct ProvenBatch 

pub struct ProvenBatch { /* private fields */ }

A transaction batch with an execution proof.

Implementations

impl ProvenBatch

pub fn new( id: BatchId, reference_block_commitment: Word, reference_block_num: BlockNumber, account_updates: BTreeMap<AccountId, BatchAccountUpdate>, input_notes: InputNotes<InputNoteCommitment>, output_notes: Vec<OutputNote>, batch_expiration_block_num: BlockNumber, transactions: OrderedTransactionHeaders, ) -> Result<Self, ProvenBatchError>

Creates a new ProvenBatch from the provided parts.

Errors

Returns an error if the batch expiration block number is not greater than the reference block number.

pub fn id(&self) -> BatchId

The ID of this batch. See BatchId for details on how it is computed.

pub fn reference_block_commitment(&self) -> Word

Returns the commitment to the reference block of the batch.

pub fn reference_block_num(&self) -> BlockNumber

Returns the number of the reference block of the batch.

pub fn batch_expiration_block_num(&self) -> BlockNumber

Returns the block number at which the batch will expire.

pub fn updated_accounts(&self) -> impl Iterator<Item = AccountId> + use<'_>

Returns an iterator over the IDs of all accounts updated in this batch.

pub fn proof_security_level(&self) -> u32

Returns the proof security level of the batch.

pub fn account_updates(&self) -> &BTreeMap<AccountId, BatchAccountUpdate>

Returns the map of account IDs mapped to their BatchAccountUpdates.

If an account was updated by multiple transactions, the BatchAccountUpdate is the result of merging the individual updates.

For example, suppose an account’s state before this batch is A and the batch contains two transactions that updated it. Applying the first transaction results in intermediate state B, and applying the second one results in state C. Then the returned update represents the state transition from A to C.

pub fn input_notes(&self) -> &InputNotes<InputNoteCommitment>

Returns the InputNotes of this batch.

pub fn created_nullifiers(&self) -> impl Iterator<Item = Nullifier> + use<'_>

Returns an iterator over the nullifiers created in this batch.

pub fn output_notes(&self) -> &[OutputNote]

Returns the output notes of the batch.

This is the aggregation of all output notes by the transactions in the batch, except the ones that were consumed within the batch itself.

pub fn transactions(&self) -> &OrderedTransactionHeaders

Returns the OrderedTransactionHeaders included in this batch.

pub fn into_transactions(self) -> OrderedTransactionHeaders

Consumes self and returns the contained OrderedTransactionHeaders of this batch.

Trait Implementations

impl Clone for ProvenBatch

fn clone(&self) -> ProvenBatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProvenBatch

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

Formats the value using the given formatter.

impl Deserializable for ProvenBatch

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for ProvenBatch

fn eq(&self, other: &ProvenBatch) -> 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 Serializable for ProvenBatch

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for ProvenBatch

impl StructuralPartialEq for ProvenBatch