Merge pull request #9338 from yyforyongyu/fix-invoice-htlcs-order

lnrpc: sort `Invoice.HTLCs` based on `HtlcIndex`
lightningnetwork · Dec 9, 2024 · c9ae63a · c9ae63a
2 parents 5659c01 + 7374392
commit c9ae63a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/release-notes/release-notes-0.19.0.md b/docs/release-notes/release-notes-0.19.0.md
@@ -90,6 +90,10 @@
 * [The `walletrpc.FundPsbt` method now has a new option to specify the maximum
   fee to output amounts ratio.](https://github.com/lightningnetwork/lnd/pull/8600)
 
+* When returning the response from list invoices RPC, the `lnrpc.Invoice.Htlcs`
+  are now [sorted](https://github.com/lightningnetwork/lnd/pull/9337) based on
+  the `InvoiceHTLC.HtlcIndex`.
+
 ## lncli Additions
 
 * [A pre-generated macaroon root key can now be specified in `lncli create` and

diff --git a/lnrpc/invoicesrpc/utils.go b/lnrpc/invoicesrpc/utils.go
@@ -1,8 +1,10 @@
 package invoicesrpc
 
 import (
+	"cmp"
 	"encoding/hex"
 	"fmt"
+	"slices"
 
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/chaincfg"
@@ -160,6 +162,11 @@ func CreateRPCInvoice(invoice *invoices.Invoice,
 		rpcHtlcs = append(rpcHtlcs, &rpcHtlc)
 	}
 
+	// Perform an inplace sort of the HTLCs to ensure they are ordered.
+	slices.SortFunc(rpcHtlcs, func(i, j *lnrpc.InvoiceHTLC) int {
+		return cmp.Compare(i.HtlcIndex, j.HtlcIndex)
+	})
+
 	rpcInvoice := &lnrpc.Invoice{
 		Memo:            string(invoice.Memo),
 		RHash:           rHash,