nits

Author: devrandom

lightning/src/ln/chan_utils.rs

@@ -685,6 +685,7 @@ pub struct CommitmentTransactionInfo {
 	pub feerate_per_kw: u32,
 	/// The HTLCs which were included in this commitment transaction in output order.
 	pub htlcs: Vec<HTLCOutputInCommitment>,
+	// A cache of pubkeys required to construct the transaction
 	pub(crate) keys: TxCreationKeys,
 }
 
@@ -771,8 +772,6 @@ impl CommitmentTransactionInfo {
 	/// Build the Bitcoin transaction.
 	///
 	/// Required channel-static fields are provided by the caller.
-	///
-	/// is_outbound is true if the channel is outbound from the point of view of the broadcaster
 	pub fn build<T: secp256k1::Signing + secp256k1::Verification>(
 		&self,
 		holder: bool,
@@ -871,6 +870,8 @@ impl CommitmentTransactionInfo {
 			txouts.push((txout, (script, Some((htlc.clone(), *t)))));
 		}
 
+		// Sort output in BIP-69 order (amount, scriptPubkey).  Tie-breaks based on HTLC
+		// CLTV expiration height.
 		sort_outputs(&mut txouts, |a, b| {
 			if let &(_, Some(ref a_htlcout)) = a {
 				if let &(_, Some(ref b_htlcout)) = b {
@@ -917,7 +918,7 @@ impl CommitmentTransactionInfo {
 		secp_ctx.sign(&sighash, funding_key)
 	}
 
-	/// Get the sighash and the transaction.
+	/// Get the SIGHASH_ALL sighash value and the transaction.
 	///
 	/// Builds the transaction and computes the sighash.  This can be used to verify a signature.
 	pub fn get_sighash<T: secp256k1::Signing + secp256k1::Verification>(&self, holder: bool, channel_static_info: &ChannelStaticInfo, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) -> (Message, Transaction) {