44use ln:: channelmanager:: { BREAKDOWN_TIMEOUT , MAX_LOCAL_BREAKDOWN_TIMEOUT } ;
55
66/// Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
7+ ///
8+ /// Default::default() provides sane defaults for most configurations
9+ /// (but currently with 0 relay fees!)
710#[ derive( Clone , Debug ) ]
811pub struct UserConfig {
912 /// Channel config that we propose to our counterparty.
@@ -14,41 +17,44 @@ pub struct UserConfig {
1417pub channel_options : ChannelConfig ,
1518}
1619
17- impl UserConfig {
18- /// Provides sane defaults for most configurations (but with 0 relay fees!)
19- pub fn new ( ) -> Self {
20+ impl Default for UserConfig {
21+ fn default ( ) -> Self {
2022 UserConfig {
21- own_channel_config : ChannelHandshakeConfig :: new ( ) ,
22- peer_channel_config_limits : ChannelHandshakeLimits :: new ( ) ,
23- channel_options : ChannelConfig :: new ( ) ,
23+ own_channel_config : ChannelHandshakeConfig :: default ( ) ,
24+ peer_channel_config_limits : ChannelHandshakeLimits :: default ( ) ,
25+ channel_options : ChannelConfig :: default ( ) ,
2426 }
2527 }
2628}
2729
2830/// Configuration we set when applicable.
31+ ///
32+ /// Default::default() provides sane defaults.
2933#[ derive( Clone , Debug ) ]
3034pub struct ChannelHandshakeConfig {
3135 /// Confirmations we will wait for before considering the channel locked in.
3236/// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
3337/// equivalent limit applied to outbound channels).
38+ ///
39+ /// Default value: 6.
3440pub minimum_depth : u32 ,
3541 /// Set to the amount of time we require our counterparty to wait to claim their money.
3642///
3743/// It's one of the main parameter of our security model. We (or one of our watchtowers) MUST
3844/// be online to check for peer having broadcast a revoked transaction to steal our funds
3945/// at least once every our_to_self_delay blocks.
40- /// Default is BREAKDOWN_TIMEOUT, we enforce it as a minimum at channel opening so you can
41- /// tweak config to ask for more security, not less.
4246///
4347/// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
4448/// case of an honest unilateral channel close, which implicitly decrease the economic value of
4549/// our channel.
50+ ///
51+ /// Default value: BREAKDOWN_TIMEOUT (currently 144), we enforce it as a minimum at channel
52+ /// opening so you can tweak config to ask for more security, not less.
4653pub our_to_self_delay : u16 ,
4754}
4855
49- impl ChannelHandshakeConfig {
50- /// Provides sane defaults for `ChannelHandshakeConfig`
51- pub fn new ( ) -> ChannelHandshakeConfig {
56+ impl Default for ChannelHandshakeConfig {
57+ fn default ( ) -> ChannelHandshakeConfig {
5258 ChannelHandshakeConfig {
5359 minimum_depth : 6 ,
5460 our_to_self_delay : BREAKDOWN_TIMEOUT ,
@@ -61,23 +67,39 @@ impl ChannelHandshakeConfig {
6167/// These limits are only applied to our counterparty's limits, not our own.
6268///
6369/// Use 0/<type>::max_value() as appropriate to skip checking.
70+ ///
71+ /// Provides sane defaults for most configurations.
72+ ///
73+ /// Most additional limits are disabled except those with which specify a default in individual
74+ /// field documentation. Note that this may result in barely-usable channels, but since they
75+ /// are applied mostly only to incoming channels that's not much of a problem.
6476#[ derive( Copy , Clone , Debug ) ]
6577pub struct ChannelHandshakeLimits {
6678 /// Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
6779/// only applies to inbound channels.
80+ ///
81+ /// Default value: 0.
6882pub min_funding_satoshis : u64 ,
6983 /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
7084/// you to limit the maximum minimum-size they can require.
85+ ///
86+ /// Default value: u64::max_value.
7187pub max_htlc_minimum_msat : u64 ,
7288 /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
7389/// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
90+ ///
91+ /// Default value: 0.
7492pub min_max_htlc_value_in_flight_msat : u64 ,
7593 /// The remote node will require we keep a certain amount in direct payment to ourselves at all
7694/// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
7795/// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
96+ ///
97+ /// Default value: u64::max_value.
7898pub max_channel_reserve_satoshis : u64 ,
7999 /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
80100/// time. This allows you to set a minimum such value.
101+ ///
102+ /// Default value: 0.
81103pub min_max_accepted_htlcs : u16 ,
82104 /// Outputs below a certain value will not be added to on-chain transactions. The dust value is
83105/// required to always be higher than this value so this only applies to HTLC outputs (and
@@ -86,39 +108,40 @@ pub struct ChannelHandshakeLimits {
86108/// This setting allows you to set a minimum dust limit for their commitment transactions,
87109/// reflecting the reality that tiny outputs are not considered standard transactions and will
88110/// not propagate through the Bitcoin network.
89- /// Defaults to 546, or the current dust limit on the Bitcoin network.
111+ ///
112+ /// Default value: 546, the current dust limit on the Bitcoin network.
90113pub min_dust_limit_satoshis : u64 ,
91114 /// Maximum allowed threshold above which outputs will not be generated in their commitment
92115/// transactions.
93116/// HTLCs below this amount plus HTLC transaction fees are not enforceable on-chain.
117+ ///
118+ /// Default value: u64::max_value.
94119pub max_dust_limit_satoshis : u64 ,
95120 /// Before a channel is usable the funding transaction will need to be confirmed by at least a
96121/// certain number of blocks, specified by the node which is not the funder (as the funder can
97122/// assume they aren't going to double-spend themselves).
98- /// This config allows you to set a limit on the maximum amount of time to wait. Defaults to
99- /// 144 blocks or roughly one day and only applies to outbound channels.
123+ /// This config allows you to set a limit on the maximum amount of time to wait.
124+ ///
125+ /// Default value: 144, or roughly one day and only applies to outbound channels.
100126pub max_minimum_depth : u32 ,
101127 /// Set to force the incoming channel to match our announced channel preference in
102128/// ChannelConfig.
103- /// Defaults to true to make the default that no announced channels are possible (which is
129+ ///
130+ /// Default value: true, to make the default that no announced channels are possible (which is
104131/// appropriate for any nodes which are not online very reliably).
105132pub force_announced_channel_preference : bool ,
106133 /// Set to the amount of time we're willing to wait to claim money back to us.
107134///
108135/// Not checking this value would be a security issue, as our peer would be able to set it to
109136/// max relative lock-time (a year) and we would "lose" money as it would be locked for a long time.
110- /// Default is MAX_LOCAL_BREAKDOWN_TIMEOUT, which we also enforce as a maximum value
137+ ///
138+ /// Default value: MAX_LOCAL_BREAKDOWN_TIMEOUT (1008), which we also enforce as a maximum value
111139/// so you can tweak config to reduce the loss of having useless locked funds (if your peer accepts)
112140pub their_to_self_delay : u16
113141}
114142
115- impl ChannelHandshakeLimits {
116- /// Provides sane defaults for most configurations.
117- ///
118- /// Most additional limits are disabled except those with which specify a default in individual
119- /// field documentation. Note that this may result in barely-usable channels, but since they
120- /// are applied mostly only to incoming channels that's not much of a problem.
121- pub fn new ( ) -> Self {
143+ impl Default for ChannelHandshakeLimits {
144+ fn default ( ) -> Self {
122145 ChannelHandshakeLimits {
123146 min_funding_satoshis : 0 ,
124147 max_htlc_minimum_msat : <u64 >:: max_value ( ) ,
@@ -141,6 +164,8 @@ pub struct ChannelConfig {
141164 /// Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
142165/// This may be allowed to change at runtime in a later update, however doing so must result in
143166/// update messages sent to notify all nodes of our updated relay fee.
167+ ///
168+ /// Default value: 0.
144169pub fee_proportional_millionths : u32 ,
145170 /// Set to announce the channel publicly and notify all nodes that they can route via this
146171/// channel.
@@ -151,6 +176,8 @@ pub struct ChannelConfig {
151176/// channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
152177///
153178/// This cannot be changed after the initial channel handshake.
179+ ///
180+ /// Default value: false.
154181pub announced_channel : bool ,
155182 /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
156183/// supports it, they will then enforce the mutual-close output to us matches what we provided
@@ -161,12 +188,14 @@ pub struct ChannelConfig {
161188/// lightning payments, so we never require that our counterparties support this option.
162189///
163190/// This cannot be changed after a channel has been initialized.
191+ ///
192+ /// Default value: true.
164193pub commit_upfront_shutdown_pubkey : bool
165194}
166195
167- impl ChannelConfig {
196+ impl Default for ChannelConfig {
168197 /// Provides sane defaults for most configurations (but with zero relay fees!).
169- pub fn new ( ) -> Self {
198+ fn default ( ) -> Self {
170199 ChannelConfig {
171200 fee_proportional_millionths : 0 ,
172201 announced_channel : false ,
0 commit comments