Struct CloseChannelRequest 

pub struct CloseChannelRequest {
    pub channel_point: Option<ChannelPoint>,
    pub force: bool,
    pub target_conf: i32,
    pub sat_per_byte: i64,
    pub delivery_address: String,
    pub sat_per_vbyte: u64,
    pub max_fee_per_vbyte: u64,
    pub no_wait: bool,
}

Fields

channel_point: Option<ChannelPoint>

The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice’s version of the commitment transaction.

force: bool

If true, then the channel will be closed forcibly. This means the current commitment transaction will be signed and broadcast.

target_conf: i32

The target number of blocks that the closure transaction should be confirmed by.

sat_per_byte: i64

👎Deprecated

Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.

delivery_address: String

An optional address to send funds to in the case of a cooperative close. If the channel was opened with an upfront shutdown script and this field is set, the request to close will fail because the channel must pay out to the upfront shutdown addresss.

sat_per_vbyte: u64

A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.

max_fee_per_vbyte: u64

The maximum fee rate the closer is willing to pay.

NOTE: This field is only respected if we’re the initiator of the channel.

no_wait: bool

If true, then the rpc call will not block while it awaits a closing txid to be broadcasted to the mempool. To obtain the closing tx one has to listen to the stream for the particular updates. Moreover if a coop close is specified and this flag is set to true the coop closing flow will be initiated even if HTLCs are active on the channel. The channel will wait until all HTLCs are resolved and then start the coop closing process. The channel will be disabled in the meantime and will disallow any new HTLCs.

Trait Implementations

impl Clone for CloseChannelRequest

fn clone(&self) -> CloseChannelRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloseChannelRequest

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

Formats the value using the given formatter.

impl Default for CloseChannelRequest

fn default() -> Self

Returns the “default value” for a type.

impl Hash for CloseChannelRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for CloseChannelRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CloseChannelRequest

fn eq(&self, other: &CloseChannelRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CloseChannelRequest

impl StructuralPartialEq for CloseChannelRequest