Merge pull request #199 from lightninglabs/itest

Add more tests, make `derivekey` CLN compatible, allow disabling log

Author: guggero

.github/workflows/main.yml

@@ -48,6 +48,9 @@ jobs:
         uses: actions/setup-go@v2
         with:
           go-version: '${{ env.GO_VERSION }}'
+          
+      - name: Install chantools
+        run: make install
 
       - name: run unit tests
         run: make unit

.golangci.yml

@@ -1,11 +1,12 @@
 run:
   # timeout for analysis
   timeout: 4m
+  go: "1.23"
 
 linters-settings:
   govet:
     # Don't report about shadowed variables
-    check-shadowing: false
+    shadow: false
   gofmt:
     # simplify code: gofmt with `-s` option, true by default
     simplify: true
@@ -17,7 +18,6 @@ linters-settings:
       rules:
         json: snake
   staticcheck:
-    go: "1.18"
     checks: ["-SA1019"]
   gomoddirectives:
     replace-allow-list:
@@ -34,7 +34,6 @@ linters:
     - varnamelen
     - wrapcheck
     - testpackage
-    - gomnd
     - err113
     - exhaustruct
     - forbidigo

README.md

@@ -484,7 +484,7 @@ Legend:
 | [compactdb](doc/chantools_compactdb.md)                     | Run database compaction manually to reclaim space                                                                                          |
 | [createwallet](doc/chantools_createwallet.md)               | :pencil: Create a new lnd compatible wallet.db file from an existing seed or by generating a new one                                       |
 | [deletepayments](doc/chantools_deletepayments.md)           | Remove ALL payments from a `channel.db` file to reduce size                                                                                |
-| [derivekey](doc/chantools_derivekey.md)                     | :pencil: Derive a single private/public key from `lnd`'s seed, use to test seed                                                            |
+| [derivekey](doc/chantools_derivekey.md)                     | :pencil: (**CLN**) Derive a single private/public key from `lnd`'s seed, use to test seed                                                  |
 | [doublespendinputs](doc/chantools_doublespendinputs.md)     | :pencil: Tries to double spend the given inputs by deriving the private for the address and sweeping the funds to the given address        |
 | [dropchannelgraph](doc/chantools_dropchannelgraph.md)       | ( :warning: ) Completely drop the channel graph from a `channel.db` to force re-sync (not recommended while channels are open!)            |
 | [dropgraphzombies](doc/chantools_dropgraphzombies.md)       | Drop all zombie channels from a `channel.db` to force a graph re-sync                                                                      |

cmd/chantools/derivekey.go

@@ -1,10 +1,13 @@
 package main
 
 import (
+	"encoding/hex"
+	"errors"
 	"fmt"
 
 	"github.com/btcsuite/btcd/btcutil"
 	"github.com/btcsuite/btcd/btcutil/hdkeychain"
+	"github.com/lightninglabs/chantools/cln"
 	"github.com/lightninglabs/chantools/lnd"
 	"github.com/spf13/cobra"
 )
@@ -27,6 +30,8 @@ type deriveKeyCommand struct {
 	Neuter   bool
 	Identity bool
 
+	HsmSecret string
+
 	rootKey *rootKey
 	cmd     *cobra.Command
 }
