Struct WalletSummary

pub struct WalletSummary {
    pub spendable_utxos: Vec<TxOutputSummary>,
    pub unsigned_peg_out_txos: Vec<TxOutputSummary>,
    pub unsigned_change_utxos: Vec<TxOutputSummary>,
    pub unconfirmed_peg_out_txos: Vec<TxOutputSummary>,
    pub unconfirmed_change_utxos: Vec<TxOutputSummary>,
}

Summary of the coins within the wallet.

Coins within the wallet go from spendable, to consumed in a transaction that does not have threshold signatures (unsigned), to threshold signed and unconfirmed on-chain (unconfirmed).

This summary provides the most granular view possible of coins in the wallet.

Fields

spendable_utxos: Vec<TxOutputSummary>

All UTXOs available as inputs for transactions

unsigned_peg_out_txos: Vec<TxOutputSummary>

Transaction outputs consumed in peg-out transactions that have not reached threshold signatures

unsigned_change_utxos: Vec<TxOutputSummary>

Change UTXOs created from peg-out transactions that have not reached threshold signatures

unconfirmed_peg_out_txos: Vec<TxOutputSummary>

Transaction outputs consumed in peg-out transactions that have reached threshold signatures waiting for finality delay confirmations

unconfirmed_change_utxos: Vec<TxOutputSummary>

Change UTXOs created from peg-out transactions that have reached threshold signatures waiting for finality delay confirmations

Implementations

impl WalletSummary

pub(crate) fn sum<'a>(txos: impl Iterator<Item = &'a TxOutputSummary>) -> Amount

pub fn total_spendable_balance(&self) -> Amount

Total amount of all spendable UTXOs

pub fn total_unsigned_peg_out_balance(&self) -> Amount

Total amount of all transaction outputs from peg-out transactions that have not reached threshold signatures

pub fn total_unsigned_change_balance(&self) -> Amount

Total amount of all change UTXOs from peg-out transactions that have not reached threshold signatures

pub fn total_unconfirmed_peg_out_balance(&self) -> Amount

Total amount of all transaction outputs from peg-out transactions that have reached threshold signatures waiting for finality delay confirmations

pub fn total_unconfirmed_change_balance(&self) -> Amount

Total amount of all change UTXOs from peg-out transactions that have reached threshold signatures waiting for finality delay confirmations

pub fn total_pending_peg_out_balance(&self) -> Amount

Total amount of all transaction outputs from peg-out transactions that are either waiting for threshold signatures or confirmations. This is the total in-flight amount leaving the wallet.

pub fn total_pending_change_balance(&self) -> Amount

Total amount of all change UTXOs from peg-out transactions that are either waiting for threshold signatures or confirmations. This is the total in-flight amount that will become spendable by the wallet.

pub fn total_owned_balance(&self) -> Amount

Total amount of immediately spendable UTXOs and pending change UTXOs. This is the spendable balance once all transactions confirm.

pub fn pending_peg_out_txos(&self) -> Vec<TxOutputSummary>

All transaction outputs from peg-out transactions that are either waiting for threshold signatures or confirmations. These are all the in-flight coins leaving the wallet.

pub fn pending_change_utxos(&self) -> Vec<TxOutputSummary>

All change UTXOs from peg-out transactions that are either waiting for threshold signatures or confirmations. These are all the in-flight coins that will become spendable by the wallet.

Trait Implementations

impl Clone for WalletSummary

fn clone(&self) -> WalletSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalletSummary

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

Formats the value using the given formatter.

impl Decodable for WalletSummary

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for WalletSummary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for WalletSummary

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl Hash for WalletSummary

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WalletSummary

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WalletSummary

impl StructuralPartialEq for WalletSummary