From: benthecarman <benthecarman@live.com>
Date: Fri, 2 Jun 2023 19:39:16 +0000 (-0500)
Subject: Add helper for getting claimable balance
X-Git-Tag: v0.0.116-alpha1~15^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=06c6750b542d99e616e769c97caf4147537a66df;p=rust-lightning

Add helper for getting claimable balance

It is annoying to have to match across all the enums of `Balance` to
just pull out the `claimable_amount_satoshis` value. This helper makes
it easier if you just want to amount.
---

diff --git a/lightning/src/chain/channelmonitor.rs b/lightning/src/chain/channelmonitor.rs
index a48f169a4..d3052b5fe 100644
--- a/lightning/src/chain/channelmonitor.rs
+++ b/lightning/src/chain/channelmonitor.rs
@@ -651,6 +651,40 @@ pub enum Balance {
 	},
 }
 
+impl Balance {
+	/// The amount claimable, in satoshis. This excludes balances that we are unsure if we are able
+	/// to claim, this is because we are waiting for a preimage or for a timeout to expire. For more
+	/// information on these balances see [`Balance::MaybeTimeoutClaimableHTLC`] and
+	/// [`Balance::MaybePreimageClaimableHTLC`].
+	///
+	/// On-chain fees required to claim the balance are not included in this amount.
+	pub fn claimable_amount_satoshis(&self) -> u64 {
+		match self {
+			Balance::ClaimableOnChannelClose {
+				claimable_amount_satoshis,
+			} => *claimable_amount_satoshis,
+			Balance::ClaimableAwaitingConfirmations {
+				claimable_amount_satoshis,
+				..
+			} => *claimable_amount_satoshis,
+			Balance::ContentiousClaimable {
+				claimable_amount_satoshis,
+				..
+			} => *claimable_amount_satoshis,
+			Balance::MaybeTimeoutClaimableHTLC {
+				..
+			} => 0,
+			Balance::MaybePreimageClaimableHTLC {
+				..
+			} => 0,
+			Balance::CounterpartyRevokedOutputClaimable {
+				claimable_amount_satoshis,
+				..
+			} => *claimable_amount_satoshis,
+		}
+	}
+}
+
 /// An HTLC which has been irrevocably resolved on-chain, and has reached ANTI_REORG_DELAY.
 #[derive(PartialEq, Eq)]
 struct IrrevocablyResolvedHTLC {