@@ -53,8 +58,14 @@ chantools derivekey --identity`,
 			"only public key(s)",
 	)
 	cc.cmd.Flags().BoolVar(
-		&cc.Identity, "identity", false, "derive the lnd "+
-			"identity_pubkey",
+		&cc.Identity, "identity", false, "derive the node's identity "+
+			"public key",
+	)
+	cc.cmd.Flags().StringVar(
+		&cc.HsmSecret, "hsm_secret", "", "the hex encoded HSM secret "+
+			"to use for deriving the multisig keys for a CLN "+
+			"node; obtain by running 'xxd -p -c32 "+
+			"~/.lightning/bitcoin/hsm_secret'",
 	)
 
 	cc.rootKey = newRootKey(cc.cmd, "decrypting the backup")
@@ -63,6 +74,40 @@ chantools derivekey --identity`,
 }
 
 func (c *deriveKeyCommand) Execute(_ *cobra.Command, _ []string) error {
+	if c.HsmSecret != "" {
+		if c.Path != "" {
+			return errors.New("cannot specify --path with " +
+				"--hsm_secret, only identity key can be " +
+				"derived")
+		}
+
+		secretBytes, err := hex.DecodeString(c.HsmSecret)
+		if err != nil {
+			return fmt.Errorf("error decoding HSM secret: %w", err)
+		}
+
+		var hsmSecret [32]byte
+		copy(hsmSecret[:], secretBytes)
+
+		nodePubKey, _, err := cln.NodeKey(hsmSecret)
+		if err != nil {
+			return fmt.Errorf("error deriving node key from HSM: "+
+				"%w", err)
+		}
+
+		result := fmt.Sprintf(
+			"Node identity public key: 	%x",
+			nodePubKey.SerializeCompressed(),
+		)
+		fmt.Println(result)
+
+		// For the tests, also log as trace level which is disabled by
+		// default.
+		log.Tracef(result)
+
+		return nil
+	}
+
 	extendedKey, err := c.rootKey.read()
 	if err != nil {
 		return fmt.Errorf("error reading root key: %w", err)

cmd/chantools/derivekey_test.go

@@ -99,8 +99,9 @@ func TestDeriveKeyXprv(t *testing.T) {
 	err := derive.Execute(nil, nil)
 	require.NoError(t, err)
 
-	h.assertLogContains("cQcdieZy2d1TAdCsa5MjmHJs2gdHcD7x22nDbhJyVTUa3Ax" +
-		"5KB3w")
+	h.assertLogContains(
+		"cQcdieZy2d1TAdCsa5MjmHJs2gdHcD7x22nDbhJyVTUa3Ax5KB3w",
+	)
 }
 
 func TestDeriveKeyXpub(t *testing.T) {
@@ -120,8 +121,10 @@ func TestDeriveKeyXpub(t *testing.T) {
 	err := derive.Execute(nil, nil)
 	require.NoError(t, err)
 
-	h.assertLogContains("03dc8655d58bd4fd4326863fe34bd5cdddbefaa3b042571" +
-		"05eb1ab99aa05e01c2a")
+	h.assertLogContains(
+		"03dc8655d58bd4fd4326863fe34bd5cdddbefaa3b04257105eb1ab99aa05e" +
+			"01c2a",
+	)
 }
 
 func TestDeriveKeyXpubNoNeuter(t *testing.T) {
@@ -140,6 +143,27 @@ func TestDeriveKeyXpubNoNeuter(t *testing.T) {
 	err := derive.Execute(nil, nil)
 	require.NoError(t, err)
 
-	h.assertLogContains("03dc8655d58bd4fd4326863fe34bd5cdddbefaa3b042571" +
-		"05eb1ab99aa05e01c2a")
+	h.assertLogContains(
+		"03dc8655d58bd4fd4326863fe34bd5cdddbefaa3b04257105eb1ab99aa05e" +
+			"01c2a",
+	)
+}
+
+func TestDeriveKeyHsmSecret(t *testing.T) {
+	h := newHarness(t)
+
+	// Derive a specific key from the serialized root key.
+	derive := &deriveKeyCommand{
+		Identity: true,
+		HsmSecret: "471a115fb8edd6281f883ac82509fb0f30707e590d895f683" +
+			"2d781f1639c07ff",
+	}
+
+	err := derive.Execute(nil, nil)
+	require.NoError(t, err)
+
+	h.assertLogContains(
+		"03508beb59d2ec4772cd7b143bbef0fdac204b240747e82bc5fe58bd0418" +
+			"4f35a3",
+	)
 }

cmd/chantools/root.go

@@ -31,7 +31,7 @@ const (
 	// version is the current version of the tool. It is set during build.
 	// NOTE: When changing this, please also update the version in the
 	// download link shown in the README.
-	version = "0.14.0"
+	version = "0.14.1"
 	na      = "n/a"
 
 	// lndVersion is the current version of lnd that we support. This is
@@ -47,15 +47,13 @@ const (
 )
 
 var (
-	Testnet bool
-	Regtest bool
-	Signet  bool
+	Testnet   bool
+	Regtest   bool
+	Signet    bool
+	NoLogFile bool
+
+	log btclog.Logger
 
-	logWriter = build.NewRotatingLogWriter()
-	subLogMgr = build.NewSubLoggerManager(build.NewDefaultLogHandlers(
-		build.DefaultLogConfig(), logWriter,
-	)...)
-	log         = build.NewSubLogger("CHAN", genSubLogger(subLogMgr))
 	chainParams = &chaincfg.MainNetParams
 )
 
@@ -103,6 +101,11 @@ func main() {
 		&Signet, "signet", "s", false, "Indicates if the public "+
 			"signet parameters should be used",
 	)
+	rootCmd.PersistentFlags().BoolVar(
+		&NoLogFile, "nologfile", false, "If set, no log file "+
+			"will be created. This is useful for testing purposes "+
+			"where we don't want to create a log file.",
+	)
 
 	rootCmd.AddCommand(
 		newChanBackupCommand(),
@@ -328,28 +331,34 @@ func readInput(input string) ([]byte, error) {
 }
 
 func setupLogging() {
-	setSubLogger("CHAN", log)
-	addSubLogger("CHDB", channeldb.UseLogger)
-	addSubLogger("BCKP", chanbackup.UseLogger)
-	addSubLogger("PEER", peer.UseLogger)
-
-	err := logWriter.InitLogRotator(
-		&build.FileLoggerConfig{
-			Compressor:     build.Gzip,
-			MaxLogFiles:    3,
-			MaxLogFileSize: 10,
-		},
-		"./results/chantools.log",
-	)
-	if err != nil {
-		panic(err)
-	}
-
+	logWriter := build.NewRotatingLogWriter()
 	subLogMgr := build.NewSubLoggerManager(build.NewDefaultLogHandlers(
 		build.DefaultLogConfig(), logWriter,
 	)...)
 
-	err = build.ParseAndSetDebugLevels("debug", subLogMgr)
+	log = build.NewSubLogger("CHAN", genSubLogger(subLogMgr))
+	log.SetLevel(btclog.LevelDebug)
+
+	setSubLogger(subLogMgr, "CHAN", log)
+	addSubLogger(subLogMgr, "CHDB", channeldb.UseLogger)
+	addSubLogger(subLogMgr, "BCKP", chanbackup.UseLogger)
+	addSubLogger(subLogMgr, "PEER", peer.UseLogger)
+
+	if !NoLogFile {
+		err := logWriter.InitLogRotator(
+			&build.FileLoggerConfig{
+				Compressor:     build.Gzip,
+				MaxLogFiles:    3,
+				MaxLogFileSize: 10,
+			},
+			"./results/chantools.log",
+		)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	err := build.ParseAndSetDebugLevels("debug", subLogMgr)
 	if err != nil {
 		panic(err)
 	}
@@ -364,17 +373,19 @@ func genSubLogger(mgr *build.SubLoggerManager) func(string) btclog.Logger {
 
 // addSubLogger is a helper method to conveniently create and register the
 // logger of one or more sub systems.
-func addSubLogger(subsystem string, useLoggers ...func(btclog.Logger)) {
+func addSubLogger(subLogMgr *build.SubLoggerManager, subsystem string,
+	useLoggers ...func(btclog.Logger)) {
+
 	// Create and register just a single logger to prevent them from
 	// overwriting each other internally.
 	logger := build.NewSubLogger(subsystem, genSubLogger(subLogMgr))
-	setSubLogger(subsystem, logger, useLoggers...)
+	setSubLogger(subLogMgr, subsystem, logger, useLoggers...)
 }
 
 // setSubLogger is a helper method to conveniently register the logger of a sub
 // system.
-func setSubLogger(subsystem string, logger btclog.Logger,
-	useLoggers ...func(btclog.Logger)) {
+func setSubLogger(subLogMgr *build.SubLoggerManager, subsystem string,
+	logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
 
 	subLogMgr.RegisterSubLogger(subsystem, logger)
 	for _, useLogger := range useLoggers {

doc/chantools.md

@@ -12,10 +12,11 @@ https://github.com/lightninglabs/chantools/.
 ### Options
 
 ```
-  -h, --help      help for chantools
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+  -h, --help        help for chantools
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_chanbackup.md

@@ -33,9 +33,10 @@ chantools chanbackup \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_closepoolaccount.md

@@ -48,9 +48,10 @@ chantools closepoolaccount \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_compactdb.md

@@ -31,9 +31,10 @@ chantools compactdb \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO