Struct ChannelClose

source

pub struct ChannelClose { /* private fields */ }

Implementations§

source §

impl ChannelClose

source

pub fn determine_resolving_fees(&self) -> Result<Option<OnchainResolvingFees>>

Returns the fees for resolving channel closes if there are enough funds to pay for fees.

Must only be called when there are onchain funds to resolve.

Returns the fee information for the available resolving options.

Requires network: yes

source

pub fn prepare_sweep( &self, destination: BitcoinAddressData, ) -> Result<SweepChannelCloseInfo, RedeemOnchainError>

Prepares a sweep of all available on-chain funds to the provided on-chain address.

Parameters:

destination - the destination address to which funds will be sent. Can be obtained using Util::decode_data

Returns information on the prepared sweep, including the exact fee that results from using the provided fee rate. The method ChannelClose::sweep can be used to broadcast the sweep transaction.

Requires network: yes

source

pub fn sweep(&self, sweep_info: SweepChannelCloseInfo) -> Result<String>

Sweeps all available channel close funds to the specified on-chain address.

Parameters:

sweep_info - a prepared sweep info that can be obtained using ChannelClose::prepare_sweep

Returns the txid of the sweep transaction.

Requires network: yes

source

pub fn swap(&self, sat_per_vbyte: u32) -> Result<String, RedeemOnchainError>

Automatically swaps on-chain funds back to lightning.

If a swap is in progress, this method will return an error.

If the current balance doesn’t fulfill the limits, this method will return an error. Before using this method use ChannelClose::determine_resolving_fees to validate a swap is available.

Parameters:

sat_per_vbyte - the fee rate to use for the on-chain transaction. Can be obtained with ChannelClose::determine_resolving_fees.
lsp_fee_params - the lsp fee params for opening a new channel if necessary. Can be obtained with ChannelClose::determine_resolving_fees.

Returns the txid of the sweeping tx.

Requires network: yes

Auto Trait Implementations§

§

impl !UnwindSafe for ChannelClose

Blanket Implementations§

source §

impl<T> Any for T
where T: 'static + ?Sized,

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

§

fn type_name(&self) -> &'static str

Gets the type name of self

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

source §

impl<T> Borrow<T> for T
where T: ?Sized,

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

§

impl<T> Downcast for T
where T: AsAny + ?Sized,

§

fn is<T>(&self) -> bool
where T: AsAny,

Returns true if the boxed type is the same as T. Read more

§

fn downcast_ref<T>(&self) -> Option<&T>
where T: AsAny,

Forward to the method defined on the type Any.

§

fn downcast_mut<T>(&mut self) -> Option<&mut T>
where T: AsAny,

Forward to the method defined on the type Any.

source §

impl<T> From<T> for T

source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more

§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more

§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into for T
where U: From<T>,

source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source §

impl<T> IntoEither for T

source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §