Enum OnchainBalanceState 

pub enum OnchainBalanceState {
    Unavailable,
    Available {
        withdrawable_sat: u64,
        emergency_reserve_sat: u64,
        unconfirmed_sat: u64,
    },
    ReserveOnly {
        reserve_sat: u64,
    },
    PendingConfirmation {
        unconfirmed_sat: u64,
    },
    Immature {
        immature_sat: u64,
    },
}

Classifies the on-chain wallet into discrete cases that a wallet UI can switch on to render the correct entry-point for the withdraw flow. Derived purely from NodeState — no RPC.

Variants

Unavailable

No funds on-chain in any form (confirmed, unconfirmed, immature, or pending channel-close payouts are all zero). Don’t render a withdraw entry point.

Available

Funds are spendable now. Render the withdraw entry point enabled with withdrawable_sat as the headline.

Fields

withdrawable_sat: u64

onchain_balance_sat - emergency_reserve_sat. Use as the displayed amount on the entry point.

emergency_reserve_sat: u64

Held back by CLN for anchor-channel safety; cannot be withdrawn without closing channels first.

unconfirmed_sat: u64

Inbound on-chain funds not yet confirmed. Informational only — not part of withdrawable_sat.

ReserveOnly

On-chain funds exist but are entirely locked as the anchor-channel emergency reserve. Render the entry point disabled with an explainer (e.g. “close channels to free these funds”).

Fields

reserve_sat: u64

PendingConfirmation

Inbound on-chain funds are awaiting confirmation. Render a “pending” indicator instead of an enabled withdraw button.

Fields

unconfirmed_sat: u64

Immature

Funds exist as CSV-timelocked outputs from a recent channel close and can’t be spent until the relative locktime expires. Render the entry point disabled with a “channel closing” explainer.

Fields

immature_sat: u64

Trait Implementations

impl Clone for OnchainBalanceState

fn clone(&self) -> OnchainBalanceState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for OnchainBalanceState

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl<UT> FfiConverter<UT> for OnchainBalanceState

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for OnchainBalanceState

type FfiType = <OnchainBalanceState as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for OnchainBalanceState

type LiftType = OnchainBalanceState

impl<UT> LiftReturn<UT> for OnchainBalanceState

type ReturnType = <OnchainBalanceState as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for OnchainBalanceState

type FfiType = <OnchainBalanceState as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for OnchainBalanceState

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for OnchainBalanceState

type ReturnType = <OnchainBalanceState as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for OnchainBalanceState

const TYPE_ID_META: MetadataBuffer