Switch to nightly rustfmt

Author: tnull

.github/workflows/rust.yml

@@ -38,7 +38,6 @@ jobs:
       - name: Install Rust ${{ matrix.toolchain }} toolchain
         run: |
           curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ matrix.toolchain }}
-          rustup override set ${{ matrix.toolchain }}
       - name: Check formatting on Rust ${{ matrix.toolchain }}
         if: matrix.check-fmt
         run: rustup component add rustfmt && cargo fmt --all -- --check

rust-toolchain.toml

@@ -0,0 +1,4 @@
+[toolchain]
+channel = "nightly-2025-10-08"
+components = [ "rustfmt" ]
+profile = "minimal"

rustfmt.toml

@@ -4,11 +4,15 @@ hard_tabs = true
 use_field_init_shorthand = true
 max_width = 100
 match_block_trailing_comma = true
-# UNSTABLE: format_code_in_doc_comments = true
-# UNSTABLE: overflow_delimited_expr = true
-# UNSTABLE: comment_width = 100
-# UNSTABLE: format_macro_matchers = true
-# UNSTABLE: format_strings = true
-# UNSTABLE: group_imports = "StdExternalCrate"
-# UNSTABLE: reorder_imports = true
-# UNSTABLE: imports_granularity = "Module"
+format_code_in_doc_comments = true
+overflow_delimited_expr = true
+comment_width = 100
+format_macro_matchers = true
+format_strings = true
+group_imports = "StdExternalCrate"
+reorder_imports = true
+imports_granularity = "Module"
+wrap_comments = true
+normalize_comments = true
+normalize_doc_attributes = true
+style_edition = "2021"

src/balance.rs

