Struct SimplePolicy

pub struct SimplePolicy {

    pub min_delay: u16,
    pub max_delay: u16,
    pub max_channel_size_sat: u64,
    pub epsilon_sat: u64,
    pub max_htlcs: usize,
    pub max_htlc_value_sat: u64,
    pub use_chain_state: bool,
    pub min_feerate_per_kw: u32,
    pub max_feerate_per_kw: u32,
    pub enforce_balance: bool,
    pub max_routing_fee_msat: u64,
    pub max_feerate_percentage: u8,
    pub dev_flags: Option<PolicyDevFlags>,
    pub filter: PolicyFilter,
    pub global_velocity_control: VelocityControlSpec,
    pub max_channels: usize,
    pub max_invoices: usize,
    pub fee_velocity_control: VelocityControlSpec,
}

A simple policy to configure a SimpleValidator

Fields

min_delay: u16

Minimum delay in blocks

max_delay: u16

Maximum delay in blocks

max_channel_size_sat: u64

Maximum channel value in satoshi

epsilon_sat: u64

amounts below this number of satoshi are not considered important

max_htlcs: usize

Maximum number of in-flight HTLCs

max_htlc_value_sat: u64

Maximum value of in-flight HTLCs

use_chain_state: bool

Whether to use knowledge of chain state (e.g. current_height)

min_feerate_per_kw: u32

Minimum feerate

max_feerate_per_kw: u32

Maximum feerate

enforce_balance: bool

Enforce holder balance

max_routing_fee_msat: u64

Maximum layer-2 fee

max_feerate_percentage: u8

Maximum layer-2 percentage fee, this is setting up the max fee percentage to pay for a payment.

dev_flags: Option<PolicyDevFlags>

Developer flags - DO NOT USE IN PRODUCTION

filter: PolicyFilter

Policy filter

global_velocity_control: VelocityControlSpec

Global velocity control specification

max_channels: usize

Maximum number of channels

max_invoices: usize

Maximum number of invoices

fee_velocity_control: VelocityControlSpec

Fee velocity control specification

Trait Implementations

impl Clone for SimplePolicy

fn clone(&self) -> SimplePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimplePolicy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SimplePolicy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Policy for SimplePolicy

fn policy_error(&self, tag: String, msg: String) -> Result<(), ValidationError>

A policy error has occurred. Policy errors can be converted to warnings by returning Ok(())

fn temporary_policy_error( &self, tag: String, msg: String, ) -> Result<(), ValidationError>

A temporary policy error has occurred. Policy errors can be converted to warnings by returning Ok(())

fn policy_log(&self, tag: String, msg: String)

Log at ERROR or WARN matching the policy error handling

fn global_velocity_control(&self) -> VelocityControlSpec

Velocity control to apply to the entire node

fn max_channels(&self) -> usize

Maximum number of concurrent channels

fn max_invoices(&self) -> usize

Maximum number of concurrent invoices (issued and approved)

fn fee_velocity_control(&self) -> VelocityControlSpec

Velocity control to apply to L1 fees paid by the node