Struct monero_wallet::WalletOutput

pub struct WalletOutput { /* private fields */ }

A scanned output and all associated data.

This struct contains all data necessary to spend this output, or handle it as a payment.

This struct is bound to a specific instance of the blockchain. If the blockchain reorganizes the block this struct is bound to, it MUST be discarded. If any outputs are mutual to both blockchains, scanning the new blockchain will yield those outputs again.

Implementations

impl WalletOutput

pub fn transaction(&self) -> [u8; 32]

The hash of the transaction which created this output.

pub fn index_in_transaction(&self) -> u32

The index of the output within the transaction.

pub fn index_on_blockchain(&self) -> u64

The index of the output on the blockchain.

pub fn key(&self) -> EdwardsPoint

The key this output may be spent by.

pub fn key_offset(&self) -> Scalar

The scalar to add to the private spend key for it to be the discrete logarithm of this output’s key.

pub fn commitment(&self) -> &Commitment

The commitment this output created.

pub fn additional_timelock(&self) -> Timelock

The additional timelock this output is subject to.

All outputs are subject to the ‘10-block lock’, a 10-block window after their inclusion on-chain during which they cannot be spent. Outputs may be additionally timelocked. This function only returns the additional timelock.

pub fn subaddress(&self) -> Option<SubaddressIndex>

The index of the subaddress this output was identified as sent to.

pub fn payment_id(&self) -> Option<PaymentId>

The payment ID included with this output.

This field may be Some even if wallet2 would not return a payment ID. wallet2 will only decrypt a payment ID if either:

A) The transaction wasn’t made by the wallet (via checking if any key images are recognized) B) For the highest-indexed input with a recognized key image, it spends an output with subaddress account (a, _) which is distinct from this output’s subaddress account

Neither of these cases are handled by monero-wallet as scanning doesn’t have the context of key images.

pub fn arbitrary_data(&self) -> &[Vec<u8>]

The arbitrary data from the extra field of the transaction which created this output.

pub fn write<W: Write>(&self, w: &mut W) -> Result<()>

Write the WalletOutput.

This is not a Monero protocol defined struct, and this is accordingly not a Monero protocol defined serialization.

pub fn serialize(&self) -> Vec<u8>

Serialize the WalletOutput to a Vec<u8>.

This is not a Monero protocol defined struct, and this is accordingly not a Monero protocol defined serialization.

pub fn read<R: Read>(r: &mut R) -> Result<WalletOutput>

Read a WalletOutput.

This is not a Monero protocol defined struct, and this is accordingly not a Monero protocol defined serialization.

Trait Implementations

impl Clone for WalletOutput

fn clone(&self) -> WalletOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalletOutput

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

Formats the value using the given formatter.

impl Drop for WalletOutput

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for WalletOutput

fn eq(&self, other: &WalletOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Zeroize for WalletOutput

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for WalletOutput

impl StructuralPartialEq for WalletOutput