Struct lnp::channel::bolt::CommonParams

pub struct CommonParams {
    pub minimum_depth: u32,
    pub feerate_per_kw: u32,
    pub announce_channel: bool,
    pub channel_type: ChannelType,
}

Structure containing part of the channel configuration (and state, as it contains adjustible fee) which must follow specific policies and be accepted or validated basing on those policies and additional protocol-level requirements.

This information applies for both channel peers and used in constructing both sides of asymmetric transactions.

Fields

minimum_depth: u32

Minimum depth of the funding transaction before the channel is considered open

feerate_per_kw: u32

indicates the 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 update_fee message).

announce_channel: bool

The least-significant bit of channel_flags. Indicates whether the initiator of the funding flow wishes to advertise this channel publicly to the network, as detailed within BOLT #7.

channel_type: ChannelType

Channel types are an explicit enumeration: for convenience of future definitions they reuse even feature bits, but they are not an arbitrary combination (they represent the persistent features which affect the channel operation).

Implementations

impl CommonParams

pub fn with(open_channel: &OpenChannel, minimum_depth: u32) -> Self

Extracts common parameters from the incoming open_channel message and local default requirement for the minimum depth.

Trait Implementations

impl Clone for CommonParams

fn clone(&self) -> CommonParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommonParams

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

Formats the value using the given formatter.

impl Default for CommonParams

fn default() -> Self

Sets reasonable values for the common channel parameters used in constructing open_channel message.

Usually this should not be used and instead crate::Channel::with should be provided with custom channel parameters basing on the current state of the bitcoin mempool and hash rate.

impl<'de> Deserialize<'de> for CommonParams

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

Deserialize this value from the given Serde deserializer.

impl Display for CommonParams

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

Formats the value using the given formatter.

impl Hash for CommonParams

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<CommonParams> for CommonParams

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

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 CommonParams

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 CommonParams

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 CommonParams

fn to_yaml_string(&self) -> String

Performs conversion of the self into a YAML-encoded string

impl Copy for CommonParams

impl Eq for CommonParams

impl StructuralEq for CommonParams

impl StructuralPartialEq for CommonParams