Struct PrepareRecoverFundsResponse 

pub struct PrepareRecoverFundsResponse {

    pub leaves: Vec<RecoverFundsLeaf>,
    pub skipped: Vec<SkippedLeaf>,
    pub recoverable_value_sats: u64,
    pub total_fee_sats: u64,
    pub cooperative_fee_sats: u64,
    pub cpfp_fee_sats: u64,
    pub fanout_fee_sats: u64,
    pub refund_fee_sats: u64,
    pub sweep_fee_sats: u64,
    pub funding: Option<RecoveryFunding>,
    pub fee_rate_sat_per_vbyte: u64,
    pub destination: String,
    pub exit_chain_state: ExitChainState,
}

Response from prepare_recover_funds: which leaves would be recovered and how, the exact fee at the requested rate, and how much to fund.

Fields

leaves: Vec<RecoverFundsLeaf>

skipped: Vec<SkippedLeaf>

The leaves the selection covers that are not in leaves, each with the reason. A leaf whose recovery already finished is not listed.

recoverable_value_sats: u64

Total value of the selected leaves, in satoshis.

total_fee_sats: u64

cooperative_fee_sats + cpfp_fee_sats + fanout_fee_sats + refund_fee_sats + sweep_fee_sats.

cooperative_fee_sats: u64

Paid from the cooperative leaves’ own value. Each leaf has two fees: the one of the transaction the operators broadcast to move it on-chain, which is already paid, and the one of its recovery transaction.

cpfp_fee_sats: u64

Paid by the CPFP children, from your funding UTXOs.

fanout_fee_sats: u64

Paid by the fan-out, from your funding UTXO. Funding one UTXO per funding.per_branch entry avoids it.

refund_fee_sats: u64

Paid from the unilateral leaves’ own value before the sweep: each leaf’s value less what its refund passes to the sweep. The output of a direct transaction, the Spark operators’ version of a leaf’s transaction, is its input less its fee, and a refund received with a watchtower fee ladder pays its own fee. For a refund that is not on-chain yet, the SDK counts the refund it expects: the operators can broadcast one with another fee.

sweep_fee_sats: u64

Paid by the final sweep, off the value it moves.

funding: Option<RecoveryFunding>

What to fund the unilateral exit with. Unset when nothing needs funding: no transaction of the recovery has a CPFP child.

fee_rate_sat_per_vbyte: u64

destination: String

exit_chain_state: ExitChainState

What the chain has already done to the unilateral leaves, read while preparing.

Trait Implementations

impl Clone for PrepareRecoverFundsResponse

fn clone(&self) -> PrepareRecoverFundsResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrepareRecoverFundsResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrepareRecoverFundsResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PrepareRecoverFundsResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.