Struct OpenChannelRequest

pub struct OpenChannelRequest {

    pub node_pubkey: Vec<u8>,
    pub node_pubkey_string: String,
    pub local_funding_amount: i64,
    pub push_sat: i64,
    pub target_conf: i32,
    pub sat_per_byte: i64,
    pub private: bool,
    pub min_htlc_msat: i64,
    pub remote_csv_delay: u32,
    pub min_confs: i32,
    pub spend_unconfirmed: bool,
    pub close_address: String,
    pub funding_shim: Option<FundingShim>,
}

Fields

node_pubkey: Vec<u8>

The pubkey of the node to open a channel with. When using REST, this field must be encoded as base64.

node_pubkey_string: String

The hex encoded pubkey of the node to open a channel with. Deprecated now that the REST gateway supports base64 encoding of bytes fields.

local_funding_amount: i64

push_sat: i64

target_conf: i32

sat_per_byte: i64

private: bool

min_htlc_msat: i64

remote_csv_delay: u32

min_confs: i32

spend_unconfirmed: bool

close_address: String

Close address is an optional address which specifies the address to which funds should be paid out to upon cooperative close. This field may only be set if the peer supports the option upfront feature bit (call listpeers to check). The remote peer will only accept cooperative closes to this address if it is set.

Note: If this value is set on channel creation, you will not be able to cooperatively close out to a different address.

funding_shim: Option<FundingShim>

Funding shims are an optional argument that allow the caller to intercept certain funding functionality. For example, a shim can be provided to use a particular key for the commitment key (ideally cold) rather than use one that is generated by the wallet as normal, or signal that signing will be carried out in an interactive manner (PSBT based).

Trait Implementations

impl Clone for OpenChannelRequest

fn clone(&self) -> OpenChannelRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenChannelRequest

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

Formats the value using the given formatter.

impl Default for OpenChannelRequest

fn default() -> OpenChannelRequest

Returns the “default value” for a type.

impl Message for OpenChannelRequest

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

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

where B: BufMut, Self: Sized,

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

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

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for OpenChannelRequest

fn eq(&self, other: &OpenChannelRequest) -> 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 StructuralPartialEq for OpenChannelRequest