X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Frouting%2Frouter.rs;h=9c5fe8e1f9bd3dab59033644591a4a59b49d173b;hb=b5e959460f1473022321c8b8868fb0f7da6906b5;hp=10bdd69b51a9b4a66e14ace4278645da4ada4be4;hpb=6082b57097a4ccca168641dac872d6afa9659502;p=rust-lightning

diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs
index 10bdd69b..9c5fe8e1 100644
--- a/lightning/src/routing/router.rs
+++ b/lightning/src/routing/router.rs
@@ -359,8 +359,12 @@ impl Route {
 		overpaid_value_msat + self.paths.iter().map(|path| path.fee_msat()).sum::<u64>()
 	}
 
-	/// Returns the total amount paid on this [`Route`], excluding the fees. Might be more than
-	/// requested if we had to reach htlc_minimum_msat.
+	/// Returns the total amount paid on this [`Route`], excluding the fees.
+	///
+	/// Might be more than requested as part of the given [`RouteParameters::final_value_msat`] if
+	/// we had to reach the [`htlc_minimum_msat`] limits.
+	///
+	/// [`htlc_minimum_msat`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
 	pub fn get_total_amount(&self) -> u64 {
 		self.paths.iter().map(|path| path.final_value_msat()).sum()
 	}