567fa9ed10
Previously the chainbackend connected to the miner using a permanent connection, which would retry the connection when it’s disconnected. It would leave multiple connections between the chainbackend and the miner, causing difficulties in debugging. Currently, there are two occasions when disconnection happens. One happens when running the open channel reorg test, the miner is connected/disconnected multiple times on purpose. The other happens when the chainbackend receives a MSG_WITNESS_TX type from the miner, which would be considered as an invalid type and disconnects the miner. With the latter one being fixed in btcd, the chainbackend will still be disconnected from the miner if it reaches the ban score by requesting too many notfound messages in a short time which is why the `--nobanning` flag is added.
131 lines
3.7 KiB
Go
131 lines
3.7 KiB
Go
// +build btcd
|
|
|
|
package lntest
|
|
|
|
import (
|
|
"encoding/hex"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/btcsuite/btcd/btcjson"
|
|
"github.com/btcsuite/btcd/chaincfg"
|
|
"github.com/btcsuite/btcd/integration/rpctest"
|
|
"github.com/btcsuite/btcd/rpcclient"
|
|
)
|
|
|
|
// logDir is the name of the temporary log directory.
|
|
const logDir = "./.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 {
|
|
// rpcConfig houses the connection config to the backing btcd instance.
|
|
rpcConfig rpcclient.ConnConfig
|
|
|
|
// harness is the backing btcd instance.
|
|
harness *rpctest.Harness
|
|
|
|
// minerAddr is the p2p address of the miner to connect to.
|
|
minerAddr string
|
|
}
|
|
|
|
// A compile time assertion to ensure BtcdBackendConfig meets the BackendConfig
|
|
// interface.
|
|
var _ BackendConfig = (*BtcdBackendConfig)(nil)
|
|
|
|
// GenArgs returns the arguments needed to be passed to LND at startup for
|
|
// using this node as a chain backend.
|
|
func (b BtcdBackendConfig) GenArgs() []string {
|
|
var args []string
|
|
encodedCert := hex.EncodeToString(b.rpcConfig.Certificates)
|
|
args = append(args, "--bitcoin.node=btcd")
|
|
args = append(args, fmt.Sprintf("--btcd.rpchost=%v", b.rpcConfig.Host))
|
|
args = append(args, fmt.Sprintf("--btcd.rpcuser=%v", b.rpcConfig.User))
|
|
args = append(args, fmt.Sprintf("--btcd.rpcpass=%v", b.rpcConfig.Pass))
|
|
args = append(args, fmt.Sprintf("--btcd.rawrpccert=%v", encodedCert))
|
|
|
|
return args
|
|
}
|
|
|
|
// ConnectMiner is called to establish a connection to the test miner.
|
|
func (b BtcdBackendConfig) ConnectMiner() error {
|
|
return b.harness.Node.Node(btcjson.NConnect, b.minerAddr, &temp)
|
|
}
|
|
|
|
// DisconnectMiner is called to disconnect the miner.
|
|
func (b BtcdBackendConfig) DisconnectMiner() error {
|
|
return b.harness.Node.Node(btcjson.NDisconnect, b.minerAddr, &temp)
|
|
}
|
|
|
|
// Name returns the name of the backend type.
|
|
func (b BtcdBackendConfig) Name() string {
|
|
return "btcd"
|
|
}
|
|
|
|
// NewBackend starts a new rpctest.Harness and returns a BtcdBackendConfig for
|
|
// that node. miner should be set to the P2P address of the miner to connect
|
|
// to.
|
|
func NewBackend(miner string, netParams *chaincfg.Params) (
|
|
*BtcdBackendConfig, func() error, error) {
|
|
|
|
args := []string{
|
|
"--rejectnonstd",
|
|
"--txindex",
|
|
"--trickleinterval=100ms",
|
|
"--debuglevel=debug",
|
|
"--logdir=" + logDir,
|
|
"--nowinservice",
|
|
// The miner will get banned and disconnected from the node if
|
|
// its requested data are not found. We add a nobanning flag to
|
|
// make sure they stay connected if it happens.
|
|
"--nobanning",
|
|
}
|
|
chainBackend, err := rpctest.New(netParams, nil, args)
|
|
if err != nil {
|
|
return nil, nil, fmt.Errorf("unable to create btcd node: %v", err)
|
|
}
|
|
|
|
if err := chainBackend.SetUp(false, 0); err != nil {
|
|
return nil, nil, fmt.Errorf("unable to set up btcd backend: %v", err)
|
|
}
|
|
|
|
bd := &BtcdBackendConfig{
|
|
rpcConfig: chainBackend.RPCConfig(),
|
|
harness: chainBackend,
|
|
minerAddr: miner,
|
|
}
|
|
|
|
cleanUp := func() error {
|
|
var errStr string
|
|
if err := chainBackend.TearDown(); err != nil {
|
|
errStr += err.Error() + "\n"
|
|
}
|
|
|
|
// After shutting down the chain backend, we'll make a copy of
|
|
// the log file before deleting the temporary log dir.
|
|
logFile := logDir + "/" + netParams.Name + "/btcd.log"
|
|
err := CopyFile("./output_btcd_chainbackend.log", logFile)
|
|
if err != nil {
|
|
errStr += fmt.Sprintf("unable to copy file: %v\n", err)
|
|
}
|
|
if err = os.RemoveAll(logDir); err != nil {
|
|
errStr += fmt.Sprintf(
|
|
"cannot remove dir %s: %v\n", logDir, err,
|
|
)
|
|
}
|
|
if errStr != "" {
|
|
return errors.New(errStr)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
return bd, cleanUp, nil
|
|
}
|