f: Highlight the list only applies to inbound channels

Author: tankyleo

src/builder.rs

@@ -435,7 +435,7 @@ impl NodeBuilder {
 	/// Configures the [`Node`] instance to source inbound liquidity from the given
 	/// [bLIP-51 / LSPS1] service.
 	///
-	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::trusted_peers_0conf_0reserve`].
+	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::inbound_trusted_peers_0conf_0reserve`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///
@@ -444,7 +444,7 @@ impl NodeBuilder {
 		&mut self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
 	) -> &mut Self {
 		// Mark the LSP as trusted for 0conf, 0reserve
-		self.config.trusted_peers_0conf_0reserve.push(node_id.clone());
+		self.config.inbound_trusted_peers_0conf_0reserve.push(node_id.clone());
 
 		let liquidity_source_config =
 			self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
@@ -456,7 +456,7 @@ impl NodeBuilder {
 	/// Configures the [`Node`] instance to source just-in-time inbound liquidity from the given
 	/// [bLIP-52 / LSPS2] service.
 	///
-	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::trusted_peers_0conf_0reserve`].
+	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::inbound_trusted_peers_0conf_0reserve`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///
@@ -465,7 +465,7 @@ impl NodeBuilder {
 		&mut self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
 	) -> &mut Self {
 		// Mark the LSP as trusted for 0conf, 0reserve
-		self.config.trusted_peers_0conf_0reserve.push(node_id.clone());
+		self.config.inbound_trusted_peers_0conf_0reserve.push(node_id.clone());
 
 		let liquidity_source_config =
 			self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
@@ -956,7 +956,7 @@ impl ArcedNodeBuilder {
 	/// Configures the [`Node`] instance to source inbound liquidity from the given
 	/// [bLIP-51 / LSPS1] service.
 	///
-	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::trusted_peers_0conf_0reserve`].
+	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::inbound_trusted_peers_0conf_0reserve`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///
@@ -970,7 +970,7 @@ impl ArcedNodeBuilder {
 	/// Configures the [`Node`] instance to source just-in-time inbound liquidity from the given
 	/// [bLIP-52 / LSPS2] service.
 	///
-	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::trusted_peers_0conf_0reserve`].
+	/// Will mark the LSP as trusted for 0-confirmation, 0-reserve channels, see [`Config::inbound_trusted_peers_0conf_0reserve`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///

src/config.rs

@@ -123,7 +123,7 @@ pub(crate) const LNURL_AUTH_TIMEOUT_SECS: u64 = 15;
 /// | `listening_addresses`                  | None               |
 /// | `announcement_addresses`               | None               |
 /// | `node_alias`                           | None               |
-/// | `trusted_peers_0conf_0reserve`         | []                 |
+/// | `inbound_trusted_peers_0conf_0reserve` | []                 |
 /// | `probing_liquidity_limit_multiplier`   | 3                  |
 /// | `anchor_channels_config`               | Some(..)           |
 /// | `route_parameters`                     | None               |
@@ -163,11 +163,17 @@ pub struct Config {
 	/// confirmations of the funding transaction (zero-conf), and allow them to spend their
 	/// entire balance (zero-reserve).
 	///
+	/// **Note:** This list only sets 0-reserve for a peer *if that peer opens the channel to
+	/// us*. If you would like to open the channel yourself, and set 0-reserve for that peer,
+	/// see [`Node::open_0reserve_channel`].
+	///
 	/// **Note:** Allowing payments via zero-confirmation channels is insecure if the funding
 	/// transaction never gets confirmed on-chain. Zero-reserve channels allow the peer to try
 	/// to steal your funds with no financial penalty. Zero-confirmation, and zero-reserve
 	/// channels should therefore only be accepted from trusted peers.
-	pub trusted_peers_0conf_0reserve: Vec<PublicKey>,
+	///
+	/// [`Node::open_0reserve_channel`]: crate::Node::open_0reserve_channel
+	pub inbound_trusted_peers_0conf_0reserve: Vec<PublicKey>,
 	/// The liquidity factor by which we filter the outgoing channels used for sending probes.
 	///
 	/// Channels with available liquidity less than the required amount times this value won't be
@@ -214,7 +220,7 @@ impl Default for Config {
 			network: DEFAULT_NETWORK,
 			listening_addresses: None,
 			announcement_addresses: None,
-			trusted_peers_0conf_0reserve: Vec::new(),
+			inbound_trusted_peers_0conf_0reserve: Vec::new(),
 			probing_liquidity_limit_multiplier: DEFAULT_PROBING_LIQUIDITY_LIMIT_MULTIPLIER,
 			anchor_channels_config: Some(AnchorChannelsConfig::default()),
 			tor_config: None,

src/event.rs

@@ -1283,8 +1283,10 @@ where
 						});
 					}
 				}
-				let is_trusted_peer =
-					self.config.trusted_peers_0conf_0reserve.contains(&counterparty_node_id);
+				let is_trusted_peer = self
+					.config
+					.inbound_trusted_peers_0conf_0reserve
+					.contains(&counterparty_node_id);
 				let res = if is_trusted_peer {
 					self.channel_manager.accept_inbound_channel_from_trusted_peer(
 						&temporary_channel_id,

src/lib.rs

@@ -1431,7 +1431,7 @@ impl Node {
 	///
 	/// Note that this only allows *the counterparty* to spend *their* entire balance in the
 	/// the channel; whether *you* are allowed to spend your own full balance is the
-	/// counterparty's decision. See [`Config::trusted_peers_0conf_0reserve`] if the
+	/// counterparty's decision. See [`Config::inbound_trusted_peers_0conf_0reserve`] if the
 	/// counterparty would like to set zero-reserve on your own balance as well.
 	///
 	/// Disconnects and reconnects are handled automatically.
@@ -1446,7 +1446,7 @@ impl Node {
 	///
 	/// Returns a [`UserChannelId`] allowing to locally keep track of the channel.
 	///
-	/// [`Config::trusted_peers_0conf_0reserve`]: crate::config::Config::trusted_peers_0conf_0reserve
+	/// [`Config::inbound_trusted_peers_0conf_0reserve`]: crate::config::Config::inbound_trusted_peers_0conf_0reserve
 	/// [`AnchorChannelsConfig::per_channel_reserve_sats`]: crate::config::AnchorChannelsConfig::per_channel_reserve_sats
 	pub fn open_0reserve_channel(
 		&self, node_id: PublicKey, address: SocketAddress, channel_amount_sats: u64,
@@ -1472,7 +1472,7 @@ impl Node {
 	///
 	/// Note that this only allows *the counterparty* to spend *their* entire balance in the
 	/// the channel; whether *you* are allowed to spend your own full balance is the
-	/// counterparty's decision. See [`Config::trusted_peers_0conf_0reserve`] if the
+	/// counterparty's decision. See [`Config::inbound_trusted_peers_0conf_0reserve`] if the
 	/// counterparty would like to set zero-reserve on your own balance as well.
 	///
 	/// Disconnects and reconnects are handled automatically.
@@ -1483,7 +1483,7 @@ impl Node {
 	///
 	/// Returns a [`UserChannelId`] allowing to locally keep track of the channel.
 	///
-	/// [`Config::trusted_peers_0conf_0reserve`]: crate::config::Config::trusted_peers_0conf_0reserve
+	/// [`Config::inbound_trusted_peers_0conf_0reserve`]: crate::config::Config::inbound_trusted_peers_0conf_0reserve
 	pub fn open_0reserve_channel_with_all(
 		&self, node_id: PublicKey, address: SocketAddress, push_to_counterparty_msat: Option<u64>,
 		channel_config: Option<ChannelConfig>,

tests/common/mod.rs

@@ -406,7 +406,7 @@ pub(crate) fn setup_two_nodes_with_store(
 	let mut config_b = random_config(anchor_channels);
 	config_b.store_type = store_type;
 	if allow_0conf_0reserve {
-		config_b.node_config.trusted_peers_0conf_0reserve.push(node_a.node_id());
+		config_b.node_config.inbound_trusted_peers_0conf_0reserve.push(node_a.node_id());
 	}
 	if anchor_channels && anchors_trusted_no_reserve {
 		config_b