Merge pull request #9772 from yyforyongyu/show-all-inputs

sweep: return all inputs in `PendingSweeps`

Author: yyforyongyu

cmd/commands/walletrpc_types.go

@@ -4,6 +4,10 @@ import "github.com/lightningnetwork/lnd/lnrpc/walletrpc"
 
 // PendingSweep is a CLI-friendly type of the walletrpc.PendingSweep proto. We
 // use this to show more useful string versions of byte slices and enums.
+//
+// TODO(yy): Remove this struct as it's easy to forget to update the values
+// here. Instead, we should rely on the struct defined in the proto
+// `PendingSweepsResponse` only.
 type PendingSweep struct {
 	OutPoint             OutPoint `json:"outpoint"`
 	WitnessType          string   `json:"witness_type"`
@@ -14,6 +18,7 @@ type PendingSweep struct {
 	Immediate            bool     `json:"immediate"`
 	Budget               uint64   `json:"budget"`
 	DeadlineHeight       uint32   `json:"deadline_height"`
+	MaturityHeight       uint32   `json:"maturity_height"`
 
 	NextBroadcastHeight uint32 `json:"next_broadcast_height"`
 	RequestedConfTarget uint32 `json:"requested_conf_target"`
@@ -33,6 +38,7 @@ func NewPendingSweepFromProto(pendingSweep *walletrpc.PendingSweep) *PendingSwee
 		Immediate:            pendingSweep.Immediate,
 		Budget:               pendingSweep.Budget,
 		DeadlineHeight:       pendingSweep.DeadlineHeight,
+		MaturityHeight:       pendingSweep.MaturityHeight,
 
 		// Deprecated fields.
 		NextBroadcastHeight: pendingSweep.NextBroadcastHeight,

docs/release-notes/release-notes-0.19.0.md

@@ -316,6 +316,15 @@ when running LND with an aux component injected (custom channels).
   to include any [gRPC metadata](https://grpc.io/docs/guides/metadata) pairs 
   that are passed to the initial request via the `context.Context`.
 
+* Previously when calling `PendingSweeps`, if the outputs being swept had a
+  locktime in the future, they would be filtered out. This is now
+  [changed](https://github.com/lightningnetwork/lnd/pull/9772) such that all
+  outputs registered in the sweeper will be returned in the RPC response
+  regardless of their locktime, which enables users to plan ahead about upcoming
+  sweeps and implement customized aggregation logic. A new field
+  `MaturityHeight` is added to `PendingSweep` to show the absolute locktime
+  value.
+
 ## lncli Updates
 
 * [Fixed](https://github.com/lightningnetwork/lnd/pull/9605) a case where

itest/lnd_channel_backup_test.go

@@ -1454,7 +1454,7 @@ func assertTimeLockSwept(ht *lntest.HarnessTest, carol, dave *node.HarnessNode,
 	// Carol should sweep her funds immediately, as they are not
 	// timelocked.
 	ht.AssertNumPendingSweeps(carol, 2)
-	ht.AssertNumPendingSweeps(dave, 1)
+	ht.AssertNumPendingSweeps(dave, 2)
 
 	// We expect Carol to sweep her funds and her anchor in a single sweep
 	// tx. In addition, Dave will attempt to sweep his anchor output but
@@ -1577,9 +1577,10 @@ func assertDLPExecuted(ht *lntest.HarnessTest,
 
 		// Both Dave and Carol should have an anchor sweep request.
 		// Note that they cannot sweep them as these anchor sweepings
-		// are uneconomical.
-		ht.AssertNumPendingSweeps(dave, 1)
-		ht.AssertNumPendingSweeps(carol, 1)
+		// are uneconomical. In addition, they should also have their
+		// leased to_local commit output.
+		ht.AssertNumPendingSweeps(dave, 2)
+		ht.AssertNumPendingSweeps(carol, 2)
 
 		// After Carol's output matures, she should also reclaim her
 		// funds.
@@ -1620,7 +1621,7 @@ func assertDLPExecuted(ht *lntest.HarnessTest,
 		// timelocked. We also expect Carol and Dave sweep their
 		// anchors if it's an anchor channel.
 		if lntest.CommitTypeHasAnchors(commitType) {
-			ht.AssertNumPendingSweeps(carol, 1)
+			ht.AssertNumPendingSweeps(carol, 2)
 			ht.AssertNumPendingSweeps(dave, 2)
 		} else {
 			ht.AssertNumPendingSweeps(dave, 1)

itest/lnd_channel_force_close_test.go

@@ -191,10 +191,18 @@ func runChannelForceClosureTest(ht *lntest.HarnessTest,
 	// expect Alice's anchor sweeping tx being published.
 	ht.MineBlocksAndAssertNumTxes(1, 1)
 
-	// Assert Alice's has one pending anchor output - because she doesn't
-	// have incoming HTLCs, her outgoing HTLC won't have a deadline, thus
-	// she won't use the anchor to perform CPFP.
-	aliceAnchor := ht.AssertNumPendingSweeps(alice, 1)[0]
+	// Assert Alice's has one pending anchor output and the commit output
+	// sweep - because she doesn't have incoming HTLCs, her outgoing HTLC
+	// won't have a deadline, thus she won't use the anchor to perform CPFP.
+	sweeps := ht.AssertNumPendingSweeps(alice, 2)
+
+	// Find the anchor sweep - assume it's the first one, and change to the
+	// second one if the first one has a larger value.
+	aliceAnchor := sweeps[0]
+	if aliceAnchor.AmountSat > sweeps[1].AmountSat {
+		aliceAnchor = sweeps[1]
+	}
+
 	require.Equal(ht, aliceAnchor.Outpoint.TxidStr,
 		waitingClose.Commitments.LocalTxid)
 
@@ -250,8 +258,9 @@ func runChannelForceClosureTest(ht *lntest.HarnessTest,
 	// commit and anchor outputs.
 	ht.MineBlocksAndAssertNumTxes(1, 1)
 
-	// Alice should still have the anchor sweeping request.
-	ht.AssertNumPendingSweeps(alice, 1)
+	// Alice should still have the anchor and commit output sweeping
+	// requests.
+	ht.AssertNumPendingSweeps(alice, 2)
 
 	// Alice should see the channel in her set of pending force closed
 	// channels with her funds still in limbo.
@@ -282,8 +291,8 @@ func runChannelForceClosureTest(ht *lntest.HarnessTest,
 
 	// At this point, the CSV will expire in the next block, meaning that
 	// the output should be offered to the sweeper.
-	sweeps := ht.AssertNumPendingSweeps(alice, 2)
-	commitSweep, anchorSweep := sweeps[0], sweeps[1]
+	aliceSweeps := ht.AssertNumPendingSweeps(alice, 2)
+	commitSweep, anchorSweep := aliceSweeps[0], aliceSweeps[1]
 	if commitSweep.AmountSat < anchorSweep.AmountSat {
 		commitSweep = anchorSweep
 	}
@@ -790,10 +799,18 @@ func runChannelForceClosureTestRestart(ht *lntest.HarnessTest,
 	// expect Alice's anchor sweeping tx being published.
 	ht.MineBlocksAndAssertNumTxes(1, 1)
 
-	// Assert Alice's has one pending anchor output - because she doesn't
-	// have incoming HTLCs, her outgoing HTLC won't have a deadline, thus
-	// she won't use the anchor to perform CPFP.
-	aliceAnchor := ht.AssertNumPendingSweeps(alice, 1)[0]
+	// Assert Alice's has one pending anchor output and the commit output
+	// sweep - because she doesn't have incoming HTLCs, her outgoing HTLC
+	// won't have a deadline, thus she won't use the anchor to perform CPFP.
+	sweeps := ht.AssertNumPendingSweeps(alice, 2)
+
+	// Find the anchor sweep - assume it's the first one, and change to the
+	// second one if the first one has a larger value.
+	aliceAnchor := sweeps[0]
+	if aliceAnchor.AmountSat > sweeps[1].AmountSat {
+		aliceAnchor = sweeps[1]
+	}
+
 	require.Equal(ht, aliceAnchor.Outpoint.TxidStr,
 		waitingClose.Commitments.LocalTxid)
 
@@ -860,8 +877,9 @@ func runChannelForceClosureTestRestart(ht *lntest.HarnessTest,
 	// commit and anchor outputs.
 	ht.MineBlocksAndAssertNumTxes(1, 1)
 
-	// Alice should still have the anchor sweeping request.
-	ht.AssertNumPendingSweeps(alice, 1)
+	// Alice should still have the anchor and commit output sweeping
+	// requests.
+	ht.AssertNumPendingSweeps(alice, 2)
 
 	// The following restart checks to ensure that outputs in the contract
 	// court are persisted while waiting for the required number of
@@ -918,7 +936,7 @@ func runChannelForceClosureTestRestart(ht *lntest.HarnessTest,
 
 	// At this point, the CSV will expire in the next block, meaning that
 	// the output should be offered to the sweeper.
-	sweeps := ht.AssertNumPendingSweeps(alice, 2)
+	sweeps = ht.AssertNumPendingSweeps(alice, 2)
 	commitSweep, anchorSweep := sweeps[0], sweeps[1]
 	if commitSweep.AmountSat < anchorSweep.AmountSat {
 		commitSweep, anchorSweep = anchorSweep, commitSweep

itest/lnd_htlc_timeout_resolver_test.go

@@ -309,8 +309,9 @@ func testHtlcTimeoutResolverExtractPreimageLocal(ht *lntest.HarnessTest) {
 
 	// Once Bob's force closing tx is confirmed, he will re-offer the
 	// anchor output to his sweeper, which won't be swept due to it being
-	// uneconomical.
-	ht.AssertNumPendingSweeps(bob, 1)
+	// uneconomical. In addition, the to_local output should also be found
+	// although it's immature.
+	ht.AssertNumPendingSweeps(bob, 2)
 
 	// Mine 3 blocks so the output will be offered to the sweeper.
 	ht.MineBlocks(defaultCSV - 1)