Struct lnp_rpc::CreateChannel
source · [−]pub struct CreateChannel {Show 13 fields
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>,
}
Expand description
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
sourceimpl CreateChannel
impl CreateChannel
sourcepub fn apply_params(&self, common: &mut CommonParams, local: &mut PeerParams)
pub fn apply_params(&self, common: &mut CommonParams, local: &mut PeerParams)
Applies customized parameters from the request to a given parameter objects
Trait Implementations
sourceimpl Clone for CreateChannel
impl Clone for CreateChannel
sourcefn clone(&self) -> CreateChannel
fn clone(&self) -> CreateChannel
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateChannel
impl Debug for CreateChannel
sourceimpl Display for CreateChannel
impl Display for CreateChannel
sourceimpl PartialEq<CreateChannel> for CreateChannel
impl PartialEq<CreateChannel> for CreateChannel
sourcefn eq(&self, other: &CreateChannel) -> bool
fn eq(&self, other: &CreateChannel) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateChannel) -> bool
fn ne(&self, other: &CreateChannel) -> bool
This method tests for !=
.
sourceimpl StrictDecode for CreateChannel
impl StrictDecode for CreateChannel
sourcefn strict_decode<D: Read>(d: D) -> Result<Self, Error>
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. Read more
sourcefn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>
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. Read more
sourcefn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>
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. Read more
sourceimpl StrictEncode for CreateChannel
impl StrictEncode for CreateChannel
sourcefn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>
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. Read more
sourcefn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>
fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>
Serializes data as a byte array using StrictEncode::strict_encode
function Read more
impl Eq for CreateChannel
impl StructuralEq for CreateChannel
impl StructuralPartialEq for CreateChannel
Auto Trait Implementations
impl RefUnwindSafe for CreateChannel
impl Send for CreateChannel
impl Sync for CreateChannel
impl Unpin for CreateChannel
impl UnwindSafe for CreateChannel
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.