Rename build_commitment_tx local/remote balances to new holder/counterparty

Author: Antoine Riard

lightning/src/ln/channel.rs

@@ -851,9 +851,9 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 		let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
 
 		let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
-		let mut remote_htlc_total_msat = 0;
-		let mut local_htlc_total_msat = 0;
-		let mut value_to_self_msat_offset = 0;
+		let mut counterparty_htlc_total_msat = 0;
+		let mut holder_htlc_total_msat = 0;
+		let mut holder_value_msat_offset = 0;
 
 		log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for {}, generated by {} with fee {}...", commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number), self.get_commitment_transaction_number_obscure_factor(), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
 
@@ -910,14 +910,14 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 
 			if include {
 				add_htlc_output!(htlc, false, None, state_name);
-				remote_htlc_total_msat += htlc.amount_msat;
+				counterparty_htlc_total_msat += htlc.amount_msat;
 			} else {
 				log_trace!(logger, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
 				match &htlc.state {
 					&InboundHTLCState::LocalRemoved(ref reason) => {
 						if generated_by_local {
 							if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
-								value_to_self_msat_offset += htlc.amount_msat as i64;
+								holder_value_msat_offset += htlc.amount_msat as i64;
 							}
 						}
 					},
@@ -937,31 +937,31 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 
 			if include {
 				add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
-				local_htlc_total_msat += htlc.amount_msat;
+				holder_htlc_total_msat += htlc.amount_msat;
 			} else {
 				log_trace!(logger, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
 				match htlc.state {
 					OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
-						value_to_self_msat_offset -= htlc.amount_msat as i64;
+						holder_value_msat_offset -= htlc.amount_msat as i64;
 					},
 					OutboundHTLCState::RemoteRemoved(None) => {
 						if !generated_by_local {
-							value_to_self_msat_offset -= htlc.amount_msat as i64;
+							holder_value_msat_offset -= htlc.amount_msat as i64;
 						}
 					},
 					_ => {},
 				}
 			}
 		}
 
-		let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
-		assert!(value_to_self_msat >= 0);
+		let holder_value_msat: i64 = (self.value_to_self_msat - holder_htlc_total_msat) as i64 + holder_value_msat_offset;
+		assert!(holder_value_msat >= 0);
 		// Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
 		// AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
 		// "violate" their reserve value by couting those against it. Thus, we have to convert
 		// everything to i64 before subtracting as otherwise we can overflow.
-		let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
-		assert!(value_to_remote_msat >= 0);
+		let counterparty_value_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (counterparty_htlc_total_msat as i64) - holder_value_msat_offset;
+		assert!(counterparty_value_msat >= 0);
 
 		#[cfg(debug_assertions)]
 		{
@@ -972,21 +972,20 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 			} else {
 				self.counterparty_max_commitment_tx_output.lock().unwrap()
 			};
-			debug_assert!(broadcaster_max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.counterparty_selected_channel_reserve_satoshis as i64);
-			broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
-			debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<ChanSigner>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
-			broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
+			debug_assert!(broadcaster_max_commitment_tx_output.0 <= holder_value_msat as u64 || holder_value_msat / 1000 >= self.counterparty_selected_channel_reserve_satoshis as i64);
+			broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, holder_value_msat as u64);
+			debug_assert!(broadcaster_max_commitment_tx_output.1 <= counterparty_value_msat as u64 || counterparty_value_msat / 1000 >= Channel::<ChanSigner>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
+			broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, counterparty_value_msat as u64);
 		}
 
 		let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
-		let (value_to_self, value_to_remote) = if self.channel_outbound {
-			(value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
+		let (holder_value, counterparty_value) = if self.channel_outbound {
+			(holder_value_msat / 1000 - total_fee as i64, counterparty_value_msat / 1000)
 		} else {
-			(value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
+			(holder_value_msat / 1000, counterparty_value_msat / 1000 - total_fee as i64)
 		};
 
-		let value_to_a = if local { value_to_self } else { value_to_remote };
-		let value_to_b = if local { value_to_remote } else { value_to_self };
+		let (value_to_a, value_to_b) = if local { (holder_value, counterparty_value) } else { (counterparty_value, holder_value) };
 
 		if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
 			log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);