Merge pull request #9625 from MPins/issue-8161

Add deletecanceledinvoice RPC call

Author: guggero

cmd/commands/cmd_invoice.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"github.com/urfave/cli"
+	"google.golang.org/protobuf/proto"
 )
 
 var AddInvoiceCommand = cli.Command{
@@ -440,3 +441,56 @@ func decodePayReq(ctx *cli.Context) error {
 	printRespJSON(resp)
 	return nil
 }
+
+var deleteCanceledInvoiceCommand = cli.Command{
+	Name:      "deletecanceledinvoice",
+	Category:  "Invoices",
+	Usage:     "Delete a canceled invoice from the database.",
+	ArgsUsage: "invoice_hash",
+	Description: `
+	This command deletes a canceled invoice from the database. Note that
+	expired invoices are automatically moved to the canceled state.
+	Once canceled, they can be deleted using this command.
+	`,
+	Flags: []cli.Flag{
+		cli.StringFlag{
+			Name:  "invoice_hash",
+			Usage: "the invoice hash to be deleted",
+		},
+	},
+	Action: actionDecorator(deleteCanceledInvoice),
+}
+
+func deleteCanceledInvoice(ctx *cli.Context) error {
+	ctxc := getContext()
+	client, cleanUp := getClient(ctx)
+	defer cleanUp()
+
+	var (
+		invoiceHash string
+		err         error
+		resp        proto.Message
+	)
+
+	switch {
+	case ctx.IsSet("invoice_hash"):
+		invoiceHash = ctx.String("invoice_hash")
+	case ctx.Args().Present():
+		invoiceHash = ctx.Args().First()
+	default:
+		return fmt.Errorf("invoice_hash argument missing")
+	}
+
+	req := &lnrpc.DelCanceledInvoiceReq{
+		InvoiceHash: invoiceHash,
+	}
+
+	resp, err = client.DeleteCanceledInvoice(ctxc, req)
+	if err != nil {
+		return err
+	}
+
+	printJSON(resp)
+
+	return nil
+}

cmd/commands/main.go

@@ -478,6 +478,7 @@ func Main() {
 		AddInvoiceCommand,
 		lookupInvoiceCommand,
 		listInvoicesCommand,
+		deleteCanceledInvoiceCommand,
 		ListChannelsCommand,
 		closedChannelsCommand,
 		listPaymentsCommand,

docs/release-notes/release-notes-0.20.0.md

@@ -83,6 +83,11 @@ circuit. The indices are only available for forwarding events saved after v0.20.
   1MB, and `gossip.msg-burst-bytes` has been increased from 200KB to 2MB.
 
 
+* Added [`deletecanceledinvoices`](
+  https://github.com/lightningnetwork/lnd/pull/9625) RPC to allow the removal of
+  a canceled invoice. Supports deleting a canceled invoice by providing its
+  payment hash.
+
 ## lncli Additions
 
 * [`lncli sendpayment` and `lncli queryroutes` now support the

invoices/errors.go

@@ -14,6 +14,9 @@ var (
 	// canceled.
 	ErrInvoiceAlreadyCanceled = errors.New("invoice already canceled")
 
+	// ErrInvoiceNotCanceled is returned when the invoice is not canceled.
+	ErrInvoiceNotCanceled = errors.New("invoice not canceled")
+
 	// ErrInvoiceAlreadyAccepted is returned when the invoice is already
 	// accepted.
 	ErrInvoiceAlreadyAccepted = errors.New("invoice already accepted")
@@ -33,6 +36,10 @@ var (
 	// match the invoice hash.
 	ErrInvoicePreimageMismatch = errors.New("preimage does not match")
 
+	// ErrNoInvoiceHash is returned when an invoice hash is expected, and
+	// none is provided.
+	ErrNoInvoiceHash = errors.New("invoice hash must be provided")
+
 	// ErrHTLCPreimageMissing is returned when trying to accept/settle an
 	// AMP HTLC but the HTLC-level preimage has not been set.
 	ErrHTLCPreimageMissing = errors.New("AMP htlc missing preimage")

itest/list_on_test.go

@@ -727,6 +727,10 @@ var allTestCases = []*lntest.TestCase{
 		Name:     "grpc not found",
 		TestFunc: testGRPCNotFound,
 	},
+	{
+		Name:     "delete canceled invoice",
+		TestFunc: testDeleteCanceledInvoice,
+	},
 }
 
 // appendPrefixed is used to add a prefix to each test name in the subtests

itest/lnd_delete_canceled_invoice_test.go

@@ -0,0 +1,99 @@
+package itest
+
+import (
+	"bytes"
+
+	"github.com/lightningnetwork/lnd/invoices"
+	"github.com/lightningnetwork/lnd/lnrpc"
+	"github.com/lightningnetwork/lnd/lntest"
+	"github.com/lightningnetwork/lnd/lntypes"
+	"github.com/stretchr/testify/require"
+)
+
+func testDeleteCanceledInvoice(ht *lntest.HarnessTest) {
+	bob := ht.NewNode("bob", nil)
+
+	// Create 2 invoices for Bob.
+	const numInvoices = 2
+	invoiceResp := make([]*lnrpc.AddInvoiceResponse, numInvoices)
+
+	for i := range numInvoices {
+		// Create a unique 32-byte preimage for each invoice.
+		preimage := bytes.Repeat([]byte{byte(i + 1)}, 32)
+
+		invoice := &lnrpc.Invoice{
+			RPreimage: preimage,
+			Value:     paymentAmt,
+		}
+
+		invoiceResp[i] = bob.RPC.AddInvoice(invoice)
+	}
+
+	// Cancel all invoices except the last one.
+	for i := range numInvoices - 1 {
+		bob.RPC.CancelInvoice(invoiceResp[i].RHash)
+	}
+
+	// Let's assert an error while providing no invoice hash.
+	bob.RPC.DeleteCanceledInvoiceAssertErr(
+		&lnrpc.DelCanceledInvoiceReq{},
+		invoices.ErrNoInvoiceHash.Error(),
+	)
+
+	// Let's assert an error while providing a hash with an invalid length.
+	bob.RPC.DeleteCanceledInvoiceAssertErr(
+		&lnrpc.DelCanceledInvoiceReq{InvoiceHash: "bb02fbfa62983b6b62"},
+		"invalid hash string length",
+	)
+
+	// Let's assert an error is returned for a hash with invalid encoding.
+	bob.RPC.DeleteCanceledInvoiceAssertErr(
+		&lnrpc.DelCanceledInvoiceReq{
+			InvoiceHash: "bb02fbfa62983b6b621376bf8230732dd3a6dce" +
+				"a9f5df803c0935ae6ce7440dg",
+		}, "encoding/hex: invalid byte",
+	)
+
+	// Let's delete one canceled invoice.
+	invoiceToDelete := lntypes.Hash(invoiceResp[0].RHash).String()
+	resp := bob.RPC.DeleteCanceledInvoice(
+		&lnrpc.DelCanceledInvoiceReq{InvoiceHash: invoiceToDelete},
+	)
+
+	require.Contains(
+		ht, resp.String(), "canceled invoice deleted successfully",
+	)
+
+	respList := bob.RPC.ListInvoices(&lnrpc.ListInvoiceRequest{})
+
+	// Assert that the invoice was deleted.
+	require.Len(ht, respList.Invoices, numInvoices-1)
+
+	// Let's assert an error while deleting a non-existent invoice.
+	bob.RPC.DeleteCanceledInvoiceAssertErr(
+		&lnrpc.DelCanceledInvoiceReq{InvoiceHash: invoiceToDelete},
+		invoices.ErrInvoiceNotFound.Error(),
+	)
+
+	// Let's assert an error while deleting a non canceled invoice.
+	notCanceledInvoice := lntypes.Hash(invoiceResp[numInvoices-1].RHash).
+		String()
+
+	bob.RPC.DeleteCanceledInvoiceAssertErr(
+		&lnrpc.DelCanceledInvoiceReq{InvoiceHash: notCanceledInvoice},
+		invoices.ErrInvoiceNotCanceled.Error(),
+	)
+
+	// Assert that the last invoice in the invoiceResp is still present and
+	// OPEN.
+	respList = bob.RPC.ListInvoices(&lnrpc.ListInvoiceRequest{})
+	require.Equal(
+		ht, invoiceResp[numInvoices-1].RHash,
+		respList.Invoices[0].RHash,
+	)
+
+	require.Equal(ht, lnrpc.Invoice_OPEN, respList.Invoices[0].State)
+
+	// Assert that just one invoice exists.
+	require.Len(ht, respList.Invoices, 1)
+}