From 7456a8880af58a050ed137d5076814ce23d782f6 Mon Sep 17 00:00:00 2001
From: Roland Bewick <roland.bewick@gmail.com>
Date: Thu, 24 Oct 2024 16:49:21 +0700
Subject: [PATCH] fix: do not show duplicated incoming funds from channel
 closures

There is overlap in balance from pending closed channels and total onchain balance.

They will show as incoming in the total onchain balance once the channel becomes sweepable.

This PR also adds extra balance info that can be retrieved from debug tools -> get balances
---
 frontend/src/screens/channels/Channels.tsx | 12 +++++-------
 lnclient/ldk/ldk.go                        | 16 ++++++++++++++++
 lnclient/lnd/lnd.go                        |  4 ++++
 lnclient/models.go                         |  9 +++++----
 4 files changed, 30 insertions(+), 11 deletions(-)

diff --git a/frontend/src/screens/channels/Channels.tsx b/frontend/src/screens/channels/Channels.tsx
index b2457118..fdcde540 100644
--- a/frontend/src/screens/channels/Channels.tsx
+++ b/frontend/src/screens/channels/Channels.tsx
@@ -318,15 +318,11 @@ export default function Channels() {
                   {new Intl.NumberFormat().format(balances.onchain.spendable)}{" "}
                   sats
                   {balances &&
-                    (balances.onchain.spendable !== balances.onchain.total ||
-                      balances.onchain.pendingBalancesFromChannelClosures >
-                        0) && (
+                    balances.onchain.spendable !== balances.onchain.total && (
                       <p className="text-xs text-muted-foreground animate-pulse">
                         +
                         {new Intl.NumberFormat().format(
-                          balances.onchain.total -
-                            balances.onchain.spendable +
-                            balances.onchain.pendingBalancesFromChannelClosures
+                          balances.onchain.total - balances.onchain.spendable
                         )}{" "}
                         sats incoming
                       </p>
@@ -435,7 +431,9 @@ export default function Channels() {
               balances.onchain.pendingBalancesFromChannelClosures
             )}{" "}
             sats pending from one or more closed channels. Once spendable again
-            these will become available in your savings balance.{" "}
+            these will become available in your savings balance. Funds from
+            channels that were force closed may take up to 2 weeks to become
+            available.{" "}
             <ExternalLink
               to="https://guides.getalby.com/user-guide/v/alby-account-and-browser-extension/alby-hub/faq-alby-hub/why-was-my-lightning-channel-closed-and-what-to-do-next"
               className="underline"
diff --git a/lnclient/ldk/ldk.go b/lnclient/ldk/ldk.go
index 3886dbcf..8c0692ce 100644
--- a/lnclient/ldk/ldk.go
+++ b/lnclient/ldk/ldk.go
@@ -1021,6 +1021,13 @@ func (ls *LDKService) GetOnchainBalance(ctx context.Context) (*lnclient.OnchainB
 		"balances": balances,
 	}).Debug("Listed Balances")
 
+	type internalLightningBalance struct {
+		BalanceType string
+		Balance     ldk_node.LightningBalance
+	}
+
+	internalLightningBalances := []internalLightningBalance{}
+
 	pendingBalancesFromChannelClosures := uint64(0)
 	// increase pending balance from any lightning balances for channels that are pending closure
 	// (they do not exist in our list of open channels)
@@ -1033,6 +1040,11 @@ func (ls *LDKService) GetOnchainBalance(ctx context.Context) (*lnclient.OnchainB
 			}
 		}
 
+		// include the balance type as it's useful to know the state of the channel
+		internalLightningBalances = append(internalLightningBalances, internalLightningBalance{
+			BalanceType: fmt.Sprintf("%T", balance),
+			Balance:     balance,
+		})
 		switch balanceType := (balance).(type) {
 		case ldk_node.LightningBalanceClaimableOnChannelClose:
 			increasePendingBalance(balanceType.ChannelId, balanceType.AmountSatoshis)
@@ -1066,6 +1078,10 @@ func (ls *LDKService) GetOnchainBalance(ctx context.Context) (*lnclient.OnchainB
 		Total:                              int64(balances.TotalOnchainBalanceSats - balances.TotalAnchorChannelsReserveSats),
 		Reserved:                           int64(balances.TotalAnchorChannelsReserveSats),
 		PendingBalancesFromChannelClosures: pendingBalancesFromChannelClosures,
+		InternalBalances: map[string]interface{}{
+			"internal_lightning_balances": internalLightningBalances,
+			"all_balances":                balances,
+		},
 	}, nil
 }
 
diff --git a/lnclient/lnd/lnd.go b/lnclient/lnd/lnd.go
index fdeb0dc3..26128490 100644
--- a/lnclient/lnd/lnd.go
+++ b/lnclient/lnd/lnd.go
@@ -760,6 +760,10 @@ func (svc *LNDService) GetOnchainBalance(ctx context.Context) (*lnclient.Onchain
 		Total:                              int64(balances.TotalBalance),
 		Reserved:                           int64(balances.ReservedBalanceAnchorChan),
 		PendingBalancesFromChannelClosures: pendingBalancesFromChannelClosures,
+		InternalBalances: map[string]interface{}{
+			"balances":         balances,
+			"pending_channels": pendingChannels,
+		},
 	}, nil
 }
 
diff --git a/lnclient/models.go b/lnclient/models.go
index a87a837f..05fca899 100644
--- a/lnclient/models.go
+++ b/lnclient/models.go
@@ -134,10 +134,11 @@ type CloseChannelResponse struct {
 }
 
 type OnchainBalanceResponse struct {
-	Spendable                          int64  `json:"spendable"`
-	Total                              int64  `json:"total"`
-	Reserved                           int64  `json:"reserved"`
-	PendingBalancesFromChannelClosures uint64 `json:"pendingBalancesFromChannelClosures"`
+	Spendable                          int64       `json:"spendable"`
+	Total                              int64       `json:"total"`
+	Reserved                           int64       `json:"reserved"`
+	PendingBalancesFromChannelClosures uint64      `json:"pendingBalancesFromChannelClosures"`
+	InternalBalances                   interface{} `json:"internalBalances"`
 }
 
 type PeerDetails struct {