itest: use groupkey on grouped asset & liquidity edge cases itests

We add support for group keys on payments and invoices across the
itests. This includes all the required helpers and optional arguments to
make adding invoices and sending payments group-key enabled.

In order to run the liquidity edge cases twice, once using only asset
IDs and once using only group keys, we need to extract the main logic
into a re-usable function that has the group key option on the top
level. If the group key flag is set, then we append the respective group
key opt to the payment & invoice related calls.

Author: GeorgeTsagk

itest/assets_test.go

@@ -726,6 +726,12 @@ func sendAssetKeySendPayment(t *testing.T, src, dst *HarnessNode, amt uint64,
 		opt(cfg)
 	}
 
+	// Nullify assetID if group key is set. RPC methods won't accept both so
+	// let's prioritize the group key if set.
+	if len(cfg.groupKey) > 0 {
+		assetID = nil
+	}
+
 	ctxb := context.Background()
 	ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
 	defer cancel()
@@ -755,6 +761,7 @@ func sendAssetKeySendPayment(t *testing.T, src, dst *HarnessNode, amt uint64,
 	stream, err := srcTapd.SendPayment(ctxt, &tchrpc.SendPaymentRequest{
 		AssetId:        assetID,
 		AssetAmount:    amt,
+		GroupKey:       cfg.groupKey,
 		PaymentRequest: sendReq,
 	})
 	require.NoError(t, err)
@@ -927,6 +934,7 @@ type payConfig struct {
 	payStatus         lnrpc.Payment_PaymentStatus
 	failureReason     lnrpc.PaymentFailureReason
 	rfq               fn.Option[rfqmsg.ID]
+	groupKey          []byte
 }
 
 func defaultPayConfig() *payConfig {
@@ -941,6 +949,16 @@ func defaultPayConfig() *payConfig {
 
 type payOpt func(*payConfig)
 
+func withMaybeGroupKey(groupMode bool, groupKey []byte) payOpt {
+	return func(c *payConfig) {
+		if !groupMode {
+			return
+		}
+
+		c.groupKey = groupKey
+	}
+}
+
 func withSmallShards() payOpt {
 	return func(c *payConfig) {
 		c.smallShards = true
@@ -995,6 +1013,12 @@ func payInvoiceWithAssets(t *testing.T, payer, rfqPeer *HarnessNode,
 		opt(cfg)
 	}
 
+	// Nullify assetID if group key is set. RPC methods won't accept both so
+	// let's prioritize the group key if set.
+	if len(cfg.groupKey) > 0 {
+		assetID = []byte{}
+	}
+
 	ctxb := context.Background()
 	ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
 	defer cancel()
@@ -1026,6 +1050,7 @@ func payInvoiceWithAssets(t *testing.T, payer, rfqPeer *HarnessNode,
 	stream, err := payerTapd.SendPayment(ctxt, &tchrpc.SendPaymentRequest{
 		AssetId:        assetID,
 		PeerPubkey:     rfqPeer.PubKey[:],
+		GroupKey:       cfg.groupKey,
 		PaymentRequest: sendReq,
 		RfqId:          rfqBytes,
 		AllowOverpay:   cfg.allowOverpay,
@@ -1087,6 +1112,7 @@ func payInvoiceWithAssets(t *testing.T, payer, rfqPeer *HarnessNode,
 
 type invoiceConfig struct {
 	errSubStr string
+	groupKey  []byte
 }
 
 func defaultInvoiceConfig() *invoiceConfig {
@@ -1103,6 +1129,16 @@ func withInvoiceErrSubStr(errSubStr string) invoiceOpt {
 	}
 }
 
+func withMaybeInvGroupKey(groupMode bool, groupKey []byte) invoiceOpt {
+	return func(c *invoiceConfig) {
+		if !groupMode {
+			return
+		}
+
+		c.groupKey = groupKey
+	}
+}
+
 func createAssetInvoice(t *testing.T, dstRfqPeer, dst *HarnessNode,
 	assetAmount uint64, assetID []byte,
 	opts ...invoiceOpt) *lnrpc.AddInvoiceResponse {
@@ -1112,6 +1148,12 @@ func createAssetInvoice(t *testing.T, dstRfqPeer, dst *HarnessNode,
 		opt(cfg)
 	}
 
+	// Nullify assetID if group key is set. RPC methods won't accept both so
+	// let's prioritize the group key if set.
+	if len(cfg.groupKey) > 0 {
+		assetID = []byte{}
+	}
+
 	ctxb := context.Background()
 	ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
 	defer cancel()
@@ -1126,6 +1168,7 @@ func createAssetInvoice(t *testing.T, dstRfqPeer, dst *HarnessNode,
 
 	resp, err := dstTapd.AddInvoice(ctxt, &tchrpc.AddInvoiceRequest{
 		AssetId:     assetID,
+		GroupKey:    cfg.groupKey,
 		AssetAmount: assetAmount,
 		PeerPubkey:  dstRfqPeer.PubKey[:],
 		InvoiceRequest: &lnrpc.Invoice{
@@ -1170,7 +1213,7 @@ func createAssetInvoice(t *testing.T, dstRfqPeer, dst *HarnessNode,
 // individual HTLCs that arrived for it and that they show the correct asset
 // amounts for the given ID when decoded.
 func assertInvoiceHtlcAssets(t *testing.T, node *HarnessNode,
-	addedInvoice *lnrpc.AddInvoiceResponse, assetID []byte,
+	addedInvoice *lnrpc.AddInvoiceResponse, assetID []byte, groupID []byte,
 	assetAmount uint64) {
 
 	ctxb := context.Background()
@@ -1189,7 +1232,14 @@ func assertInvoiceHtlcAssets(t *testing.T, node *HarnessNode,
 
 	t.Logf("Asset invoice: %v", toProtoJSON(t, invoice))
 
-	targetID := hex.EncodeToString(assetID)
+	var targetID string
+	switch {
+	case len(groupID) > 0:
+		targetID = hex.EncodeToString(groupID)
+
+	case len(assetID) > 0:
+		targetID = hex.EncodeToString(assetID)
+	}
 
 	var totalAssetAmount uint64
 	for _, htlc := range invoice.Htlcs {
@@ -1216,7 +1266,7 @@ func assertInvoiceHtlcAssets(t *testing.T, node *HarnessNode,
 // individual HTLCs that arrived for it and that they show the correct asset
 // amounts for the given ID when decoded.
 func assertPaymentHtlcAssets(t *testing.T, node *HarnessNode, payHash []byte,
-	assetID []byte, assetAmount uint64) {
+	assetID []byte, groupID []byte, assetAmount uint64) {
 
 	ctxb := context.Background()
 	ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
@@ -1237,7 +1287,14 @@ func assertPaymentHtlcAssets(t *testing.T, node *HarnessNode, payHash []byte,
 
 	t.Logf("Asset payment: %v", toProtoJSON(t, payment))
 
-	targetID := hex.EncodeToString(assetID)
+	var targetID string
+	switch {
+	case len(groupID) > 0:
+		targetID = hex.EncodeToString(groupID)
+
+	case len(assetID) > 0:
+		targetID = hex.EncodeToString(assetID)
+	}
 
 	var totalAssetAmount uint64
 	for _, htlc := range payment.Htlcs {
@@ -1267,7 +1324,19 @@ type assetHodlInvoice struct {
 }
 
 func createAssetHodlInvoice(t *testing.T, dstRfqPeer, dst *HarnessNode,
-	assetAmount uint64, assetID []byte) assetHodlInvoice {
+	assetAmount uint64, assetID []byte,
+	opts ...invoiceOpt) assetHodlInvoice {
+
+	cfg := defaultInvoiceConfig()
+	for _, opt := range opts {
+		opt(cfg)
+	}
+
+	// Nullify assetID if group key is set. RPC methods won't accept both so
+	// let's prioritize the group key if set.
+	if len(cfg.groupKey) > 0 {
+		assetID = []byte{}
+	}
 
 	ctxb := context.Background()
 	ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
@@ -1291,6 +1360,7 @@ func createAssetHodlInvoice(t *testing.T, dstRfqPeer, dst *HarnessNode,
 
 	resp, err := dstTapd.AddInvoice(ctxt, &tchrpc.AddInvoiceRequest{
 		AssetId:     assetID,
+		GroupKey:    cfg.groupKey,
 		AssetAmount: assetAmount,
 		PeerPubkey:  dstRfqPeer.PubKey[:],
 		InvoiceRequest: &lnrpc.Invoice{