multi: add sql backend support

Makefile

@@ -44,6 +44,9 @@ DOCKER_TOOLS = docker run \
 
 TEST_FLAGS = -test.timeout=20m
 
+DEV_TAGS =  kvdb_postgres kvdb_sqlite
+
+
 UNIT := $(GOLIST) | $(XARGS) env $(GOTEST) $(TEST_FLAGS)
 LDFLAGS := -X main.Commit=$(shell git describe --tags)
 RELEASE_LDFLAGS := -s -w -buildid= $(LDFLAGS)
@@ -70,7 +73,7 @@ build:
 
 install:
 	@$(call print, "Installing chantools.")
-	$(GOINSTALL) -ldflags "$(LDFLAGS)" ./...
+	$(GOINSTALL) -tags="$(DEV_TAGS)" -ldflags "$(LDFLAGS)" ./...
 
 release:
 	@$(call print, "Creating release of chantools.")

cmd/chantools/chanbackup.go

@@ -55,10 +55,13 @@ func (c *chanBackupCommand) Execute(_ *cobra.Command, _ []string) error {
 	}
 
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("channel DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, true)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("channel DB is required")
+	// }
+
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
 		return fmt.Errorf("error opening rescue DB: %w", err)
 	}

cmd/chantools/deletepayments.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"errors"
 	"fmt"
 
 	"github.com/lightninglabs/chantools/lnd"
