Struct lnp::channel::bolt::PeerParams

pub struct PeerParams {
    pub dust_limit_satoshis: u64,
    pub to_self_delay: u16,
    pub htlc_minimum_msat: u64,
    pub max_htlc_value_in_flight_msat: u64,
    pub channel_reserve_satoshis: u64,
    pub max_accepted_htlcs: u16,
}

Structure containing part of the channel state which must follow specific policies and be accepted or validated basing on those policies and additional protocol-level requirements.

This information applies for only to one of the peers and requested by the other peer. It is used in constructing transactions which should be signed by the node demanding this requirements.

Should be instantiated from the node configuration persistent storage and/or command line parameters and provided to the channel constructor via crate::Channel::with.

Later, when creating new channels, it should be copied from the local channel defaults object and updated / checked against local policies upon receiving accept_channel reply by setting super::BoltChannel::remote_params to a value returned from [super::BoltChannel::local_params][.confirm_outbound](Policy:: confirm_outbound) method.

Upon receiving open_channel message from the remote node must validate the proposed parameters against local policy with [super::BoltChannel::policy][.validate_inbound](Policy:: validate_inbound) method and assign the return value to super::BoltChannel::remote_params.

Fields

dust_limit_satoshis: u64

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

to_self_delay: u16

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

htlc_minimum_msat: u64

Indicates the smallest value HTLC this node will accept.

max_htlc_value_in_flight_msat: u64

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

channel_reserve_satoshis: u64

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

max_accepted_htlcs: u16

The maximum number of inbound HTLCs towards sender

Trait Implementations

impl Clone for PeerParams

fn clone(&self) -> PeerParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeerParams

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

Formats the value using the given formatter.

impl Default for PeerParams

fn default() -> Self

Sets reasonable values for the channel parameters requested from the other peer in sent open_channel or accept_channel messages.

Usually this should not be used and instead crate::Channel::with should be provided with custom channel parameters basing on the user preferences.

impl<'de> Deserialize<'de> for PeerParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PeerParams

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

Formats the value using the given formatter.

impl From<&AcceptChannel> for PeerParams

fn from(accept_channel: &AcceptChannel) -> Self

Extracts peer-specific parameters from the incoming accept_channel message. These parameters are applied to the local node.

impl From<&OpenChannel> for PeerParams

fn from(open_channel: &OpenChannel) -> Self

Extracts peer-specific parameters from the incoming open_channel message. These parameters are applied to the local node.

impl Hash for PeerParams

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 PartialEq<PeerParams> for PeerParams

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for PeerParams

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 PeerParams

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 ToYamlString for PeerParams

fn to_yaml_string(&self) -> String

Performs conversion of the self into a YAML-encoded string

impl Copy for PeerParams

impl Eq for PeerParams

impl StructuralEq for PeerParams

impl StructuralPartialEq for PeerParams