GlcoinCore/lightning-terminal
1
0
Fork 0
mirror of https://github.com/lightninglabs/lightning-terminal.git synced 2026-08-13 12:33:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

itest: add groupkey mode to liquidity edge cases

Browse source 
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.
This commit is contained in:
George Tsagkarelis 2025-03-19 15:00:58 +01:00
parent 957dec6adb
commit e75169c5b8
No known key found for this signature in database
GPG key ID: E08DEA9B12B66AF6
3 changed files with 229 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

64
itest/assets_test.go
View file

@ -4,7 +4,6 @@ import (
"bytes"
"context"
"crypto/rand"
"crypto/sha256"
"encoding/hex"
"encoding/json"
"fmt"
@ -727,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 = []byte{}
}
ctxb := context.Background()
ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
defer cancel()
@ -1014,6 +1019,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()
@ -1139,6 +1150,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()
@ -1219,12 +1236,11 @@ func assertInvoiceHtlcAssets(t *testing.T, node *HarnessNode,
var targetID string
switch {
case len(groupID) > 0:
targetID = hex.EncodeToString(groupID)
case len(assetID) > 0:
targetID = hex.EncodeToString(assetID)
case len(groupID) > 0:
groupHash := sha256.Sum256(groupID)
targetID = hex.EncodeToString(groupHash[:])
}
var totalAssetAmount uint64
@ -1275,12 +1291,11 @@ func assertPaymentHtlcAssets(t *testing.T, node *HarnessNode, payHash []byte,
var targetID string
switch {
case len(groupID) > 0:
targetID = hex.EncodeToString(groupID)
case len(assetID) > 0:
targetID = hex.EncodeToString(assetID)
case len(groupID) > 0:
groupHash := sha256.Sum256(groupID)
targetID = hex.EncodeToString(groupHash[:])
}
var totalAssetAmount uint64
@ -1311,7 +1326,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)
@ -1335,6 +1362,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{
@ -1373,6 +1401,22 @@ func createAssetHodlInvoice(t *testing.T, dstRfqPeer, dst *HarnessNode,
}
}
// addGroupModeOpt may add a group key option to the opts array, if the group
// mode boolean is true.
func addGroupModeOpt(opts *[]payOpt, groupMode bool, groupID []byte) {
if groupMode {
*opts = append(*opts, withGroupKey(groupID))
}
}
// addGroupModeInvOpt may add a group key option to the opts array, if the group
// mode boolean is true.
func addGroupModeInvOpt(opts *[]invoiceOpt, groupMode bool, groupID []byte) {
if groupMode {
*opts = append(*opts, withInvGroupKey(groupID))
}
}
func waitForSendEvent(t *testing.T,
sendEvents taprpc.TaprootAssets_SubscribeSendEventsClient,
expectedState tapfreighter.SendState) {

217
itest/litd_custom_channels_test.go
View file

@ -9,6 +9,7 @@ import (
"slices"
"time"
"github.com/btcsuite/btcd/btcec/v2"
"github.com/btcsuite/btcd/btcec/v2/schnorr"
"github.com/btcsuite/btcd/btcutil"
"github.com/btcsuite/btcd/chaincfg/chainhash"
@ -1724,10 +1725,13 @@ func testCustomChannelsBreach(ctx context.Context, net *NetworkHarness,
t.Logf("Charlie UTXOs after breach: %v", toProtoJSON(t.t, charlieUTXOs))
}
// testCustomChannelsLiquidityEdgeCases is a test that runs through some
// taproot asset channel liquidity related edge cases.
func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
net *NetworkHarness, t *harnessTest) {
// testCustomChannelsLiquidtyEdgeCasesCore is the core logic of the liquidity
// edge cases. This test goes through certain scenarios that expose edge cases
// and behaviors that proved to be buggy in the past and have been directly
// addressed. It accepts an extra parameter which dictates whether it should use
// group keys or asset IDs.
func testCustomChannelsLiquidtyEdgeCasesCore(ctx context.Context,
net *NetworkHarness, t *harnessTest, groupMode bool) {
lndArgs := slices.Clone(lndArgsTemplate)
litdArgs := slices.Clone(litdArgsTemplate)
@ -1807,18 +1811,27 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
fabiaTap := newTapClient(t.t, fabia)
yaraTap := newTapClient(t.t, yara)
assetReq := itest.CopyRequest(&mintrpc.MintAssetRequest{
Asset: itestAsset,
})
// In order to use group keys in this test, the asset must belong to a
// group.
if groupMode {
assetReq.Asset.NewGroupedAsset = true
}
// Mint an asset on Charlie and sync all nodes to Charlie as the
// universe.
mintedAssets := itest.MintAssetsConfirmBatch(
t.t, t.lndHarness.Miner.Client, charlieTap,
[]*mintrpc.MintAssetRequest{
{
Asset: itestAsset,
},
},
[]*mintrpc.MintAssetRequest{assetReq},
)
cents := mintedAssets[0]
assetID := cents.AssetGenesis.AssetId
groupID := cents.GetAssetGroup().GetTweakedGroupKey()
groupKey, err := btcec.ParsePubKey(groupID)
require.NoError(t.t, err)
t.Logf("Minted %d lightning cents, syncing universes...", cents.Amount)
syncUniverses(t.t, charlieTap, dave, erin, fabia, yara)
@ -1848,10 +1861,13 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
logBalance(t.t, nodes, assetID, "initial")
var opts []payOpt
addGroupModeOpt(&opts, groupMode, groupID)
// Normal case.
// Send 50 assets from Charlie to Dave.
sendAssetKeySendPayment(
t.t, charlie, dave, 50, assetID, fn.None[int64](),
t.t, charlie, dave, 50, assetID, fn.None[int64](), opts...,
)
logBalance(t.t, nodes, assetID, "after 50 assets")
@ -1874,10 +1890,13 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
timeoutChan := time.After(PaymentTimeout / 2)
done := make(chan bool, 1)
opts = []payOpt{withFailure(lnrpc.Payment_FAILED, failureNoRoute)}
addGroupModeOpt(&opts, groupMode, groupID)
go func() {
sendAssetKeySendPayment(
t.t, dave, charlie, 50, assetID, fn.None[int64](),
withFailure(lnrpc.Payment_FAILED, failureNoRoute),
opts...,
)
done <- true
@ -1896,10 +1915,13 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
logBalance(t.t, nodes, assetID, "10k sats")
opts = []payOpt{}
addGroupModeOpt(&opts, groupMode, groupID)
// Now Dave tries to send 50 assets again, this time he should have
// enough sats.
sendAssetKeySendPayment(
t.t, dave, charlie, 50, assetID, fn.None[int64](),
t.t, dave, charlie, 50, assetID, fn.None[int64](), opts...,
)
logBalance(t.t, nodes, assetID, "after 50 sats backwards")
@ -1913,9 +1935,12 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
logBalance(t.t, nodes, assetID, "after 1 sat")
opts = []payOpt{withSmallShards()}
addGroupModeOpt(&opts, groupMode, groupID)
// Pay a normal bolt11 invoice involving RFQ flow.
_ = createAndPayNormalInvoice(
t.t, charlie, dave, erin, 20_000, assetID, withSmallShards(),
t.t, charlie, dave, erin, 20_000, assetID, opts...,
)
logBalance(t.t, nodes, assetID, "after 20k sat asset payment")
@ -1926,8 +1951,12 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
//
// Pay a bolt11 invoice with assets, which evaluates to more than the
// channel btc capacity.
opts = []payOpt{withSmallShards()}
addGroupModeOpt(&opts, groupMode, groupID)
_ = createAndPayNormalInvoice(
t.t, charlie, dave, erin, 1_000_000, assetID, withSmallShards(),
t.t, charlie, dave, erin, 1_000_000, assetID, opts...,
)
logBalance(t.t, nodes, assetID, "after big asset payment (btc "+
@ -1935,30 +1964,45 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
// Edge case: Big asset invoice paid by direct peer with assets.
const bigAssetAmount = 100_000
invOpts := []invoiceOpt{}
addGroupModeInvOpt(&invOpts, groupMode, groupID)
invoiceResp := createAssetInvoice(
t.t, charlie, dave, bigAssetAmount, assetID,
t.t, charlie, dave, bigAssetAmount, assetID, invOpts...,
)
opts = []payOpt{}
addGroupModeOpt(&opts, groupMode, groupID)
payInvoiceWithAssets(
t.t, charlie, dave, invoiceResp.PaymentRequest, assetID,
opts...,
)
logBalance(t.t, nodes, assetID, "after big asset payment (asset "+
"invoice, direct)")
groupBytes := asset.ID(schnorr.SerializePubKey(groupKey))
// Make sure the invoice on the receiver side and the payment on the
// sender side show the individual HTLCs that arrived for it and that
// they show the correct asset amounts when decoded.
assertInvoiceHtlcAssets(
t.t, dave, invoiceResp, assetID, nil, bigAssetAmount,
t.t, dave, invoiceResp, assetID, groupBytes[:], bigAssetAmount,
)
assertPaymentHtlcAssets(
t.t, charlie, invoiceResp.RHash, assetID, nil, bigAssetAmount,
t.t, charlie, invoiceResp.RHash, assetID, groupBytes[:],
bigAssetAmount,
)
opts = []payOpt{}
addGroupModeOpt(&opts, groupMode, groupID)
// Dave sends 200k assets and 5k sats to Yara.
sendAssetKeySendPayment(
t.t, dave, yara, 2*bigAssetAmount, assetID, fn.None[int64](),
opts...,
)
sendKeySendPayment(t.t, dave, yara, 5_000)
@ -1968,12 +2012,19 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
// Yara with assets. This is a multi-hop payment going over 2 asset
// channels, where the total asset value exceeds the btc capacity of the
// channels.
invOpts = []invoiceOpt{}
addGroupModeInvOpt(&invOpts, groupMode, groupID)
invoiceResp = createAssetInvoice(
t.t, dave, charlie, bigAssetAmount, assetID,
t.t, dave, charlie, bigAssetAmount, assetID, invOpts...,
)
opts = []payOpt{}
addGroupModeOpt(&opts, groupMode, groupID)
payInvoiceWithAssets(
t.t, yara, dave, invoiceResp.PaymentRequest, assetID,
t.t, yara, dave, invoiceResp.PaymentRequest, assetID, opts...,
)
logBalance(t.t, nodes, assetID, "after big asset payment (asset "+
@ -1983,10 +2034,15 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
// Yara with satoshi. This is a multi-hop payment going over 2 asset
// channels, where the total asset value is less than the default anchor
// amount of 354 sats.
createAssetInvoice(t.t, dave, charlie, 1, assetID, withInvoiceErrSubStr(
"cannot create invoice over 1 asset units, as the minimal "+
"transportable amount",
))
invOpts = []invoiceOpt{
withInvoiceErrSubStr(
"cannot create invoice over 1 asset units, as the " +
"minimal transportable amount",
),
}
addGroupModeInvOpt(&invOpts, groupMode, groupID)
createAssetInvoice(t.t, dave, charlie, 1, assetID, invOpts...)
logBalance(t.t, nodes, assetID, "after small payment (asset "+
"invoice, <354sats)")
@ -2001,17 +2057,25 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
ValueMsat: 18_000,
})
require.NoError(t.t, err)
opts = []payOpt{
withFeeLimit(2_000), withPayErrSubStr("rejecting payment of " +
"20000 mSAT"),
}
addGroupModeOpt(&opts, groupMode, groupID)
payInvoiceWithAssets(
t.t, charlie, dave, btcInvoiceResp.PaymentRequest, assetID,
withFeeLimit(2_000), withPayErrSubStr(
"rejecting payment of 20000 mSAT",
),
opts...,
)
opts = []payOpt{withFeeLimit(2_000), withAllowOverpay()}
addGroupModeOpt(&opts, groupMode, groupID)
// When we override the uneconomical payment, it should succeed.
payInvoiceWithAssets(
t.t, charlie, dave, btcInvoiceResp.PaymentRequest, assetID,
withFeeLimit(2_000), withAllowOverpay(),
opts...,
)
logBalance(
t.t, nodes, assetID, "after small payment (BTC invoice 1 sat)",
@ -2025,11 +2089,17 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
ValueMsat: 1_000,
})
require.NoError(t.t, err)
payInvoiceWithAssets(
t.t, charlie, dave, btcInvoiceResp.PaymentRequest, assetID,
opts = []payOpt{
withFeeLimit(1_000), withAllowOverpay(), withPayErrSubStr(
"rejecting payment of 2000 mSAT",
),
}
addGroupModeOpt(&opts, groupMode, groupID)
payInvoiceWithAssets(
t.t, charlie, dave, btcInvoiceResp.PaymentRequest, assetID,
opts...,
)
// Edge case: Check if the RFQ HTLC tracking accounts for cancelled
@ -2038,22 +2108,40 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
// cancel, then pay to a normal invoice which should succeed.
// We start by sloshing some funds in the Erin<->Fabia.
opts = []payOpt{}
addGroupModeOpt(&opts, groupMode, groupID)
sendAssetKeySendPayment(
t.t, erin, fabia, 100_000, assetID, fn.Some[int64](20_000),
opts...,
)
logBalance(t.t, nodes, assetID, "balance after 1st slosh")
// If we are running this test in group mode, then the manual rfq
// negotiation needs to also happen on the group key.
var assetSpecifier rfqrpc.AssetSpecifier
if groupMode {
assetSpecifier = rfqrpc.AssetSpecifier{
Id: &rfqrpc.AssetSpecifier_GroupKey{
GroupKey: groupID,
},
}
} else {
assetSpecifier = rfqrpc.AssetSpecifier{
Id: &rfqrpc.AssetSpecifier_AssetId{
AssetId: assetID,
},
}
}
// We create the RFQ order. We set the max amt to ~180k sats which is
// going to evaluate to about 10k assets.
inOneHour := time.Now().Add(time.Hour)
resQ, err := charlieTap.RfqClient.AddAssetSellOrder(
ctx, &rfqrpc.AddAssetSellOrderRequest{
AssetSpecifier: &rfqrpc.AssetSpecifier{
Id: &rfqrpc.AssetSpecifier_AssetId{
AssetId: assetID,
},
},
AssetSpecifier: &assetSpecifier,
PaymentMaxAmt: 180_000_000,
Expiry: uint64(inOneHour.Unix()),
PeerPubKey: dave.PubKey[:],
@ -2062,17 +2150,27 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
)
require.NoError(t.t, err)
invOpts = []invoiceOpt{}
addGroupModeInvOpt(&invOpts, groupMode, groupID)
// We now create a hodl invoice on Fabia, for 10k assets.
hodlInv := createAssetHodlInvoice(t.t, erin, fabia, 10_000, assetID)
hodlInv := createAssetHodlInvoice(
t.t, erin, fabia, 10_000, assetID, invOpts...,
)
// Charlie tries to pay via Dave, by providing the RFQ quote ID that was
// manually created above.
var quoteID rfqmsg.ID
copy(quoteID[:], resQ.GetAcceptedQuote().Id)
payInvoiceWithAssets(
t.t, charlie, dave, hodlInv.payReq, assetID, withSmallShards(),
opts = []payOpt{withSmallShards(),
withFailure(lnrpc.Payment_IN_FLIGHT, failureNone),
withRFQ(quoteID),
}
addGroupModeOpt(&opts, groupMode, groupID)
payInvoiceWithAssets(
t.t, charlie, dave, hodlInv.payReq, assetID, opts...,
)
// We now assert that the expected numbers of HTLCs are present on each
@ -2103,16 +2201,22 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
assertNumHtlcs(t.t, erin, 0)
assertNumHtlcs(t.t, fabia, 0)
invOpts = []invoiceOpt{}
addGroupModeInvOpt(&invOpts, groupMode, groupID)
// Now Fabia creates the normal invoice.
invoiceResp = createAssetInvoice(
t.t, erin, fabia, 10_000, assetID,
t.t, erin, fabia, 10_000, assetID, invOpts...,
)
opts = []payOpt{withSmallShards(), withRFQ(quoteID)}
addGroupModeOpt(&opts, groupMode, groupID)
// Now Charlie pays the invoice, again by using the manually specified
// RFQ quote ID. This payment should succeed.
payInvoiceWithAssets(
t.t, charlie, dave, invoiceResp.PaymentRequest, assetID,
withSmallShards(), withRFQ(quoteID),
opts...,
)
logBalance(t.t, nodes, assetID, "after manual rfq hodl")
@ -2129,11 +2233,7 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
inOneHour = time.Now().Add(time.Hour)
res, err := charlieTap.RfqClient.AddAssetBuyOrder(
ctx, &rfqrpc.AddAssetBuyOrderRequest{
AssetSpecifier: &rfqrpc.AssetSpecifier{
Id: &rfqrpc.AssetSpecifier_AssetId{
AssetId: assetID,
},
},
AssetSpecifier: &assetSpecifier,
AssetMaxAmt: 10_000,
Expiry: uint64(inOneHour.Unix()),
PeerPubKey: dave.PubKey[:],
@ -2162,16 +2262,41 @@ func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
})
require.NoError(t.t, err)
opts = []payOpt{
withPayErrSubStr("context deadline exceeded"),
withFailure(lnrpc.Payment_FAILED, failureNone),
}
addGroupModeOpt(&opts, groupMode, groupID)
// Now Erin tries to pay the invoice. Since rfq quote cannot satisfy the
// total amount of the invoice this payment will fail.
payInvoiceWithSatoshi(
t.t, erin, iResp, withPayErrSubStr("context deadline exceeded"),
withFailure(lnrpc.Payment_FAILED, failureNone),
t.t, erin, iResp, opts...,
)
logBalance(t.t, nodes, assetID, "after small manual rfq")
}
// testCustomChannelsLiquidityEdgeCases is a test that runs through some
// taproot asset channel liquidity related edge cases.
func testCustomChannelsLiquidityEdgeCases(ctx context.Context,
net *NetworkHarness, t *harnessTest) {
// Run liquidity edge cases and only use single asset IDs for invoices
// and payments.
testCustomChannelsLiquidtyEdgeCasesCore(ctx, net, t, false)
}
// testCustomChannelsLiquidityEdgeCasesGroup is a test that runs through some
// taproot asset channel liquidity related edge cases using group keys.
func testCustomChannelsLiquidityEdgeCasesGroup(ctx context.Context,
net *NetworkHarness, t *harnessTest) {
// Run liquidity edge cases and only use group keys for invoices and
// payments.
testCustomChannelsLiquidtyEdgeCasesCore(ctx, net, t, true)
}
// testCustomChannelsStrictForwarding is a test that tests the strict forwarding
// behavior of a node when it comes to paying asset invoices with assets and
// BTC invoices with satoshis.

4
itest/litd_test_list_on_test.go
View file

@ -48,6 +48,10 @@ var allTestCases = []*testCase{
name: "test custom channels liquidity",
test: testCustomChannelsLiquidityEdgeCases,
},
{
name: "test custom channels liquidity group",
test: testCustomChannelsLiquidityEdgeCasesGroup,
},
{
name: "test custom channels htlc force close",
test: testCustomChannelsHtlcForceClose,