Struct bdk_chain::Balance

pub struct Balance {
    pub immature: Amount,
    pub trusted_pending: Amount,
    pub untrusted_pending: Amount,
    pub confirmed: Amount,
}

Balance, differentiated into various categories.

Fields

immature: Amount

All coinbase outputs not yet matured

trusted_pending: Amount

Unconfirmed UTXOs generated by a wallet tx

untrusted_pending: Amount

Unconfirmed UTXOs received from an external wallet

confirmed: Amount

Confirmed and immediately spendable balance

Implementations

impl Balance

pub fn trusted_spendable(&self) -> Amount

Get sum of trusted_pending and confirmed coins.

This is the balance you can spend right now that shouldn’t get cancelled via another party double spending it.

pub fn total(&self) -> Amount

Get the whole balance visible to the wallet.

Trait Implementations

impl Add for Balance

type Output = Balance

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Clone for Balance

fn clone(&self) -> Balance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Balance

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

Formats the value using the given formatter.

impl Default for Balance

fn default() -> Balance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Balance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Balance

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

Formats the value using the given formatter.

impl PartialEq for Balance

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

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 Balance

impl StructuralPartialEq for Balance