Struct WalletBalanceResult 

pub struct WalletBalanceResult {
    pub balance: u64,
    pub pending: u64,
    pub source: Option<WalletReadSource>,
    pub synced: bool,
    pub peak_height: Option<u32>,
}

control.wallet.balance — an address’s balance for one asset, as the node’s chain read saw it.

A READ-only result: this reports chain state, it never moves funds. It is a strict SUPERSET of dig-app’s frozen BalanceResponse { balance } — the node emits the richer shape, and because dig-app’s struct does not deny unknown fields it reads balance losslessly and ignores the rest. That superset relationship is the “no dig-app code change” guarantee, pinned by the conformance KAT.

Fields

balance: u64

The CONFIRMED, spendable balance in the asset’s base unit (mojos for XCH, base units for DIG). The only field dig-app 3.x reads.

pending: u64

Incoming funds seen but not yet confirmed (asset base units); not yet spendable.

source: Option<WalletReadSource>

Which tier produced these figures, or None from a node too old to disclose it.

See WalletReadSource. Absent (null / omitted) is a THIRD state, not a default tier: it means the answering node predates tier disclosure, so the caller knows the tier is unknown rather than being told a tier that was never reported.

The Option carries the backwards compatibility on its own — serde treats a missing Option field as None — so no #[serde(default)] is needed and none is written; a REQUIRED field here would reject an older node’s payload outright.

synced: bool

Whether THESE figures reflect a caught-up view of the tier that ANSWERED, measured against that tier’s own peak. When false, they are STALE or drawn from a tier that tracks no peak.

This describes the ANSWER, not the node: a WalletReadSource::Fallback answer is measured against the ORACLE’s peak, never against the node’s own replica or its held peers, neither of which produced the figures.

true only when that peak came from the SAME read that produced these figures; a carried-over peak means false.

peak_height: Option<u32>

The peak block height of the tier that ANSWERED, or null when that tier tracks no peak.

For a WalletReadSource::Fallback answer this is the oracle’s own reported height, and for a WalletReadSource::Db answer the replica’s. It is never the node’s replica height stamped onto an oracle’s figures, and never a CACHED row, which no live tier bounds.

It MUST be the height that tier reported in the SAME read that produced the figures, or null.

Trait Implementations

impl Clone for WalletBalanceResult

fn clone(&self) -> WalletBalanceResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WalletBalanceResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WalletBalanceResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WalletBalanceResult

impl PartialEq for WalletBalanceResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WalletBalanceResult

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 WalletBalanceResult