f ClaimableBalance -> Balance

Author: TheBlueMatt

lightning/src/chain/channelmonitor.rs

@@ -541,7 +541,7 @@ impl_writeable_tlv_based_enum_upgradable!(ChannelMonitorUpdateStep,
 /// be provided.
 #[derive(Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(test, derive(PartialOrd, Ord))]
-pub enum ClaimableBalance {
+pub enum Balance {
 	/// The channel is not yet closed (or the commitment or closing transaction has not yet
 	/// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
 	/// force-closed now.
@@ -566,7 +566,7 @@ pub enum ClaimableBalance {
 	///
 	/// Once the spending transaction confirms, before it has reached enough confirmations to be
 	/// considered safe from chain reorganizations, the balance will instead be provided via
-	/// [`ClaimableBalance::ClaimableAwaitingConfirmations`].
+	/// [`Balance::ClaimableAwaitingConfirmations`].
 	ContentiousClaimable {
 		/// The amount available to claim, in satoshis, excluding the on-chain fees which will be
 		/// required to do so.
@@ -1369,9 +1369,9 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 	/// state(s) may not be fully captured here.
 	// TODO, fix that ^
 	///
-	/// See [`ClaimableBalance`] for additional details on the types of claimable balances which
+	/// See [`Balance`] for additional details on the types of claimable balances which
 	/// may be returned here and their meanings.
-	pub fn get_claimable_balances(&self) -> Vec<ClaimableBalance> {
+	pub fn get_claimable_balances(&self) -> Vec<Balance> {
 		let mut res = Vec::new();
 		let us = self.inner.lock().unwrap();
 
@@ -1405,12 +1405,12 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 								} else { None }
 							});
 							if let Some(conf_thresh) = htlc_update_pending {
-								res.push(ClaimableBalance::ClaimableAwaitingConfirmations {
+								res.push(Balance::ClaimableAwaitingConfirmations {
 									claimable_amount_satoshis: htlc.amount_msat / 1000,
 									confirmation_height: conf_thresh,
 								});
 							} else {
-								res.push(ClaimableBalance::MaybeClaimableHTLCAwaitingTimeout {
+								res.push(Balance::MaybeClaimableHTLCAwaitingTimeout {
 									claimable_amount_satoshis: htlc.amount_msat / 1000,
 									claimable_height: htlc.cltv_expiry,
 								});
@@ -1429,12 +1429,12 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 								} else { None }
 							});
 							if let Some((conf_thresh, true)) = htlc_spend_pending {
-								res.push(ClaimableBalance::ClaimableAwaitingConfirmations {
+								res.push(Balance::ClaimableAwaitingConfirmations {
 									claimable_amount_satoshis: htlc.amount_msat / 1000,
 									confirmation_height: conf_thresh,
 								});
 							} else {
-								res.push(ClaimableBalance::ContentiousClaimable {
+								res.push(Balance::ContentiousClaimable {
 									claimable_amount_satoshis: htlc.amount_msat / 1000,
 									timeout_height: htlc.cltv_expiry,
 								});
@@ -1457,7 +1457,7 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 							Some(descriptor.output.value)
 						} else { None }
 					}) {
-						res.push(ClaimableBalance::ClaimableAwaitingConfirmations {
+						res.push(Balance::ClaimableAwaitingConfirmations {
 							claimable_amount_satoshis: value,
 							confirmation_height: conf_thresh,
 						});
@@ -1471,7 +1471,7 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 			} else if txid == us.current_holder_commitment_tx.txid {
 				walk_htlcs!(true, us.current_holder_commitment_tx.htlc_outputs.iter().map(|(a, _, _)| a));
 				if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
-					res.push(ClaimableBalance::ClaimableAwaitingConfirmations {
+					res.push(Balance::ClaimableAwaitingConfirmations {
 						claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
 						confirmation_height: conf_thresh,
 					});
@@ -1481,7 +1481,7 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 				if txid == prev_commitment.txid {
 					walk_htlcs!(true, prev_commitment.htlc_outputs.iter().map(|(a, _, _)| a));
 					if let Some(conf_thresh) = pending_commitment_tx_conf_thresh {
-						res.push(ClaimableBalance::ClaimableAwaitingConfirmations {
+						res.push(Balance::ClaimableAwaitingConfirmations {
 							claimable_amount_satoshis: prev_commitment.to_self_value_sat,
 							confirmation_height: conf_thresh,
 						});
@@ -1494,7 +1494,7 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 					// We blindly assume this is a cooperative close transaction here, and that
 					// neither us nor our counterparty misbehaved. At worst we've under-estimated
 					// the amount we can claim as we'll punish a misbehaving counterparty.
-					res.push(ClaimableBalance::ClaimableAwaitingConfirmations {
+					res.push(Balance::ClaimableAwaitingConfirmations {
 						claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat,
 						confirmation_height: conf_thresh,
 					});
@@ -1507,15 +1507,15 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
 			for (htlc, _, _) in us.current_holder_commitment_tx.htlc_outputs.iter() {
 				if htlc.transaction_output_index.is_none() { continue; }
 				if htlc.offered {
-					res.push(ClaimableBalance::MaybeClaimableHTLCAwaitingTimeout {
+					res.push(Balance::MaybeClaimableHTLCAwaitingTimeout {
 						claimable_amount_satoshis: htlc.amount_msat / 1000,
 						claimable_height: htlc.cltv_expiry,
 					});
 				} else if us.payment_preimages.get(&htlc.payment_hash).is_some() {
 					claimable_inbound_htlc_value_sat += htlc.amount_msat / 1000;
 				}
 			}
-			res.push(ClaimableBalance::ClaimableOnChannelClose {
+			res.push(Balance::ClaimableOnChannelClose {
 				claimable_amount_satoshis: us.current_holder_commitment_tx.to_self_value_sat + claimable_inbound_htlc_value_sat,
 			});
 		}
@@ -2708,7 +2708,7 @@ impl<Signer: Sign> ChannelMonitorImpl<Signer> {
 									// we've already failed the HTLC as the commitment transaction
 									// which was broadcasted was revoked. In that case, we should
 									// spend the HTLC output here immediately, and expose that fact
-									// as a ClaimableBalance, something which we do not yet do.
+									// as a Balance, something which we do not yet do.
 									// TODO: Track the above as claimable!
 								}
 								continue 'outer_loop;