docs: add release notes

Author: Euler-B

docs/release-notes/release-notes-0.20.1.md

@@ -103,6 +103,13 @@
    for conservative budgeting and includes griefing protection by limiting the
    number of probed LSPs. It enhances the previous LSP design by being more
    generic and more flexible.
+ 
+ * The `listchannels` RPC now [exposes the actual 
+   spendable balance](https://github.com/lightningnetwork/lnd/pull/10624)
+   by adding `local_spendable_balance` and `remote_spendable_balance` fields. 
+   This provides users with a precise view of their actionable liquidity by 
+   correctly accounting for channel reserves and funds currently tied up in 
+   in-flight HTLCs.
 
 ## lncli Updates
 

htlcswitch/mock.go

@@ -167,7 +167,9 @@ type mockServer struct {
 
 var _ lnpeer.Peer = (*mockServer)(nil)
 
-func initSwitchWithDB(startingHeight uint32, db *channeldb.DB) (*Switch, error) {
+func initSwitchWithDB(startingHeight uint32, db *channeldb.DB) (
+	*Switch, error) {
+
 	signAliasUpdate := func(u *lnwire.ChannelUpdate1) (*ecdsa.Signature,
 		error) {
 
@@ -375,7 +377,8 @@ func encodeFwdInfo(w io.Writer, f *hop.ForwardingInfo) error {
 		return err
 	}
 
-	if err := binary.Write(w, binary.BigEndian, f.OutgoingCTLV); err != nil {
+	if err := binary.Write(
+		w, binary.BigEndian, f.OutgoingCTLV); err != nil {
 		return err
 	}
 
@@ -438,10 +441,11 @@ func (o *mockObfuscator) IntermediateEncrypt(reason lnwire.OpaqueReason) lnwire.
 	return reason
 }
 
-func (o *mockObfuscator) EncryptMalformedError(reason lnwire.OpaqueReason) lnwire.OpaqueReason {
+func (o *mockObfuscator) EncryptMalformedError(
+	reason lnwire.OpaqueReason) lnwire.OpaqueReason {
+
 	var b bytes.Buffer
 	b.Write(fakeHmac)
-
 	b.Write(reason)
 
 	return b.Bytes()
@@ -508,7 +512,9 @@ func (p *mockIteratorDecoder) DecodeHopIterator(r io.Reader, rHash []byte,
 		}
 
 		var nextHopBytes [8]byte
-		binary.BigEndian.PutUint64(nextHopBytes[:], f.NextHop.ToUint64())
+		binary.BigEndian.PutUint64(
+			nextHopBytes[:], f.NextHop.ToUint64(),
+		)
 
 		hops[i] = hop.NewLegacyPayload(&sphinx.HopData{
 			Realm:         [1]byte{}, // hop.BitcoinNetwork
@@ -569,7 +575,8 @@ func decodeFwdInfo(r io.Reader, f *hop.ForwardingInfo) error {
 		return err
 	}
 
-	if err := binary.Read(r, binary.BigEndian, &f.OutgoingCTLV); err != nil {
+	if err := binary.Read(
+		r, binary.BigEndian, &f.OutgoingCTLV); err != nil {
 		return err
 	}
 
@@ -917,7 +924,8 @@ func (f *mockChannelLink) Bandwidth() lnwire.MilliSatoshi {
 	return 99999999
 }
 
-// RemoteBandwidth returns a hardcoded amount of milli-satoshis for the mock link.
+// RemoteBandwidth returns a hardcoded amount of milli-satoshis for
+// the mock link.
 //
 // NOTE: Part of the ChannelLink interface.
 func (f *mockChannelLink) RemoteBandwidth() lnwire.MilliSatoshi {

lnwallet/channel.go

@@ -3789,9 +3789,8 @@ func (b BufferType) String() string {
 // the adjusted balance, the buffer (less the commit fee), and the commit fee.
 func (lc *LightningChannel) applyCommitFee(
 	balance lnwire.MilliSatoshi, commitWeight lntypes.WeightUnit,
-	feePerKw chainfee.SatPerKWeight,
-	buffer BufferType, isInitiator bool) (lnwire.MilliSatoshi, lnwire.MilliSatoshi,
-	lnwire.MilliSatoshi, error) {
+	feePerKw chainfee.SatPerKWeight, buffer BufferType, isInitiator bool) (
+	lnwire.MilliSatoshi, lnwire.MilliSatoshi, lnwire.MilliSatoshi, error) {
 
 	commitFee := feePerKw.FeeForWeight(commitWeight)
 	commitFeeMsat := lnwire.NewMSatFromSatoshis(commitFee)
@@ -9081,6 +9080,7 @@ func (lc *LightningChannel) RemoteAvailableBalance() lnwire.MilliSatoshi {
 	defer lc.RUnlock()
 
 	bal, _ := lc.remoteAvailableBalance(FeeBuffer)
+
 	return bal
 }
 
@@ -9105,7 +9105,8 @@ func (lc *LightningChannel) remoteAvailableBalance(
 // calculate the available balance for either the local or remote party,
 // depending on the isRemote flag.
 func (lc *LightningChannel) availableBalanceGeneric(
-	buffer BufferType, isRemote bool) (lnwire.MilliSatoshi, lntypes.WeightUnit) {
+	buffer BufferType, isRemote bool) (
+	lnwire.MilliSatoshi, lntypes.WeightUnit) {
 
 	htlcView := lc.fetchHTLCView(
 		lc.updateLogs.Remote.logIndex, lc.updateLogs.Local.logIndex,
@@ -9219,7 +9220,11 @@ func (lc *LightningChannel) availableCommitmentBalance(view *HtlcView,
 		// declare bufferAmt beforehand.
 		var bufferAmt lnwire.MilliSatoshi
 		balance, bufferAmt, commitFee, err = lc.applyCommitFee(
-			balance, futureCommitWeight, feePerKw, buffer, initiator,
+			balance,
+			futureCommitWeight,
+			feePerKw,
+			buffer,
+			initiator,
 		)
 		if err != nil {
 			lc.log.Debugf("No available balance after "+

lnwallet/channel_test.go

@@ -5549,20 +5549,22 @@ func TestChanRemoteAvailableBalance(t *testing.T) {
 
 		// Query the RemoteAvailableBalance from Alice's PoV.
 		// This should be what Bob can send.
-		aliceRemoteAvailableBalance := aliceChannel.RemoteAvailableBalance()
+		aliceRemoteBalance := aliceChannel.RemoteAvailableBalance()
 
 		// Query the AvailableBalance from Bob's PoV.
 		bobAvailableBalance := bobChannel.AvailableBalance()
 
-		require.Equal(t, bobAvailableBalance, aliceRemoteAvailableBalance,
-			"Alice's view of Bob's balance should match Bob's own view")
+		require.Equal(t, bobAvailableBalance, aliceRemoteBalance,
+			"Alice's view of Bob's balance should match "+
+				"Bob's own view")
 
 		// Also check from Bob's PoV.
-		bobRemoteAvailableBalance := bobChannel.RemoteAvailableBalance()
+		bobRemoteBalance := bobChannel.RemoteAvailableBalance()
 		aliceAvailableBalance := aliceChannel.AvailableBalance()
 
-		require.Equal(t, aliceAvailableBalance, bobRemoteAvailableBalance,
-			"Bob's view of Alice's balance should match Alice's own view")
+		require.Equal(t, aliceAvailableBalance, bobRemoteBalance,
+			"Bob's view of Alice's balance should match "+
+				"Alice's own view")
 	}
 
 	// Initially, both should be correct.

peer/brontide_test.go

@@ -267,8 +267,8 @@ func TestPeerChannelClosureAcceptFeeInitiator(t *testing.T) {
 		msg: closingSigned,
 	}
 
-	// Alice should accept Bob's fee, broadcast the cooperative close tx, and
-	// send a ClosingSigned message back to Bob.
+	// Alice should accept Bob's fee, broadcast the cooperative close tx,
+	// and send a ClosingSigned message back to Bob.
 
 	// Alice should now broadcast the closing transaction.
 	select {
@@ -295,7 +295,8 @@ func TestPeerChannelClosureAcceptFeeInitiator(t *testing.T) {
 			bobFee, closingSignedMsg.FeeSatoshis)
 	}
 
-	// Alice should be waiting on a single confirmation for the coop close tx.
+	// Alice should be waiting on a single confirmation
+	// for the coop close tx.
 	notifier.ConfChan <- &chainntnfs.TxConfirmation{}
 }
 
@@ -378,10 +379,10 @@ func TestPeerChannelClosureFeeNegotiationsResponder(t *testing.T) {
 		msg: closingSigned,
 	}
 
-	// Alice will now see the new fee we propose, but with current settings it
-	// won't accept it immediately as it differs too much by its ideal fee. We
-	// should get a new proposal back, which should have the average fee rate
-	// proposed.
+	// Alice will now see the new fee we propose, but with current settings
+	// it won't accept it immediately as it differs too much by its ideal
+	// fee. We should get a new proposal back, which should have the average
+	// fee rate proposed.
 	select {
 	case outMsg := <-alicePeer.outgoingQueue:
 		msg = outMsg.msg
@@ -479,7 +480,8 @@ func TestPeerChannelClosureFeeNegotiationsResponder(t *testing.T) {
 		t.Fatalf("expected to receive closing signed message, got %T", msg)
 	}
 
-	// Alice should be waiting on a single confirmation for the coop close tx.
+	// Alice should be waiting on a single confirmation
+	// for the coop close tx.
 	notifier.ConfChan <- &chainntnfs.TxConfirmation{}
 }
 
@@ -675,7 +677,8 @@ func TestPeerChannelClosureFeeNegotiationsInitiator(t *testing.T) {
 		t.Fatalf("expected to receive closing signed message, got %T", msg)
 	}
 
-	// Alice should be waiting on a single confirmation for the coop close tx.
+	// Alice should be waiting on a single confirmation
+	// for the coop close tx.
 	notifier.ConfChan <- &chainntnfs.TxConfirmation{}
 }
 
@@ -773,8 +776,9 @@ func TestCustomShutdownScript(t *testing.T) {
 	tests := []struct {
 		name string
 
-		// update is a function used to set values on the channel set up for the
-		// test. It is used to set values for upfront shutdown addresses.
+		// update is a function used to set values on the channel set up
+		// for the test. It is used to set values for upfront shutdown
+		// addresses.
 		update func(a, b *channeldb.OpenChannel)
 
 		// userCloseScript is the address specified by the user.

peer/test_utils.go

@@ -406,6 +406,9 @@ func (m *mockUpdateHandler) ChanID() lnwire.ChannelID { return m.cid }
 // Bandwidth currently returns a dummy value.
 func (m *mockUpdateHandler) Bandwidth() lnwire.MilliSatoshi { return 0 }
 
+// RemoteBandwidth currently returns a dummy value.
+func (m *mockUpdateHandler) RemoteBandwidth() lnwire.MilliSatoshi { return 0 }
+
 // EligibleToForward currently returns a dummy value.
 func (m *mockUpdateHandler) EligibleToForward() bool { return false }
 
@@ -415,12 +418,13 @@ func (m *mockUpdateHandler) MayAddOutgoingHtlc(lnwire.MilliSatoshi) error { retu
 type mockMessageConn struct {
 	t *testing.T
 
-	// MessageConn embeds our interface so that the mock does not need to
-	// implement every function. The mock will panic if an unspecified function
-	// is called.
+	// MessageConn embeds our interface so that
+	// the mock does not need to implement every function.
+	// The mock will panic if an unspecifiedfunction is called.
 	MessageConn
 
-	// writtenMessages is a channel that our mock pushes written messages into.
+	// writtenMessages is a channel that our mock pushes written messages
+	// into.
 	writtenMessages chan []byte
 
 	readMessages   chan []byte