Struct PreparedOnchainSend 

pub struct PreparedOnchainSend {
    pub utxos: Vec<Outpoint>,
    pub total_input_sat: u64,
    pub fee_sat: u64,
    pub recipient_sat: u64,
    pub sat_per_vbyte: u32,
}

Preview of an on-chain send: the inputs CLN would select at the given fee rate, the resulting fee, and the amount the recipient would receive. Inputs are NOT reserved — the wallet is free to spend them via other paths until onchain_send actually broadcasts.

Pass utxos and sat_per_vbyte back to onchain_send to broadcast with identical inputs and fee.

Amounts are in satoshis: on-chain transactions cannot carry sub-sat precision, so msat denomination would be misleading here.

Fields

utxos: Vec<Outpoint>

UTXOs that would be spent, in selection order.

total_input_sat: u64

Sum of all input UTXO values, in satoshis.

fee_sat: u64

Fee that would be paid, in satoshis.

recipient_sat: u64

Amount the recipient would receive, in satoshis. For a sweep (“all”) this equals total_input_sat - fee_sat. For a fixed amount this equals the requested amount.

sat_per_vbyte: u32

Effective fee rate (sat per virtual byte) the node used to compute this preview. Equal to the caller’s sat_per_vbyte if one was supplied; otherwise the rate the node picked at “normal” priority. Pass this back to onchain_send to reproduce the previewed fee.

Trait Implementations

impl<UT> ConvertError<UT> for PreparedOnchainSend

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

impl<UT> FfiConverter<UT> for PreparedOnchainSend

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 PreparedOnchainSend

type FfiType = <PreparedOnchainSend 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 PreparedOnchainSend

type LiftType = PreparedOnchainSend

impl<UT> LiftReturn<UT> for PreparedOnchainSend

type ReturnType = <PreparedOnchainSend 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 PreparedOnchainSend

type FfiType = <PreparedOnchainSend 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 PreparedOnchainSend

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PreparedOnchainSend

type ReturnType = <PreparedOnchainSend 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 PreparedOnchainSend

const TYPE_ID_META: MetadataBuffer