Struct TransactionSummary

pub struct TransactionSummary<AccountId> { /* private fields */ }

Available on crate feature test-dependencies only.

Information about a transaction that the wallet is interested in.

Implementations

impl<AccountId> TransactionSummary<AccountId>

pub fn from_parts( account_id: AccountId, txid: TxId, expiry_height: Option<BlockHeight>, mined_height: Option<BlockHeight>, account_value_delta: ZatBalance, total_spent: Zatoshis, total_received: Zatoshis, fee_paid: Option<Zatoshis>, spent_note_count: usize, has_change: bool, sent_note_count: usize, received_note_count: usize, memo_count: usize, expired_unmined: bool, is_shielding: bool, ) -> Self

Constructs a TransactionSummary from its parts.

See the documentation for each getter method below to determine how each method argument should be prepared.

pub fn account_id(&self) -> &AccountId

Returns the wallet-internal ID for the account that this transaction was received by or sent from.

pub fn txid(&self) -> TxId

Returns the transaction’s ID.

pub fn expiry_height(&self) -> Option<BlockHeight>

Returns the expiry height of the transaction, if known.

• None means that the expiry height is unknown.
• Some(0) means that the transaction does not expire.

pub fn mined_height(&self) -> Option<BlockHeight>

Returns the height of the mined block containing this transaction, or None if the wallet has not yet observed the transaction to be mined.

pub fn account_value_delta(&self) -> ZatBalance

Returns the net change in balance that this transaction caused to the account.

For example, an account-internal transaction (such as a shielding operation) would show -fee_paid as the account value delta.

pub fn total_spent(&self) -> Zatoshis

Returns the total value of notes spent by the account in this transaction.

pub fn total_received(&self) -> Zatoshis

Returns the total value of notes received by the account in this transaction.

pub fn fee_paid(&self) -> Option<Zatoshis>

Returns the fee paid by this transaction, if known.

pub fn spent_note_count(&self) -> usize

Returns the number of notes spent by the account in this transaction.

pub fn has_change(&self) -> bool

Returns true if the account received a change note as part of this transaction.

This implies that the transaction was (at least in part) sent from the account.

pub fn sent_note_count(&self) -> usize

Returns the number of notes created in this transaction that were sent to a wallet-external address.

pub fn received_note_count(&self) -> usize

Returns the number of notes created in this transaction that were received by the account.

pub fn expired_unmined(&self) -> bool

Returns true if, from the wallet’s current view of the chain, this transaction expired before it was mined.

pub fn memo_count(&self) -> usize

Returns the number of non-empty memos viewable by the account in this transaction.

pub fn is_shielding(&self) -> bool

Returns true if this is detectably a shielding transaction.

Specifically, true means that at a minimum:

• All of the wallet-spent and wallet-received notes are consistent with a shielding transaction.
• The transaction contains at least one wallet-spent output.
• The transaction contains at least one wallet-received note.
• We do not know about any external outputs of the transaction.

There may be some shielding transactions for which this method returns false, due to them not being detectable by the wallet as shielding transactions under the above metrics.