diff --git a/itest/lnd_open_channel_test.go b/itest/lnd_open_channel_test.go index 29946e4cc..12b13a14f 100644 --- a/itest/lnd_open_channel_test.go +++ b/itest/lnd_open_channel_test.go @@ -5,17 +5,14 @@ import ( "strings" "testing" - "github.com/btcsuite/btcd/btcjson" "github.com/btcsuite/btcd/btcutil" "github.com/btcsuite/btcd/chaincfg/chainhash" - "github.com/btcsuite/btcd/integration/rpctest" "github.com/lightningnetwork/lnd/chainreg" "github.com/lightningnetwork/lnd/funding" "github.com/lightningnetwork/lnd/lnrpc" "github.com/lightningnetwork/lnd/lntest" "github.com/lightningnetwork/lnd/lntest/node" "github.com/lightningnetwork/lnd/lntest/rpc" - "github.com/lightningnetwork/lnd/lntest/wait" "github.com/stretchr/testify/require" ) @@ -30,44 +27,12 @@ func testOpenChannelAfterReorg(ht *lntest.HarnessTest) { ht.Skipf("skipping reorg test for neutrino backend") } - temp := "temp" - - // Set up a new miner that we can use to cause a reorg. - tempLogDir := ".tempminerlogs" - logFilename := "output-open_channel_reorg-temp_miner.log" - tempMiner := lntest.NewTempMiner( - ht.Context(), ht.T, tempLogDir, logFilename, - ) - defer tempMiner.Stop() - - // Setup the temp miner - require.NoError(ht, tempMiner.SetUp(false, 0), - "unable to set up mining node") + // Create a temp miner. + tempMiner := ht.Miner.SpawnTempMiner() miner := ht.Miner alice, bob := ht.Alice, ht.Bob - // We start by connecting the new miner to our original miner, - // such that it will sync to our original chain. - err := miner.Client.Node( - btcjson.NConnect, tempMiner.P2PAddress(), &temp, - ) - require.NoError(ht, err, "unable to connect miners") - - nodeSlice := []*rpctest.Harness{miner.Harness, tempMiner.Harness} - err = rpctest.JoinNodes(nodeSlice, rpctest.Blocks) - require.NoError(ht, err, "unable to join node on blocks") - - // The two miners should be on the same blockheight. - assertMinerBlockHeightDelta(ht, miner, tempMiner, 0) - - // We disconnect the two miners, such that we can mine two different - // chains and can cause a reorg later. - err = miner.Client.Node( - btcjson.NDisconnect, tempMiner.P2PAddress(), &temp, - ) - require.NoError(ht, err, "unable to disconnect miners") - // Create a new channel that requires 1 confs before it's considered // open, then broadcast the funding transaction params := lntest.OpenChannelParams{ @@ -98,7 +63,7 @@ func testOpenChannelAfterReorg(ht *lntest.HarnessTest) { // Ensure the chain lengths are what we expect, with the temp miner // being 5 blocks ahead. - assertMinerBlockHeightDelta(ht, miner, tempMiner, 5) + miner.AssertMinerBlockHeightDelta(tempMiner, 5) chanPoint := &lnrpc.ChannelPoint{ FundingTxid: &lnrpc.ChannelPoint_FundingTxidBytes{ @@ -125,22 +90,14 @@ func testOpenChannelAfterReorg(ht *lntest.HarnessTest) { // Connecting to the temporary miner should now cause our original // chain to be re-orged out. - err = miner.Client.Node(btcjson.NConnect, tempMiner.P2PAddress(), &temp) - require.NoError(ht, err, "unable to connect temp miner") - - nodes := []*rpctest.Harness{tempMiner.Harness, miner.Harness} - err = rpctest.JoinNodes(nodes, rpctest.Blocks) - require.NoError(ht, err, "unable to join node on blocks") + miner.ConnectMiner(tempMiner) // Once again they should be on the same chain. - assertMinerBlockHeightDelta(ht, miner, tempMiner, 0) + miner.AssertMinerBlockHeightDelta(tempMiner, 0) // Now we disconnect the two miners, and connect our original miner to // our chain backend once again. - err = miner.Client.Node( - btcjson.NDisconnect, tempMiner.P2PAddress(), &temp, - ) - require.NoError(ht, err, "unable to disconnect temp miner") + miner.DisconnectMiner(tempMiner) ht.ConnectMiner() @@ -531,36 +488,6 @@ func runBasicChannelCreationAndUpdates(ht *lntest.HarnessTest, ) } -// assertMinerBlockHeightDelta ensures that tempMiner is 'delta' blocks ahead -// of miner. -func assertMinerBlockHeightDelta(ht *lntest.HarnessTest, - miner, tempMiner *lntest.HarnessMiner, delta int32) { - - // Ensure the chain lengths are what we expect. - err := wait.NoError(func() error { - _, tempMinerHeight, err := tempMiner.Client.GetBestBlock() - if err != nil { - return fmt.Errorf("unable to get current "+ - "blockheight %v", err) - } - - _, minerHeight, err := miner.Client.GetBestBlock() - if err != nil { - return fmt.Errorf("unable to get current "+ - "blockheight %v", err) - } - - if tempMinerHeight != minerHeight+delta { - return fmt.Errorf("expected new miner(%d) to be %d "+ - "blocks ahead of original miner(%d)", - tempMinerHeight, delta, minerHeight) - } - - return nil - }, defaultTimeout) - require.NoError(ht, err, "failed to assert block height delta") -} - // verifyCloseUpdate is used to verify that a closed channel update is of the // expected type. func verifyCloseUpdate(chanUpdate *lnrpc.ChannelEventUpdate, diff --git a/itest/lnd_zero_conf_test.go b/itest/lnd_zero_conf_test.go index ae3ca0ec7..f2190bd2a 100644 --- a/itest/lnd_zero_conf_test.go +++ b/itest/lnd_zero_conf_test.go @@ -5,9 +5,7 @@ import ( "testing" "time" - "github.com/btcsuite/btcd/btcjson" "github.com/btcsuite/btcd/btcutil" - "github.com/btcsuite/btcd/integration/rpctest" "github.com/go-errors/errors" "github.com/lightningnetwork/lnd/aliasmgr" "github.com/lightningnetwork/lnd/chainreg" @@ -906,8 +904,6 @@ func testZeroConfReorg(ht *lntest.HarnessTest) { ht.Skipf("skipping zero-conf reorg test for neutrino backend") } - var temp = "temp" - // Since zero-conf is opt in, the harness nodes provided won't be able // to open zero-conf channels. In that case, we just spin up new nodes. zeroConfArgs := []string{ @@ -963,37 +959,7 @@ func testZeroConfReorg(ht *lntest.HarnessTest) { // exists in the graph. // // First, we'll setup a new miner that we can use to cause a reorg. - tempLogDir := ".tempminerlogs" - logFilename := "output-open_channel_reorg-temp_miner.log" - tempMiner := lntest.NewTempMiner( - ht.Context(), ht.T, tempLogDir, logFilename, - ) - defer tempMiner.Stop() - - require.NoError( - ht.T, tempMiner.SetUp(false, 0), "unable to setup mining node", - ) - - // We start by connecting the new miner to our original miner, such - // that it will sync to our original chain. - err := ht.Miner.Client.Node( - btcjson.NConnect, tempMiner.P2PAddress(), &temp, - ) - require.NoError(ht.T, err, "unable to connect node") - - nodeSlice := []*rpctest.Harness{ht.Miner.Harness, tempMiner.Harness} - err = rpctest.JoinNodes(nodeSlice, rpctest.Blocks) - require.NoError(ht.T, err, "unable to join node on blocks") - - // The two miners should be on the same block height. - assertMinerBlockHeightDelta(ht, ht.Miner, tempMiner, 0) - - // We disconnect the two miners, such that we can mine two chains and - // cause a reorg later. - err = ht.Miner.Client.Node( - btcjson.NDisconnect, tempMiner.P2PAddress(), &temp, - ) - require.NoError(ht.T, err, "unable to remove node") + tempMiner := ht.Miner.SpawnTempMiner() // We now cause a fork, by letting our original miner mine 1 block and // our new miner will mine 2. We also expect the funding transition to @@ -1002,7 +968,7 @@ func testZeroConfReorg(ht *lntest.HarnessTest) { tempMiner.MineEmptyBlocks(2) // Ensure the temp miner is one block ahead. - assertMinerBlockHeightDelta(ht, ht.Miner, tempMiner, 1) + ht.Miner.AssertMinerBlockHeightDelta(tempMiner, 1) // Wait for Carol to sync to the original miner's chain. _, minerHeight := ht.Miner.GetBestBlock() @@ -1015,24 +981,14 @@ func testZeroConfReorg(ht *lntest.HarnessTest) { // Connecting to the temporary miner should cause the original miner to // reorg to the longer chain. - err = ht.Miner.Client.Node( - btcjson.NConnect, tempMiner.P2PAddress(), &temp, - ) - require.NoError(ht.T, err, "unable to remove node") - - nodes := []*rpctest.Harness{tempMiner.Harness, ht.Miner.Harness} - err = rpctest.JoinNodes(nodes, rpctest.Blocks) - require.NoError(ht.T, err, "unable to join node on blocks") + ht.Miner.ConnectMiner(tempMiner) // They should now be on the same chain. - assertMinerBlockHeightDelta(ht, ht.Miner, tempMiner, 0) + ht.Miner.AssertMinerBlockHeightDelta(tempMiner, 0) // Now we disconnect the two miners and reconnect our original chain // backend. - err = ht.Miner.Client.Node( - btcjson.NDisconnect, tempMiner.P2PAddress(), &temp, - ) - require.NoError(ht.T, err, "unable to remove node") + ht.Miner.DisconnectMiner(tempMiner) ht.ConnectMiner() diff --git a/lntest/btcd.go b/lntest/btcd.go index 3ba613539..09f33472b 100644 --- a/lntest/btcd.go +++ b/lntest/btcd.go @@ -21,12 +21,6 @@ import ( // logDirPattern is the pattern of the name of the temporary log directory. const logDirPattern = "%s/.backendlogs" -// temp is used to signal we want to establish a temporary connection using the -// btcd Node API. -// -// NOTE: Cannot be const, since the node API expects a reference. -var temp = "temp" - // BtcdBackendConfig is an implementation of the BackendConfig interface // backed by a btcd node. type BtcdBackendConfig struct { diff --git a/lntest/harness_miner.go b/lntest/harness_miner.go index abbf2877d..90c7418cf 100644 --- a/lntest/harness_miner.go +++ b/lntest/harness_miner.go @@ -34,7 +34,15 @@ const ( slowMineDelay = 100 * time.Millisecond ) -var harnessNetParams = &chaincfg.RegressionNetParams +var ( + harnessNetParams = &chaincfg.RegressionNetParams + + // temp is used to signal we want to establish a temporary connection + // using the btcd Node API. + // + // NOTE: Cannot be const, since the node API expects a reference. + temp = "temp" +) type HarnessMiner struct { *testing.T @@ -487,3 +495,89 @@ func (h *HarnessMiner) MineEmptyBlocks(num int) []*wire.MsgBlock { return blocks } + +// SpawnTempMiner creates a temp miner and syncs it with the current miner. +// Once miners are synced, the temp miner is disconnected from the original +// miner and returned. +func (h *HarnessMiner) SpawnTempMiner() *HarnessMiner { + require := require.New(h.T) + + // Setup a temp miner. + tempLogDir := ".tempminerlogs" + logFilename := "output-temp_miner.log" + tempMiner := NewTempMiner(h.runCtx, h.T, tempLogDir, logFilename) + + // Make sure to clean the miner when the test ends. + h.T.Cleanup(tempMiner.Stop) + + // Setup the miner. + require.NoError(tempMiner.SetUp(false, 0), "unable to setup miner") + + // Connect the temp miner to the original miner. + err := h.Client.Node(btcjson.NConnect, tempMiner.P2PAddress(), &temp) + require.NoError(err, "unable to connect node") + + // Sync the blocks. + nodeSlice := []*rpctest.Harness{h.Harness, tempMiner.Harness} + err = rpctest.JoinNodes(nodeSlice, rpctest.Blocks) + require.NoError(err, "unable to join node on blocks") + + // The two miners should be on the same block height. + h.AssertMinerBlockHeightDelta(tempMiner, 0) + + // Once synced, we now disconnect the temp miner so it'll be + // independent from the original miner. + err = h.Client.Node(btcjson.NDisconnect, tempMiner.P2PAddress(), &temp) + require.NoError(err, "unable to disconnect miners") + + return tempMiner +} + +// ConnectMiner connects the miner to a temp miner. +func (h *HarnessMiner) ConnectMiner(tempMiner *HarnessMiner) { + require := require.New(h.T) + + // Connect the current miner to the temporary miner. + err := h.Client.Node(btcjson.NConnect, tempMiner.P2PAddress(), &temp) + require.NoError(err, "unable to connect temp miner") + + nodes := []*rpctest.Harness{tempMiner.Harness, h.Harness} + err = rpctest.JoinNodes(nodes, rpctest.Blocks) + require.NoError(err, "unable to join node on blocks") +} + +// DisconnectMiner disconnects the miner from the temp miner. +func (h *HarnessMiner) DisconnectMiner(tempMiner *HarnessMiner) { + err := h.Client.Node(btcjson.NDisconnect, tempMiner.P2PAddress(), &temp) + require.NoError(h.T, err, "unable to disconnect temp miner") +} + +// AssertMinerBlockHeightDelta ensures that tempMiner is 'delta' blocks ahead +// of miner. +func (h *HarnessMiner) AssertMinerBlockHeightDelta(tempMiner *HarnessMiner, + delta int32) { + + // Ensure the chain lengths are what we expect. + err := wait.NoError(func() error { + _, tempMinerHeight, err := tempMiner.Client.GetBestBlock() + if err != nil { + return fmt.Errorf("unable to get current "+ + "blockheight %v", err) + } + + _, minerHeight, err := h.Client.GetBestBlock() + if err != nil { + return fmt.Errorf("unable to get current "+ + "blockheight %v", err) + } + + if tempMinerHeight != minerHeight+delta { + return fmt.Errorf("expected new miner(%d) to be %d "+ + "blocks ahead of original miner(%d)", + tempMinerHeight, delta, minerHeight) + } + + return nil + }, DefaultTimeout) + require.NoError(h.T, err, "failed to assert block height delta") +} diff --git a/peer/brontide.go b/peer/brontide.go index 1b1534b2d..7866dbe3c 100644 --- a/peer/brontide.go +++ b/peer/brontide.go @@ -1099,7 +1099,7 @@ func (p *Brontide) readNextMessage() (lnwire.Message, error) { pktLen, err := noiseConn.ReadNextHeader() if err != nil { - return nil, err + return nil, fmt.Errorf("read next header: %w", err) } // First we'll read the next _full_ message. We do this rather than @@ -1128,7 +1128,7 @@ func (p *Brontide) readNextMessage() (lnwire.Message, error) { // pool. rawMsg, readErr := noiseConn.ReadNextBody(buf[:pktLen]) if readErr != nil { - return readErr + return fmt.Errorf("read next body: %w", readErr) } msgLen = uint64(len(rawMsg)) diff --git a/server.go b/server.go index 4719691e9..e28d8a757 100644 --- a/server.go +++ b/server.go @@ -4012,6 +4012,7 @@ func (s *server) peerTerminationWatcher(p *peer.Brontide, ready chan struct{}) { // If the server is exiting then we can bail out early ourselves as all // the other sub-systems will already be shutting down. if s.Stopped() { + srvrLog.Debugf("Server quitting, exit early for peer %v", p) return }