nits by val

Author: Evanfeenstra

lightning/src/ln/channelmanager.rs

@@ -121,7 +121,7 @@ pub enum PendingHTLCRouting {
 	},
 	/// An HTLC paid to an invoice (supposedly) generated by us.
 	/// At this point, we have not checked that the invoice being paid was actually generated by us,
-	/// but rather its claiming to pay an invoice of ours.
+	/// but rather it's claiming to pay an invoice of ours.
 	Receive {
 		/// Payment secret and total msat received.
 		payment_data: msgs::FinalOnionHopData,
@@ -141,8 +141,8 @@ pub enum PendingHTLCRouting {
 	ReceiveKeysend {
 		/// This was added in 0.0.116 and will break deserialization on downgrades.
 		payment_data: Option<msgs::FinalOnionHopData>,
-		/// Preimage for this onion payment. This preimage will be used in the invoice
-		/// generated and immediately settled for the spontaneous payment.
+		/// Preimage for this onion payment. This preimage is provided by the sender and will be
+		/// used to settle the spontaneous payment.
 		payment_preimage: PaymentPreimage,
 		/// See [`RecipientOnionFields::payment_metadata`] for more info.
 		payment_metadata: Option<Vec<u8>>,
@@ -160,9 +160,9 @@ pub struct PendingHTLCInfo {
 	/// Further routing details based on whether the HTLC is being forwarded or received.
 	pub routing: PendingHTLCRouting,
 	/// Shared secret from the previous hop.
-	/// Used to obfuscate any corresponding return packets back to the previous hop.
+	/// Used encrypt failure packets in the event that the HTLC needs to be failed backwards.
 	pub incoming_shared_secret: [u8; 32],
-	/// Hash of the payment preimage. Used to cross-lock the payment across the hop.
+	/// Hash of the payment preimage, to lock the payment until the receiver releases the preimage.
 	pub payment_hash: PaymentHash,
 	/// Amount offered by this HTLC.
 	pub incoming_amt_msat: Option<u64>, // Added in 0.0.113

lightning/src/ln/onion_payment.rs

@@ -1,6 +1,6 @@
 //! Utilities for channelmanager.rs
 //!
-//! Includes a public peel_payment_onion function for use by external projects or libraries.
+//! Includes a public [`peel_payment_onion`] function for use by external projects or libraries.
 
 use bitcoin::hashes::Hash;
 use bitcoin::hashes::sha256::Hash as Sha256;
@@ -379,8 +379,8 @@ mod tests {
 	use crate::ln::ChannelId;
 	use crate::ln::channelmanager::RecipientOnionFields;
 	use crate::ln::features::{ChannelFeatures, NodeFeatures};
-    use crate::ln::msgs;
-    use crate::ln::onion_utils::create_payment_onion;
+	use crate::ln::msgs;
+	use crate::ln::onion_utils::create_payment_onion;
 	use crate::routing::router::{Path, RouteHop};
 	use crate::util::test_utils;
 
@@ -496,4 +496,4 @@ mod tests {
 			prng_seed, hops, recipient_amount, pay_secret)
 	}
 
-}
+}