Files
lnd/itest/lnd_coop_close_rbf_test.go
T
Olaoluwa Osuntokun bb781bbe84 itest: add new coop close rbf itest
This ensures that during the RBF process, if one confirms, a re-org
occurs, then another confirms, that we'll properly detect this case.
2026-01-15 16:22:26 -08:00

330 lines
11 KiB
Go

package itest
import (
"fmt"
"github.com/btcsuite/btcd/btcutil"
"github.com/btcsuite/btcd/chaincfg/chainhash"
"github.com/lightningnetwork/lnd/lnrpc"
"github.com/lightningnetwork/lnd/lntest"
"github.com/lightningnetwork/lnd/lntest/wait"
"github.com/lightningnetwork/lnd/lnwallet/chainfee"
"github.com/stretchr/testify/require"
)
func testCoopCloseRbf(ht *lntest.HarnessTest) {
rbfCoopFlags := []string{"--protocol.rbf-coop-close"}
// Set the fee estimate to 1sat/vbyte. This ensures that our manually
// initiated RBF attempts will always be successful.
ht.SetFeeEstimate(250)
ht.SetFeeEstimateWithConf(250, 6)
// To kick things off, we'll create two new nodes, then fund them with
// enough coins to make a 50/50 channel.
cfgs := [][]string{rbfCoopFlags, rbfCoopFlags}
params := lntest.OpenChannelParams{
Amt: btcutil.Amount(1000000),
PushAmt: btcutil.Amount(1000000 / 2),
}
chanPoints, nodes := ht.CreateSimpleNetwork(cfgs, params)
alice, bob := nodes[0], nodes[1]
chanPoint := chanPoints[0]
// Now that both sides are active with a funded channel, we can kick
// off the test.
//
// To start, we'll have Alice try to close the channel, with a fee rate
// of 5 sat/byte.
aliceFeeRate := chainfee.SatPerVByte(5)
aliceCloseStream, aliceCloseUpdate := ht.CloseChannelAssertPending(
alice, chanPoint, false,
lntest.WithCoopCloseFeeRate(aliceFeeRate),
lntest.WithLocalTxNotify(),
)
// Confirm that this new update was at 5 sat/vb.
alicePendingUpdate := aliceCloseUpdate.GetClosePending()
require.NotNil(ht, aliceCloseUpdate)
require.Equal(
ht, int64(aliceFeeRate), alicePendingUpdate.FeePerVbyte,
)
require.True(ht, alicePendingUpdate.LocalCloseTx)
// Now, we'll have Bob attempt to RBF the close transaction with a
// higher fee rate, double that of Alice's.
bobFeeRate := aliceFeeRate * 2
bobCloseStream, bobCloseUpdate := ht.CloseChannelAssertPending(
bob, chanPoint, false, lntest.WithCoopCloseFeeRate(bobFeeRate),
lntest.WithLocalTxNotify(),
)
// Confirm that this new update was at 10 sat/vb.
bobPendingUpdate := bobCloseUpdate.GetClosePending()
require.NotNil(ht, bobCloseUpdate)
require.Equal(ht, bobPendingUpdate.FeePerVbyte, int64(bobFeeRate))
require.True(ht, bobPendingUpdate.LocalCloseTx)
var err error
// Alice should've also received a similar update that Bob has
// increased the closing fee rate to 10 sat/vb with his settled funds.
aliceCloseUpdate, err = ht.ReceiveCloseChannelUpdate(aliceCloseStream)
require.NoError(ht, err)
alicePendingUpdate = aliceCloseUpdate.GetClosePending()
require.NotNil(ht, aliceCloseUpdate)
require.Equal(ht, alicePendingUpdate.FeePerVbyte, int64(bobFeeRate))
require.False(ht, alicePendingUpdate.LocalCloseTx)
// We'll now attempt to make a fee update that increases Alice's fee
// rate by 6 sat/vb, which should be rejected as it is too small of an
// increase for the RBF rules. The RPC API however will return the new
// fee. We'll skip the mempool check here as it won't make it in.
aliceRejectedFeeRate := aliceFeeRate + 1
_, aliceCloseUpdate = ht.CloseChannelAssertPending(
alice, chanPoint, false,
lntest.WithCoopCloseFeeRate(aliceRejectedFeeRate),
lntest.WithLocalTxNotify(), lntest.WithSkipMempoolCheck(),
)
alicePendingUpdate = aliceCloseUpdate.GetClosePending()
require.NotNil(ht, aliceCloseUpdate)
require.Equal(
ht, alicePendingUpdate.FeePerVbyte,
int64(aliceRejectedFeeRate),
)
require.True(ht, alicePendingUpdate.LocalCloseTx)
_, err = ht.ReceiveCloseChannelUpdate(bobCloseStream)
require.NoError(ht, err)
// We'll now attempt a fee update that we can't actually pay for. This
// will actually show up as an error to the remote party.
aliceRejectedFeeRate = 100_000
_, _ = ht.CloseChannelAssertPending(
alice, chanPoint, false,
lntest.WithCoopCloseFeeRate(aliceRejectedFeeRate),
lntest.WithLocalTxNotify(),
lntest.WithExpectedErrString("cannot pay for fee"),
)
// At this point, we'll have Alice+Bob reconnect so we can ensure that
// we can continue to do RBF bumps even after a reconnection.
ht.DisconnectNodes(alice, bob)
ht.ConnectNodes(alice, bob)
// Next, we'll have Alice double that fee rate again to 20 sat/vb.
aliceFeeRate = bobFeeRate * 2
aliceCloseStream, aliceCloseUpdate = ht.CloseChannelAssertPending(
alice, chanPoint, false,
lntest.WithCoopCloseFeeRate(aliceFeeRate),
lntest.WithLocalTxNotify(),
)
alicePendingUpdate = aliceCloseUpdate.GetClosePending()
require.NotNil(ht, aliceCloseUpdate)
require.Equal(
ht, alicePendingUpdate.FeePerVbyte, int64(aliceFeeRate),
)
require.True(ht, alicePendingUpdate.LocalCloseTx)
// To conclude, we'll mine a block which should now confirm Alice's
// version of the coop close transaction.
block := ht.MineBlocksAndAssertNumTxes(1, 1)[0]
// Both Alice and Bob should trigger a final close update to signal the
// closing transaction has confirmed.
aliceClosingTxid := ht.WaitForChannelCloseEvent(aliceCloseStream)
ht.AssertTxInBlock(block, aliceClosingTxid)
}
// testRBFCoopCloseDisconnect tests that when a node disconnects that the node
// is properly disconnected.
func testRBFCoopCloseDisconnect(ht *lntest.HarnessTest) {
rbfCoopFlags := []string{"--protocol.rbf-coop-close"}
// To kick things off, we'll create two new nodes, then fund them with
// enough coins to make a 50/50 channel.
cfgs := [][]string{rbfCoopFlags, rbfCoopFlags}
params := lntest.OpenChannelParams{
Amt: btcutil.Amount(1000000),
PushAmt: btcutil.Amount(1000000 / 2),
}
_, nodes := ht.CreateSimpleNetwork(cfgs, params)
alice, bob := nodes[0], nodes[1]
// Make sure the nodes are connected.
ht.AssertConnected(alice, bob)
// Disconnect Bob from Alice.
ht.DisconnectNodes(alice, bob)
}
// testCoopCloseRBFWithReorg tests that when a cooperative close transaction
// is reorganized out during confirmation waiting, the system properly handles
// RBF replacements and re-registration for any spend of the funding output.
func testCoopCloseRBFWithReorg(ht *lntest.HarnessTest) {
// Skip this test for neutrino backend as we can't trigger reorgs.
if ht.IsNeutrinoBackend() {
ht.Skipf("skipping reorg test for neutrino backend")
}
// Force cooperative close to require 3 confirmations for predictable
// testing.
const requiredConfs = 3
rbfCoopFlags := []string{
"--protocol.rbf-coop-close",
"--dev.force-channel-close-confs=3",
}
// Set the fee estimate to 1sat/vbyte to ensure our RBF attempts work.
ht.SetFeeEstimate(250)
ht.SetFeeEstimateWithConf(250, 6)
// Create two nodes with enough coins for a 50/50 channel.
cfgs := [][]string{rbfCoopFlags, rbfCoopFlags}
params := lntest.OpenChannelParams{
Amt: btcutil.Amount(10_000_000),
PushAmt: btcutil.Amount(5_000_000),
}
chanPoints, nodes := ht.CreateSimpleNetwork(cfgs, params)
alice, bob := nodes[0], nodes[1]
chanPoint := chanPoints[0]
// Initiate cooperative close with initial fee rate of 5 sat/vb.
initialFeeRate := chainfee.SatPerVByte(5)
_, aliceCloseUpdate := ht.CloseChannelAssertPending(
alice, chanPoint, false,
lntest.WithCoopCloseFeeRate(initialFeeRate),
lntest.WithLocalTxNotify(),
)
// Verify the initial close transaction is at the expected fee rate.
alicePendingUpdate := aliceCloseUpdate.GetClosePending()
require.NotNil(ht, aliceCloseUpdate)
require.Equal(
ht, int64(initialFeeRate), alicePendingUpdate.FeePerVbyte,
)
// Capture the initial close transaction from the mempool.
initialCloseTxid, err := chainhash.NewHash(alicePendingUpdate.Txid)
require.NoError(ht, err)
initialCloseTx := ht.AssertTxInMempool(*initialCloseTxid)
// Create first RBF replacement before any mining.
firstRbfFeeRate := chainfee.SatPerVByte(10)
_, firstRbfUpdate := ht.CloseChannelAssertPending(
bob, chanPoint, false,
lntest.WithCoopCloseFeeRate(firstRbfFeeRate),
lntest.WithLocalTxNotify(),
)
// Capture the first RBF transaction.
closePending := firstRbfUpdate.GetClosePending()
firstRbfTxid, err := chainhash.NewHash(closePending.Txid)
require.NoError(ht, err)
firstRbfTx := ht.AssertTxInMempool(*firstRbfTxid)
_, bestHeight := ht.GetBestBlock()
ht.Logf("Current block height: %d", bestHeight)
// Mine n-1 blocks (2 blocks when requiring 3 confirmations) with the
// first RBF transaction. This is just shy of full confirmation.
block1 := ht.Miner().MineBlockWithTxes(
[]*btcutil.Tx{btcutil.NewTx(firstRbfTx)},
)
ht.Logf("Mined block %d with first RBF tx", bestHeight+1)
block2 := ht.MineEmptyBlocks(1)[0]
ht.Logf("Mined block %d", bestHeight+2)
ht.Logf("Re-orging two blocks to remove first RBF tx")
// Trigger a reorganization that removes the last 2 blocks. This is safe
// because we haven't reached full confirmation yet.
bestBlockHash := block2.Header.BlockHash()
require.NoError(
ht, ht.Miner().Client.InvalidateBlock(&bestBlockHash),
)
bestBlockHash = block1.Header.BlockHash()
require.NoError(
ht, ht.Miner().Client.InvalidateBlock(&bestBlockHash),
)
_, bestHeight = ht.GetBestBlock()
ht.Logf("Re-orged to block height: %d", bestHeight)
ht.Log("Mining blocks to surpass previous chain")
// Mine 2 empty blocks to trigger the reorg on the nodes.
ht.MineEmptyBlocks(2)
_, bestHeight = ht.GetBestBlock()
ht.Logf("Mined blocks to reach height: %d", bestHeight)
// Now, instead of mining the second RBF, mine the INITIAL transaction
// to test that the system can handle any valid spend of the funding
// output.
block := ht.Miner().MineBlockWithTxes(
[]*btcutil.Tx{btcutil.NewTx(initialCloseTx)},
)
ht.AssertTxInBlock(block, *initialCloseTxid)
// Mine additional blocks to reach the required confirmations (3 total).
ht.MineEmptyBlocks(requiredConfs - 1)
// Both parties should see that the channel is now fully closed on chain
// with the expected closing txid.
expectedClosingTxid := initialCloseTxid.String()
err = wait.NoError(func() error {
req := &lnrpc.ClosedChannelsRequest{}
aliceClosedChans := alice.RPC.ClosedChannels(req)
bobClosedChans := bob.RPC.ClosedChannels(req)
if len(aliceClosedChans.Channels) != 1 {
return fmt.Errorf("alice: expected 1 closed "+
"chan, got %d", len(aliceClosedChans.Channels))
}
if len(bobClosedChans.Channels) != 1 {
return fmt.Errorf("bob: expected 1 closed chan, got %d",
len(bobClosedChans.Channels))
}
// Verify both Alice and Bob have the expected closing txid.
aliceClosedChan := aliceClosedChans.Channels[0]
if aliceClosedChan.ClosingTxHash != expectedClosingTxid {
return fmt.Errorf("alice: expected closing txid %s, "+
"got %s",
expectedClosingTxid,
aliceClosedChan.ClosingTxHash)
}
if aliceClosedChan.CloseType !=
lnrpc.ChannelCloseSummary_COOPERATIVE_CLOSE {
return fmt.Errorf("alice: expected cooperative "+
"close, got %v",
aliceClosedChan.CloseType)
}
bobClosedChan := bobClosedChans.Channels[0]
if bobClosedChan.ClosingTxHash != expectedClosingTxid {
return fmt.Errorf("bob: expected closing txid %s, "+
"got %s",
expectedClosingTxid,
bobClosedChan.ClosingTxHash)
}
if bobClosedChan.CloseType !=
lnrpc.ChannelCloseSummary_COOPERATIVE_CLOSE {
return fmt.Errorf("bob: expected cooperative "+
"close, got %v",
bobClosedChan.CloseType)
}
return nil
}, defaultTimeout)
require.NoError(ht, err)
ht.Logf("Successfully verified closing txid: %s", expectedClosingTxid)
}