Enum ReceiveProgress 

pub enum ReceiveProgress {
    Mempool {
        value: Amount,
    },
    Confirming {
        value: Amount,
        height: u64,
        confirmations: u64,
        required: u64,
    },
}

Progress of a single incoming peg-in.

Each variant describes one deposit, identified by the outpoint it is looked up or paired with. An address that has been paid more than once has one of these per payment rather than a combined view, so nothing is aggregated away.

There is no “nothing has arrived” variant: a deposit no guardian has seen has no outpoint to describe it, so absence is expressed by WalletClientModule::address_receive_progress reporting no deposits.

Every variant is derived from advisory, non-consensus data reported by individual guardians, so none of them is authoritative and progress may move backwards: a reorg or an eviction can take a deposit back to being unseen entirely. No variant means money has been received - a deposit is only actually claimed once WalletClientModule::await_receive returns, and an output is deliberately still reported here for a short while after that.

Variants

Mempool

The deposit is in a guardian’s mempool but is not mined.

The weakest signal there is: an unmined transaction can be replaced or evicted, and a deposit in this state can disappear again. Treat it as “we have seen your payment”, never as money received.

Only guardians whose bitcoin backend can enumerate a mempool report these, so on a federation without one a deposit stays unseen until it is mined.

Fields

value: Amount

Confirming

The deposit has been mined but is not yet deep enough for the federation to act on it.

Fields

value: Amount

height: u64

Height of the block that mined the deposit.

Reported as the guardians saw it, so a reorg can move a deposit to a different height or back to being unseen entirely.

confirmations: u64

Confirmations counting the block that mined the transaction as the first, matching what a block explorer displays.

required: u64

Confirmations needed before the federation records the output.

Trait Implementations

impl Clone for ReceiveProgress

fn clone(&self) -> ReceiveProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiveProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReceiveProgress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReceiveProgress

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

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 ReceiveProgress

impl StructuralPartialEq for ReceiveProgress