Struct lightning::util::sweep::OutputSweeper

pub struct OutputSweeper<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref>
where
    B::Target: BroadcasterInterface,
    D::Target: ChangeDestinationSource,
    E::Target: FeeEstimator,
    F::Target: Filter + Sync + Send,
    K::Target: KVStore,
    L::Target: Logger,
    O::Target: OutputSpender,
{ /* private fields */ }

A utility that keeps track of SpendableOutputDescriptors, persists them in a given KVStore and regularly retries sweeping them based on a callback given to the constructor methods.

Users should call Self::track_spendable_outputs for any SpendableOutputDescriptors received via Event::SpendableOutputs.

This needs to be notified of chain state changes either via its Listen or Confirm implementation and hence has to be connected with the utilized chain data sources.

If chain data is provided via the Confirm interface or via filtered blocks, users are required to give their chain data sources (i.e., Filter implementation) to the respective constructor.

Implementations

impl<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref> OutputSweeper<B, D, E, F, K, L, O>

where B::Target: BroadcasterInterface, D::Target: ChangeDestinationSource, E::Target: FeeEstimator, F::Target: Filter + Sync + Send, K::Target: KVStore, L::Target: Logger, O::Target: OutputSpender,

pub fn new( best_block: BestBlock, broadcaster: B, fee_estimator: E, chain_data_source: Option<F>, output_spender: O, change_destination_source: D, kv_store: K, logger: L ) -> Self

Constructs a new OutputSweeper.

If chain data is provided via the Confirm interface or via filtered blocks, users also need to register their Filter implementation via the given chain_data_source.

pub fn track_spendable_outputs( &self, output_descriptors: Vec<SpendableOutputDescriptor>, channel_id: Option<ChannelId>, exclude_static_outputs: bool, delay_until_height: Option<u32> ) -> Result<(), ()>

Tells the sweeper to track the given outputs descriptors.

Usually, this should be called based on the values emitted by the Event::SpendableOutputs.

The given exclude_static_outputs flag controls whether the sweeper will filter out SpendableOutputDescriptor::StaticOutputs, which may be handled directly by the on-chain wallet implementation.

If delay_until_height is set, we will delay the spending until the respective block height is reached. This can be used to batch spends, e.g., to reduce on-chain fees.

Returns Err on persistence failure, in which case the call may be safely retried.

pub fn tracked_spendable_outputs(&self) -> Vec<TrackedSpendableOutput>

Returns a list of the currently tracked spendable outputs.

pub fn current_best_block(&self) -> BestBlock

Gets the latest best block which was connected either via the Listen or Confirm interfaces.

Trait Implementations

impl<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref> Confirm for OutputSweeper<B, D, E, F, K, L, O>

where B::Target: BroadcasterInterface, D::Target: ChangeDestinationSource, E::Target: FeeEstimator, F::Target: Filter + Sync + Send, K::Target: KVStore, L::Target: Logger, O::Target: OutputSpender,

fn transactions_confirmed( &self, header: &Header, txdata: &TransactionData<'_>, height: u32 )

Notifies LDK of transactions confirmed in a block with a given header and height.

fn transaction_unconfirmed(&self, txid: &Txid)

Notifies LDK of a transaction that is no longer confirmed as result of a chain reorganization.

fn best_block_updated(&self, header: &Header, height: u32)

Notifies LDK of an update to the best header connected at the given height.

fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)>

Returns transactions that must be monitored for reorganization out of the chain along with the height and the hash of the block as part of which it had been previously confirmed.

impl<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref> Listen for OutputSweeper<B, D, E, F, K, L, O>

where B::Target: BroadcasterInterface, D::Target: ChangeDestinationSource, E::Target: FeeEstimator, F::Target: Filter + Sync + Send, K::Target: KVStore, L::Target: Logger, O::Target: OutputSpender,

fn filtered_block_connected( &self, header: &Header, txdata: &TransactionData<'_>, height: u32 )

Notifies the listener that a block was added at the given height, with the transaction data possibly filtered.

fn block_disconnected(&self, header: &Header, height: u32)

Notifies the listener that a block was removed at the given height.

fn block_connected(&self, block: &Block, height: u32)

Notifies the listener that a block was added at the given height.

impl<B: Deref, D: Deref, E: Deref, F: Deref, K: Deref, L: Deref, O: Deref> ReadableArgs<(B, E, Option<F>, O, D, K, L)> for OutputSweeper<B, D, E, F, K, L, O>

where B::Target: BroadcasterInterface, D::Target: ChangeDestinationSource, E::Target: FeeEstimator, F::Target: Filter + Sync + Send, K::Target: KVStore, L::Target: Logger, O::Target: OutputSpender,

fn read<R: Read>( reader: &mut R, args: (B, E, Option<F>, O, D, K, L) ) -> Result<Self, DecodeError>

Reads a Self in from the given Read.