Skip to content

Commit 998d0d0

Browse files
committed
Add ReserveType to ChannelDetails
We expose the reserve type of each channel through a new ReserveType enum on ChannelDetails. This tells users whether a channel uses adaptive anchor reserves, has no reserve due to a trusted peer, or is a legacy pre-anchor channel. The reserve type is derived at query time in list_channels by checking the channel's type features against trusted_peers_no_reserve. Additionally, We replace the From<LdkChannelDetails> impl with an explicit from_ldk method that takes the anchor channels config.
1 parent 8b5c797 commit 998d0d0

2 files changed

Lines changed: 75 additions & 5 deletions

File tree

src/lib.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,9 @@ use types::{
177177
HRNResolver, KeysManager, OnionMessenger, PaymentStore, PeerManager, Router, Scorer, Sweeper,
178178
Wallet,
179179
};
180-
pub use types::{ChannelDetails, CustomTlvRecord, PeerDetails, SyncAndAsyncKVStore, UserChannelId};
180+
pub use types::{
181+
ChannelDetails, CustomTlvRecord, PeerDetails, ReserveType, SyncAndAsyncKVStore, UserChannelId,
182+
};
181183
pub use vss_client;
182184

183185
use crate::scoring::setup_background_pathfinding_scores_sync;
@@ -1069,7 +1071,11 @@ impl Node {
10691071

10701072
/// Retrieve a list of known channels.
10711073
pub fn list_channels(&self) -> Vec<ChannelDetails> {
1072-
self.channel_manager.list_channels().into_iter().map(|c| c.into()).collect()
1074+
self.channel_manager
1075+
.list_channels()
1076+
.into_iter()
1077+
.map(|c| ChannelDetails::from_ldk(c, self.config.anchor_channels_config.as_ref()))
1078+
.collect()
10731079
}
10741080

10751081
/// Connect to a node on the peer-to-peer network.

src/types.rs

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ use lightning_net_tokio::SocketDescriptor;
3434

3535
use crate::chain::bitcoind::UtxoSourceClient;
3636
use crate::chain::ChainSource;
37-
use crate::config::ChannelConfig;
37+
use crate::config::{AnchorChannelsConfig, ChannelConfig};
3838
use crate::data_store::DataStore;
3939
use crate::fee_estimator::OnchainFeeEstimator;
4040
use crate::logger::Logger;
@@ -428,6 +428,47 @@ pub struct ChannelCounterparty {
428428
pub outbound_htlc_maximum_msat: Option<u64>,
429429
}
430430

431+
/// Describes the reserve behavior of a channel based on its type and trust configuration.
432+
///
433+
/// This captures the combination of the channel's on-chain construction (anchor outputs vs legacy
434+
/// static_remote_key) and whether the counterparty is in our trusted peers list. It tells the
435+
/// user what reserve obligations exist for this channel without exposing internal protocol details.
436+
///
437+
/// See [`AnchorChannelsConfig`] for how reserve behavior is configured.
438+
///
439+
/// [`AnchorChannelsConfig`]: crate::config::AnchorChannelsConfig
440+
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
441+
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
442+
pub enum ReserveType {
443+
/// An anchor outputs channel where we maintain a per-channel on-chain reserve for fee
444+
/// bumping force-close transactions.
445+
///
446+
/// Anchor channels allow either party to fee-bump commitment transactions via CPFP
447+
/// at broadcast time. Because the pre-signed commitment fee may be insufficient under
448+
/// current fee conditions, the broadcaster must supply additional funds (hence adaptive)
449+
/// through an anchor output spend. The reserve ensures sufficient on-chain funds are
450+
/// available to cover this.
451+
///
452+
/// This is the default for anchor channels when the counterparty is not in
453+
/// [`trusted_peers_no_reserve`].
454+
///
455+
/// [`trusted_peers_no_reserve`]: crate::config::AnchorChannelsConfig::trusted_peers_no_reserve
456+
Adaptive,
457+
/// An anchor outputs channel where we do not maintain any reserve, because the counterparty
458+
/// is in our [`trusted_peers_no_reserve`] list.
459+
///
460+
/// In this mode, we trust the counterparty to broadcast a valid commitment transaction on
461+
/// our behalf and do not set aside funds for fee bumping.
462+
///
463+
/// [`trusted_peers_no_reserve`]: crate::config::AnchorChannelsConfig::trusted_peers_no_reserve
464+
TrustedPeersNoReserve,
465+
/// A legacy (pre-anchor) channel using only `option_static_remotekey`.
466+
///
467+
/// These channels do not use anchor outputs and therefore do not require an on-chain reserve
468+
/// for fee bumping. Commitment transaction fees are pre-committed at channel open time.
469+
Legacy,
470+
}
471+
431472
/// Details of a channel as returned by [`Node::list_channels`].
432473
///
433474
/// When a channel is spliced, most fields continue to refer to the original pre-splice channel
@@ -588,10 +629,32 @@ pub struct ChannelDetails {
588629
pub inbound_htlc_maximum_msat: Option<u64>,
589630
/// Set of configurable parameters that affect channel operation.
590631
pub config: ChannelConfig,
632+
/// The type of on-chain reserve maintained for this channel.
633+
///
634+
/// See [`ReserveType`] for details on how reserves differ between anchor and legacy channels.
635+
pub reserve_type: ReserveType,
591636
}
592637

593-
impl From<LdkChannelDetails> for ChannelDetails {
594-
fn from(value: LdkChannelDetails) -> Self {
638+
impl ChannelDetails {
639+
pub(crate) fn from_ldk(
640+
value: LdkChannelDetails, anchor_channels_config: Option<&AnchorChannelsConfig>,
641+
) -> Self {
642+
let is_anchor_channel =
643+
value.channel_type.as_ref().map_or(false, |ct| ct.supports_anchors_zero_fee_htlc_tx());
644+
645+
let reserve_type = if is_anchor_channel {
646+
let is_trusted = anchor_channels_config.map_or(false, |c| {
647+
c.trusted_peers_no_reserve.contains(&value.counterparty.node_id)
648+
});
649+
if is_trusted {
650+
ReserveType::TrustedPeersNoReserve
651+
} else {
652+
ReserveType::Adaptive
653+
}
654+
} else {
655+
ReserveType::Legacy
656+
};
657+
595658
ChannelDetails {
596659
channel_id: value.channel_id,
597660
counterparty: ChannelCounterparty {
@@ -630,6 +693,7 @@ impl From<LdkChannelDetails> for ChannelDetails {
630693
inbound_htlc_maximum_msat: value.inbound_htlc_maximum_msat,
631694
// unwrap safety: `config` is only `None` for LDK objects serialized prior to 0.0.109.
632695
config: value.config.map(|c| c.into()).unwrap(),
696+
reserve_type,
633697
}
634698
}
635699
}

0 commit comments

Comments
 (0)