Struct lnp_rpc::CreateChannel

pub struct CreateChannel {

    pub remote_peer: NodeAddr,
    pub report_to: Option<ClientId>,
    pub funding_sat: u64,
    pub push_msat: u64,
    pub fee_rate: Option<u32>,
    pub announce_channel: Option<bool>,
    pub channel_type: Option<ChannelType>,
    pub dust_limit: Option<u64>,
    pub to_self_delay: Option<u16>,
    pub htlc_max_count: Option<u16>,
    pub htlc_min_value: Option<u64>,
    pub htlc_max_total_value: Option<u64>,
    pub channel_reserve: Option<u64>,
}

Request to create channel originating from a client

Fields

remote_peer: NodeAddr

Node to open a channel with

report_to: Option<ClientId>

Client identifier to report about the progress

funding_sat: u64

Amount of satoshis for channel funding

push_msat: u64

Amount of millisatoshis to pay to the remote peer at the channel opening

fee_rate: Option<u32>

Initial fee rate in satoshi per 1000-weight (i.e. 1/4 the more normally-used ‘satoshi per 1000 vbytes’) that this side will pay for commitment and HTLC transactions, as described in BOLT #3 (this can be adjusted later with an Fee message).

announce_channel: Option<bool>

Should the channel be announced to the lightning network. Required for the node to earn routing fees. Setting this flag results in the channel and node becoming public.

channel_type: Option<ChannelType>

Channel type as defined in BOLT-2.

dust_limit: Option<u64>

The threshold below which outputs on transactions broadcast by sender will be omitted.

to_self_delay: Option<u16>

The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction

htlc_max_count: Option<u16>

The maximum number of the received HTLCs.

htlc_min_value: Option<u64>

Indicates the smallest value of an HTLC this node will accept, in milli-satoshi.

htlc_max_total_value: Option<u64>

The maximum inbound HTLC value in flight towards this node, in milli-satoshi

channel_reserve: Option<u64>

The minimum value unencumbered by HTLCs for the counterparty to keep in the channel, in satoshis.

Implementations

impl CreateChannel

pub fn apply_params(&self, common: &mut CommonParams, local: &mut PeerParams)

Applies customized parameters from the request to a given parameter objects

Trait Implementations

impl Clone for CreateChannel

fn clone(&self) -> CreateChannel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChannel

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

Formats the value using the given formatter.

impl Display for CreateChannel

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

Formats the value using the given formatter.

impl PartialEq<CreateChannel> for CreateChannel

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StrictDecode for CreateChannel

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for CreateChannel

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl Eq for CreateChannel

impl StructuralEq for CreateChannel

impl StructuralPartialEq for CreateChannel