@@ -94,7 +94,8 @@ pub enum LightningBalance {
 		/// [`LightningBalance::MaybeTimeoutClaimableHTLC::outbound_payment`] flag set, as well as
 		/// any dust HTLCs which would otherwise be represented the same.
 		///
-		/// This amount (rounded up to a whole satoshi value) will not be included in `amount_satoshis`.
+		/// This amount (rounded up to a whole satoshi value) will not be included in
+		/// `amount_satoshis`.
 		outbound_payment_htlc_rounded_msat: u64,
 		/// The amount of millisatoshis which has been burned to fees from HTLCs which are outbound
 		/// from us and are related to a forwarded HTLC. This is the sum of the millisatoshis part
@@ -103,16 +104,17 @@ pub enum LightningBalance {
 		/// [`LightningBalance::MaybeTimeoutClaimableHTLC::outbound_payment`] flag *not* set, as
 		/// well as any dust HTLCs which would otherwise be represented the same.
 		///
-		/// This amount (rounded up to a whole satoshi value) will not be included in `amount_satoshis`.
+		/// This amount (rounded up to a whole satoshi value) will not be included in
+		/// `amount_satoshis`.
 		outbound_forwarded_htlc_rounded_msat: u64,
 		/// The amount of millisatoshis which has been burned to fees from HTLCs which are inbound
 		/// to us and for which we know the preimage. This is the sum of the millisatoshis part of
 		/// all HTLCs which would be represented by [`LightningBalance::ContentiousClaimable`] on
 		/// channel close, but whose current value is included in `amount_satoshis`, as well as any
 		/// dust HTLCs which would otherwise be represented the same.
 		///
-		/// This amount (rounded up to a whole satoshi value) will not be included in the counterparty's
-		/// `amount_satoshis`.
+		/// This amount (rounded up to a whole satoshi value) will not be included in the
+		/// counterparty's `amount_satoshis`.
 		inbound_claiming_htlc_rounded_msat: u64,
 		/// The amount of millisatoshis which has been burned to fees from HTLCs which are inbound
 		/// to us and for which we do not know the preimage. This is the sum of the millisatoshis
@@ -229,7 +231,8 @@ impl LightningBalance {
 				inbound_claiming_htlc_rounded_msat,
 				inbound_htlc_rounded_msat,
 			} => {
-				// unwrap safety: confirmed_balance_candidate_index is guaranteed to index into balance_candidates
+				// unwrap safety: confirmed_balance_candidate_index is guaranteed to index into
+				// balance_candidates
 				let balance = balance_candidates.get(confirmed_balance_candidate_index).unwrap();
 
 				Self::ClaimableOnChannelClose {
@@ -305,8 +308,8 @@ impl LightningBalance {
 /// Details about the status of a known balance currently being swept to our on-chain wallet.
 #[derive(Debug, Clone)]
 pub enum PendingSweepBalance {
-	/// The spendable output is about to be swept, but a spending transaction has yet to be generated and
-	/// broadcast.
+	/// The spendable output is about to be swept, but a spending transaction has yet to be
+	/// generated and broadcast.
 	PendingBroadcast {
 		/// The identifier of the channel this balance belongs to.
 		channel_id: Option<ChannelId>,

src/builder.rs

@@ -183,7 +183,8 @@ pub enum BuildError {
 	LoggerSetupFailed,
 	/// The given network does not match the node's previously configured network.
 	NetworkMismatch,
-	/// The role of the node in an asynchronous payments context is not compatible with the current configuration.
+	/// The role of the node in an asynchronous payments context is not compatible with the current
+	/// configuration.
 	AsyncPaymentsConfigMismatch,
 }
 
@@ -325,8 +326,8 @@ impl NodeBuilder {
 
 	/// Configures the [`Node`] instance to source its chain data from the given Esplora server.
 	///
-	/// The given `headers` will be included in all requests to the Esplora server, typically used for
-	/// authentication purposes.
+	/// The given `headers` will be included in all requests to the Esplora server, typically used
+	/// for authentication purposes.
 	///
 	/// If no `sync_config` is given, default values are used. See [`EsploraSyncConfig`] for more
 	/// information.
@@ -353,12 +354,12 @@ impl NodeBuilder {
 
 	/// Configures the [`Node`] instance to connect to a Bitcoin Core node via RPC.
 	///
-	/// This method establishes an RPC connection that enables all essential chain operations including
-	/// transaction broadcasting and chain data synchronization.
+	/// This method establishes an RPC connection that enables all essential chain operations
+	/// including transaction broadcasting and chain data synchronization.
 	///
 	/// ## Parameters:
-	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
-	///   connection.
+	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin
+	///   Core RPC connection.
 	pub fn set_chain_source_bitcoind_rpc(
 		&mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 	) -> &mut Self {
@@ -372,15 +373,16 @@ impl NodeBuilder {
 		self
 	}
 
-	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
+	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST
+	/// endpoint.
 	///
 	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
 	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
 	///
 	/// ## Parameters:
 	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
-	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
-	///   connection
+	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin
+	///   Core RPC connection
 	pub fn set_chain_source_bitcoind_rest(
 		&mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 		rpc_user: String, rpc_password: String,
@@ -413,7 +415,8 @@ 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 channels, see [`Config::trusted_peers_0conf`].
+	/// Will mark the LSP as trusted for 0-confirmation channels, see
+	/// [`Config::trusted_peers_0conf`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///
@@ -434,7 +437,8 @@ 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 channels, see [`Config::trusted_peers_0conf`].
+	/// Will mark the LSP as trusted for 0-confirmation channels, see
+	/// [`Config::trusted_peers_0conf`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///
@@ -507,7 +511,8 @@ impl NodeBuilder {
 		self
 	}
 
-	/// Sets the IP address and TCP port on which [`Node`] will listen for incoming network connections.
+	/// Sets the IP address and TCP port on which [`Node`] will listen for incoming network
+	/// connections.
 	pub fn set_listening_addresses(
 		&mut self, listening_addresses: Vec<SocketAddress>,
 	) -> Result<&mut Self, BuildError> {
@@ -519,9 +524,11 @@ impl NodeBuilder {
 		Ok(self)
 	}
 
-	/// Sets the IP address and TCP port which [`Node`] will announce to the gossip network that it accepts connections on.
+	/// Sets the IP address and TCP port which [`Node`] will announce to the gossip network that it
+	/// accepts connections on.
 	///
-	/// **Note**: If unset, the [`listening_addresses`] will be used as the list of addresses to announce.
+	/// **Note**: If unset, the [`listening_addresses`] will be used as the list of addresses to
+	/// announce.
 	///
 	/// [`listening_addresses`]: Self::set_listening_addresses
 	pub fn set_announcement_addresses(
@@ -593,11 +600,12 @@ impl NodeBuilder {
 	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
 	/// previously configured.
 	///
-	/// Uses [LNURL-auth] based authentication scheme as default method for authentication/authorization.
+	/// Uses [LNURL-auth] based authentication scheme as default method for
+	/// authentication/authorization.
 	///
-	/// The LNURL challenge will be retrieved by making a request to the given `lnurl_auth_server_url`.
-	/// The returned JWT token in response to the signed LNURL request, will be used for
-	/// authentication/authorization of all the requests made to VSS.
+	/// The LNURL challenge will be retrieved by making a request to the given
+	/// `lnurl_auth_server_url`. The returned JWT token in response to the signed LNURL request,
+	/// will be used for authentication/authorization of all the requests made to VSS.
 	///
 	/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
 	///
@@ -627,10 +635,9 @@ impl NodeBuilder {
 			derive_xprv(config, &seed_bytes, VSS_HARDENED_CHILD_INDEX, Arc::clone(&logger))?;
 
 		let lnurl_auth_xprv = vss_xprv
-			.derive_priv(
-				&Secp256k1::new(),
-				&[ChildNumber::Hardened { index: VSS_LNURL_AUTH_HARDENED_CHILD_INDEX }],
-			)
+			.derive_priv(&Secp256k1::new(), &[ChildNumber::Hardened {
+				index: VSS_LNURL_AUTH_HARDENED_CHILD_INDEX,
+			}])
 			.map_err(|e| {
 				log_error!(logger, "Failed to derive VSS secret: {}", e);
 				BuildError::KVStoreSetupFailed
@@ -829,8 +836,8 @@ impl ArcedNodeBuilder {
 
 	/// Configures the [`Node`] instance to source its chain data from the given Esplora server.
 	///
-	/// The given `headers` will be included in all requests to the Esplora server, typically used for
-	/// authentication purposes.
+	/// The given `headers` will be included in all requests to the Esplora server, typically used
+	/// for authentication purposes.
 	///
 	/// If no `sync_config` is given, default values are used. See [`EsploraSyncConfig`] for more
 	/// information.
@@ -857,12 +864,12 @@ impl ArcedNodeBuilder {
 
 	/// Configures the [`Node`] instance to connect to a Bitcoin Core node via RPC.
 	///
-	/// This method establishes an RPC connection that enables all essential chain operations including
-	/// transaction broadcasting and chain data synchronization.
+	/// This method establishes an RPC connection that enables all essential chain operations
+	/// including transaction broadcasting and chain data synchronization.
 	///
 	/// ## Parameters:
-	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
-	///   connection.
+	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin
+	///   Core RPC connection.
 	pub fn set_chain_source_bitcoind_rpc(
 		&self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
 	) {
@@ -874,15 +881,16 @@ impl ArcedNodeBuilder {
 		);
 	}
 
-	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
+	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST
+	/// endpoint.
 	///
 	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
 	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
 	///
 	/// ## Parameters:
 	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
-	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
-	///   connection
+	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin
+	///   Core RPC connection
 	pub fn set_chain_source_bitcoind_rest(
 		&self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 		rpc_user: String, rpc_password: String,
@@ -912,7 +920,8 @@ 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 channels, see [`Config::trusted_peers_0conf`].
+	/// Will mark the LSP as trusted for 0-confirmation channels, see
+	/// [`Config::trusted_peers_0conf`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///
@@ -926,7 +935,8 @@ 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 channels, see [`Config::trusted_peers_0conf`].
+	/// Will mark the LSP as trusted for 0-confirmation channels, see
+	/// [`Config::trusted_peers_0conf`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
 	///
@@ -982,16 +992,19 @@ impl ArcedNodeBuilder {
 		self.inner.write().unwrap().set_network(network);
 	}
 
-	/// Sets the IP address and TCP port on which [`Node`] will listen for incoming network connections.
+	/// Sets the IP address and TCP port on which [`Node`] will listen for incoming network
+	/// connections.
 	pub fn set_listening_addresses(
 		&self, listening_addresses: Vec<SocketAddress>,
 	) -> Result<(), BuildError> {
 		self.inner.write().unwrap().set_listening_addresses(listening_addresses).map(|_| ())
 	}
 
-	/// Sets the IP address and TCP port which [`Node`] will announce to the gossip network that it accepts connections on.
+	/// Sets the IP address and TCP port which [`Node`] will announce to the gossip network that it
+	/// accepts connections on.
 	///
-	/// **Note**: If unset, the [`listening_addresses`] will be used as the list of addresses to announce.
+	/// **Note**: If unset, the [`listening_addresses`] will be used as the list of addresses to
+	/// announce.
 	///
 	/// [`listening_addresses`]: Self::set_listening_addresses
 	pub fn set_announcement_addresses(
@@ -1030,11 +1043,12 @@ impl ArcedNodeBuilder {
 	/// Builds a [`Node`] instance with a [VSS] backend and according to the options
 	/// previously configured.
 	///
-	/// Uses [LNURL-auth] based authentication scheme as default method for authentication/authorization.
+	/// Uses [LNURL-auth] based authentication scheme as default method for
+	/// authentication/authorization.
 	///
-	/// The LNURL challenge will be retrieved by making a request to the given `lnurl_auth_server_url`.
-	/// The returned JWT token in response to the signed LNURL request, will be used for
-	/// authentication/authorization of all the requests made to VSS.
+	/// The LNURL challenge will be retrieved by making a request to the given
+	/// `lnurl_auth_server_url`. The returned JWT token in response to the signed LNURL request,
+	/// will be used for authentication/authorization of all the requests made to VSS.
 	///
 	/// `fixed_headers` are included as it is in all the requests made to VSS and LNURL auth server.
 	///
@@ -1116,7 +1130,12 @@ fn build_with_store_internal(
 
 	if let Err(err) = may_announce_channel(&config) {
 		if config.announcement_addresses.is_some() {
-			log_error!(logger, "Announcement addresses were set but some required configuration options for node announcement are missing: {}", err);
+			log_error!(
+				logger,
+				"Announcement addresses were set but some required configuration options for node \
+				 announcement are missing: {}",
+				err
+			);
 			let build_error = if matches!(err, AnnounceError::MissingNodeAlias) {
 				BuildError::InvalidNodeAlias
 			} else {
@@ -1126,7 +1145,12 @@ fn build_with_store_internal(
 		}
 
 		if config.node_alias.is_some() {
-			log_error!(logger, "Node alias was set but some required configuration options for node announcement are missing: {}", err);
+			log_error!(
+				logger,
+				"Node alias was set but some required configuration options for node announcement \
+				 are missing: {}",
+				err
+			);
 			return Err(BuildError::InvalidListeningAddresses);
 		}
 	}
@@ -1747,7 +1771,8 @@ fn optionally_install_rustls_cryptoprovider() {
 	static INIT_CRYPTO: Once = Once::new();
 
 	INIT_CRYPTO.call_once(|| {
-		// Ensure we always install a `CryptoProvider` for `rustls` if it was somehow not previously installed by now.
+		// Ensure we always install a `CryptoProvider` for `rustls` if it was somehow not previously
+		// installed by now.
 		if rustls::crypto::CryptoProvider::get_default().is_none() {
 			let _ = rustls::crypto::ring::default_provider().install_default();
 		}
@@ -1830,7 +1855,8 @@ fn derive_xprv(
 		})
 }
 
-/// Sanitize the user-provided node alias to ensure that it is a valid protocol-specified UTF-8 string.
+/// Sanitize the user-provided node alias to ensure that it is a valid protocol-specified UTF-8
+/// string.
 pub(crate) fn sanitize_alias(alias_str: &str) -> Result<NodeAlias, BuildError> {
 	let alias = alias_str.trim();