config: flag legacy fields with documentation

This commit is contained in:
Jesse de Wit
2024-02-08 11:00:44 +01:00
parent 31bf2a885a
commit 044bf3d491

View File

@@ -42,11 +42,8 @@ type NodeConfig struct {
// have. // have.
MinConfs *uint32 `json:"minConfs,string"` MinConfs *uint32 `json:"minConfs,string"`
// Smallest htlc amount routed over channels opened with the OpenChannel // Smallest htlc amount routed over channels a channel. It is configured on
// rpc call. // the node itself, but this value is returned in the ChannelInformation rpc.
//
// Deprecated: This config option is part of the OpenChannel rpc, which is
// deprecated.
MinHtlcMsat uint64 `json:"minHtlcMsat,string"` MinHtlcMsat uint64 `json:"minHtlcMsat,string"`
// The base fee for routing payments over the channel. It is configured on // The base fee for routing payments over the channel. It is configured on
@@ -62,11 +59,15 @@ type NodeConfig struct {
// Fee for opening a zero conf channel in satoshi per 10000 satoshi based // Fee for opening a zero conf channel in satoshi per 10000 satoshi based
// on the incoming payment amount. // on the incoming payment amount.
// This field is for legacy support for clients that don't support
// OpeningFeeParams.
ChannelFeePermyriad int64 `json:"channelFeePermyriad,string"` ChannelFeePermyriad int64 `json:"channelFeePermyriad,string"`
// Minimum fee for opening a zero conf channel in millisatoshi. If the fee // Minimum fee for opening a zero conf channel in millisatoshi. If the fee
// using ChannelFeePermyriad is less than this amount, this amount is the // using ChannelFeePermyriad is less than this amount, this amount is the
// actual fee to be paid. // actual fee to be paid.
// This field is for legacy support for clients that don't support
// OpeningFeeParams.
ChannelMinimumFeeMsat int64 `json:"channelMinimumFeeMsat,string"` ChannelMinimumFeeMsat int64 `json:"channelMinimumFeeMsat,string"`
// Channel capacity that is added on top of the incoming payment amount // Channel capacity that is added on top of the incoming payment amount
@@ -75,6 +76,8 @@ type NodeConfig struct {
// The channel can be closed if not used this duration in seconds. This is // The channel can be closed if not used this duration in seconds. This is
// not enforced by lspd, but gives an indication to clients. // not enforced by lspd, but gives an indication to clients.
// This field is for legacy support for clients that don't support
// OpeningFeeParams.
MaxInactiveDuration uint64 `json:"maxInactiveDuration,string"` MaxInactiveDuration uint64 `json:"maxInactiveDuration,string"`
// The maximum time to hold a htlc after sending a notification when the // The maximum time to hold a htlc after sending a notification when the