X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fchain%2Fchannelmonitor.rs;h=d3052b5fed4087f6de9ccd9dd7fc3047106fbf60;hb=b6787a4f369cc01304b3ea0e4598c149dcc8234b;hp=a48f169a4d5e605b330f49896bc191779dd389d7;hpb=32eb89474cdc1e400ef89eab76d590d19da4746a;p=rust-lightning

diff --git a/lightning/src/chain/channelmonitor.rs b/lightning/src/chain/channelmonitor.rs
index a48f169a..d3052b5f 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 {