Struct TransactionRequest

pub struct TransactionRequest { /* private fields */ }

Specifies a transaction request that can be executed by an account.

A request contains information about input notes to be consumed by the transaction (if any), description of the transaction script to be executed (if any), and a set of notes expected to be generated by the transaction or by consuming notes generated by the transaction.

Implementations

impl TransactionRequest

pub fn unauthenticated_input_notes(&self) -> &[Note]

Returns a reference to the transaction request’s unauthenticated note list.

pub fn unauthenticated_input_note_ids( &self, ) -> impl Iterator<Item = NoteId> + '_

Returns an iterator over unauthenticated note IDs for the transaction request.

pub fn authenticated_input_note_ids(&self) -> impl Iterator<Item = NoteId> + '_

Returns an iterator over authenticated input note IDs for the transaction request.

pub fn input_notes(&self) -> &BTreeMap<NoteId, Option<NoteArgs>>

Returns a mapping for input note IDs and their optional NoteArgs.

pub fn get_input_note_ids(&self) -> Vec<NoteId>

Returns a list of all input note IDs.

pub fn get_note_args(&self) -> BTreeMap<NoteId, NoteArgs>

Returns a map of note IDs to their respective NoteArgs. The result will include exclusively note IDs for notes for which NoteArgs have been defined.

pub fn expected_output_notes(&self) -> impl Iterator<Item = &Note>

Returns an iterator over the expected output notes.

pub fn expected_future_notes( &self, ) -> impl Iterator<Item = &(NoteDetails, NoteTag)>

Returns an iterator over expected future notes.

pub fn script_template(&self) -> &Option<TransactionScriptTemplate>

Returns the TransactionScriptTemplate.

pub fn advice_map(&self) -> &AdviceMap

Returns the AdviceMap for the transaction request.

pub fn merkle_store(&self) -> &MerkleStore

Returns the MerkleStore for the transaction request.

pub fn foreign_accounts(&self) -> &BTreeSet<ForeignAccount>

Returns the IDs of the required foreign accounts for the transaction request.

pub fn ignore_invalid_input_notes(&self) -> bool

Returns whether to ignore invalid input notes or not.

Trait Implementations

impl Clone for TransactionRequest

fn clone(&self) -> TransactionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionRequest

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

Formats the value using the given formatter.

impl Deserializable for TransactionRequest

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 TransactionRequest

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

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 TransactionRequest

impl StructuralPartialEq for TransactionRequest