@@ -45,10 +44,12 @@ run lnd ` + lndVersion + ` or later after using this command!'`,
 
 func (c *deletePaymentsCommand) Execute(_ *cobra.Command, _ []string) error {
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("channel DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, false)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("channel DB is required")
+	// }
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
 		return fmt.Errorf("error opening rescue DB: %w", err)
 	}

cmd/chantools/dropchannelgraph.go

@@ -82,10 +82,13 @@ chantools dropchannelgraph \
 
 func (c *dropChannelGraphCommand) Execute(_ *cobra.Command, _ []string) error {
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("channel DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, false)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("channel DB is required")
+	// }
+
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
 		return fmt.Errorf("error opening rescue DB: %w", err)
 	}

cmd/chantools/dropgraphzombies.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"errors"
 	"fmt"
 
 	"github.com/lightninglabs/chantools/lnd"
@@ -52,10 +51,12 @@ run lnd ` + lndVersion + ` or later after using this command!'`,
 
 func (c *dropGraphZombiesCommand) Execute(_ *cobra.Command, _ []string) error {
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("channel DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, false)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("channel DB is required")
+	// }
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
 		return fmt.Errorf("error opening rescue DB: %w", err)
 	}

cmd/chantools/dumpchannels.go

@@ -54,10 +54,12 @@ given lnd channel.db gile in a human readable format.`,
 
 func (c *dumpChannelsCommand) Execute(_ *cobra.Command, _ []string) error {
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("channel DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, true)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("channel DB is required")
+	// }
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
 		return fmt.Errorf("error opening rescue DB: %w", err)
 	}

cmd/chantools/forceclose.go

@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"encoding/hex"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"io"
 	"os"
@@ -79,10 +78,12 @@ func (c *forceCloseCommand) Execute(_ *cobra.Command, _ []string) error {
 	}
 
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("rescue DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, true)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("rescue DB is required")
+	// }
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
 		return fmt.Errorf("error opening rescue DB: %w", err)
 	}

cmd/chantools/migratedb.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"errors"
 	"fmt"
 
 	"github.com/lightninglabs/chantools/lnd"
@@ -41,12 +40,14 @@ run lnd ` + lndVersion + ` or later after using this command!'`,
 
 func (c *migrateDBCommand) Execute(_ *cobra.Command, _ []string) error {
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("channel DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, false)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("channel DB is required")
+	// }
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
-		return fmt.Errorf("error opening DB: %w", err)
+		return fmt.Errorf("error opening rescue DB: %w", err)
 	}
 
 	return db.Close()

cmd/chantools/removechannel.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"errors"
 	"fmt"
 	"strconv"
 	"strings"
@@ -53,12 +52,14 @@ run lnd ` + lndVersion + ` or later after using this command!`,
 
 func (c *removeChannelCommand) Execute(_ *cobra.Command, _ []string) error {
 	// Check that we have a channel DB.
-	if c.ChannelDB == "" {
-		return errors.New("channel DB is required")
-	}
-	db, err := lnd.OpenDB(c.ChannelDB, false)
+	// if c.ChannelDB == "" {
+	// 	return errors.New("channel DB is required")
+	// }
+	dbConfig := GetDBConfig()
+
+	db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 	if err != nil {
-		return fmt.Errorf("error opening channel DB: %w", err)
+		return fmt.Errorf("error opening rescue DB: %w", err)
 	}
 	defer func() {
 		if err := db.Close(); err != nil {

cmd/chantools/rescueclosed.go

@@ -125,8 +125,11 @@ func (c *rescueClosedCommand) Execute(_ *cobra.Command, _ []string) error {
 	// What way of recovery has the user chosen? From summary and DB or from
 	// address and commit point?
 	switch {
+	// Needs an update we don't use the string anymore
 	case c.ChannelDB != "":
-		db, err := lnd.OpenDB(c.ChannelDB, true)
+		dbConfig := GetDBConfig()
+
+		db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 		if err != nil {
 			return fmt.Errorf("error opening rescue DB: %w", err)
 		}

cmd/chantools/rescuefunding.go

@@ -158,7 +158,9 @@ func (c *rescueFundingCommand) Execute(_ *cobra.Command, _ []string) error {
 			"channel point or both local and remote pubkey")
 
 	case c.ChannelDB != "" && c.DBChannelPoint != "":
-		db, err := lnd.OpenDB(c.ChannelDB, true)
+		dbConfig := GetDBConfig()
+
+		db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 		if err != nil {
 			return fmt.Errorf("error opening rescue DB: %w", err)
 		}

cmd/chantools/root.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/btcsuite/btcd/btcutil"
 	"github.com/btcsuite/btcd/btcutil/hdkeychain"
 	"github.com/btcsuite/btcd/chaincfg"
 	"github.com/btcsuite/btclog"
@@ -19,7 +20,10 @@ import (
 	"github.com/lightningnetwork/lnd/build"
 	"github.com/lightningnetwork/lnd/chanbackup"
 	"github.com/lightningnetwork/lnd/channeldb"
+	"github.com/lightningnetwork/lnd/kvdb/postgres"
+	"github.com/lightningnetwork/lnd/kvdb/sqlite"
 	"github.com/lightningnetwork/lnd/peer"
+	"github.com/ory/viper"
 	"github.com/spf13/cobra"
 )
 
@@ -50,6 +54,8 @@ var (
 	logWriter   = build.NewRotatingLogWriter()
 	log         = build.NewSubLogger("CHAN", genSubLogger(logWriter))
 	chainParams = &chaincfg.MainNetParams
+	// defaultDataDir is the default data directory for lnd.
+	defaultDataDir = btcutil.AppDataDir("lnd", false)
 )
 
 var rootCmd = &cobra.Command{
@@ -96,6 +102,24 @@ func main() {
 		&Signet, "signet", "s", false, "Indicates if the public "+
 			"signet parameters should be used",
 	)
+	rootCmd.PersistentFlags().String("db.backend", "bolt", "The selected database backend (bolt/etcd/postgres/sqlite)")
+
+	// Bolt settings
+	rootCmd.PersistentFlags().Duration("db.bolt.dbtimeout", 10*time.Second, "Specify the timeout value used when opening the database")
+	rootCmd.PersistentFlags().String("db.bolt.data-dir", defaultDataDir, "Lnd data dir where bolt dbs are located")
+	rootCmd.PersistentFlags().String("db.bolt.tower-dir", defaultDataDir, "Lnd watchtower dir where bolt dbs are located")
+
+	// Sqlite settings
+	rootCmd.PersistentFlags().String("db.sqlite.data-dir", defaultDataDir, "Lnd data dir where sqlite dbs are located")
+	rootCmd.PersistentFlags().String("db.sqlite.tower-dir", defaultDataDir, "Lnd watchtower dir where sqlite dbs are located")
+	rootCmd.PersistentFlags().Duration("db.sqlite.timeout", 10*time.Second, "Specify the timeout value used when opening the database")
+
+	// Postgres settings
+	rootCmd.PersistentFlags().String("db.postgres.dsn", "", "Postgres connection string")
+	rootCmd.PersistentFlags().Duration("db.postgres.timeout", 10*time.Second, "Specify the timeout value used when opening the database")
+
+	// Bind flags to viper
+	viper.BindPFlags(rootCmd.PersistentFlags())
 
 	rootCmd.AddCommand(
 		newChanBackupCommand(),
@@ -275,10 +299,11 @@ func (f *inputFlags) parseInputType() ([]*dataformat.SummaryEntry, error) {
 		target = &dataformat.SummaryEntryFile{}
 
 	case f.FromChannelDB != "":
-		db, err := lnd.OpenDB(f.FromChannelDB, true)
+		dbConfig := GetDBConfig()
+
+		db, err := lnd.OpenChannelDB(dbConfig, chainParams.Name)
 		if err != nil {
-			return nil, fmt.Errorf("error opening channel DB: %w",
-				err)
+			return nil, fmt.Errorf("error opening rescue DB: %w", err)
 		}
 		target = &dataformat.ChannelDBFile{DB: db.ChannelStateDB()}
 		return target.AsSummaryEntries()
@@ -365,3 +390,28 @@ func newExplorerAPI(apiURL string) *btc.ExplorerAPI {
 	// Otherwise use the provided URL.
 	return &btc.ExplorerAPI{BaseURL: apiURL}
 }
+
+// GetDBConfig returns the database configuration from viper/cobra flags
+func GetDBConfig() lnd.DB {
+	return lnd.DB{
+		Backend: viper.GetString("db.backend"),
+		Bolt: &lnd.Bolt{
+			DBTimeout: viper.GetDuration("db.bolt.dbtimeout"),
+			DataDir:   viper.GetString("db.bolt.data-dir"),
+			TowerDir:  viper.GetString("db.bolt.tower-dir"),
+		},
+		Sqlite: &lnd.Sqlite{
+			DataDir:  viper.GetString("db.sqlite.data-dir"),
+			TowerDir: viper.GetString("db.sqlite.tower-dir"),
+			Config: &sqlite.Config{
+				MaxConnections: viper.GetInt("db.sqlite.timeout"),
+			},
+		},
+		Postgres: &postgres.Config{
+			Dsn:            viper.GetString("db.postgres.dsn"),
+			MaxConnections: viper.GetInt("db.postgres.max-connections"),
+			Timeout:        viper.GetDuration("db.postgres.timeout"),
+		},
+		// Add Etcd config if needed
+	}
+}