loop/sweepbatcher/sweep_batcher_test.go

6061 lines
160 KiB
Go
Raw Permalink Normal View History

2023-10-10 18:18:52 +03:00
package sweepbatcher
import (
"context"
"database/sql"
"database/sql/driver"
"errors"
"fmt"
2026-03-05 12:18:05 +01:00
"maps"
2024-06-25 01:10:12 -03:00
"os"
"sync"
"sync/atomic"
2023-10-10 18:18:52 +03:00
"testing"
"time"
"github.com/btcsuite/btcd/blockchain"
"github.com/btcsuite/btcd/btcec/v2"
"github.com/btcsuite/btcd/btcec/v2/schnorr/musig2"
2023-10-10 18:18:52 +03:00
"github.com/btcsuite/btcd/btcutil"
"github.com/btcsuite/btcd/chaincfg"
2023-10-10 18:18:52 +03:00
"github.com/btcsuite/btcd/chaincfg/chainhash"
"github.com/btcsuite/btcd/wire"
"github.com/btcsuite/btclog/v2"
"github.com/lightninglabs/lndclient"
2023-10-10 18:18:52 +03:00
"github.com/lightninglabs/loop/loopdb"
"github.com/lightninglabs/loop/loopdb/sqlc"
2023-10-10 18:18:52 +03:00
"github.com/lightninglabs/loop/test"
"github.com/lightninglabs/loop/utils"
"github.com/lightningnetwork/lnd/build"
2023-10-10 18:18:52 +03:00
"github.com/lightningnetwork/lnd/chainntnfs"
"github.com/lightningnetwork/lnd/clock"
"github.com/lightningnetwork/lnd/input"
2023-10-10 18:18:52 +03:00
"github.com/lightningnetwork/lnd/lntypes"
"github.com/lightningnetwork/lnd/lnwallet/chainfee"
"github.com/stretchr/testify/assert"
2023-10-10 18:18:52 +03:00
"github.com/stretchr/testify/require"
)
const (
swapInvoice = "lntb1230n1pjjszzgpp5j76f03wrkya4sm4gxv6az5nmz5aqsvmn4" +
"tpguu2sdvdyygedqjgqdq9xyerxcqzzsxqr23ssp5rwzmwtfjmsgranfk8sr" +
"4p4gcgmvyd42uug8pxteg2mkk23ndvkqs9qyyssq44ruk3ex59cmv4dm6k4v" +
"0kc6c0gcqjs0gkljfyd6c6uatqa2f67xlx3pcg5tnvcae5p3jju8ra77e87d" +
"vhhs0jrx53wnc0fq9rkrhmqqelyx7l"
eventuallyCheckFrequency = 100 * time.Millisecond
ntfnBufferSize = 1024
confTarget = 123
2023-10-10 18:18:52 +03:00
)
// destAddr is a dummy p2wkh address to use as the destination address for
// the swaps.
var destAddr = func() btcutil.Address {
p2wkhAddr := "bcrt1qq68r6ff4k4pjx39efs44gcyccf7unqnu5qtjjz"
addr, err := btcutil.DecodeAddress(p2wkhAddr, nil)
if err != nil {
panic(err)
}
return addr
}()
var htlcKeys = func() loopdb.HtlcKeys {
var senderKey, receiverKey [33]byte
// Generate keys.
_, senderPubKey := test.CreateKey(1)
copy(senderKey[:], senderPubKey.SerializeCompressed())
_, receiverPubKey := test.CreateKey(2)
copy(receiverKey[:], receiverPubKey.SerializeCompressed())
return loopdb.HtlcKeys{
SenderScriptKey: senderKey,
ReceiverScriptKey: receiverKey,
SenderInternalPubKey: senderKey,
ReceiverInternalPubKey: receiverKey,
}
}()
func testVerifySchnorrSig(pubKey *btcec.PublicKey, hash, sig []byte) error {
return nil
}
2023-10-10 18:18:52 +03:00
func testMuSig2SignSweep(ctx context.Context,
protocolVersion loopdb.ProtocolVersion, swapHash lntypes.Hash,
paymentAddr [32]byte, nonce []byte, sweepTxPsbt []byte,
prevoutMap map[wire.OutPoint]*wire.TxOut) (
[]byte, []byte, error) {
return testMuSig2SigningData()
}
// testMuSig2SigningData returns size-correct placeholder data. These tests
// only exercise control flow around the signing response, not cryptographic
// validity.
func testMuSig2SigningData() ([]byte, []byte, error) {
return make([]byte, musig2.PubNonceSize),
make([]byte, input.MuSig2PartialSigSize), nil
}
// TestValidateServerMuSig2SigningData ensures that MuSig2 cosigning data from
// the server is accepted when well-formed and rejected when the nonce or
// partial signature has an unexpected length.
func TestValidateServerMuSig2SigningData(t *testing.T) {
validNonce, validSig, err := testMuSig2SigningData()
require.NoError(t, err)
testCases := []struct {
name string
serverNonce []byte
serverSig []byte
errContains string
}{
{
name: "valid signing data",
serverNonce: validNonce,
serverSig: validSig,
},
{
name: "invalid nonce length",
serverNonce: validNonce[:musig2.PubNonceSize-1],
serverSig: validSig,
errContains: "invalid server nonce length",
},
{
name: "invalid partial signature length",
serverNonce: validNonce,
serverSig: validSig[:input.MuSig2PartialSigSize-1],
errContains: "invalid server partial signature length",
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
err := validateServerMuSig2SigningData(
tc.serverNonce, tc.serverSig,
)
if tc.errContains == "" {
require.NoError(t, err)
return
}
require.ErrorContains(t, err, tc.errContains)
})
}
2023-10-10 18:18:52 +03:00
}
var customSignature = func() []byte {
sig := [64]byte{10, 20, 30}
return sig[:]
}()
func testSignMuSig2func(ctx context.Context, muSig2Version input.MuSig2Version,
swapHash lntypes.Hash, rootHash chainhash.Hash,
sigHash [32]byte) ([]byte, error) {
return customSignature, nil
}
2023-10-10 18:18:52 +03:00
var dummyNotifier = SpendNotifier{
SpendChan: make(chan *SpendDetail, ntfnBufferSize),
2023-10-10 18:18:52 +03:00
SpendErrChan: make(chan error, ntfnBufferSize),
QuitChan: make(chan bool, ntfnBufferSize),
}
func checkBatcherError(t *testing.T, err error) {
if !errors.Is(err, context.Canceled) &&
!errors.Is(err, ErrBatcherShuttingDown) &&
!errors.Is(err, ErrBatchShuttingDown) {
require.NoError(t, err)
}
}
// getBatches returns batches in thread-safe way.
func getBatches(ctx context.Context, batcher *Batcher) []*batch {
var batches []*batch
batcher.testRunInEventLoop(ctx, func() {
for _, batch := range batcher.batches {
batches = append(batches, batch)
}
})
return batches
}
// tryGetOnlyBatch returns a single batch if there is exactly one batch, or nil.
func tryGetOnlyBatch(ctx context.Context, batcher *Batcher) *batch {
batches := getBatches(ctx, batcher)
if len(batches) == 1 {
return batches[0]
} else {
return nil
}
}
// getOnlyBatch makes sure the batcher has exactly one batch and returns it.
func getOnlyBatch(t *testing.T, ctx context.Context, batcher *Batcher) *batch {
batches := getBatches(ctx, batcher)
require.Len(t, batches, 1)
return batches[0]
}
// numBatches returns the number of batches in the batcher.
func (b *Batcher) numBatches(ctx context.Context) int {
return len(getBatches(ctx, b))
}
// numSweeps returns the number of sweeps in the batch.
func (b *batch) numSweeps(ctx context.Context) int {
var numSweeps int
b.testRunInEventLoop(ctx, func() {
numSweeps = len(b.sweeps)
})
return numSweeps
}
// snapshot returns the snapshot of the batch. It is safe to read in parallel
// with the event loop running.
func (b *batch) snapshot(ctx context.Context) *batch {
var snapshot *batch
b.testRunInEventLoop(ctx, func() {
// Deep copy sweeps.
2026-03-05 12:18:05 +01:00
sweeps := maps.Clone(b.sweeps)
// Deep copy cfg.
cfg := *b.cfg
// Deep copy the batch, only data fields.
snapshot = &batch{
id: b.id,
state: b.state,
primarySweepID: b.primarySweepID,
sweeps: sweeps,
currentHeight: b.currentHeight,
batchTxid: b.batchTxid,
batchPkScript: b.batchPkScript,
batchAddress: b.batchAddress,
rbfCache: b.rbfCache,
cfg: &cfg,
}
})
return snapshot
}
// testSweepBatcherBatchCreation tests that sweep requests enter the expected
2023-10-10 18:18:52 +03:00
// batch based on their timeout distance.
func testSweepBatcherBatchCreation(t *testing.T, store testStore,
batcherStore testBatcherStore) {
2023-10-10 18:18:52 +03:00
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
2023-10-10 18:18:52 +03:00
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
2023-10-10 18:18:52 +03:00
go func() {
err := batcher.Run(ctx)
checkBatcherError(t, err)
2023-10-10 18:18:52 +03:00
}()
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
op2 := wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
}
op3 := wire.OutPoint{
Hash: chainhash.Hash{3, 3},
Index: 3,
}
2023-10-10 18:18:52 +03:00
// Create a sweep request.
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op1,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
2023-10-10 18:18:52 +03:00
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
// Insert the same swap twice, this should be a noop.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
// Once batcher receives sweep request it will eventually spin up a
// batch.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Create a second sweep request that has a timeout distance less than
// our configured threshold.
sweepReq2 := SweepRequest{
SwapHash: lntypes.Hash{2, 2, 2},
Inputs: []Input{{
Value: 2222,
Outpoint: op2,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap2 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance - 1,
AmountRequested: 2222,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{2},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq2.SwapHash, swap2)
require.NoError(t, err)
store.AssertLoopOutStored()
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
2023-10-10 18:18:52 +03:00
// Tick tock next block.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Wait for tx to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Batcher should not create a second batch as timeout distance is small
// enough.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Create a third sweep request that has more timeout distance than
// the default.
sweepReq3 := SweepRequest{
SwapHash: lntypes.Hash{3, 3, 3},
Inputs: []Input{{
Value: 3333,
Outpoint: op3,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap3 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance + 1,
AmountRequested: 3333,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{3},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq3.SwapHash, swap3)
require.NoError(t, err)
store.AssertLoopOutStored()
require.NoError(t, batcher.AddSweep(ctx, &sweepReq3))
2023-10-10 18:18:52 +03:00
// Since the second batch got created we check that it registered its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Batcher should create a second batch as timeout distance is greater
// than the threshold
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 2
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
require.Eventually(t, func() bool {
2024-05-28 22:35:08 -03:00
// Verify that each batch has the correct number of sweeps
// in it.
batches := getBatches(ctx, batcher)
for _, batch := range batches {
batch := batch.snapshot(ctx)
2023-10-10 18:18:52 +03:00
switch batch.primarySweepID {
case op1:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 2 {
return false
}
case op3:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 1 {
return false
}
}
}
return true
}, test.Timeout, eventuallyCheckFrequency)
// Check that all sweeps were stored.
require.True(t, batcherStore.AssertSweepStored(op1))
require.True(t, batcherStore.AssertSweepStored(op2))
require.True(t, batcherStore.AssertSweepStored(op3))
2023-10-10 18:18:52 +03:00
}
// testFeeBumping tests that sweep is RBFed with slightly higher fee rate after
// each block unless WithCustomFeeRate is passed.
func testFeeBumping(t *testing.T, store testStore,
batcherStore testBatcherStore, noFeeBumping bool) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
// Disable fee bumping, if requested.
var opts []BatcherOption
if noFeeBumping {
customFeeRate := func(_ context.Context, _ lntypes.Hash,
_ wire.OutPoint) (chainfee.SatPerKWeight, error) {
// Always provide the same value, no bumping.
return test.DefaultMockFee, nil
}
opts = append(opts, WithCustomFeeRate(customFeeRate))
}
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore, opts...)
go func() {
err := batcher.Run(ctx)
checkBatcherError(t, err)
}()
// Create a sweep request.
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1_000_000,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
},
}},
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1_000_000,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
tx1 := <-lnd.TxPublishChannel
out1 := tx1.TxOut[0].Value
// Tick tock next block.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Wait for another sweep tx to be published.
tx2 := <-lnd.TxPublishChannel
out2 := tx2.TxOut[0].Value
if noFeeBumping {
// Expect output to stay the same.
require.Equal(t, out1, out2, "expected out to stay the same")
} else {
// Expect output to drop.
require.Greater(t, out1, out2, "expected out to drop")
}
}
// walletKitWrapper wraps a wallet kit and memorizes the label of the most
// recent published transaction.
type walletKitWrapper struct {
lndclient.WalletKitClient
lastLabel string
}
// PublishTransaction publishes the transaction and memorizes its label.
func (w *walletKitWrapper) PublishTransaction(ctx context.Context,
tx *wire.MsgTx, label string) error {
w.lastLabel = label
return w.WalletKitClient.PublishTransaction(ctx, tx, label)
}
// testTxLabeler tests transaction labels.
func testTxLabeler(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
walletKit := &walletKitWrapper{WalletKitClient: lnd.WalletKit}
batcher := NewBatcher(walletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
var (
runErr error
wg sync.WaitGroup
)
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Create a sweep request.
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op1,
}},
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// When batch is successfully created it will execute it's first step,
// which leads to a spend monitor of the primary sweep.
<-lnd.RegisterSpendChannel
// Eventually request will be consumed and a new batch will spin up.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Find the batch and assign it to a local variable for easier access.
var wantLabel string
for _, btch := range getBatches(ctx, batcher) {
btch := btch.snapshot(ctx)
if btch.primarySweepID == op1 {
wantLabel = fmt.Sprintf(
"BatchOutSweepSuccess -- %d", btch.id,
)
}
}
// Now test the label.
require.Equal(t, wantLabel, walletKit.lastLabel)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
// Define dummy tx labeler, always returning "test".
txLabeler := func(batchID int32) string {
return "test"
}
// Now try it with option WithTxLabeler.
batcher = NewBatcher(walletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore, WithTxLabeler(txLabeler))
ctx, cancel = context.WithCancel(context.Background())
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Expect batch to register for spending.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Now test the label.
require.Equal(t, "test", walletKit.lastLabel)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
}
// testTransactionPublisher wraps a wallet kit and returns publish error on
// the first publish attempt. Further attempts succeed.
type testTransactionPublisher struct {
lndclient.WalletKitClient
attempts int
}
var errTestPublish = errors.New("test publish error")
// PublishTransaction publishes the transaction or fails it's the first attempt.
func (p *testTransactionPublisher) PublishTransaction(ctx context.Context,
tx *wire.MsgTx, label string) error {
p.attempts++
if p.attempts == 1 {
return errTestPublish
}
return p.WalletKitClient.PublishTransaction(ctx, tx, label)
}
// testPublishErrorHandler tests that publish error handler installed with
// WithPublishErrorHandler, works as expected.
func testPublishErrorHandler(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
walletKit := &testTransactionPublisher{WalletKitClient: lnd.WalletKit}
// Catch all publish errors and send them to a channel.
publishErrorChan := make(chan error)
errorHandler := func(err error, errMsg string, log btclog.Logger) {
log.Warnf("%s: %v", errMsg, err)
publishErrorChan <- err
}
batcher := NewBatcher(walletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore, WithPublishErrorHandler(errorHandler))
var (
runErr error
wg sync.WaitGroup
)
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Create a sweep request.
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
},
}},
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// When batch is successfully created it will execute it's first step,
// which leads to a spend monitor of the primary sweep.
<-lnd.RegisterSpendChannel
// Eventually request will be consumed and a new batch will spin up.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// The first attempt to publish the batch tx is expected to fail.
require.ErrorIs(t, <-publishErrorChan, errTestPublish)
// Mine a block to trigger another publishing attempt.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Now publishing should succeed for tx to be published.
<-lnd.TxPublishChannel
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
}
// testSweepBatcherSimpleLifecycle tests the simple lifecycle of the batches
2023-10-10 18:18:52 +03:00
// that are created and run by the batcher.
func testSweepBatcherSimpleLifecycle(t *testing.T, store testStore,
batcherStore testBatcherStore) {
2023-10-10 18:18:52 +03:00
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
2023-10-10 18:18:52 +03:00
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
runErrChan := make(chan error)
2023-10-10 18:18:52 +03:00
go func() {
runErrChan <- batcher.Run(ctx)
2023-10-10 18:18:52 +03:00
}()
// Create a sweep request.
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
const (
inputValue = 1111
outputValue = 50
fee = inputValue - outputValue
)
spendErrChan := make(chan error, 1)
notifier := &SpendNotifier{
SpendChan: make(chan *SpendDetail, 1),
SpendErrChan: spendErrChan,
QuitChan: make(chan bool, 1),
}
2023-10-10 18:18:52 +03:00
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: inputValue,
Outpoint: op1,
}},
Notifier: notifier,
2023-10-10 18:18:52 +03:00
}
const initiationHeight = 550
2023-10-10 18:18:52 +03:00
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: inputValue,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
InitiationHeight: initiationHeight,
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
2023-10-10 18:18:52 +03:00
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
2023-10-10 18:18:52 +03:00
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
// When batch is successfully created it will execute it's first step,
// which leads to a spend monitor of the primary sweep.
spendReg := <-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Eventually request will be consumed and a new batch will spin up.
var primarySweepID wire.OutPoint
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
primarySweepID = batch.snapshot(ctx).primarySweepID
2023-10-10 18:18:52 +03:00
// Batch should have the sweep stored.
return batch.numSweeps(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// The primary sweep id should be that of the first inserted sweep.
require.Equal(t, primarySweepID, op1)
2023-10-10 18:18:52 +03:00
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// After receiving a height notification the batch will step again,
// leading to a new spend monitoring.
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
batch = batch.snapshot(ctx)
2023-10-10 18:18:52 +03:00
return batch.currentHeight == 601
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Emulate spend error.
testError := errors.New("test error")
spendReg.ErrChan <- testError
// Make sure the caller of AddSweep got the spending error.
notifierErr := <-spendErrChan
require.Error(t, notifierErr)
require.ErrorIs(t, notifierErr, testError)
// Wait for the batcher to crash because of the spending error.
runErr := <-runErrChan
require.ErrorIs(t, runErr, testError)
// Now launch the batcher again.
batcher = NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
go func() {
runErrChan <- batcher.Run(ctx)
}()
// When batch is successfully created it will execute it's first step,
// which leads to a spend monitor of the primary sweep.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Deliver sweep request to batcher.
spendChan := make(chan *SpendDetail, 1)
confErrChan := make(chan error)
notifier = &SpendNotifier{
SpendChan: spendChan,
SpendErrChan: make(chan error, 1),
ConfErrChan: confErrChan,
QuitChan: make(chan bool, 1),
}
sweepReq1.Notifier = notifier
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Wait for the notifier to be installed.
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
batch = batch.snapshot(ctx)
sweep := batch.sweeps[batch.primarySweepID]
return sweep.notifier != nil &&
sweep.notifier.SpendChan == spendChan
}, test.Timeout, eventuallyCheckFrequency)
2023-10-10 18:18:52 +03:00
// Create the spending tx that will trigger the spend monitor of the
// batch.
spendingTx := &wire.MsgTx{
Version: 1,
// Since the spend monitor is registered on the primary sweep's
// outpoint we insert that outpoint here.
TxIn: []*wire.TxIn{
{
PreviousOutPoint: op1,
2023-10-10 18:18:52 +03:00
},
},
TxOut: []*wire.TxOut{
{
Value: outputValue,
2023-10-10 18:18:52 +03:00
PkScript: []byte{3, 2, 1},
},
},
}
spendingTxHash := spendingTx.TxHash()
// Mock the spend notification that spends the swap.
spendDetail := &chainntnfs.SpendDetail{
SpentOutPoint: &op1,
2023-10-10 18:18:52 +03:00
SpendingTx: spendingTx,
SpenderTxHash: &spendingTxHash,
SpenderInputIndex: 0,
}
// We notify the spend.
lnd.SpendChannel <- spendDetail
// Make sure the notifier got a proper spending notification.
spending := <-spendChan
require.Equal(t, spendingTxHash, spending.Tx.TxHash())
require.Equal(t, btcutil.Amount(fee), spending.OnChainFeePortion)
2023-10-10 18:18:52 +03:00
// After receiving the spend, the batch is now monitoring for confs.
confReg := <-lnd.RegisterConfChannel
// Make sure the confirmation has proper height hint. It should pass
// the swap initiation height, not the current height.
require.Equal(t, int32(initiationHeight), confReg.HeightHint)
2023-10-10 18:18:52 +03:00
// The batch should eventually read the spend notification and progress
// its state to closed.
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
batch = batch.snapshot(ctx)
return batch.state == Closed
}, test.Timeout, eventuallyCheckFrequency)
// Emulate a confirmation error.
confReg.ErrChan <- testError
// Make sure the notifier gets the confirmation error.
confErr := <-confErrChan
require.ErrorIs(t, confErr, testError)
// Wait for the batcher to crash because of the confirmation error.
runErr = <-runErrChan
require.ErrorIs(t, runErr, testError)
// Now launch the batcher again.
batcher = NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
go func() {
runErrChan <- batcher.Run(ctx)
}()
// When batch is successfully created it will execute it's first step,
// which leads to a spend monitor of the primary sweep.
<-lnd.RegisterSpendChannel
// Deliver sweep request to batcher.
spendChan = make(chan *SpendDetail, 1)
confChan := make(chan *ConfDetail)
notifier = &SpendNotifier{
SpendChan: spendChan,
SpendErrChan: make(chan error, 1),
ConfChan: confChan,
QuitChan: make(chan bool, 1),
}
sweepReq1.Notifier = notifier
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Wait for tx to be published. A closed batch is stored in DB as Open.
<-lnd.TxPublishChannel
// Wait for the notifier to be installed.
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
batch = batch.snapshot(ctx)
sweep := batch.sweeps[batch.primarySweepID]
return sweep.notifier != nil &&
sweep.notifier.SpendChan == spendChan
}, test.Timeout, eventuallyCheckFrequency)
// We notify the spend.
lnd.SpendChannel <- spendDetail
// Make sure the notifier got a proper spending notification.
spending = <-spendChan
require.Equal(t, spendingTxHash, spending.Tx.TxHash())
require.Equal(t, btcutil.Amount(fee), spending.OnChainFeePortion)
// After receiving the spend, the batch is now monitoring for confs.
confReg = <-lnd.RegisterConfChannel
// Make sure the confirmation has proper height hint. It should pass
// the swap initiation height, not the current height.
require.Equal(t, int32(initiationHeight), confReg.HeightHint)
// The batch should eventually read the spend notification and progress
// its state to closed.
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
batch = batch.snapshot(ctx)
2023-10-10 18:18:52 +03:00
return batch.state == Closed
}, test.Timeout, eventuallyCheckFrequency)
err = lnd.NotifyHeight(604)
require.NoError(t, err)
// We mock the tx confirmation notification.
lnd.ConfChannel <- &chainntnfs.TxConfirmation{
BlockHeight: 604,
Tx: spendingTx,
2023-10-10 18:18:52 +03:00
}
// Make sure the notifier gets a confirmation notification.
conf := <-confChan
require.Equal(t, uint32(604), conf.BlockHeight)
require.Equal(t, spendingTx.TxHash(), conf.Tx.TxHash())
require.Equal(t, btcutil.Amount(fee), conf.OnChainFeePortion)
2023-10-10 18:18:52 +03:00
// Eventually the batch receives the confirmation notification and
// confirms itself.
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
2023-10-10 18:18:52 +03:00
return batch.isComplete()
}, test.Timeout, eventuallyCheckFrequency)
// Now emulate adding the sweep again after it was fully confirmed.
// This triggers another code path (monitorSpendAndNotify).
spendChan = make(chan *SpendDetail, 1)
confChan = make(chan *ConfDetail)
notifier = &SpendNotifier{
SpendChan: spendChan,
SpendErrChan: make(chan error, 1),
ConfChan: confChan,
QuitChan: make(chan bool, 1),
}
sweepReq1.Notifier = notifier
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Expect a spending registration.
<-lnd.RegisterSpendChannel
// We notify the spend.
lnd.SpendChannel <- spendDetail
// Now expect the notifier to produce the spending details.
spending = <-spendChan
require.Equal(t, spendingTxHash, spending.Tx.TxHash())
require.Equal(t, btcutil.Amount(fee), spending.OnChainFeePortion)
// We mock the tx confirmation notification.
<-lnd.RegisterConfChannel
lnd.ConfChannel <- &chainntnfs.TxConfirmation{
BlockHeight: 604,
Tx: spendingTx,
}
// Make sure the notifier gets a confirmation notification.
conf = <-confChan
require.Equal(t, uint32(604), conf.BlockHeight)
require.Equal(t, spendingTx.TxHash(), conf.Tx.TxHash())
require.Equal(t, btcutil.Amount(fee), conf.OnChainFeePortion)
// Now check what happens in case of a spending error.
spendErrChan = make(chan error, 1)
notifier = &SpendNotifier{
SpendChan: make(chan *SpendDetail, 1),
SpendErrChan: spendErrChan,
QuitChan: make(chan bool, 1),
}
sweepReq1.Notifier = notifier
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Expect a spending registration.
spendReg = <-lnd.RegisterSpendChannel
// Emulate spend error.
spendReg.ErrChan <- testError
// Make sure the caller of AddSweep got the spending error.
notifierErr = <-spendErrChan
require.Error(t, notifierErr)
require.ErrorIs(t, notifierErr, testError)
// Wait for the batcher to crash because of the spending error.
runErr = <-runErrChan
require.ErrorIs(t, runErr, testError)
// Now launch the batcher again.
batcher = NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
go func() {
runErrChan <- batcher.Run(ctx)
}()
// Now check what happens in case of a confirmation error.
confErrChan = make(chan error, 1)
notifier = &SpendNotifier{
SpendChan: make(chan *SpendDetail, 1),
SpendErrChan: make(chan error, 1),
ConfErrChan: confErrChan,
QuitChan: make(chan bool, 1),
}
sweepReq1.Notifier = notifier
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Expect a spending registration.
<-lnd.RegisterSpendChannel
// We notify the spend.
lnd.SpendChannel <- spendDetail
// We mock the tx confirmation error notification.
confReg = <-lnd.RegisterConfChannel
confReg.ErrChan <- testError
// Make sure the notifier gets the confirmation error.
confErr = <-confErrChan
require.ErrorIs(t, confErr, testError)
// Wait for the batcher to crash because of the confirmation error.
runErr = <-runErrChan
require.ErrorIs(t, runErr, testError)
2023-10-10 18:18:52 +03:00
}
// testSweepBatcherSkippedTxns tests that option WithSkippedTxns
// works as expected.
func testSweepBatcherSkippedTxns(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Create a sweep request.
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
swapHash := lntypes.Hash{1, 1, 1}
const (
inputValue = 1111
initiationHeight = 550
)
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: inputValue,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
InitiationHeight: initiationHeight,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, swapHash, swap1)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: inputValue,
Outpoint: op1,
}},
Notifier: &dummyNotifier,
}))
// When batch is successfully created it will execute it's first step,
// which leads to a spend monitor of the primary sweep.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Record batch ID.
var oldBatchID int32
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
oldBatchID = batch.id
return true
}, test.Timeout, eventuallyCheckFrequency)
// Restart the batcher, adding the oldBatchID to skipped batches.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
ctx, cancel = context.WithCancel(context.Background())
defer cancel()
batcher = NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
WithSkippedTxns(map[chainhash.Hash]struct{}{
op1.Hash: {},
}),
)
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Add the same swap with another outpoint.
op2 := wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
}
require.NoError(t, batcher.AddSweep(ctx, &SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: inputValue,
Outpoint: op2,
}},
Notifier: &dummyNotifier,
}))
// Make sure it is launched in a new batch.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
tx := <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 1)
// Record new batch ID.
var newBatchID int32
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
newBatchID = batch.id
return true
}, test.Timeout, eventuallyCheckFrequency)
// Make sure it is another batch.
require.NotEqual(t, oldBatchID, newBatchID)
// Stop the batcher.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
}
// wrappedLogger implements btclog.Logger, recording last debug message format.
// It is needed to watch for messages in tests.
type wrappedLogger struct {
btclog.Logger
mu sync.Mutex
debugMessages []string
infoMessages []string
warnMessages []string
}
// Debugf logs debug message.
2026-03-05 12:18:05 +01:00
func (l *wrappedLogger) Debugf(format string, params ...any) {
l.mu.Lock()
defer l.mu.Unlock()
l.debugMessages = append(l.debugMessages, format)
l.Logger.Debugf(format, params...)
}
// Infof logs info message.
2026-03-05 12:18:05 +01:00
func (l *wrappedLogger) Infof(format string, params ...any) {
l.mu.Lock()
defer l.mu.Unlock()
l.infoMessages = append(l.infoMessages, format)
l.Logger.Infof(format, params...)
}
// Warnf logs a warning message.
2026-03-05 12:18:05 +01:00
func (l *wrappedLogger) Warnf(format string, params ...any) {
l.mu.Lock()
defer l.mu.Unlock()
l.warnMessages = append(l.warnMessages, format)
l.Logger.Warnf(format, params...)
}
// testDelays tests that WithInitialDelay and WithPublishDelay work.
func testDelays(t *testing.T, store testStore, batcherStore testBatcherStore) {
// Set initial delay and publish delay.
const (
initialDelay = 4 * time.Second
publishDelay = 3 * time.Second
)
initialDelayProvider := func(_ context.Context, _ int,
_ btcutil.Amount, fast bool) (time.Duration, error) {
return initialDelay, nil
}
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
startTime := time.Date(2018, 11, 1, 0, 0, 0, 0, time.UTC)
tickSignal := make(chan time.Duration)
testClock := clock.NewTestClockWithTickSignal(startTime, tickSignal)
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
WithInitialDelay(initialDelayProvider),
WithPublishDelay(publishDelay), WithClock(testClock),
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Create a sweep request.
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
sweepReq := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op1,
}},
Notifier: &dummyNotifier,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 1000,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, sweepReq.SwapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// Expect two timers to be set: initialDelay and publishDelay,
// and RegisterSpend to be called. The order is not determined,
// so catch these actions from two separate goroutines.
var wg2 sync.WaitGroup
2026-03-05 12:18:05 +01:00
wg2.Go(func() {
// Since a batch was created we check that it registered for its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
2026-03-05 12:18:05 +01:00
})
var delays []time.Duration
2026-03-05 12:18:05 +01:00
wg2.Go(func() {
// Expect two timers: initialDelay and publishDelay.
delays = append(delays, <-tickSignal)
delays = append(delays, <-tickSignal)
2026-03-05 12:18:05 +01:00
})
// Wait for RegisterSpend and for timer registrations.
wg2.Wait()
// Expect timer for initialDelay and publishDelay to be registered.
wantDelays := []time.Duration{publishDelay, initialDelay}
require.Equal(t, wantDelays, delays)
// Eventually the batch is launched.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// Replace the logger in the batch with wrappedLogger to watch messages.
batch1 := getOnlyBatch(t, ctx, batcher)
testLogger := &wrappedLogger{
Logger: batch1.log(),
}
batch1.setLog(testLogger)
// Advance the clock to publishDelay. It will trigger the publishDelay
// timer, but won't result in publishing, because of initialDelay.
now := startTime.Add(publishDelay)
testClock.SetTime(now)
// Wait for batch publishing to be skipped, because initialDelay has not
// ended.
require.EventuallyWithT(t, func(c *assert.CollectT) {
testLogger.mu.Lock()
defer testLogger.mu.Unlock()
assert.Contains(c, testLogger.debugMessages, stillWaitingMsg)
}, test.Timeout, eventuallyCheckFrequency)
// Advance the clock to the end of initialDelay.
now = startTime.Add(initialDelay)
testClock.SetTime(now)
// Expect timer for publishDelay to be registered.
require.Equal(t, publishDelay, <-tickSignal)
// Advance the clock.
now = now.Add(publishDelay)
testClock.SetTime(now)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Once batcher receives sweep request it will eventually spin up a
// batch.
require.Eventually(t, func() bool {
// Make sure that the sweep was stored
if !batcherStore.AssertSweepStored(op1) {
return false
}
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
// Make sure the batch has one sweep.
return batch.numSweeps(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// Make sure we have stored the batch.
batches, err := batcherStore.FetchUnconfirmedSweepBatches(ctx)
require.NoError(t, err)
require.Len(t, batches, 1)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
// Advance the clock by 1 second.
now = now.Add(time.Second)
testClock.SetTime(now)
// Now launch it again.
batcher = NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
WithInitialDelay(initialDelayProvider),
WithPublishDelay(publishDelay), WithClock(testClock),
)
ctx, cancel = context.WithCancel(context.Background())
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Expect a timer to be set: 0 (instead of publishDelay), and
// RegisterSpend to be called. The order is not determined, so catch
// these actions from two separate goroutines.
var wg3 sync.WaitGroup
2026-03-05 12:18:05 +01:00
wg3.Go(func() {
// Since a batch was created we check that it registered for its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
2026-03-05 12:18:05 +01:00
})
delays = nil
2026-03-05 12:18:05 +01:00
wg3.Go(func() {
// Expect one timer: publishDelay (0).
delays = append(delays, <-tickSignal)
2026-03-05 12:18:05 +01:00
})
// Wait for RegisterSpend and for timer registration.
wg3.Wait()
// Wait for batch to load.
require.Eventually(t, func() bool {
// Make sure that the sweep was stored
if !batcherStore.AssertSweepStored(op1) {
return false
}
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
// Make sure the batch has one sweep.
return batch.numSweeps(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// Expect one timer: publishDelay (0).
wantDelays = []time.Duration{0}
require.Equal(t, wantDelays, delays)
// Advance the clock.
now = now.Add(time.Millisecond)
testClock.SetTime(now)
// Tick tock next block.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Expect timer for publishDelay (0) to be registered. Make sure
// sweepbatcher does not wait for recovered batches after new block
// arrives as well.
require.Equal(t, time.Duration(0), <-tickSignal)
// Advance the clock.
now = now.Add(time.Millisecond)
testClock.SetTime(now)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
// Advance the clock by 1 second.
now = now.Add(time.Second)
testClock.SetTime(now)
// Now test for large initialDelay and make sure it is cancelled
// for an urgent sweep.
const largeInitialDelay = 6 * time.Hour
largeInitialDelayProvider := func(_ context.Context, _ int,
_ btcutil.Amount, fast bool) (time.Duration, error) {
return largeInitialDelay, nil
}
batcher = NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
WithInitialDelay(largeInitialDelayProvider),
WithPublishDelay(publishDelay), WithClock(testClock),
)
ctx, cancel = context.WithCancel(context.Background())
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Expect spend notification and publication for the first batch.
// Expect a timer to be set: 0 (instead of publishDelay), and
// RegisterSpend to be called. The order is not determined, so catch
// these actions from two separate goroutines.
var wg4 sync.WaitGroup
2026-03-05 12:18:05 +01:00
wg4.Go(func() {
// Since a batch was created we check that it registered for its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
2026-03-05 12:18:05 +01:00
})
delays = nil
2026-03-05 12:18:05 +01:00
wg4.Go(func() {
// Expect one timer: publishDelay (0).
delays = append(delays, <-tickSignal)
2026-03-05 12:18:05 +01:00
})
// Wait for RegisterSpend and for timer registration.
wg4.Wait()
// Expect one timer: publishDelay (0).
wantDelays = []time.Duration{0}
require.Equal(t, wantDelays, delays)
// Get spend notification and tx publication for the first batch.
<-lnd.TxPublishChannel
// Create a sweep request which is not urgent, but close to.
sweepReq2 := SweepRequest{
SwapHash: lntypes.Hash{2, 2, 2},
Inputs: []Input{{
Value: 1111,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
},
}},
Notifier: &dummyNotifier,
}
const blocksInDelay = int32(largeInitialDelay / (10 * time.Minute))
swap2 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
// CltvExpiry is not urgent, but close.
CltvExpiry: 600 + blocksInDelay*2 + 5,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{2},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, sweepReq2.SwapHash, swap2)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
// Expect the sweep to be added to new batch. Expect two timers:
// largeInitialDelay and publishDelay. RegisterSpend is called in
// parallel, so catch these actions from two separate goroutines.
var wg5 sync.WaitGroup
2026-03-05 12:18:05 +01:00
wg5.Go(func() {
// Since a batch was created we check that it registered for its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
2026-03-05 12:18:05 +01:00
})
delays = nil
2026-03-05 12:18:05 +01:00
wg5.Go(func() {
// Expect two timer: largeInitialDelay, publishDelay.
delays = append(delays, <-tickSignal)
delays = append(delays, <-tickSignal)
2026-03-05 12:18:05 +01:00
})
// Wait for RegisterSpend and for timers' registrations.
wg5.Wait()
// Expect two timers: largeInitialDelay, publishDelay.
wantDelays = []time.Duration{publishDelay, largeInitialDelay}
require.Equal(t, wantDelays, delays)
// Replace the logger in the batch with wrappedLogger to watch messages.
var testLogger2 *wrappedLogger
for _, batch := range getBatches(ctx, batcher) {
if batch.id != batch1.id {
testLogger2 = &wrappedLogger{
Logger: batch.log(),
}
batch.setLog(testLogger2)
}
}
require.NotNil(t, testLogger2)
// Add another sweep which is urgent. It will go to the same batch
// to make sure minimum timeout is calculated properly.
sweepReq3 := SweepRequest{
SwapHash: lntypes.Hash{3, 3, 3},
Inputs: []Input{{
Value: 1111,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{3, 3},
Index: 3,
},
}},
Notifier: &dummyNotifier,
}
swap3 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
// CltvExpiry is urgent.
CltvExpiry: 600 + blocksInDelay*2 - 5,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{3},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, sweepReq3.SwapHash, swap3)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq3))
// Wait for sweep to be added to the batch.
require.EventuallyWithT(t, func(c *assert.CollectT) {
testLogger2.mu.Lock()
defer testLogger2.mu.Unlock()
assert.Contains(
c, testLogger2.infoMessages, "adding sweep %v, swap %x",
)
}, test.Timeout, eventuallyCheckFrequency)
// Advance the clock by publishDelay. Don't wait largeInitialDelay.
now = now.Add(publishDelay)
testClock.SetTime(now)
// Wait for tx to be published.
tx := <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 2)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
}
// testCustomDelays tests per-sweep customization in WithInitialDelay.
func testCustomDelays(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
// Set initial delay and publish delay.
const (
initialDelay1 = 100 * time.Second
initialDelay2 = 4 * time.Second
publishDelay = 3 * time.Second
)
swapHash1 := lntypes.Hash{1, 1, 1}
swapHash2 := lntypes.Hash{2, 2, 2}
const (
swapSize1 = 1111
swapSize2 = 2222
)
// initialDelay returns initialDelay depending of batch size (sats).
initialDelayProvider := func(_ context.Context, numSweeps int,
value btcutil.Amount, fast bool) (time.Duration, error) {
if value <= swapSize1 {
// Verify the number of sweeps.
if numSweeps != 1 {
return 0, fmt.Errorf("got unexpected number "+
"of sweeps: %d, want %d", numSweeps, 1)
}
return initialDelay1, nil
} else {
// Verify the number of sweeps.
if numSweeps != 2 {
return 0, fmt.Errorf("got unexpected number "+
"of sweeps: %d, want %d", numSweeps, 2)
}
return initialDelay2, nil
}
}
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
startTime := time.Date(2018, 11, 1, 0, 0, 0, 0, time.UTC)
now := startTime
tickSignal := make(chan time.Duration)
testClock := clock.NewTestClockWithTickSignal(startTime, tickSignal)
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
WithInitialDelay(initialDelayProvider),
WithPublishDelay(publishDelay), WithClock(testClock),
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Create a sweep request.
sweepReq1 := SweepRequest{
SwapHash: swapHash1,
Inputs: []Input{{
Value: swapSize1,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
},
}},
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 1000,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, swapHash1, swap1)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Expect two timers to be set: initialDelay and publishDelay,
// and RegisterSpend to be called. The order is not determined,
// so catch these actions from two separate goroutines.
var wg2 sync.WaitGroup
2026-03-05 12:18:05 +01:00
wg2.Go(func() {
// Since a batch was created we check that it registered for its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
2026-03-05 12:18:05 +01:00
})
var delays []time.Duration
2026-03-05 12:18:05 +01:00
wg2.Go(func() {
// Expect two timers: initialDelay and publishDelay.
delays = append(delays, <-tickSignal)
delays = append(delays, <-tickSignal)
2026-03-05 12:18:05 +01:00
})
// Wait for RegisterSpend and for timer registrations.
wg2.Wait()
// Expect timer for initialDelay1 and publishDelay to be registered.
wantDelays := []time.Duration{publishDelay, initialDelay1}
require.Equal(t, wantDelays, delays)
// Eventually the batch is launched.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// Now add swap 2, which has lower initialDelay.
sweepReq2 := SweepRequest{
SwapHash: swapHash2,
Inputs: []Input{{
Value: swapSize2,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
},
}},
Notifier: &dummyNotifier,
}
swap2 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 1000,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{2},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, swapHash2, swap2)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
// Expect timer for initialDelay2 to be registered, because
// initialDelay2 is lower than initialDelay1, meaning that swap2
// has higher priority than swap1.
require.Equal(t, initialDelay2, <-tickSignal)
// Replace the logger in the batch with wrappedLogger to watch messages.
batch1 := getOnlyBatch(t, ctx, batcher)
testLogger := &wrappedLogger{
Logger: batch1.log(),
}
batch1.setLog(testLogger)
// Wait for publishDelay.
now = now.Add(publishDelay)
testClock.SetTime(now)
// Wait for batch publishing to be skipped, because initialDelay2
// has not ended.
require.EventuallyWithT(t, func(c *assert.CollectT) {
testLogger.mu.Lock()
defer testLogger.mu.Unlock()
assert.Contains(c, testLogger.debugMessages, stillWaitingMsg)
}, test.Timeout, eventuallyCheckFrequency)
// Wait for initialDelay2.
now = now.Add(initialDelay2 - publishDelay)
testClock.SetTime(now)
// It should subscribe for publishDelay now.
require.Equal(t, publishDelay, <-tickSignal)
// Wait for publishDelay.
now = now.Add(publishDelay)
testClock.SetTime(now)
// Wait for tx to be published.
tx := <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 2)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
}
// testMaxSweepsPerBatch tests the limit on max number of sweeps per batch.
func testMaxSweepsPerBatch(t *testing.T, store testStore,
batcherStore testBatcherStore) {
// Disable logging, because this test is very noisy.
oldLogger := log()
UseLogger(build.NewSubLogger("SWEEP", nil))
defer UseLogger(oldLogger)
defer test.Guard(t, test.WithGuardTimeout(5*time.Minute))()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
startTime := time.Date(2018, 11, 1, 0, 0, 0, 0, time.UTC)
testClock := clock.NewTestClock(startTime)
// Create muSig2SignSweep failing all sweeps to force non-cooperative
// scenario (it increases transaction size).
muSig2SignSweep := func(ctx context.Context,
protocolVersion loopdb.ProtocolVersion, swapHash lntypes.Hash,
paymentAddr [32]byte, nonce []byte, sweepTxPsbt []byte,
prevoutMap map[wire.OutPoint]*wire.TxOut) (
[]byte, []byte, error) {
return nil, nil, fmt.Errorf("test error")
}
// Set publish delay.
const publishDelay = 3 * time.Second
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
muSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore, WithPublishDelay(publishDelay),
WithClock(testClock),
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
const swapsNum = MaxSweepsPerBatch + 1
// Expect 2 batches to be registered.
expectedBatches := (swapsNum + MaxSweepsPerBatch - 1) /
MaxSweepsPerBatch
2026-03-05 12:18:05 +01:00
for i := range swapsNum {
preimage := lntypes.Preimage{2, byte(i % 256), byte(i / 256)}
swapHash := preimage.Hash()
outpoint := wire.OutPoint{
Hash: chainhash.Hash{byte(i + 1)},
Index: uint32(i + 1),
}
// Create a sweep request.
sweepReq := SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: 1111,
Outpoint: outpoint,
}},
Notifier: &dummyNotifier,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 1000,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: preimage,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, swapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// If this is new batch, expect a spend registration.
if i%MaxSweepsPerBatch == 0 {
<-lnd.RegisterSpendChannel
}
}
// Eventually the batches are launched and all the sweeps are added.
require.Eventually(t, func() bool {
// Make sure all the batches have started.
batches := getBatches(ctx, batcher)
if len(batches) != expectedBatches {
return false
}
// Make sure all the sweeps were added.
sweepsNum := 0
for _, batch := range batches {
sweepsNum += batch.numSweeps(ctx)
}
return sweepsNum == swapsNum
}, test.Timeout, eventuallyCheckFrequency)
// Advance the clock to publishDelay, so batches are published.
now := startTime.Add(publishDelay)
testClock.SetTime(now)
// Expect mockSigner.SignOutputRaw calls to sign non-cooperative
// sweeps.
2026-03-05 12:18:05 +01:00
for range expectedBatches {
<-lnd.SignOutputRawChannel
}
// Wait for txs to be published.
inputsNum := 0
const maxWeight = lntypes.WeightUnit(400_000)
2026-03-05 12:18:05 +01:00
for range expectedBatches {
tx := <-lnd.TxPublishChannel
inputsNum += len(tx.TxIn)
// Make sure the transaction size is standard.
weight := lntypes.WeightUnit(
blockchain.GetTransactionWeight(btcutil.NewTx(tx)),
)
require.Less(t, weight, maxWeight)
t.Logf("tx weight: %v", weight)
}
// Make sure the number of inputs in batch transactions is equal
// to the number of swaps.
require.Equal(t, swapsNum, inputsNum)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
}
// testSweepBatcherSweepReentry tests that when an old version of the batch tx
2023-10-10 18:18:52 +03:00
// gets confirmed the sweep leftovers are sent back to the batcher.
func testSweepBatcherSweepReentry(t *testing.T, store testStore,
batcherStore testBatcherStore) {
2023-10-10 18:18:52 +03:00
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
2023-10-10 18:18:52 +03:00
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
2023-10-10 18:18:52 +03:00
go func() {
err := batcher.Run(ctx)
checkBatcherError(t, err)
2023-10-10 18:18:52 +03:00
}()
// Create some sweep requests with timeouts not too far away, in order
// to enter the same batch.
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
value1 := btcutil.Amount(1111)
2023-10-10 18:18:52 +03:00
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: value1,
Outpoint: op1,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
2023-10-10 18:18:52 +03:00
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
2023-10-10 18:18:52 +03:00
require.NoError(t, err)
store.AssertLoopOutStored()
sweepReq2 := SweepRequest{
SwapHash: lntypes.Hash{2, 2, 2},
Inputs: []Input{{
Value: 2222,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
},
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap2 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 2222,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{2},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
2023-10-10 18:18:52 +03:00
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq2.SwapHash, swap2)
require.NoError(t, err)
store.AssertLoopOutStored()
sweepReq3 := SweepRequest{
SwapHash: lntypes.Hash{3, 3, 3},
Inputs: []Input{{
Value: 3333,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{3, 3},
Index: 3,
},
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap3 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 3333,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{3},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
2023-10-10 18:18:52 +03:00
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq3.SwapHash, swap3)
require.NoError(t, err)
store.AssertLoopOutStored()
// Feed the sweeps to the batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
// After inserting the primary (first) sweep, a spend monitor should be
// registered.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Add the second sweep.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
2023-10-10 18:18:52 +03:00
// Add next block to trigger batch publishing.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Add the third sweep.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq3))
2023-10-10 18:18:52 +03:00
// Add next block to trigger batch publishing.
err = lnd.NotifyHeight(602)
require.NoError(t, err)
// Wait for tx to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Batcher should create a batch for the sweeps.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Find the batch and store it in a local variable for easier access.
b := &batch{}
for _, btch := range getBatches(ctx, batcher) {
btch.testRunInEventLoop(ctx, func() {
if btch.primarySweepID == op1 {
b = btch
}
})
2023-10-10 18:18:52 +03:00
}
// Batcher should contain all sweeps.
require.Eventually(t, func() bool {
return b.numSweeps(ctx) == 3
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Verify that the batch has a primary sweep id that matches the first
// inserted sweep, sweep1.
require.Equal(t, b.primarySweepID, op1)
2023-10-10 18:18:52 +03:00
// Create the spending tx. In order to simulate an older version of the
// batch transaction being confirmed, we only insert the primary sweep's
// outpoint as a TxIn. This means that the other two sweeps did not
// appear in the spending transaction. (This simulates a possible
// scenario caused by RBF replacements.)
spendingTx := &wire.MsgTx{
Version: 1,
TxIn: []*wire.TxIn{
{
PreviousOutPoint: op1,
2023-10-10 18:18:52 +03:00
},
},
TxOut: []*wire.TxOut{
{
Value: int64(value1.ToUnit(
2024-05-28 22:35:08 -03:00
btcutil.AmountSatoshi,
)),
2023-10-10 18:18:52 +03:00
PkScript: []byte{3, 2, 1},
},
},
}
spendingTxHash := spendingTx.TxHash()
spendDetail := &chainntnfs.SpendDetail{
SpentOutPoint: &op1,
2023-10-10 18:18:52 +03:00
SpendingTx: spendingTx,
SpenderTxHash: &spendingTxHash,
SpenderInputIndex: 0,
SpendingHeight: 603,
2023-10-10 18:18:52 +03:00
}
// Send the spending notification to the mock channel.
lnd.SpendChannel <- spendDetail
// After receiving the spend notification the batch should progress to
// the next step, which is monitoring for confirmations.
<-lnd.RegisterConfChannel
// Eventually the batch reads the notification and proceeds to a closed
// state.
require.Eventually(t, func() bool {
b := b.snapshot(ctx)
2023-10-10 18:18:52 +03:00
return b.state == Closed
}, test.Timeout, eventuallyCheckFrequency)
// We mock the confirmation notification.
lnd.ConfChannel <- &chainntnfs.TxConfirmation{
Tx: spendingTx,
}
// Since second batch was created we check that it registered for its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
// Here is a race condition, which is unlikely to cause a crash: if we
// wait for publish tx before sending a conf notification (previous
// action), then conf notification can go to the second batch (since
// the mock does not have a way to direct a notification to proper
// subscriber) and the first batch does not exit, waiting for the
// confirmation forever.
<-lnd.TxPublishChannel
// Re-add one of remaining sweeps to trigger removing the completed
// batch from the batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq3))
2023-10-10 18:18:52 +03:00
// Eventually the batch receives the confirmation notification,
// gracefully exits and the batcher deletes it.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Find the other batch, which includes the sweeps that did not appear
// in the spending tx.
b = getOnlyBatch(t, ctx, batcher)
2023-10-10 18:18:52 +03:00
// After all the sweeps enter, it should contain 2 sweeps.
require.Eventually(t, func() bool {
return b.numSweeps(ctx) == 2
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// The batch should be in an open state.
b1 := b.snapshot(ctx)
require.Equal(t, b1.state, Open)
2023-10-10 18:18:52 +03:00
}
// testSweepBatcherGroup tests adding a group of UTXOs with the same swap hash
// to the batcher.
func testSweepBatcherGroup(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
go func() {
err := batcher.Run(ctx)
checkBatcherError(t, err)
}()
swapHash := lntypes.Hash{1, 1, 1}
outpoint1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
outpoint2 := wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, swapHash, swap1)
require.NoError(t, err)
store.AssertLoopOutStored()
// Create sweep request with a group of two UTXOs.
sweepReq := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{
{
Outpoint: outpoint1,
Value: 1111,
},
{
Outpoint: outpoint2,
Value: 2222,
},
},
Notifier: &dummyNotifier,
}
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// After inserting the primary (first) sweep, a spend monitor should be
// registered.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
tx := <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 2)
require.ElementsMatch(
t, []wire.OutPoint{outpoint1, outpoint2},
[]wire.OutPoint{
tx.TxIn[0].PreviousOutPoint,
tx.TxIn[1].PreviousOutPoint,
},
)
}
// testSweepBatcherNonWalletAddr tests that sweep requests that sweep to a non
2023-10-10 18:18:52 +03:00
// wallet address enter individual batches.
func testSweepBatcherNonWalletAddr(t *testing.T, store testStore,
batcherStore testBatcherStore) {
2023-10-10 18:18:52 +03:00
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
2023-10-10 18:18:52 +03:00
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
2023-10-10 18:18:52 +03:00
go func() {
err := batcher.Run(ctx)
checkBatcherError(t, err)
2023-10-10 18:18:52 +03:00
}()
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
op2 := wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
}
op3 := wire.OutPoint{
Hash: chainhash.Hash{3, 3},
Index: 3,
}
2023-10-10 18:18:52 +03:00
// Create a sweep request.
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op1,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
2023-10-10 18:18:52 +03:00
},
IsExternalAddr: true,
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
2023-10-10 18:18:52 +03:00
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Once batcher receives sweep request it will eventually spin up a
// batch.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Insert the same swap twice, this should be a noop.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
// Create a second sweep request that has a timeout distance less than
// our configured threshold.
sweepReq2 := SweepRequest{
SwapHash: lntypes.Hash{2, 2, 2},
Inputs: []Input{{
Value: 2222,
Outpoint: op2,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap2 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance - 1,
AmountRequested: 2222,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{2},
2023-10-10 18:18:52 +03:00
},
IsExternalAddr: true,
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq2.SwapHash, swap2)
require.NoError(t, err)
store.AssertLoopOutStored()
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Batcher should create a second batch as first batch is a non wallet
// addr batch.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 2
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for second batch to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Create a third sweep request that has more timeout distance than
// the default.
sweepReq3 := SweepRequest{
SwapHash: lntypes.Hash{3, 3, 3},
Inputs: []Input{{
Value: 3333,
Outpoint: op3,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap3 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance + 1,
AmountRequested: 2222,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{3},
2023-10-10 18:18:52 +03:00
},
IsExternalAddr: true,
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq3.SwapHash, swap3)
require.NoError(t, err)
store.AssertLoopOutStored()
require.NoError(t, batcher.AddSweep(ctx, &sweepReq3))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Batcher should create a new batch as timeout distance is greater than
// the threshold
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 3
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx to be published for 3rd batch.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
require.Eventually(t, func() bool {
2024-05-28 22:35:08 -03:00
// Verify that each batch has the correct number of sweeps
// in it.
batches := getBatches(ctx, batcher)
for _, batch := range batches {
batch := batch.snapshot(ctx)
2023-10-10 18:18:52 +03:00
switch batch.primarySweepID {
case op1:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 1 {
return false
}
case op2:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 1 {
return false
}
case op3:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 1 {
return false
}
}
}
return true
}, test.Timeout, eventuallyCheckFrequency)
// Check that all sweeps were stored.
require.True(t, batcherStore.AssertSweepStored(op1))
require.True(t, batcherStore.AssertSweepStored(op2))
require.True(t, batcherStore.AssertSweepStored(op3))
2023-10-10 18:18:52 +03:00
}
// testSweepBatcherComposite tests that sweep requests that sweep to both wallet
2023-10-10 18:18:52 +03:00
// addresses and non-wallet addresses enter the correct batches.
func testSweepBatcherComposite(t *testing.T, store testStore,
batcherStore testBatcherStore) {
2023-10-10 18:18:52 +03:00
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
lnd.SetMinRelayFee(200)
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
2023-10-10 18:18:52 +03:00
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
2023-10-10 18:18:52 +03:00
go func() {
err := batcher.Run(ctx)
checkBatcherError(t, err)
2023-10-10 18:18:52 +03:00
}()
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
op2 := wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
}
op3 := wire.OutPoint{
Hash: chainhash.Hash{3, 3},
Index: 3,
}
op4 := wire.OutPoint{
Hash: chainhash.Hash{4, 4},
Index: 4,
}
op5 := wire.OutPoint{
Hash: chainhash.Hash{5, 5},
Index: 5,
}
op6 := wire.OutPoint{
Hash: chainhash.Hash{6, 6},
Index: 6,
}
2023-10-10 18:18:52 +03:00
// Create a sweep request.
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op1,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq1.SwapHash, swap1)
2023-10-10 18:18:52 +03:00
require.NoError(t, err)
store.AssertLoopOutStored()
// Create a second sweep request that has a timeout distance less than
// our configured threshold.
sweepReq2 := SweepRequest{
SwapHash: lntypes.Hash{2, 2, 2},
Inputs: []Input{{
Value: 2222,
Outpoint: op2,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap2 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance - 1,
AmountRequested: 2222,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{2},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq2.SwapHash, swap2)
require.NoError(t, err)
store.AssertLoopOutStored()
// Create a third sweep request that has less timeout distance than the
// default max, but is not spending to a wallet address.
sweepReq3 := SweepRequest{
SwapHash: lntypes.Hash{3, 3, 3},
Inputs: []Input{{
Value: 3333,
Outpoint: op3,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap3 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance - 3,
AmountRequested: 3333,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{3},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
IsExternalAddr: true,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq3.SwapHash, swap3)
require.NoError(t, err)
store.AssertLoopOutStored()
// Create a fourth sweep request that has a timeout which is not valid
// for the first batch, so it will cause it to create a new batch.
sweepReq4 := SweepRequest{
SwapHash: lntypes.Hash{4, 4, 4},
Inputs: []Input{{
Value: 444,
Outpoint: op4,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap4 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance + 1,
AmountRequested: 444,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{4},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq4.SwapHash, swap4)
require.NoError(t, err)
store.AssertLoopOutStored()
// Create a fifth sweep request that has a timeout which is not valid
// for the first batch, but a valid timeout for the new batch.
sweepReq5 := SweepRequest{
SwapHash: lntypes.Hash{5, 5, 5},
Inputs: []Input{{
Value: 555,
Outpoint: op5,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap5 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance + 5,
AmountRequested: 555,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{5},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq5.SwapHash, swap5)
require.NoError(t, err)
store.AssertLoopOutStored()
// Create a sixth sweep request that has a valid timeout for the new
// batch, but is paying to a non-wallet address.
sweepReq6 := SweepRequest{
SwapHash: lntypes.Hash{6, 6, 6},
Inputs: []Input{{
Value: 666,
Outpoint: op6,
}},
2023-10-10 18:18:52 +03:00
Notifier: &dummyNotifier,
}
swap6 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111 + defaultMaxTimeoutDistance + 6,
AmountRequested: 666,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{6},
2023-10-10 18:18:52 +03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
IsExternalAddr: true,
2023-10-10 18:18:52 +03:00
}
err = store.CreateLoopOut(ctx, sweepReq6.SwapHash, swap6)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Once batcher receives sweep request it will eventually spin up a
// batch.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx to be published.
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Insert the same swap twice, this should be a noop.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
2023-10-10 18:18:52 +03:00
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
2023-10-10 18:18:52 +03:00
// Batcher should not create a second batch as timeout distance is small
// enough.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 1
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Publish a block to trigger batch 1 republishing.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Wait for tx for the first batch to be published (2 sweeps).
tx := <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 2)
require.NoError(t, batcher.AddSweep(ctx, &sweepReq3))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Batcher should create a second batch as this sweep pays to a non
// wallet address.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 2
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx for the second batch to be published (1 sweep).
tx = <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 1)
require.NoError(t, batcher.AddSweep(ctx, &sweepReq4))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Batcher should create a third batch as timeout distance is greater
// than the threshold.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 3
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx for the third batch to be published (1 sweep).
tx = <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 1)
require.NoError(t, batcher.AddSweep(ctx, &sweepReq5))
2023-10-10 18:18:52 +03:00
// Publish a block to trigger batch 3 republishing.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Wait for 3 txs for the 3 batches.
<-lnd.TxPublishChannel
<-lnd.TxPublishChannel
<-lnd.TxPublishChannel
2023-10-10 18:18:52 +03:00
// Batcher should not create a fourth batch as timeout distance is small
// enough for it to join the last batch.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 3
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
require.NoError(t, batcher.AddSweep(ctx, &sweepReq6))
2023-10-10 18:18:52 +03:00
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
2023-10-10 18:18:52 +03:00
// Batcher should create a fourth batch as this sweep pays to a non
// wallet address.
require.Eventually(t, func() bool {
return batcher.numBatches(ctx) == 4
2023-10-10 18:18:52 +03:00
}, test.Timeout, eventuallyCheckFrequency)
// Wait for tx for the 4th batch to be published (1 sweep).
tx = <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, 1)
2023-10-10 18:18:52 +03:00
require.Eventually(t, func() bool {
// Verify that each batch has the correct number of sweeps in
// it.
batches := getBatches(ctx, batcher)
for _, batch := range batches {
batch := batch.snapshot(ctx)
2023-10-10 18:18:52 +03:00
switch batch.primarySweepID {
case op1:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 2 {
return false
}
case op3:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 1 {
return false
}
case op4:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 2 {
return false
}
case op5:
2023-10-10 18:18:52 +03:00
if len(batch.sweeps) != 1 {
return false
}
}
}
return true
}, test.Timeout, eventuallyCheckFrequency)
// Check that all sweeps were stored.
require.True(t, batcherStore.AssertSweepStored(op1))
require.True(t, batcherStore.AssertSweepStored(op2))
require.True(t, batcherStore.AssertSweepStored(op3))
require.True(t, batcherStore.AssertSweepStored(op4))
require.True(t, batcherStore.AssertSweepStored(op5))
require.True(t, batcherStore.AssertSweepStored(op6))
2023-10-10 18:18:52 +03:00
}
2024-05-22 19:30:16 +02:00
// makeTestTx creates a test transaction with a single output of the given
// value.
func makeTestTx(value int64) *wire.MsgTx {
tx := wire.NewMsgTx(wire.TxVersion)
tx.AddTxOut(wire.NewTxOut(value, nil))
return tx
}
// testGetFeePortionForSweep tests that the fee portion for a sweep is correctly
2024-05-22 19:30:16 +02:00
// calculated.
func testGetFeePortionForSweep(t *testing.T, store testStore,
batcherStore testBatcherStore) {
2024-05-22 19:30:16 +02:00
tests := []struct {
name string
spendTxValue int64
numSweeps int
totalSweptAmt btcutil.Amount
expectedFeePortion btcutil.Amount
expectedRoundingDiff btcutil.Amount
}{
{
"Even Split",
100, 5, 200, 20, 0,
},
{
"Single Sweep",
100, 1, 200, 100, 0,
},
{
"With Rounding Diff",
200, 4, 350, 37, 2,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
spendTx := makeTestTx(tt.spendTxValue)
feePortion, roundingDiff := getFeePortionForSweep(
spendTx, tt.numSweeps, tt.totalSweptAmt,
)
require.Equal(t, tt.expectedFeePortion, feePortion)
require.Equal(t, tt.expectedRoundingDiff, roundingDiff)
})
}
}
// testRestoringEmptyBatch tests that the batcher can be restored with an empty
// batch.
func testRestoringEmptyBatch(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
_, err = batcherStore.InsertSweepBatch(ctx, &dbBatch{})
require.NoError(t, err)
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
op := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
// Create a sweep request.
sweepReq := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op,
}},
Notifier: &dummyNotifier,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq.SwapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Once batcher receives sweep request it will eventually spin up a
// batch.
require.Eventually(t, func() bool {
// Make sure that the sweep was stored and we have exactly one
// active batch.
if !batcherStore.AssertSweepStored(op) {
return false
}
return batcher.numBatches(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// Make sure we have only one batch stored (as we dropped the dormant
// one).
batches, err := batcherStore.FetchUnconfirmedSweepBatches(ctx)
require.NoError(t, err)
require.Len(t, batches, 1)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
}
type loopStoreMock struct {
loops map[lntypes.Hash]*loopdb.LoopOut
mu sync.Mutex
// backend is the store passed to the test. An empty swap with the ID
// passed is stored to this place to satisfy SQL foreign key constraint.
backend testStore
// preimage is last preimage first byte used in fake swap in backend.
// It has to be unique to satisfy SQL constraint.
preimage byte
}
func newLoopStoreMock(backend testStore) *loopStoreMock {
return &loopStoreMock{
loops: make(map[lntypes.Hash]*loopdb.LoopOut),
backend: backend,
}
}
func (s *loopStoreMock) FetchLoopOutSwap(ctx context.Context,
hash lntypes.Hash) (*loopdb.LoopOut, error) {
s.mu.Lock()
defer s.mu.Unlock()
out, has := s.loops[hash]
if !has {
return nil, errors.New("loop not found")
}
return out, nil
}
func (s *loopStoreMock) putLoopOutSwap(hash lntypes.Hash, out *loopdb.LoopOut) {
s.mu.Lock()
defer s.mu.Unlock()
_, existed := s.loops[hash]
s.loops[hash] = out
if existed {
// The swap exists, no need to create one in backend, since it
// stores fake data anyway.
return
}
if _, ok := s.backend.(*loopdb.StoreMock); ok {
// Do not create a fake loop in loopdb.StoreMock, because it
// blocks on notification channels and this is not needed.
return
}
// Put a swap with the same ID to backend store to satisfy SQL foreign
// key constraint. Don't store the data to ensure it is not used.
err := s.backend.CreateLoopOut(context.Background(), hash,
&loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 999,
AmountRequested: 999,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{s.preimage},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
},
)
s.backend.AssertLoopOutStored()
// Make preimage unique to pass SQL constraints.
s.preimage++
if err != nil {
panic(err)
}
}
// AssertLoopOutStored asserts that a swap is stored.
func (s *loopStoreMock) AssertLoopOutStored() {
s.backend.AssertLoopOutStored()
}
// testHandleSweepTwice tests that handing the same sweep twice must not
// add it to different batches.
func testHandleSweepTwice(t *testing.T, backend testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
store := newLoopStoreMock(backend)
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
const shortCltv = 111
const longCltv = 111 + defaultMaxTimeoutDistance + 6
// Create two sweep requests with CltvExpiry distant from each other
// to go assigned to separate batches.
op1 := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
sweepReq1 := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op1,
}},
Notifier: &dummyNotifier,
}
loopOut1 := &loopdb.LoopOut{
Loop: loopdb.Loop{
Hash: lntypes.Hash{1, 1, 1},
},
Contract: &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: shortCltv,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
},
}
op2 := wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 2,
}
sweepReq2 := SweepRequest{
SwapHash: lntypes.Hash{2, 2, 2},
Inputs: []Input{{
Value: 2222,
Outpoint: op2,
}},
Notifier: &dummyNotifier,
}
loopOut2 := &loopdb.LoopOut{
Loop: loopdb.Loop{
Hash: lntypes.Hash{2, 2, 2},
},
Contract: &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: longCltv,
AmountRequested: 2222,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
},
}
store.putLoopOutSwap(sweepReq1.SwapHash, loopOut1)
store.putLoopOutSwap(sweepReq2.SwapHash, loopOut2)
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Since two batches were created we check that it registered for its
// primary sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Deliver the second sweep. It will go to a separate batch,
// since CltvExpiry values are distant enough.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Once batcher receives sweep request it will eventually spin up
// batches.
require.Eventually(t, func() bool {
// Make sure that the sweep was stored and we have exactly one
// active batch.
if !batcherStore.AssertSweepStored(op1) {
return false
}
if !batcherStore.AssertSweepStored(op2) {
return false
}
return batcher.numBatches(ctx) == 2
}, test.Timeout, eventuallyCheckFrequency)
// Change the second sweep so that it can be added to the first batch.
// Change CltvExpiry.
loopOut2 = &loopdb.LoopOut{
Loop: loopdb.Loop{
Hash: lntypes.Hash{2, 2, 2},
},
Contract: &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: shortCltv,
AmountRequested: 2222,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
},
}
store.putLoopOutSwap(sweepReq2.SwapHash, loopOut2)
// Re-add the second sweep. It is expected to stay in second batch,
// not added to both batches.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
require.Eventually(t, func() bool {
// Make sure there are two batches.
batches := getBatches(ctx, batcher)
if len(batches) != 2 {
return false
}
// Find the batch with largest ID. It must be the second batch.
// Variable batches is a map, not a slice, so we have to visit
// all the items and find the one with maximum id.
var secondBatch *batch
for _, batch := range batches {
if secondBatch == nil || batch.id > secondBatch.id {
secondBatch = batch
}
}
snapshot := secondBatch.snapshot(ctx)
// Make sure the second batch has the second sweep.
sweep2, has := snapshot.sweeps[op2]
if !has {
return false
}
// Make sure the second sweep's timeout has been updated.
return sweep2.timeout == shortCltv
}, test.Timeout, eventuallyCheckFrequency)
// Make sure each batch has one sweep. If the second sweep was added to
// both batches, the following check won't pass.
batches := getBatches(ctx, batcher)
for _, batch := range batches {
// Make sure the batch has one sweep.
require.Equal(t, 1, batch.numSweeps(ctx))
}
// Publish a block to trigger batch 2 republishing.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Wait for txs to be published.
<-lnd.TxPublishChannel
<-lnd.TxPublishChannel
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
}
// testRestoringPreservesConfTarget tests that after the batch is written to DB
// and loaded back, its batchConfTarget value is preserved.
func testRestoringPreservesConfTarget(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Create a sweep request.
op := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
sweepReq := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: op,
}},
Notifier: &dummyNotifier,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, sweepReq.SwapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Once batcher receives sweep request it will eventually spin up a
// batch.
require.Eventually(t, func() bool {
// Make sure that the sweep was stored
if !batcherStore.AssertSweepStored(op) {
return false
}
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
// Make sure the batch has one sweep.
snapshot := batch.snapshot(ctx)
// Make sure the batch has one sweep.
if len(snapshot.sweeps) != 1 {
return false
}
// Make sure the batch has proper batchConfTarget.
return snapshot.cfg.batchConfTarget == confTarget
}, test.Timeout, eventuallyCheckFrequency)
// Make sure we have stored the batch.
batches, err := batcherStore.FetchUnconfirmedSweepBatches(ctx)
require.NoError(t, err)
require.Len(t, batches, 1)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
// Now launch it again.
batcher = NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
ctx, cancel = context.WithCancel(context.Background())
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Expect registration for spend notification.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Wait for batch to load.
require.Eventually(t, func() bool {
// Make sure that the sweep was stored
if !batcherStore.AssertSweepStored(op) {
return false
}
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
// Make sure the batch has one sweep.
return batch.numSweeps(ctx) == 1
}, test.Timeout, eventuallyCheckFrequency)
// Make sure batchConfTarget was preserved.
batch := getOnlyBatch(t, ctx, batcher).snapshot(ctx)
require.Equal(t, int32(confTarget), batch.cfg.batchConfTarget)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
}
type sweepFetcherMock struct {
store map[wire.OutPoint]*SweepInfo
mu sync.Mutex
}
func (f *sweepFetcherMock) setSweep(outpoint wire.OutPoint, info *SweepInfo) {
f.mu.Lock()
defer f.mu.Unlock()
f.store[outpoint] = info
}
func (f *sweepFetcherMock) FetchSweep(ctx context.Context, _ lntypes.Hash,
outpoint wire.OutPoint) (*SweepInfo, error) {
f.mu.Lock()
defer f.mu.Unlock()
return f.store[outpoint], nil
}
// cancelingSweepFetcher cancels its caller context while returning a backend
// fetch error.
type cancelingSweepFetcher struct {
cancel context.CancelFunc
}
func (f *cancelingSweepFetcher) FetchSweep(context.Context, lntypes.Hash,
wire.OutPoint) (*SweepInfo, error) {
// Simulate the caller canceling while the backend returns a
// driver-level error.
f.cancel()
return nil, driver.ErrBadConn
}
// testAddSweepReturnsContextErrorOnFetchCancellation asserts that AddSweep
// returns context.Canceled instead of a backend error when sweep fetching races
// with caller cancellation.
func testAddSweepReturnsContextErrorOnFetchCancellation(t *testing.T,
_ testStore, batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(t.Context())
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, &cancelingSweepFetcher{cancel: cancel},
)
err := batcher.AddSweep(ctx, &SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
},
}},
})
require.ErrorIs(t, err, context.Canceled)
require.NotErrorIs(t, err, driver.ErrBadConn)
}
// TestAddSweepReturnsContextErrorOnFetchCancellation asserts that AddSweep
// returns the context cancellation error if sweep fetching fails while the
// caller context is being canceled.
func TestAddSweepReturnsContextErrorOnFetchCancellation(t *testing.T) {
runTests(t, testAddSweepReturnsContextErrorOnFetchCancellation)
}
// cancelingStatusStore wraps a batcher store and cancels the test context when
// Run checks sweep status. This simulates a backend failure that happens after
// AddSweep already handed the request to the batcher event loop.
type cancelingStatusStore struct {
testBatcherStore
cancel context.CancelFunc
calls atomic.Int32
}
// GetSweepStatus cancels the context and returns a driver error on the second
// status lookup. The first lookup belongs to AddSweep setup; the second lookup
// belongs to Run/handleSweeps after the request has been accepted.
func (s *cancelingStatusStore) GetSweepStatus(ctx context.Context,
outpoint wire.OutPoint) (bool, error) {
if s.calls.Add(1) == 2 {
s.cancel()
return false, driver.ErrBadConn
}
return s.testBatcherStore.GetSweepStatus(ctx, outpoint)
}
// testAddSweepReturnsContextErrorOnRunCancellation asserts that Batcher.Run
// returns the run context's cancellation error when an already accepted sweep
// request fails during shutdown.
func testAddSweepReturnsContextErrorOnRunCancellation(t *testing.T,
_ testStore, batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(t.Context())
defer cancel()
// Use a custom fetcher so AddSweep can complete its setup without
// needing a swap-store lookup.
swapHash := lntypes.Hash{2, 2, 2}
amt := btcutil.Amount(1111)
op := wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 1,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 222,
AmountRequested: amt,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
swapPaymentAddr, err := utils.ObtainSwapPaymentAddr(
swapInvoice, lnd.ChainParams,
)
require.NoError(t, err)
htlc, err := utils.GetHtlc(
swapHash, &swap.SwapContract, lnd.ChainParams,
)
require.NoError(t, err)
sweepFetcher := &sweepFetcherMock{
store: map[wire.OutPoint]*SweepInfo{
op: {
ConfTarget: confTarget,
Timeout: 111,
SwapInvoicePaymentAddr: *swapPaymentAddr,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HTLCKeys: htlcKeys,
HTLC: *htlc,
HTLCSuccessEstimator: htlc.AddSuccessToEstimator,
DestAddr: destAddr,
},
},
}
statusStore := &cancelingStatusStore{
testBatcherStore: batcherStore,
cancel: cancel,
}
// Avoid fee-estimator calls in this test. The race being tested is the
// store lookup that happens after the request reaches Batcher.Run.
customFeeRate := func(context.Context, lntypes.Hash,
wire.OutPoint) (chainfee.SatPerKWeight, error) {
return chainfee.SatPerKWeight(30000), nil
}
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
statusStore, sweepFetcher, WithCustomFeeRate(customFeeRate),
)
runErrChan := make(chan error, 1)
go func() {
runErrChan <- batcher.Run(ctx)
}()
<-batcher.initDone
// AddSweep should finish normally. The injected cancellation is tied to
// the second status lookup, which is performed later by handleSweeps.
err = batcher.AddSweep(ctx, &SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: amt,
Outpoint: op,
}},
})
require.NoError(t, err)
// Run should report the context cancellation instead of the lower-level
// driver error returned by the store.
select {
case err := <-runErrChan:
require.ErrorIs(t, err, context.Canceled)
require.NotErrorIs(t, err, driver.ErrBadConn)
case <-time.After(test.Timeout):
t.Fatalf("expected batcher to exit")
}
}
// TestAddSweepReturnsContextErrorOnRunCancellation asserts that Run returns
// the context cancellation error if handling an already accepted sweep request
// fails while the run context is being canceled.
func TestAddSweepReturnsContextErrorOnRunCancellation(t *testing.T) {
runTests(t, testAddSweepReturnsContextErrorOnRunCancellation)
}
// testRunReturnsContextErrorOnErrChanCancellation asserts that Run returns the
// run context's cancellation error when an async batcher error is ready during
// shutdown.
func testRunReturnsContextErrorOnErrChanCancellation(t *testing.T,
_ testStore, batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
sweepFetcher := &sweepFetcherMock{
store: make(map[wire.OutPoint]*SweepInfo),
}
// Run several attempts so the test exercises the errChan branch even
// though the run context cancellation branch is ready at the same time.
for range 20 {
ctx, cancel := context.WithCancel(t.Context())
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig,
lnd.ChainParams, batcherStore, sweepFetcher,
)
runErrChan := make(chan error, 1)
go func() {
runErrChan <- batcher.Run(ctx)
}()
<-batcher.initDone
// Queue the backend error from inside the event loop so Run cannot
// observe the cancellation until both cases are ready.
batcher.testRunInEventLoop(t.Context(), func() {
cancel()
batcher.errChan <- driver.ErrBadConn
})
select {
case err := <-runErrChan:
require.ErrorIs(t, err, context.Canceled)
require.NotErrorIs(t, err, driver.ErrBadConn)
case <-time.After(test.Timeout):
t.Fatalf("expected batcher to exit")
}
}
}
// TestRunReturnsContextErrorOnErrChanCancellation asserts that Run returns the
// context cancellation error if an async batcher error races with shutdown.
func TestRunReturnsContextErrorOnErrChanCancellation(t *testing.T) {
runTests(t, testRunReturnsContextErrorOnErrChanCancellation)
}
// cancelingPresignedHelper is a PresignedHelper implementation that cancels
// the caller context while returning a driver-level signing error.
type cancelingPresignedHelper struct {
cancel context.CancelFunc
}
// DestPkScript satisfies the PresignedHelper interface. It is not used by
// PresignSweepsGroup, which already receives the destination address directly.
func (h *cancelingPresignedHelper) DestPkScript(context.Context,
wire.OutPoint) ([]byte, error) {
return nil, nil
}
// SignTx cancels the caller context and returns a driver-level error, matching
// the shutdown race this test exercises.
func (h *cancelingPresignedHelper) SignTx(context.Context, wire.OutPoint,
*wire.MsgTx, btcutil.Amount, chainfee.SatPerKWeight,
chainfee.SatPerKWeight, bool) (*wire.MsgTx, error) {
h.cancel()
return nil, driver.ErrBadConn
}
// CleanupTransactions satisfies the PresignedHelper interface. It is not
// exercised by this presigning-only test.
func (h *cancelingPresignedHelper) CleanupTransactions(context.Context,
[]wire.OutPoint) error {
return nil
}
// testPresignSweepsGroupReturnsContextErrorOnCancellation asserts that
// PresignSweepsGroup returns the context cancellation error if presigning fails
// while the caller context is being canceled.
func testPresignSweepsGroupReturnsContextErrorOnCancellation(t *testing.T,
_ testStore, batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(t.Context())
// The store is not used by PresignSweepsGroup, but runTests passes
// both mock and SQL-backed stores so the test stays consistent with
// the rest of this file.
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, nil, WithPresignedHelper(
&cancelingPresignedHelper{cancel: cancel},
),
)
err := batcher.PresignSweepsGroup(
ctx, []Input{{
Value: btcutil.Amount(1_000_000),
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{3, 3},
Index: 1,
},
}}, sweepTimeout, destAddr, nil,
)
require.ErrorIs(t, err, context.Canceled)
require.NotErrorIs(t, err, driver.ErrBadConn)
}
// TestPresignSweepsGroupReturnsContextErrorOnCancellation asserts that
// PresignSweepsGroup returns the context cancellation error if presigning fails
// while the caller context is being canceled.
func TestPresignSweepsGroupReturnsContextErrorOnCancellation(t *testing.T) {
runTests(t, testPresignSweepsGroupReturnsContextErrorOnCancellation)
}
// testSweepFetcher tests providing custom sweep fetcher to Batcher.
func testSweepFetcher(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
// Extract payment address from the invoice.
swapPaymentAddr, err := utils.ObtainSwapPaymentAddr(
swapInvoice, lnd.ChainParams,
)
require.NoError(t, err)
swapHash := lntypes.Hash{1, 1, 1}
// Provide min fee rate for the sweep.
feeRate := chainfee.SatPerKWeight(30000)
amt := btcutil.Amount(1_000_000)
weight := lntypes.WeightUnit(396) // Weight for 1-to-1 tx.
expectedFee := feeRate.FeeForWeight(weight)
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 222,
AmountRequested: amt,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 321,
}
htlc, err := utils.GetHtlc(
swapHash, &swap.SwapContract, lnd.ChainParams,
)
require.NoError(t, err)
sweepInfo := &SweepInfo{
ConfTarget: confTarget,
Timeout: 111,
SwapInvoicePaymentAddr: *swapPaymentAddr,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HTLCKeys: htlcKeys,
HTLC: *htlc,
HTLCSuccessEstimator: htlc.AddSuccessToEstimator,
DestAddr: destAddr,
}
// Create a sweep request.
op := wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
}
sweepReq := SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: amt,
Outpoint: op,
}},
Notifier: &dummyNotifier,
}
sweepFetcher := &sweepFetcherMock{
store: map[wire.OutPoint]*SweepInfo{
op: sweepInfo,
},
}
// Create a swap in the DB. It is needed to satisfy SQL constraints in
// case of SQL test. The data is not actually used, since we pass sweep
// fetcher, so put different conf target to make sure it is not used.
err = store.CreateLoopOut(ctx, swapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
customFeeRate := func(_ context.Context, _ lntypes.Hash,
_ wire.OutPoint) (chainfee.SatPerKWeight, error) {
// Always provide the same value, no bumping.
return feeRate, nil
}
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
nil, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepFetcher, WithCustomFeeRate(customFeeRate),
WithCustomSignMuSig2(testSignMuSig2func))
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
// Once batcher receives sweep request it will eventually spin up a
// batch.
require.Eventually(t, func() bool {
// Make sure that the sweep was stored
if !batcherStore.AssertSweepStored(op) {
return false
}
// Try to get the batch.
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
// Make sure the batch has one sweep.
snapshot := batch.snapshot(ctx)
if len(snapshot.sweeps) != 1 {
return false
}
// Make sure the batch has proper batchConfTarget.
return snapshot.cfg.batchConfTarget == confTarget
}, test.Timeout, eventuallyCheckFrequency)
// Get the published transaction and check the fee rate.
tx := <-lnd.TxPublishChannel
out := btcutil.Amount(tx.TxOut[0].Value)
gotFee := amt - out
require.Equal(t, expectedFee, gotFee, "fees don't match")
gotWeight := lntypes.WeightUnit(
blockchain.GetTransactionWeight(btcutil.NewTx(tx)),
)
require.Equal(t, weight, gotWeight, "weights don't match")
gotFeeRate := chainfee.NewSatPerKWeight(gotFee, gotWeight)
require.Equal(t, feeRate, gotFeeRate, "fee rates don't match")
// Make sure we have stored the batch.
batches, err := batcherStore.FetchUnconfirmedSweepBatches(ctx)
require.NoError(t, err)
require.Len(t, batches, 1)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
}
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
// testSweepBatcherCloseDuringAdding tests that sweep batcher works correctly
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
// if it is closed (stops running) during AddSweep call.
func testSweepBatcherCloseDuringAdding(t *testing.T, store testStore,
batcherStore testBatcherStore) {
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore)
runErrChan := make(chan error, 1)
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
go func() {
runErrChan <- batcher.Run(ctx)
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
}()
// Add many swaps.
for i := byte(1); i < 255; i++ {
swapHash := lntypes.Hash{i, i, i}
// Create a swap contract.
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{i},
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
}
err = store.CreateLoopOut(ctx, swapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
}
var wg sync.WaitGroup
2026-03-05 12:18:05 +01:00
wg.Go(func() {
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
// Add many sweeps.
for i := byte(1); i < 255; i++ {
// Create a sweep request.
sweepReq := SweepRequest{
SwapHash: lntypes.Hash{i, i, i},
Inputs: []Input{{
Value: 1111,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{i, i},
Index: 1,
},
}},
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
Notifier: &dummyNotifier,
}
// Deliver sweep request to batcher.
err := batcher.AddSweep(ctx, &sweepReq)
if errors.Is(err, ErrBatcherShuttingDown) {
break
}
if errors.Is(err, context.Canceled) {
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
break
}
if errors.Is(err, sql.ErrTxDone) {
break
}
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
require.NoError(t, err)
}
2026-03-05 12:18:05 +01:00
})
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
2026-03-05 12:18:05 +01:00
wg.Go(func() {
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
// Close sweepbatcher during addings.
time.Sleep(1 * time.Millisecond)
cancel()
2026-03-05 12:18:05 +01:00
})
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
// We don't know how many spend notification registrations will be
// issued, so accept them while waiting for all goroutines to stop.
addDone := make(chan struct{})
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
go func() {
defer close(addDone)
wg.Wait()
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
}()
for addDone != nil || runErrChan != nil {
select {
case <-lnd.RegisterSpendChannel:
case <-addDone:
addDone = nil
case err := <-runErrChan:
checkBatcherError(t, err)
runErrChan = nil
case <-time.After(test.Timeout):
t.Fatalf("expected batcher close during adding to finish")
}
}
sweepbatcher: fix race condition when stopping The race was detected in CI and locally when running with -race. It happened between the following calls: WARNING: DATA RACE Write at 0x00c0003e6638 by goroutine 1374: runtime.racewrite() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).Wait() sweepbatcher/sweep_batch.go:463 +0x6e github.com/lightninglabs/loop/sweepbatcher.(*Batcher).Run.func1() sweepbatcher/sweep_batcher.go:272 +0x10e Previous read at 0x00c0003e6638 by goroutine 1388: runtime.raceread() <autogenerated>:1 +0x1e github.com/lightninglabs/loop/sweepbatcher.(*batch).monitorConfirmations() sweepbatcher/sweep_batch.go:1144 +0x285 github.com/lightninglabs/loop/sweepbatcher.(*batch).handleSpend() sweepbatcher/sweep_batch.go:1309 +0x10e4 github.com/lightninglabs/loop/sweepbatcher.(*batch).Run() sweepbatcher/sweep_batch.go:526 +0xb04 github.com/lightninglabs/loop/sweepbatcher.(*Batcher).spinUpBatch.func1() sweepbatcher/sweep_batcher.go:455 +0xbd The race was caused because wg.Add(1) and wg.Wait() were running from different goroutines (one goroutine was running batch.Run() and another - batcher.Run()). To avoid this scenario, wg.Wait() call was moved into batch.Run() call, so it waits itself for its children goroutines, after which the channel b.finished is closed, and it serves a signal for external waiters (the batcher, calling batch.Wait()). Also the channel batch.stopped was renamed to batch.stopping to better reflect its nature. Added TestSweepBatcherCloseDuringAdding to make sure adding a sweep during shutting down does not cause a crash. The test did not catch the original race condition.
2024-06-14 23:31:23 -03:00
}
// testSweepBatcherHandleSweepRace reproduces a race between AddSweep and the
// event loop handling the sweep after the sweep has already confirmed. During
// the race the handler gets stale completion data, incorrectly spins up a new
// batch and rewrites the sweep's parent batch. This test verifies that no
// extra batch is created and the sweep stays associated with its original
// batch.
func testSweepBatcherHandleSweepRace(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
<-batcher.initDone
const (
sweepValue = btcutil.Amount(1_000_000)
confHeight = 605
)
sweepOutpoint := wire.OutPoint{
Hash: chainhash.Hash{0, 0, 0, 1},
Index: 5,
}
spendChan := make(chan *SpendDetail, 10)
spendErrChan := make(chan error, 1)
confChan := make(chan *ConfDetail, 10)
confErrChan := make(chan error, 1)
notifier := &SpendNotifier{
SpendChan: spendChan,
SpendErrChan: spendErrChan,
ConfChan: confChan,
ConfErrChan: confErrChan,
QuitChan: make(chan bool),
}
swapHash := lntypes.Hash{7, 7, 7}
sweepReq := SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: sweepValue,
Outpoint: sweepOutpoint,
}},
Notifier: notifier,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 144,
AmountRequested: sweepValue,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
Preimage: lntypes.Preimage{7},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err = store.CreateLoopOut(ctx, swapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// Make sure the batch starts monitoring the primary sweep.
<-lnd.RegisterSpendChannel
publishedTx := <-lnd.TxPublishChannel
var originalBatchID int32
require.Eventually(t, func() bool {
batch := tryGetOnlyBatch(ctx, batcher)
if batch == nil {
return false
}
originalBatchID = batch.snapshot(ctx).id
return true
}, test.Timeout, eventuallyCheckFrequency)
var addWG sync.WaitGroup
addErrChan := make(chan error, 2)
addCtx, addCancel := context.WithCancel(ctx)
defer addCancel()
confCtx, confCancel := context.WithCancel(ctx)
defer confCancel()
2026-03-05 12:18:05 +01:00
addWG.Go(func() {
2025-11-11 23:36:03 -03:00
// After this goroutine completes, stop the goroutine that
// handles registrations as well. Give it one second to finish
// the last AddSweep to prevent goroutine leaks.
defer time.AfterFunc(time.Second, confCancel)
for {
select {
case <-addCtx.Done():
return
default:
}
err := batcher.AddSweep(ctx, &sweepReq)
if err != nil {
addErrChan <- err
return
}
}
2026-03-05 12:18:05 +01:00
})
// Wait a bit so the AddSweep loop runs and keeps handleSweep busy.
time.Sleep(100 * time.Millisecond)
// This goroutine handles spending and confirmation registrations.
// One spending registration has been created above, so the loop starts
// with the next step - notifying about spending.
2026-03-05 12:18:05 +01:00
addWG.Go(func() {
for {
spendingTx := publishedTx
spendingHash := spendingTx.TxHash()
spendDetail := &chainntnfs.SpendDetail{
SpentOutPoint: &sweepOutpoint,
SpendingTx: spendingTx,
SpenderTxHash: &spendingHash,
SpenderInputIndex: 0,
}
lnd.SpendChannel <- spendDetail
select {
case <-spendChan:
case <-time.After(test.Timeout):
addErrChan <- fmt.Errorf("expected spend " +
"notification")
return
}
<-lnd.RegisterConfChannel
require.NoError(t, lnd.NotifyHeight(confHeight))
lnd.ConfChannel <- &chainntnfs.TxConfirmation{
BlockHeight: confHeight,
Tx: spendingTx,
}
select {
case <-confChan:
case <-time.After(test.Timeout):
addErrChan <- fmt.Errorf("expected " +
"confirmation notification")
return
}
select {
// If another spending registration is issued, it means
// handleSweep chose the monitorSpendAndNotify path, so
// any race has already occurred. Stop calling AddSweep.
case <-lnd.RegisterSpendChannel:
addCancel()
case <-confCtx.Done():
return
}
}
2026-03-05 12:18:05 +01:00
})
addWG.Wait()
select {
case err := <-addErrChan:
require.NoError(t, err, "error from a goroutine")
default:
}
require.Eventually(t, func() bool {
running, err := batcherStore.FetchUnconfirmedSweepBatches(ctx)
if err != nil {
return false
}
return len(running) == 0
}, test.Timeout, eventuallyCheckFrequency)
// Make sure the sweep belongs to the original batch. If another batch
// launches, the sweep is reassigns to the new batch.
sweeps, err := batcherStore.FetchBatchSweeps(ctx, originalBatchID)
require.NoError(t, err)
require.Len(t, sweeps, 1)
require.Equal(t, sweepOutpoint, sweeps[0].Outpoint)
parentBatch, err := batcherStore.GetParentBatch(ctx, sweepOutpoint)
require.NoError(t, err)
require.Equal(t, originalBatchID, parentBatch.ID)
cancel()
wg.Wait()
checkBatcherError(t, runErr)
}
// testSweepBatcherHandleBatchShutdown simulates a sweep that is re-added after
// its batch has already completed and begun shutting down. Before the fix,
// addSweeps surfaced ErrBatchShuttingDown, causing handleSweeps to return an
// error and, ultimately, AddSweep to deliver ErrBatcherShuttingDown back to
// the caller. The regression ensures we fall back to the persisted sweep
// status and silently switch to the monitor path.
func testSweepBatcherHandleBatchShutdown(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
ctx := context.Background()
swapHash := lntypes.Hash{2, 2, 2}
sweepOutpoint := wire.OutPoint{
Hash: chainhash.Hash{0, 0, 0, 2},
Index: 1,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 144,
AmountRequested: 1_000,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
Preimage: lntypes.Preimage{2},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
err := store.CreateLoopOut(ctx, swapHash, swap)
require.NoError(t, err)
// Insert a confirmed batch/sweep pair directly into the store so
// GetSweepStatus/GetParentBatch report that the swap already finished.
dbEntry := &dbBatch{}
batchID, err := batcherStore.InsertSweepBatch(ctx, dbEntry)
require.NoError(t, err)
dbEntry.ID = batchID
dbEntry.Confirmed = true
require.NoError(t, batcherStore.UpdateSweepBatch(ctx, dbEntry))
err = batcherStore.UpsertSweep(ctx, &dbSweep{
BatchID: batchID,
SwapHash: swapHash,
Outpoint: sweepOutpoint,
Amount: 1_000,
Completed: true,
})
require.NoError(t, err)
// Build a minimal batch that already contains the sweep. Its event-loop
// channels are serviced by a helper goroutine so scheduleNextCall can
// run without spinning up the full batch.Run machinery.
testCfg := &batchConfig{
maxTimeoutDistance: defaultMaxTimeoutDistance,
}
completedBatch := &batch{
id: batchID,
state: Confirmed,
primarySweepID: sweepOutpoint,
sweeps: map[wire.OutPoint]sweep{
sweepOutpoint: {
swapHash: swapHash,
outpoint: sweepOutpoint,
value: 1_000,
confTarget: 6,
minFeeRate: 1,
},
},
callEnter: make(chan struct{}),
callLeave: make(chan struct{}),
stopping: make(chan struct{}),
finished: make(chan struct{}),
quit: make(chan struct{}),
cfg: testCfg,
store: batcherStore,
}
completedBatch.setLog(batchPrefixLogger("test-shutdown"))
// scheduleNextCall interacts with callEnter/callLeave to serialize
// access to the batch state. We don't run the full batch.Run loop in
// this test, so we spin up a helper goroutine that grants and releases
// those slots whenever a test handler grabs them via scheduleNextCall.
// The helper also closes b.stopping the first time it runs to mimic the
// behavior of a batch whose Run method already exited (which is what
// causes ErrBatchShuttingDown).
var once sync.Once
callLoopDone := make(chan struct{})
go func() {
defer close(callLoopDone)
for range completedBatch.callEnter {
once.Do(func() {
close(completedBatch.stopping)
})
<-completedBatch.callLeave
}
}()
defer func() {
// Stop the helper loop to avoid leaking the goroutine once the
// test completes. Closing callEnter unblocks the goroutine, and
// waiting on callLoopDone ensures it has drained callLeave
// before we return.
close(completedBatch.callEnter)
<-callLoopDone
}()
testBatcher := &Batcher{
batches: map[int32]*batch{batchID: completedBatch},
store: batcherStore,
chainParams: &chaincfg.TestNet3Params,
clock: clock.NewTestClock(time.Unix(0, 0)),
initialDelayProvider: zeroInitialDelay,
}
testSweep := &sweep{
swapHash: swapHash,
outpoint: sweepOutpoint,
confTarget: 6,
minFeeRate: 1,
value: 1_000,
}
err = testBatcher.handleSweeps(ctx, []*sweep{testSweep}, nil, false)
require.NoError(t, err)
}
// failingBaseDB wraps a BaseDB and injects a failure after the batch row is
// marked confirmed but before the sweeps are persisted, emulating a crash.
type failingBaseDB struct {
// BaseDB is the actual database implementation we delegate to.
BaseDB
// mu synchronizes access to the failure state.
mu sync.Mutex
// armed is set once we observe the batch row being marked confirmed.
armed bool
// failed ensures we only inject the failure once.
failed bool
// failErr is the error returned to callers when the injection triggers.
failErr error
}
// newFailingBaseDB creates a new failure-injecting wrapper around the provided
// BaseDB implementation.
func newFailingBaseDB(inner BaseDB) *failingBaseDB {
return &failingBaseDB{
BaseDB: inner,
failErr: errors.New("forced failure after confirming batch"),
}
}
// markArmed remembers that the batch row was updated to confirmed so the next
// sweep update will be forced to fail.
func (f *failingBaseDB) markArmed() {
f.mu.Lock()
defer f.mu.Unlock()
if !f.failed {
f.armed = true
}
}
// shouldFail returns true exactly once after the wrapper has been armed.
func (f *failingBaseDB) shouldFail() bool {
f.mu.Lock()
defer f.mu.Unlock()
if f.armed && !f.failed {
f.failed = true
f.armed = false
return true
}
return false
}
// UpdateBatch proxies the batch update and arms the failure if the batch was
// marked confirmed.
func (f *failingBaseDB) UpdateBatch(ctx context.Context,
arg sqlc.UpdateBatchParams) error {
if arg.Confirmed {
f.markArmed()
}
return f.BaseDB.UpdateBatch(ctx, arg)
}
// UpsertSweep forwards the sweep update unless a failure injection is pending.
func (f *failingBaseDB) UpsertSweep(ctx context.Context,
arg sqlc.UpsertSweepParams) error {
if f.shouldFail() {
return f.failErr
}
return f.BaseDB.UpsertSweep(ctx, arg)
}
// ExecTx wraps the transactional Querier with failingQuerier so the failure
// state is respected inside transactions.
func (f *failingBaseDB) ExecTx(ctx context.Context, opts loopdb.TxOptions,
txBody func(Querier) error) error {
return f.BaseDB.ExecTx(ctx, opts, func(q Querier) error {
return txBody(&failingQuerier{
Querier: q,
parent: f,
})
})
}
// failingQuerier proxies the ExecTx-scoped Querier to propagate the failure
// injection logic into transactional code paths.
type failingQuerier struct {
// Querier is the underlying transactional view.
Querier
// parent references the owning failingBaseDB so we share the failure
// state across transactional calls.
parent *failingBaseDB
}
// UpdateBatch mirrors failingBaseDB.UpdateBatch within a transaction scope.
func (f *failingQuerier) UpdateBatch(ctx context.Context,
arg sqlc.UpdateBatchParams) error {
if arg.Confirmed {
f.parent.markArmed()
}
return f.Querier.UpdateBatch(ctx, arg)
}
// UpsertSweep mirrors failingBaseDB.UpsertSweep for transactional calls.
func (f *failingQuerier) UpsertSweep(ctx context.Context,
arg sqlc.UpsertSweepParams) error {
if f.parent.shouldFail() {
return f.parent.failErr
}
return f.Querier.UpsertSweep(ctx, arg)
}
// TestSweepBatcherConfirmedBatchIncompleteSweeps documents the current crash
// window where a batch can be marked confirmed while its sweeps remain
// incomplete in the DB. This test runs only against the loopdb backend and
// injects failures at the BaseDB layer to simulate a crash.
func TestSweepBatcherConfirmedBatchIncompleteSweeps(t *testing.T) {
logger := btclog.NewSLogger(btclog.NewDefaultHandler(os.Stdout))
logger.SetLevel(btclog.LevelTrace)
UseLogger(logger.SubSystem("SWEEP"))
// Set up a fresh loopdb instance so we exercise the real SQL backend.
sqlDB := loopdb.NewTestDB(t)
typedSqlDB := loopdb.NewTypedStore[Querier](sqlDB)
faultyDB := newFailingBaseDB(typedSqlDB)
lnd := test.NewMockLnd()
batcherStore := NewSQLStore(faultyDB, lnd.ChainParams)
swapStore := newLoopdbStore(t, sqlDB)
const (
sweepValue = btcutil.Amount(1_000_000)
confHeight = 777
)
ctx := context.Background()
sweepOutpoint := wire.OutPoint{
Hash: chainhash.Hash{0, 0, 0, 3},
Index: 7,
}
swapHash := lntypes.Hash{3, 3, 3}
notifier := &SpendNotifier{
SpendChan: make(chan *SpendDetail, ntfnBufferSize),
ConfChan: make(chan *ConfDetail, ntfnBufferSize),
QuitChan: make(chan bool, ntfnBufferSize),
}
sweepReq := SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: sweepValue,
Outpoint: sweepOutpoint,
}},
Notifier: notifier,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 144,
AmountRequested: sweepValue,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
Preimage: lntypes.Preimage{3},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: confTarget,
}
// Seed the DB with an initiated Loop Out swap so AddSweep can load it.
require.NoError(t, swapStore.CreateLoopOut(ctx, swapHash, swap))
swapStore.AssertLoopOutStored()
sweepStore, err := NewSweepFetcherFromSwapStore(
swapStore, lnd.ChainParams,
)
require.NoError(t, err)
ctx1, cancel1 := context.WithCancel(ctx)
defer cancel1()
// The failing DB wrapper will arm itself when the batch row is updated,
// then abort the first sweep update performed in the same transaction,
// mimicking a crash between those two steps.
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore,
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx1)
2026-03-05 12:18:05 +01:00
})
<-batcher.initDone
// Add the sweep once so the batcher spins up a batch.
require.NoError(t, batcher.AddSweep(ctx1, &sweepReq))
<-lnd.RegisterSpendChannel
publishedTx := <-lnd.TxPublishChannel
spendDetail := &chainntnfs.SpendDetail{
SpentOutPoint: &sweepOutpoint,
SpendingTx: publishedTx,
SpenderTxHash: new(chainhash.Hash),
SpenderInputIndex: 0,
}
*spendDetail.SpenderTxHash = publishedTx.TxHash()
lnd.SpendChannel <- spendDetail
<-lnd.RegisterConfChannel
require.NoError(t, lnd.NotifyHeight(confHeight))
lnd.ConfChannel <- &chainntnfs.TxConfirmation{
BlockHeight: confHeight,
Tx: publishedTx,
}
// The failing BaseDB injects its error while handleConf stores the
// confirmed batch/sweeps. Observe that error, then verify the DB was
// left consistent (both the batch and sweeps remain unconfirmed).
wg.Wait()
require.ErrorIs(t, runErr, faultyDB.failErr)
completed, err := batcherStore.GetSweepStatus(ctx, sweepOutpoint)
require.NoError(t, err)
parentBatch, err := batcherStore.GetParentBatch(ctx, sweepOutpoint)
require.NoError(t, err)
require.Equal(t, parentBatch.Confirmed, completed,
"inconsistent DB: confirmed batch vs sweep completion")
}
// testCustomSignMuSig2 tests the operation with custom musig2 signer.
func testCustomSignMuSig2(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
// Use custom MuSig2 signer function.
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
nil, testVerifySchnorrSig, lnd.ChainParams, batcherStore,
sweepStore, WithCustomSignMuSig2(testSignMuSig2func))
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Create a sweep request.
sweepReq := SweepRequest{
SwapHash: lntypes.Hash{1, 1, 1},
Inputs: []Input{{
Value: 1111,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
},
}},
Notifier: &dummyNotifier,
}
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1111,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, sweepReq.SwapHash, swap)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
tx := <-lnd.TxPublishChannel
// Check the signature.
gotSig := tx.TxIn[0].Witness[0]
require.Equal(t, customSignature, gotSig, "signatures don't match")
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
checkBatcherError(t, runErr)
}
// testWithMixedBatch tests mixed batches construction. It also tests
// non-cooperative sweeping (using a preimage). Sweeps are added one by one.
func testWithMixedBatch(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
// Extract payment address from the invoice.
swapPaymentAddr, err := utils.ObtainSwapPaymentAddr(
swapInvoice, lnd.ChainParams,
)
require.NoError(t, err)
// Use sweepFetcher to provide NonCoopHint for swapHash1.
sweepFetcher := &sweepFetcherMock{
store: map[wire.OutPoint]*SweepInfo{},
}
// Create 3 sweeps:
// 1. known in advance to be non-cooperative,
// 2. fails cosigning during an attempt,
// 3. co-signs successfully.
// Create 3 preimages, for 3 sweeps.
var preimages = []lntypes.Preimage{
{1},
{2},
{3},
}
// Swap hashes must match the preimages, for non-cooperative spending
// path to work.
var swapHashes = []lntypes.Hash{
preimages[0].Hash(),
preimages[1].Hash(),
preimages[2].Hash(),
}
// Create muSig2SignSweep working only for 3rd swapHash.
muSig2SignSweep := func(ctx context.Context,
protocolVersion loopdb.ProtocolVersion, swapHash lntypes.Hash,
paymentAddr [32]byte, nonce []byte, sweepTxPsbt []byte,
prevoutMap map[wire.OutPoint]*wire.TxOut) (
[]byte, []byte, error) {
if swapHash == swapHashes[2] {
return testMuSig2SigningData()
} else {
return nil, nil, fmt.Errorf("test error")
}
}
// Use mixed batches.
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
muSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepFetcher,
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Expected weights for transaction having 1, 2, and 3 sweeps.
wantWeights := []lntypes.WeightUnit{559, 952, 1182}
// Two non-cooperative sweeps, one cooperative.
wantWitnessSizes := []int{4, 4, 1}
// Create 3 swaps and 3 sweeps.
for i, swapHash := range swapHashes {
outpoint := wire.OutPoint{
Hash: chainhash.Hash{byte(i + 1)},
Index: uint32(i + 1),
}
// Publish a block to trigger republishing.
err = lnd.NotifyHeight(601 + int32(i))
require.NoError(t, err)
// Put a swap into store to satisfy SQL constraints.
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1_000_000,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: preimages[i],
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
require.NoError(t, store.CreateLoopOut(ctx, swapHash, swap))
store.AssertLoopOutStored()
// Add SweepInfo to sweepFetcher.
htlc, err := utils.GetHtlc(
swapHash, &swap.SwapContract, lnd.ChainParams,
)
require.NoError(t, err)
sweepInfo := &SweepInfo{
Preimage: preimages[i],
ConfTarget: confTarget,
Timeout: 111,
SwapInvoicePaymentAddr: *swapPaymentAddr,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HTLCKeys: htlcKeys,
HTLC: *htlc,
HTLCSuccessEstimator: htlc.AddSuccessToEstimator,
DestAddr: destAddr,
}
// The first sweep is known in advance to be non-cooperative.
if i == 0 {
sweepInfo.NonCoopHint = true
}
sweepFetcher.setSweep(outpoint, sweepInfo)
// Create sweep request.
sweepReq := SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: 1_000_000,
Outpoint: outpoint,
}},
Notifier: &dummyNotifier,
}
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
if i == 0 {
// Since a batch was created we check that it registered
// for its primary sweep's spend.
<-lnd.RegisterSpendChannel
}
// Expect mockSigner.SignOutputRaw call to sign non-cooperative
// sweeps.
<-lnd.SignOutputRawChannel
// A transaction is published.
tx := <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, i+1)
// Check types of inputs.
var witnessSizes []int
for _, txIn := range tx.TxIn {
witnessSizes = append(witnessSizes, len(txIn.Witness))
}
// The order of inputs is not deterministic, because they
// are stored in map.
require.ElementsMatch(t, wantWitnessSizes[:i+1], witnessSizes)
// Calculate expected values.
feeRate := test.DefaultMockFee
for range i {
// Bump fee the number of blocks passed.
feeRate += defaultFeeRateStep
}
amt := btcutil.Amount(1_000_000 * (i + 1))
weight := wantWeights[i]
expectedFee := feeRate.FeeForWeight(weight)
// Check weight.
gotWeight := lntypes.WeightUnit(
blockchain.GetTransactionWeight(btcutil.NewTx(tx)),
)
require.Equal(t, weight, gotWeight, "weights don't match")
// Check fee.
out := btcutil.Amount(tx.TxOut[0].Value)
gotFee := amt - out
require.Equal(t, expectedFee, gotFee, "fees don't match")
// Check fee rate.
gotFeeRate := chainfee.NewSatPerKWeight(gotFee, gotWeight)
require.Equal(t, feeRate, gotFeeRate, "fee rates don't match")
}
// Make sure we have stored the batch.
batches, err := batcherStore.FetchUnconfirmedSweepBatches(ctx)
require.NoError(t, err)
require.Len(t, batches, 1)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
}
// testWithMixedBatchCustom tests mixed batches construction, custom scenario.
// All sweeps are added at once.
func testWithMixedBatchCustom(t *testing.T, store testStore,
batcherStore testBatcherStore, preimages []lntypes.Preimage,
muSig2SignSweep MuSig2SignSweep, nonCoopHints []bool,
expectSignOutputRawChannel bool, wantWeight lntypes.WeightUnit,
wantWitnessSizes []int) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
// Extract payment address from the invoice.
swapPaymentAddr, err := utils.ObtainSwapPaymentAddr(
swapInvoice, lnd.ChainParams,
)
require.NoError(t, err)
// Use sweepFetcher to provide NonCoopHint for swapHash1.
sweepFetcher := &sweepFetcherMock{
store: map[wire.OutPoint]*SweepInfo{},
}
// Swap hashes must match the preimages, for non-cooperative spending
// path to work.
swapHashes := make([]lntypes.Hash, len(preimages))
for i, preimage := range preimages {
swapHashes[i] = preimage.Hash()
}
// Use mixed batches.
batcher := NewBatcher(
lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
muSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepFetcher,
)
var wg sync.WaitGroup
var runErr error
2026-03-05 12:18:05 +01:00
wg.Go(func() {
runErr = batcher.Run(ctx)
2026-03-05 12:18:05 +01:00
})
// Wait for the batcher to be initialized.
<-batcher.initDone
// Create swaps and sweeps.
for i, swapHash := range swapHashes {
outpoint := wire.OutPoint{
Hash: chainhash.Hash{byte(i + 1)},
Index: uint32(i + 1),
}
// Put a swap into store to satisfy SQL constraints.
swap := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1_000_000,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: preimages[i],
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
require.NoError(t, store.CreateLoopOut(ctx, swapHash, swap))
store.AssertLoopOutStored()
// Add SweepInfo to sweepFetcher.
htlc, err := utils.GetHtlc(
swapHash, &swap.SwapContract, lnd.ChainParams,
)
require.NoError(t, err)
sweepFetcher.setSweep(outpoint, &SweepInfo{
Preimage: preimages[i],
NonCoopHint: nonCoopHints[i],
ConfTarget: confTarget,
Timeout: 111,
SwapInvoicePaymentAddr: *swapPaymentAddr,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HTLCKeys: htlcKeys,
HTLC: *htlc,
HTLCSuccessEstimator: htlc.AddSuccessToEstimator,
DestAddr: destAddr,
})
// Create sweep request.
sweepReq := SweepRequest{
SwapHash: swapHash,
Inputs: []Input{{
Value: 1_000_000,
Outpoint: outpoint,
}},
Notifier: &dummyNotifier,
}
require.NoError(t, batcher.AddSweep(ctx, &sweepReq))
if i == 0 {
// Since a batch was created we check that it registered
// for its primary sweep's spend.
<-lnd.RegisterSpendChannel
}
}
if expectSignOutputRawChannel {
// Expect mockSigner.SignOutputRaw call to sign non-cooperative
// sweeps.
<-lnd.SignOutputRawChannel
}
// A transaction is published.
tx := <-lnd.TxPublishChannel
require.Len(t, tx.TxIn, len(preimages))
// Check types of inputs.
var witnessSizes []int
for _, txIn := range tx.TxIn {
witnessSizes = append(witnessSizes, len(txIn.Witness))
}
// The order of inputs is not deterministic, because they
// are stored in map.
require.ElementsMatch(t, wantWitnessSizes, witnessSizes)
// Calculate expected values.
feeRate := test.DefaultMockFee
amt := btcutil.Amount(1_000_000 * len(preimages))
expectedFee := feeRate.FeeForWeight(wantWeight)
// Check weight.
gotWeight := lntypes.WeightUnit(
blockchain.GetTransactionWeight(btcutil.NewTx(tx)),
)
require.Equal(t, wantWeight, gotWeight, "weights don't match")
// Check fee.
out := btcutil.Amount(tx.TxOut[0].Value)
gotFee := amt - out
require.Equal(t, expectedFee, gotFee, "fees don't match")
// Check fee rate.
gotFeeRate := chainfee.NewSatPerKWeight(gotFee, gotWeight)
require.Equal(t, feeRate, gotFeeRate, "fee rates don't match")
// Make sure we have stored the batch.
batches, err := batcherStore.FetchUnconfirmedSweepBatches(ctx)
require.NoError(t, err)
require.Len(t, batches, 1)
// Now make the batcher quit by canceling the context.
cancel()
wg.Wait()
// Make sure the batcher exited without an error.
checkBatcherError(t, runErr)
}
// testWithMixedBatchLarge tests mixed batches construction, many sweeps.
// All sweeps are added at once.
func testWithMixedBatchLarge(t *testing.T, store testStore,
batcherStore testBatcherStore) {
// Create 9 sweeps. 3 groups of 3 sweeps.
// 1. known in advance to be non-cooperative,
// 2. fails cosigning during an attempt,
// 3. co-signs successfully.
var preimages = []lntypes.Preimage{
{1}, {2}, {3},
{4}, {5}, {6},
{7}, {8}, {9},
}
// Create muSig2SignSweep. It fails all the sweeps, works only one time
// for swapHashes[2] and works any number of times for 5 and 8. This
// emulates client disconnect after first successful co-signing.
swapHash2Used := false
muSig2SignSweep := func(ctx context.Context,
protocolVersion loopdb.ProtocolVersion, swapHash lntypes.Hash,
paymentAddr [32]byte, nonce []byte, sweepTxPsbt []byte,
prevoutMap map[wire.OutPoint]*wire.TxOut) (
[]byte, []byte, error) {
switch {
case swapHash == preimages[2].Hash():
if swapHash2Used {
return nil, nil, fmt.Errorf("disconnected")
} else {
swapHash2Used = true
return testMuSig2SigningData()
}
case swapHash == preimages[5].Hash():
return testMuSig2SigningData()
case swapHash == preimages[8].Hash():
return testMuSig2SigningData()
default:
return nil, nil, fmt.Errorf("test error")
}
}
// The first sweep in a group is known in advance to be
// non-cooperative.
nonCoopHints := []bool{
true, false, false,
true, false, false,
true, false, false,
}
// Expect mockSigner.SignOutputRaw call to sign non-cooperative
// sweeps.
expectSignOutputRawChannel := true
// Two non-cooperative sweeps, one cooperative.
wantWitnessSizes := []int{4, 4, 4, 4, 4, 1, 4, 4, 1}
// Expected weight.
wantWeight := lntypes.WeightUnit(3377)
testWithMixedBatchCustom(t, store, batcherStore, preimages,
muSig2SignSweep, nonCoopHints, expectSignOutputRawChannel,
wantWeight, wantWitnessSizes)
}
// testWithMixedBatchCoopOnly tests mixed batches construction,
// All sweeps are added at once. All the sweeps are cooperative.
func testWithMixedBatchCoopOnly(t *testing.T, store testStore,
batcherStore testBatcherStore) {
// Create 3 sweeps, all cooperative.
var preimages = []lntypes.Preimage{
{1}, {2}, {3},
}
// Create muSig2SignSweep, working for all sweeps.
muSig2SignSweep := func(ctx context.Context,
protocolVersion loopdb.ProtocolVersion, swapHash lntypes.Hash,
paymentAddr [32]byte, nonce []byte, sweepTxPsbt []byte,
prevoutMap map[wire.OutPoint]*wire.TxOut) (
[]byte, []byte, error) {
return testMuSig2SigningData()
}
// All the sweeps are cooperative.
nonCoopHints := []bool{false, false, false}
// Do not expect a mockSigner.SignOutputRaw call, because there are no
// non-cooperative sweeps.
expectSignOutputRawChannel := false
// Two non-cooperative sweeps, one cooperative.
wantWitnessSizes := []int{1, 1, 1}
// Expected weight.
wantWeight := lntypes.WeightUnit(856)
testWithMixedBatchCustom(t, store, batcherStore, preimages,
muSig2SignSweep, nonCoopHints, expectSignOutputRawChannel,
wantWeight, wantWitnessSizes)
}
// testWithMixedBatchNonCoopHintOnly tests mixed batches construction,
// All sweeps are added at once. All the sweeps are known to be non-cooperative
// in advance.
func testWithMixedBatchNonCoopHintOnly(t *testing.T, store testStore,
batcherStore testBatcherStore) {
// Create 3 sweeps, all known to be non-cooperative in advance.
var preimages = []lntypes.Preimage{
{1}, {2}, {3},
}
// Create muSig2SignSweep, panicking for all sweeps.
muSig2SignSweep := func(ctx context.Context,
protocolVersion loopdb.ProtocolVersion, swapHash lntypes.Hash,
paymentAddr [32]byte, nonce []byte, sweepTxPsbt []byte,
prevoutMap map[wire.OutPoint]*wire.TxOut) (
[]byte, []byte, error) {
panic("must not be called in this test")
}
// All the sweeps are non-cooperative, this is known in advance.
nonCoopHints := []bool{true, true, true}
// Expect mockSigner.SignOutputRaw call to sign non-cooperative
// sweeps.
expectSignOutputRawChannel := true
// Two non-cooperative sweeps, one cooperative.
wantWitnessSizes := []int{4, 4, 4}
// Expected weight.
wantWeight := lntypes.WeightUnit(1345)
testWithMixedBatchCustom(t, store, batcherStore, preimages,
muSig2SignSweep, nonCoopHints, expectSignOutputRawChannel,
wantWeight, wantWitnessSizes)
}
// testWithMixedBatchCoopFailedOnly tests mixed batches construction,
// All sweeps are added at once. All the sweeps fail co-signing.
func testWithMixedBatchCoopFailedOnly(t *testing.T, store testStore,
batcherStore testBatcherStore) {
// Create 3 sweeps, all fail co-signing.
var preimages = []lntypes.Preimage{
{1}, {2}, {3},
}
// Create muSig2SignSweep, failing any co-sign attempt.
muSig2SignSweep := func(ctx context.Context,
protocolVersion loopdb.ProtocolVersion, swapHash lntypes.Hash,
paymentAddr [32]byte, nonce []byte, sweepTxPsbt []byte,
prevoutMap map[wire.OutPoint]*wire.TxOut) (
[]byte, []byte, error) {
return nil, nil, fmt.Errorf("test error")
}
// All the sweeps are non-cooperative, but this is not known in advance.
nonCoopHints := []bool{false, false, false}
// Expect mockSigner.SignOutputRaw call to sign non-cooperative
// sweeps.
expectSignOutputRawChannel := true
// Two non-cooperative sweeps, one cooperative.
wantWitnessSizes := []int{4, 4, 4}
// Expected weight.
wantWeight := lntypes.WeightUnit(1345)
testWithMixedBatchCustom(t, store, batcherStore, preimages,
muSig2SignSweep, nonCoopHints, expectSignOutputRawChannel,
wantWeight, wantWitnessSizes)
}
// testFeeRateGrows tests that fee rate of a batch does not decrease and is at
// least as high as the highest fee rate of sweeps.
func testFeeRateGrows(t *testing.T, store testStore,
batcherStore testBatcherStore) {
defer test.Guard(t)()
lnd := test.NewMockLnd()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
require.NoError(t, err)
// Create a map to store fee rates.
swap2feeRate := map[lntypes.Hash]chainfee.SatPerKWeight{}
var swap2feeRateMu sync.Mutex
setFeeRate := func(swapHash lntypes.Hash, rate chainfee.SatPerKWeight) {
swap2feeRateMu.Lock()
defer swap2feeRateMu.Unlock()
swap2feeRate[swapHash] = rate
}
customFeeRate := func(_ context.Context, swapHash lntypes.Hash,
_ wire.OutPoint) (chainfee.SatPerKWeight, error) {
swap2feeRateMu.Lock()
defer swap2feeRateMu.Unlock()
return swap2feeRate[swapHash], nil
}
const (
feeRateLow = chainfee.SatPerKWeight(10_000)
feeRateMedium = chainfee.SatPerKWeight(30_000)
feeRateHigh = chainfee.SatPerKWeight(50_000)
)
batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
batcherStore, sweepStore, WithCustomFeeRate(customFeeRate))
go func() {
err := batcher.Run(ctx)
checkBatcherError(t, err)
}()
// Create the first sweep.
swapHash1 := lntypes.Hash{1, 1, 1}
setFeeRate(swapHash1, feeRateMedium)
sweepReq1 := SweepRequest{
SwapHash: swapHash1,
Inputs: []Input{{
Value: 1_000_000,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{1, 1},
Index: 1,
},
}},
Notifier: &dummyNotifier,
}
swap1 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1_000_000,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{1},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, swapHash1, swap1)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Since a batch was created we check that it registered for its primary
// sweep's spend.
<-lnd.RegisterSpendChannel
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Make sure the fee rate is feeRateMedium.
batch := getOnlyBatch(t, ctx, batcher)
snapshot := batch.snapshot(ctx)
require.Len(t, snapshot.sweeps, 1)
require.Equal(t, feeRateMedium, snapshot.rbfCache.FeeRate)
// Now decrease the fee of sweep1.
setFeeRate(swapHash1, feeRateLow)
require.NoError(t, batcher.AddSweep(ctx, &sweepReq1))
// Tick tock next block.
err = lnd.NotifyHeight(601)
require.NoError(t, err)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Make sure the fee rate is still feeRateMedium.
snapshot = batch.snapshot(ctx)
require.Equal(t, feeRateMedium, snapshot.rbfCache.FeeRate)
// Add sweep2, with feeRateMedium.
swapHash2 := lntypes.Hash{2, 2, 2}
setFeeRate(swapHash2, feeRateMedium)
sweepReq2 := SweepRequest{
SwapHash: swapHash2,
Inputs: []Input{{
Value: 1_000_000,
Outpoint: wire.OutPoint{
Hash: chainhash.Hash{2, 2},
Index: 1,
},
}},
Notifier: &dummyNotifier,
}
swap2 := &loopdb.LoopOutContract{
SwapContract: loopdb.SwapContract{
CltvExpiry: 111,
AmountRequested: 1_000_000,
ProtocolVersion: loopdb.ProtocolVersionMuSig2,
HtlcKeys: htlcKeys,
// Make preimage unique to pass SQL constraints.
Preimage: lntypes.Preimage{2},
},
DestAddr: destAddr,
SwapInvoice: swapInvoice,
SweepConfTarget: 111,
}
err = store.CreateLoopOut(ctx, swapHash2, swap2)
require.NoError(t, err)
store.AssertLoopOutStored()
// Deliver sweep request to batcher.
require.NoError(t, batcher.AddSweep(ctx, &sweepReq2))
// Tick tock next block.
err = lnd.NotifyHeight(602)
require.NoError(t, err)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Make sure the fee rate is still feeRateMedium.
snapshot = batch.snapshot(ctx)
require.Len(t, snapshot.sweeps, 2)
require.Equal(t, feeRateMedium, snapshot.rbfCache.FeeRate)
// Now update fee rate of second sweep (which is not primary) to
// feeRateHigh. Fee rate of sweep 1 is still feeRateLow.
setFeeRate(swapHash2, feeRateHigh)
// Tick tock next block.
err = lnd.NotifyHeight(603)
require.NoError(t, err)
// Wait for tx to be published.
<-lnd.TxPublishChannel
// Make sure the fee rate increased to feeRateHigh.
snapshot = batch.snapshot(ctx)
require.Equal(t, feeRateHigh, snapshot.rbfCache.FeeRate)
}
// TestSweepBatcherBatchCreation tests that sweep requests enter the expected
// batch based on their timeout distance.
func TestSweepBatcherBatchCreation(t *testing.T) {
runTests(t, testSweepBatcherBatchCreation)
}
// TestFeeBumping tests that sweep is RBFed with slightly higher fee rate after
// each block unless WithCustomFeeRate is passed.
func TestFeeBumping(t *testing.T) {
t.Run("regular", func(t *testing.T) {
runTests(t, func(t *testing.T, store testStore,
batcherStore testBatcherStore) {
testFeeBumping(t, store, batcherStore, false)
})
})
t.Run("fixed fee rate", func(t *testing.T) {
runTests(t, func(t *testing.T, store testStore,
batcherStore testBatcherStore) {
testFeeBumping(t, store, batcherStore, true)
})
})
}
// TestTxLabeler tests transaction labels.
func TestTxLabeler(t *testing.T) {
runTests(t, testTxLabeler)
}
// TestPublishErrorHandler tests transaction labels.
func TestPublishErrorHandler(t *testing.T) {
runTests(t, testPublishErrorHandler)
}
// TestSweepBatcherSimpleLifecycle tests the simple lifecycle of the batches
// that are created and run by the batcher.
func TestSweepBatcherSimpleLifecycle(t *testing.T) {
runTests(t, testSweepBatcherSimpleLifecycle)
}
// TestSweepBatcherSkippedTxns tests that option WithSkippedTxns
// works as expected.
func TestSweepBatcherSkippedTxns(t *testing.T) {
runTests(t, testSweepBatcherSkippedTxns)
}
// TestDelays tests that WithInitialDelay and WithPublishDelay work.
func TestDelays(t *testing.T) {
runTests(t, testDelays)
}
// TestCustomDelays tests per-sweep customization in WithInitialDelay.
func TestCustomDelays(t *testing.T) {
runTests(t, testCustomDelays)
}
// TestMaxSweepsPerBatch tests the limit on max number of sweeps per batch.
func TestMaxSweepsPerBatch(t *testing.T) {
runTests(t, testMaxSweepsPerBatch)
}
// TestSweepBatcherSweepReentry tests that when an old version of the batch tx
// gets confirmed the sweep leftovers are sent back to the batcher.
func TestSweepBatcherSweepReentry(t *testing.T) {
runTests(t, testSweepBatcherSweepReentry)
}
// TestSweepBatcherGroup tests adding a group of UTXOs with the same swap hash
// to the batcher.
func TestSweepBatcherGroup(t *testing.T) {
runTests(t, testSweepBatcherGroup)
}
// TestSweepBatcherNonWalletAddr tests that sweep requests that sweep to a non
// wallet address enter individual batches.
func TestSweepBatcherNonWalletAddr(t *testing.T) {
runTests(t, testSweepBatcherNonWalletAddr)
}
// TestSweepBatcherComposite tests that sweep requests that sweep to both wallet
// addresses and non-wallet addresses enter the correct batches.
func TestSweepBatcherComposite(t *testing.T) {
runTests(t, testSweepBatcherComposite)
}
// TestGetFeePortionForSweep tests that the fee portion for a sweep is correctly
// calculated.
func TestGetFeePortionForSweep(t *testing.T) {
runTests(t, testGetFeePortionForSweep)
}
// TestRestoringEmptyBatch tests that the batcher can be restored with an empty
// batch.
func TestRestoringEmptyBatch(t *testing.T) {
runTests(t, testRestoringEmptyBatch)
}
// TestHandleSweepTwice tests that handing the same sweep twice must not
// add it to different batches.
func TestHandleSweepTwice(t *testing.T) {
runTests(t, testHandleSweepTwice)
}
// TestRestoringPreservesConfTarget tests that after the batch is written to DB
// and loaded back, its batchConfTarget value is preserved.
func TestRestoringPreservesConfTarget(t *testing.T) {
runTests(t, testRestoringPreservesConfTarget)
}
// TestSweepFetcher tests providing custom sweep fetcher to Batcher.
func TestSweepFetcher(t *testing.T) {
runTests(t, testSweepFetcher)
}
// TestSweepBatcherCloseDuringAdding tests that sweep batcher works correctly
// if it is closed (stops running) during AddSweep call.
func TestSweepBatcherCloseDuringAdding(t *testing.T) {
runTests(t, testSweepBatcherCloseDuringAdding)
}
// TestSweepBatcherHandleSweepRace ensures we reproduce the data race where a
// sweep is re-added while the original batch is confirming.
func TestSweepBatcherHandleSweepRace(t *testing.T) {
runTests(t, testSweepBatcherHandleSweepRace)
}
// TestSweepBatcherHandleBatchShutdown covers the regression where a sweep that
// finishes while being re-added must not surface ErrBatcherShuttingDown.
func TestSweepBatcherHandleBatchShutdown(t *testing.T) {
runTests(t, testSweepBatcherHandleBatchShutdown)
}
// TestCustomSignMuSig2 tests the operation with custom musig2 signer.
func TestCustomSignMuSig2(t *testing.T) {
runTests(t, testCustomSignMuSig2)
}
// TestWithMixedBatch tests mixed batches construction. It also tests
// non-cooperative sweeping (using a preimage). Sweeps are added one by one.
func TestWithMixedBatch(t *testing.T) {
runTests(t, testWithMixedBatch)
}
// TestWithMixedBatchLarge tests mixed batches construction, many sweeps.
// All sweeps are added at once.
func TestWithMixedBatchLarge(t *testing.T) {
runTests(t, testWithMixedBatchLarge)
}
// TestWithMixedBatchCoopOnly tests mixed batches construction,
// All sweeps are added at once. All the sweeps are cooperative.
func TestWithMixedBatchCoopOnly(t *testing.T) {
runTests(t, testWithMixedBatchCoopOnly)
}
// TestWithMixedBatchNonCoopHintOnly tests mixed batches construction,
// All sweeps are added at once. All the sweeps are known to be non-cooperative
// in advance.
func TestWithMixedBatchNonCoopHintOnly(t *testing.T) {
runTests(t, testWithMixedBatchNonCoopHintOnly)
}
// TestWithMixedBatchCoopFailedOnly tests mixed batches construction,
// All sweeps are added at once. All the sweeps fail co-signing.
func TestWithMixedBatchCoopFailedOnly(t *testing.T) {
runTests(t, testWithMixedBatchCoopFailedOnly)
}
// TestFeeRateGrows tests that fee rate of a batch does not decrease and is at
// least as high as the highest fee rate of sweeps.
func TestFeeRateGrows(t *testing.T) {
runTests(t, testFeeRateGrows)
}
// testBatcherStore is BatcherStore used in tests.
type testBatcherStore interface {
BatcherStore
// AssertSweepStored asserts that a sweep is stored.
AssertSweepStored(outpoint wire.OutPoint) bool
}
type loopdbBatcherStore struct {
BatcherStore
sweepsSet map[wire.OutPoint]struct{}
mu sync.Mutex
}
// UpsertSweep inserts a sweep into the database, or updates an existing sweep
// if it already exists. This wrapper was added to update sweepsSet.
func (s *loopdbBatcherStore) UpsertSweep(ctx context.Context,
sweep *dbSweep) error {
s.mu.Lock()
defer s.mu.Unlock()
err := s.BatcherStore.UpsertSweep(ctx, sweep)
if err == nil {
s.sweepsSet[sweep.Outpoint] = struct{}{}
}
return err
}
// AssertSweepStored asserts that a sweep is stored.
func (s *loopdbBatcherStore) AssertSweepStored(outpoint wire.OutPoint) bool {
s.mu.Lock()
defer s.mu.Unlock()
_, has := s.sweepsSet[outpoint]
return has
}
// testStore is loopdb used in tests.
type testStore interface {
loopdb.SwapStore
// AssertLoopOutStored asserts that a swap is stored.
AssertLoopOutStored()
}
// loopdbStore wraps loopdb.SwapStore and implements testStore interface.
type loopdbStore struct {
loopdb.SwapStore
t *testing.T
loopOutStoreChan chan struct{}
}
// newLoopdbStore creates new loopdbStore instance.
func newLoopdbStore(t *testing.T, swapStore loopdb.SwapStore) *loopdbStore {
return &loopdbStore{
SwapStore: swapStore,
t: t,
loopOutStoreChan: make(chan struct{}, 1),
}
}
// CreateLoopOut adds an initiated swap to the store.
func (s *loopdbStore) CreateLoopOut(ctx context.Context, hash lntypes.Hash,
swap *loopdb.LoopOutContract) error {
err := s.SwapStore.CreateLoopOut(ctx, hash, swap)
if err == nil {
s.loopOutStoreChan <- struct{}{}
}
return err
}
// AssertLoopOutStored asserts that a swap is stored.
func (s *loopdbStore) AssertLoopOutStored() {
s.t.Helper()
select {
case <-s.loopOutStoreChan:
case <-time.After(test.Timeout):
s.t.Fatalf("expected swap to be stored")
}
}
// runTests runs a test with both mock and loopdb.
func runTests(t *testing.T, testFn func(t *testing.T, store testStore,
batcherStore testBatcherStore)) {
logger := btclog.NewSLogger(btclog.NewDefaultHandler(os.Stdout))
2024-06-25 01:10:12 -03:00
logger.SetLevel(btclog.LevelTrace)
UseLogger(logger.SubSystem("SWEEP"))
2024-06-25 01:10:12 -03:00
t.Run("mocks", func(t *testing.T) {
store := loopdb.NewStoreMock(t)
batcherStore := NewStoreMock()
testFn(t, store, batcherStore)
})
t.Run("loopdb", func(t *testing.T) {
sqlDB := loopdb.NewTestDB(t)
typedSqlDB := loopdb.NewTypedStore[Querier](sqlDB)
lnd := test.NewMockLnd()
batcherStore := NewSQLStore(typedSqlDB, lnd.ChainParams)
testStore := newLoopdbStore(t, sqlDB)
testBatcherStore := &loopdbBatcherStore{
BatcherStore: batcherStore,
sweepsSet: make(map[wire.OutPoint]struct{}),
}
testFn(t, testStore, testBatcherStore)
})
}