Struct Policy

pub struct Policy {
    pub to_self_delay_max: u16,
    pub feerate_per_kw_range: Range<u32>,
    pub minimum_depth: u32,
    pub maximum_depth: Option<u32>,
    pub funding_satoshis_min: Option<u64>,
    pub htlc_minimum_msat_max: Option<u64>,
    pub max_htlc_value_in_flight_msat_min: Option<u64>,
    pub channel_reserve_satoshis_max_abs: Option<u64>,
    pub channel_reserve_satoshis_max_percent: Option<u8>,
    pub max_accepted_htlcs_min: Option<u16>,
    pub dust_limit_satoshis_max: Option<u64>,
}

Policy to validate channel parameters proposed by a remote peer.

By default, crate::Channel::new uses reasonable default policy created by Policy::default() method. Channel creator may provide a custom policy by using crate::Channel::with method.

Fields

to_self_delay_max: u16

Reasonable limit to check value of to_self_delay required by a remote node, in blocks.

feerate_per_kw_range: Range<u32>

Range of acceptable channel fees.

minimum_depth: u32

Minimum funding transaction mining depth required from the remote node for a channel proposed by it.

maximum_depth: Option<u32>

Maximum funding transaction mining depth which may be required by a remote node for a channel opened by a local node.

funding_satoshis_min: Option<u64>

Minimum funding for a channel by this node.

htlc_minimum_msat_max: Option<u64>

The maximum acceptable limit on the value stored in a single HTLC.

max_htlc_value_in_flight_msat_min: Option<u64>

Minimum boundary for the upper limit of in-flight HTLC funds.

channel_reserve_satoshis_max_abs: Option<u64>

Maximum reserve for a channel from a local node required by the remote node in absolute value.

channel_reserve_satoshis_max_percent: Option<u8>

Maximum reserve for a channel from a local node required by the remote node in persents from the channel funding.

max_accepted_htlcs_min: Option<u16>

Minimum boundary to the limit of HTLCs offered to a remote peer.

dust_limit_satoshis_max: Option<u64>

Maximum value for the dust limit required by a remote node.

Implementations

impl Policy

pub fn with_clightning_defaults() -> Policy

Sets policy to match default policy used in c-lightning

pub fn with_lnd_defaults() -> Policy

Sets policy to match default policy used in LND

pub fn with_eclair_defaults() -> Policy

Sets policy to match default policy used in Eclair

pub fn validate_inbound( &self, open_channel: &OpenChannel, ) -> Result<PeerParams, PolicyError>

Validates parameters proposed by remote peer in open_channel message against the policy

Arguments

• self: local policy;
• open_channel: BOLT-2 message received by the peer.

Returns

PeerParams to use for constructing channel transactions which should be signed by the local node.

pub fn confirm_outbound( &self, our_params: PeerParams, accept_channel: &AcceptChannel, ) -> Result<PeerParams, PolicyError>

Confirms that parameters which were asked by a remote node via accept_channel message are confirming our policy.

Arguments

• self: local policy;
• params: parameters proposed by the local node in open_channel message;
• accept_channel: BOLT-2 message received by the peer.

Returns

PeerParams to use for constructing channel transactions which should be signed by the local node.

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl Default for Policy

fn default() -> Policy

Sets reasonable values for the local node policies

impl<'de> Deserialize<'de> for Policy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Policy

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

Formats the value using the given formatter.

impl Hash for Policy

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

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

Tests for self and other values to be equal, and is used by ==.

const 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 Serialize for Policy

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 Policy

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 Policy

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>, 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 Policy

Available on crate feature serde only.

fn to_yaml_string(&self) -> String

Performs conversion of the self into a YAML-encoded string

impl Eq for Policy

impl StructuralPartialEq for Policy