Struct Balance 

pub struct Balance {
    pub spendable: Amount,
    pub needs_refresh: Amount,
    pub pending_lightning_send: Amount,
    pub claimable_lightning_receive: Amount,
    pub pending_in_round: Amount,
    pub pending_board: Amount,
    pub pending_arkoor_send: Amount,
    pub pending_offboard: Amount,
    pub pending_exit: Amount,
}

The different balances of a Bark wallet.

spendable_sat counts the spendable VTXOs, needs_refresh_sat the ones that have to be refreshed before they can be sent again, and every other field what an operation in progress holds, so the fields never overlap.

See BalanceSummary for the totals to show a user.

All amounts are in sats.

Fields

spendable: Amount

Sats that are immediately spendable, either in-round or out-of-round.

needs_refresh: Amount

Sats in VTXOs that can no longer be sent in an arkoor payment because they have expired or their exit depth has reached the server’s limit. They can still be offboarded, exited or refreshed, but are not part of spendable_sat until maintenance has refreshed them.

pending_lightning_send: Amount

Sats locked in an outgoing Lightning payment that has not yet settled.

claimable_lightning_receive: Amount

Sats in HTLC VTXOs of an incoming Lightning payment whose preimage has been revealed but which have not been swapped for spendable VTXOs yet. A payment that can still be cancelled is not counted.

pending_in_round: Amount

Sats locked in VTXOs forfeited for a round that has not yet completed.

pending_board: Amount

Sats in board transactions that are waiting for sufficient on-chain confirmations before becoming spendable.

pending_arkoor_send: Amount

Sats locked in an outgoing arkoor payment that has not completed yet: the whole input amount, until the send finalizes and the change comes back as spendable.

pending_offboard: Amount

Sats locked in an offboard whose transaction has not been broadcast yet, including any change that comes back. Once the transaction is on the network the sats belong to the on-chain wallet.

pending_exit: Amount

Sats held in VTXOs whose unilateral exit has committed on-chain but which haven’t yet been drained to the onchain wallet: their state is crate::primitives::VtxoStateInfo::Exited and their exit has not reached crate::exit::ExitStateKind::Claimed.

Trait Implementations

impl Clone for Balance

fn clone(&self) -> Self

Returns a duplicate 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<'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 Eq for Balance

impl From<&Balance> for BalanceSummary

fn from(v: &Balance) -> Self

Converts to this type from the input type.

impl From<Balance> for Balance

fn from(v: Balance) -> Self

Converts to this type from the input type.

impl From<Balance> for BalanceSummary

fn from(v: Balance) -> Self

Converts to this type from the input type.

impl PartialEq for Balance

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for Balance