Struct TransactionPerspective

pub struct TransactionPerspective {
    pub payload_keys: BTreeMap<StateCommitment, PayloadKey>,
    pub spend_nullifiers: BTreeMap<Nullifier, Note>,
    pub advice_notes: BTreeMap<StateCommitment, Note>,
    pub address_views: Vec<AddressView>,
    pub denoms: Cache,
    pub transaction_id: TransactionId,
    pub prices: Vec<EstimatedPrice>,
    pub extended_metadata: BTreeMap<Id, Any>,
    pub creation_transaction_ids_by_nullifier: BTreeMap<Nullifier, TransactionId>,
    pub nullification_transaction_ids_by_commitment: BTreeMap<StateCommitment, TransactionId>,
    pub batch_swap_output_data: Vec<BatchSwapOutputData>,
    pub position_metadata_key: Option<PositionMetadataKey>,
}

This represents the data to understand an individual transaction without disclosing viewing keys.

Fields

payload_keys: BTreeMap<StateCommitment, PayloadKey>

List of per-action payload keys. These can be used to decrypt the notes, swaps, and memo keys in the transaction.

One-to-one correspondence between:

• Output and note,
• Swap and note (NFT),

There is not a one-to-one correspondence between SwapClaim and notes, i.e. there are two notes per SwapClaim.

For outputs, we can use the PayloadKey associated with that output to decrypt the wrapped_memo_key, which will be used to decrypt the memo in the transaction. This needs to be done only once, because there is one memo shared between all outputs.

spend_nullifiers: BTreeMap<Nullifier, Note>

Mapping of nullifiers spent in this transaction to notes.

advice_notes: BTreeMap<StateCommitment, Note>

The openings of note commitments referred to in the transaction but otherwise not included in the transaction.

address_views: Vec<AddressView>

The views of any relevant address.

denoms: Cache

Any relevant denoms for viewed assets.

transaction_id: TransactionId

The transaction ID associated with this TransactionPerspective

prices: Vec<EstimatedPrice>

Any relevant estimated prices.

extended_metadata: BTreeMap<Id, Any>

Any relevant extended metadata.

creation_transaction_ids_by_nullifier: BTreeMap<Nullifier, TransactionId>

Associates nullifiers with the transaction IDs that created the state commitments.

Allows walking backwards from a spend to the transaction that created the note.

nullification_transaction_ids_by_commitment: BTreeMap<StateCommitment, TransactionId>

Associates commitments with the transaction IDs that eventually nullified them.

Allows walking forwards from an output to the transaction that later spent it.

batch_swap_output_data: Vec<BatchSwapOutputData>

Any relevant batch swap output data.

This can be used to fill in information about swap outputs.

position_metadata_key: Option<PositionMetadataKey>

The key used to decrypt position metadata.

We leave this as optional for maximal backwards compatibility.

Implementations

impl TransactionPerspective

pub fn view_value(&self, value: Value) -> ValueView

pub fn view_note(&self, note: Note) -> NoteView

pub fn view_address(&self, address: Address) -> AddressView

pub fn get_and_view_advice_note( &self, commitment: &StateCommitment, ) -> Option<NoteView>

Trait Implementations

impl Clone for TransactionPerspective

fn clone(&self) -> TransactionPerspective

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionPerspective

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

Formats the value using the given formatter.

impl Default for TransactionPerspective

fn default() -> TransactionPerspective

Returns the “default value” for a type.

impl From<TransactionPerspective> for TransactionPerspective

fn from(msg: TransactionPerspective) -> Self

Converts to this type from the input type.

impl TryFrom<TransactionPerspective> for TransactionPerspective

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: TransactionPerspective) -> Result<Self, Self::Error>

Performs the conversion.