multi: move lnd specific code to own package

guggero · guggero · commit 9c2b85c21b16 · 2020-03-30T18:14:04.000+02:00
diff --git a/.golangci.yml b/.golangci.yml
@@ -21,6 +21,7 @@ linters:
     - gosec
     - funlen
     - maligned
+    - interfacer
 
 issues:
   exclude-rules:
diff --git a/cmd/chantools/chanbackup.go b/cmd/chantools/chanbackup.go
@@ -3,13 +3,13 @@ package main
 import (
 	"bytes"
 	"fmt"
-	"github.com/guggero/chantools/btc"
-	"github.com/lightningnetwork/lnd/chanbackup"
-	"github.com/lightningnetwork/lnd/keychain"
 	"path"
 
 	"github.com/btcsuite/btcutil/hdkeychain"
+	"github.com/guggero/chantools/lnd"
+	"github.com/lightningnetwork/lnd/chanbackup"
 	"github.com/lightningnetwork/lnd/channeldb"
+	"github.com/lightningnetwork/lnd/keychain"
 )
 
 type chanBackupCommand struct {
@@ -55,7 +55,7 @@ func (c *chanBackupCommand) Execute(_ []string) error {
 		return fmt.Errorf("error opening rescue DB: %v", err)
 	}
 	multiFile := chanbackup.NewMultiFile(c.MultiFile)
-	keyRing := &btc.HDKeyRing{
+	keyRing := &lnd.HDKeyRing{
 		ExtendedKey: extendedKey,
 		ChainParams: chainParams,
 	}
@@ -70,7 +70,7 @@ func createChannelBackup(db *channeldb.DB, multiFile *chanbackup.MultiFile,
 		return fmt.Errorf("error extracting channel backup: %v", err)
 	}
 	multi := &chanbackup.Multi{
-		Version: chanbackup.DefaultMultiVersion,
+		Version:       chanbackup.DefaultMultiVersion,
 		StaticBackups: singles,
 	}
 	var b bytes.Buffer
diff --git a/cmd/chantools/compactdb.go b/cmd/chantools/compactdb.go
@@ -65,7 +65,9 @@ func (c *compactDBCommand) compact(dst, src *bbolt.DB) error {
 	if err != nil {
 		return err
 	}
-	defer tx.Rollback()
+	defer func() {
+		_ = tx.Rollback()
+	}()
 
 	if err := c.walk(src, func(keys [][]byte, k, v []byte, seq uint64) error {
 		// On each key/value, check if we have exceeded tx size.
@@ -166,9 +168,9 @@ func (c *compactDBCommand) walkBucket(b *bbolt.Bucket, keypath [][]byte,
 		if v == nil {
 			bkt := b.Bucket(k)
 			if bkt == nil {
-				log.Warnf("Could not read bucket '%s' (full " +
-					"path '%s') database is likely " +
-					"corrupted. Continuing anyway but " +
+				log.Warnf("Could not read bucket '%s' (full "+
+					"path '%s') database is likely "+
+					"corrupted. Continuing anyway but "+
 					"skipping corrupt bucket.", k, keypath)
 				return nil
 			}
diff --git a/cmd/chantools/derivekey.go b/cmd/chantools/derivekey.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/btcsuite/btcutil"
 	"github.com/btcsuite/btcutil/hdkeychain"
-	"github.com/guggero/chantools/btc"
+	"github.com/guggero/chantools/lnd"
 )
 
 type deriveKeyCommand struct {
@@ -41,11 +41,11 @@ func deriveKey(extendedKey *hdkeychain.ExtendedKey, path string,
 	neuter bool) error {
 
 	fmt.Printf("Deriving path %s for network %s.\n", path, chainParams.Name)
-	parsedPath, err := btc.ParsePath(path)
+	parsedPath, err := lnd.ParsePath(path)
 	if err != nil {
 		return fmt.Errorf("could not parse derivation path: %v", err)
 	}
-	derivedKey, err := btc.DeriveChildren(extendedKey, parsedPath)
+	derivedKey, err := lnd.DeriveChildren(extendedKey, parsedPath)
 	if err != nil {
 		return fmt.Errorf("could not derive children: %v", err)
 	}
diff --git a/cmd/chantools/dumpbackup.go b/cmd/chantools/dumpbackup.go
@@ -5,8 +5,8 @@ import (
 
 	"github.com/btcsuite/btcutil/hdkeychain"
 	"github.com/davecgh/go-spew/spew"
-	"github.com/guggero/chantools/btc"
 	"github.com/guggero/chantools/dump"
+	"github.com/guggero/chantools/lnd"
 	"github.com/lightningnetwork/lnd/chanbackup"
 	"github.com/lightningnetwork/lnd/keychain"
 )
@@ -41,7 +41,7 @@ func (c *dumpBackupCommand) Execute(_ []string) error {
 		return fmt.Errorf("backup file is required")
 	}
 	multiFile := chanbackup.NewMultiFile(c.MultiFile)
-	keyRing := &btc.HDKeyRing{
+	keyRing := &lnd.HDKeyRing{
 		ExtendedKey: extendedKey,
 		ChainParams: chainParams,
 	}
diff --git a/cmd/chantools/filterbackup.go b/cmd/chantools/filterbackup.go
@@ -7,7 +7,7 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcutil/hdkeychain"
-	"github.com/guggero/chantools/btc"
+	"github.com/guggero/chantools/lnd"
 	"github.com/lightningnetwork/lnd/chanbackup"
 	"github.com/lightningnetwork/lnd/keychain"
 )
@@ -46,7 +46,7 @@ func (c *filterBackupCommand) Execute(_ []string) error {
 		return fmt.Errorf("backup file is required")
 	}
 	multiFile := chanbackup.NewMultiFile(c.MultiFile)
-	keyRing := &btc.HDKeyRing{
+	keyRing := &lnd.HDKeyRing{
 		ExtendedKey: extendedKey,
 		ChainParams: chainParams,
 	}
diff --git a/cmd/chantools/fixoldbackup.go b/cmd/chantools/fixoldbackup.go
@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcutil/hdkeychain"
-	"github.com/guggero/chantools/btc"
+	"github.com/guggero/chantools/lnd"
 	"github.com/lightningnetwork/lnd/chanbackup"
 	"github.com/lightningnetwork/lnd/keychain"
 )
@@ -40,15 +40,15 @@ func (c *fixOldBackupCommand) Execute(_ []string) error {
 		return fmt.Errorf("backup file is required")
 	}
 	multiFile := chanbackup.NewMultiFile(c.MultiFile)
-	keyRing := &btc.HDKeyRing{
+	keyRing := &lnd.HDKeyRing{
 		ExtendedKey: extendedKey,
 		ChainParams: chainParams,
 	}
 	return fixOldChannelBackup(multiFile, keyRing)
 }
 
 func fixOldChannelBackup(multiFile *chanbackup.MultiFile,
-	ring *btc.HDKeyRing) error {
+	ring *lnd.HDKeyRing) error {
 
 	multi, err := multiFile.ExtractMulti(ring)
 	if err != nil {
diff --git a/cmd/chantools/forceclose.go b/cmd/chantools/forceclose.go
@@ -14,6 +14,7 @@ import (
 	"github.com/btcsuite/btcutil/hdkeychain"
 	"github.com/guggero/chantools/btc"
 	"github.com/guggero/chantools/dataformat"
+	"github.com/guggero/chantools/lnd"
 	"github.com/lightningnetwork/lnd/channeldb"
 	"github.com/lightningnetwork/lnd/input"
 )
@@ -49,7 +50,7 @@ func (c *forceCloseCommand) Execute(_ []string) error {
 		return fmt.Errorf("rescue DB is required")
 	}
 	db, err := channeldb.Open(
-		path.Dir(c.ChannelDB),channeldb.OptionSetSyncFreelist(true),
+		path.Dir(c.ChannelDB), channeldb.OptionSetSyncFreelist(true),
 		channeldb.OptionReadOnly(true),
 	)
 	if err != nil {
@@ -73,7 +74,7 @@ func forceCloseChannels(extendedKey *hdkeychain.ExtendedKey,
 		return err
 	}
 	api := &btc.ExplorerAPI{BaseURL: cfg.APIURL}
-	signer := &btc.Signer{
+	signer := &lnd.Signer{
 		ExtendedKey: extendedKey,
 		ChainParams: chainParams,
 	}
@@ -103,7 +104,7 @@ func forceCloseChannels(extendedKey *hdkeychain.ExtendedKey,
 		}
 
 		// Create signed transaction.
-		lc := &btc.LightningChannel{
+		lc := &lnd.LightningChannel{
 			LocalChanCfg:  channel.LocalChanCfg,
 			RemoteChanCfg: channel.RemoteChanCfg,
 			ChannelState:  channel,
diff --git a/cmd/chantools/genimportscript.go b/cmd/chantools/genimportscript.go
@@ -7,7 +7,7 @@ import (
 	"github.com/btcsuite/btcd/chaincfg"
 	"github.com/btcsuite/btcutil"
 	"github.com/btcsuite/btcutil/hdkeychain"
-	"github.com/guggero/chantools/btc"
+	"github.com/guggero/chantools/lnd"
 )
 
 const (
@@ -84,10 +84,10 @@ func (c *genImportScriptCommand) Execute(_ []string) error {
 
 	// External branch first (m/84'/<coinType>'/0'/0/x).
 	for i := uint32(0); i < c.RecoveryWindow; i++ {
-		derivedKey, err := btc.DeriveChildren(extendedKey, []uint32{
-			btc.HardenedKeyStart + uint32(84),
-			btc.HardenedKeyStart + chainParams.HDCoinType,
-			btc.HardenedKeyStart + uint32(0),
+		derivedKey, err := lnd.DeriveChildren(extendedKey, []uint32{
+			lnd.HardenedKeyStart + uint32(84),
+			lnd.HardenedKeyStart + chainParams.HDCoinType,
+			lnd.HardenedKeyStart + uint32(0),
 			0,
 			i,
 		})
@@ -102,10 +102,10 @@ func (c *genImportScriptCommand) Execute(_ []string) error {
 
 	// Now the internal branch (m/84'/<coinType>'/0'/1/x).
 	for i := uint32(0); i < c.RecoveryWindow; i++ {
-		derivedKey, err := btc.DeriveChildren(extendedKey, []uint32{
-			btc.HardenedKeyStart + uint32(84),
-			btc.HardenedKeyStart + chainParams.HDCoinType,
-			btc.HardenedKeyStart + uint32(0),
+		derivedKey, err := lnd.DeriveChildren(extendedKey, []uint32{
+			lnd.HardenedKeyStart + uint32(84),
+			lnd.HardenedKeyStart + chainParams.HDCoinType,
+			lnd.HardenedKeyStart + uint32(0),
 			1,
 			i,
 		})
diff --git a/cmd/chantools/rescueclosed.go b/cmd/chantools/rescueclosed.go
@@ -12,8 +12,8 @@ import (
 	"github.com/btcsuite/btcd/btcec"
 	"github.com/btcsuite/btcutil"
 	"github.com/btcsuite/btcutil/hdkeychain"
-	"github.com/guggero/chantools/btc"
 	"github.com/guggero/chantools/dataformat"
+	"github.com/guggero/chantools/lnd"
 	"github.com/lightningnetwork/lnd/channeldb"
 	"github.com/lightningnetwork/lnd/input"
 	"github.com/lightningnetwork/lnd/keychain"
@@ -197,10 +197,10 @@ func fillCache(extendedKey *hdkeychain.ExtendedKey) error {
 	cache = make([]*cacheEntry, cacheSize)
 
 	for i := 0; i < cacheSize; i++ {
-		key, err := btc.DeriveChildren(extendedKey, []uint32{
-			btc.HardenedKeyStart + uint32(keychain.BIP0043Purpose),
-			btc.HardenedKeyStart + chainParams.HDCoinType,
-			btc.HardenedKeyStart +
+		key, err := lnd.DeriveChildren(extendedKey, []uint32{
+			lnd.HardenedKeyStart + uint32(keychain.BIP0043Purpose),
+			lnd.HardenedKeyStart + chainParams.HDCoinType,
+			lnd.HardenedKeyStart +
 				uint32(keychain.KeyFamilyPaymentBase),
 			0,
 			uint32(i),
diff --git a/cmd/chantools/sweeptimelock.go b/cmd/chantools/sweeptimelock.go
@@ -12,6 +12,7 @@ import (
 	"github.com/btcsuite/btcutil/hdkeychain"
 	"github.com/guggero/chantools/btc"
 	"github.com/guggero/chantools/dataformat"
+	"github.com/guggero/chantools/lnd"
 	"github.com/lightningnetwork/lnd/input"
 )
 
@@ -72,7 +73,7 @@ func sweepTimeLock(extendedKey *hdkeychain.ExtendedKey, apiURL string,
 	publish bool) error {
 
 	// Create signer and transaction template.
-	signer := &btc.Signer{
+	signer := &lnd.Signer{
 		ExtendedKey: extendedKey,
 		ChainParams: chainParams,
 	}
diff --git a/cmd/chantools/walletinfo.go b/cmd/chantools/walletinfo.go
@@ -111,7 +111,7 @@ func walletInfo(w *wallet.Wallet) error {
 		},
 	})
 	if err != nil {
-		return fmt.Errorf("unable to open key ring for coin type %d: " +
+		return fmt.Errorf("unable to open key ring for coin type %d: "+
 			"%v", chainParams.HDCoinType, err)
 	}
 	idPrivKey.Curve = btcec.S256()
diff --git a/lnd/channel.go b/lnd/channel.go
@@ -1,4 +1,4 @@
-package btc
+package lnd
 
 import (
 	"github.com/btcsuite/btcd/txscript"
diff --git a/lnd/hdkeychain.go b/lnd/hdkeychain.go
@@ -1,4 +1,4 @@
-package btc
+package lnd
 
 import (
 	"fmt"
diff --git a/lnd/signer.go b/lnd/signer.go
@@ -1,4 +1,4 @@
-package btc
+package lnd
 
 import (
 	"fmt"

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`
`6`	`6`	`"github.com/btcsuite/btcutil"`
`7`	`7`	`"github.com/btcsuite/btcutil/hdkeychain"`
`8`		`- "github.com/guggero/chantools/btc"`
	`8`	`+ "github.com/guggero/chantools/lnd"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`type deriveKeyCommand struct {`
`@@ -41,11 +41,11 @@ func deriveKey(extendedKey *hdkeychain.ExtendedKey, path string,`
`41`	`41`	`neuter bool) error {`
`42`	`42`
`43`	`43`	`fmt.Printf("Deriving path %s for network %s.\n", path, chainParams.Name)`
`44`		`- parsedPath, err := btc.ParsePath(path)`
	`44`	`+ parsedPath, err := lnd.ParsePath(path)`
`45`	`45`	`if err != nil {`
`46`	`46`	`return fmt.Errorf("could not parse derivation path: %v", err)`
`47`	`47`	`}`
`48`		`- derivedKey, err := btc.DeriveChildren(extendedKey, parsedPath)`
	`48`	`+ derivedKey, err := lnd.DeriveChildren(extendedKey, parsedPath)`
`49`	`49`	`if err != nil {`
`50`	`50`	`return fmt.Errorf("could not derive children: %v", err)`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,8 @@ import (`
`5`	`5`
`6`	`6`	`"github.com/btcsuite/btcutil/hdkeychain"`
`7`	`7`	`"github.com/davecgh/go-spew/spew"`
`8`		`- "github.com/guggero/chantools/btc"`
`9`	`8`	`"github.com/guggero/chantools/dump"`
	`9`	`+ "github.com/guggero/chantools/lnd"`
`10`	`10`	`"github.com/lightningnetwork/lnd/chanbackup"`
`11`	`11`	`"github.com/lightningnetwork/lnd/keychain"`
`12`	`12`	`)`
`@@ -41,7 +41,7 @@ func (c *dumpBackupCommand) Execute(_ []string) error {`
`41`	`41`	`return fmt.Errorf("backup file is required")`
`42`	`42`	`}`
`43`	`43`	`multiFile := chanbackup.NewMultiFile(c.MultiFile)`
`44`		`- keyRing := &btc.HDKeyRing{`
	`44`	`+ keyRing := &lnd.HDKeyRing{`
`45`	`45`	`ExtendedKey: extendedKey,`
`46`	`46`	`ChainParams: chainParams,`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import (`
`7`	`7`	`"time"`
`8`	`8`
`9`	`9`	`"github.com/btcsuite/btcutil/hdkeychain"`
`10`		`- "github.com/guggero/chantools/btc"`
	`10`	`+ "github.com/guggero/chantools/lnd"`
`11`	`11`	`"github.com/lightningnetwork/lnd/chanbackup"`
`12`	`12`	`"github.com/lightningnetwork/lnd/keychain"`
`13`	`13`	`)`
`@@ -46,7 +46,7 @@ func (c *filterBackupCommand) Execute(_ []string) error {`
`46`	`46`	`return fmt.Errorf("backup file is required")`
`47`	`47`	`}`
`48`	`48`	`multiFile := chanbackup.NewMultiFile(c.MultiFile)`
`49`		`- keyRing := &btc.HDKeyRing{`
	`49`	`+ keyRing := &lnd.HDKeyRing{`
`50`	`50`	`ExtendedKey: extendedKey,`
`51`	`51`	`ChainParams: chainParams,`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"time"`
`7`	`7`
`8`	`8`	`"github.com/btcsuite/btcutil/hdkeychain"`
`9`		`- "github.com/guggero/chantools/btc"`
	`9`	`+ "github.com/guggero/chantools/lnd"`
`10`	`10`	`"github.com/lightningnetwork/lnd/chanbackup"`
`11`	`11`	`"github.com/lightningnetwork/lnd/keychain"`
`12`	`12`	`)`
`@@ -40,15 +40,15 @@ func (c *fixOldBackupCommand) Execute(_ []string) error {`
`40`	`40`	`return fmt.Errorf("backup file is required")`
`41`	`41`	`}`
`42`	`42`	`multiFile := chanbackup.NewMultiFile(c.MultiFile)`
`43`		`- keyRing := &btc.HDKeyRing{`
	`43`	`+ keyRing := &lnd.HDKeyRing{`
`44`	`44`	`ExtendedKey: extendedKey,`
`45`	`45`	`ChainParams: chainParams,`
`46`	`46`	`}`
`47`	`47`	`return fixOldChannelBackup(multiFile, keyRing)`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`func fixOldChannelBackup(multiFile *chanbackup.MultiFile,`
`51`		`- ring *btc.HDKeyRing) error {`
	`51`	`+ ring *lnd.HDKeyRing) error {`
`52`	`52`
`53`	`53`	`multi, err := multiFile.ExtractMulti(ring)`
`54`	`54`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ import (`
`14`	`14`	`"github.com/btcsuite/btcutil/hdkeychain"`
`15`	`15`	`"github.com/guggero/chantools/btc"`
`16`	`16`	`"github.com/guggero/chantools/dataformat"`
	`17`	`+ "github.com/guggero/chantools/lnd"`
`17`	`18`	`"github.com/lightningnetwork/lnd/channeldb"`
`18`	`19`	`"github.com/lightningnetwork/lnd/input"`
`19`	`20`	`)`
`@@ -49,7 +50,7 @@ func (c *forceCloseCommand) Execute(_ []string) error {`
`49`	`50`	`return fmt.Errorf("rescue DB is required")`
`50`	`51`	`}`
`51`	`52`	`db, err := channeldb.Open(`
`52`		`- path.Dir(c.ChannelDB),channeldb.OptionSetSyncFreelist(true),`
	`53`	`+ path.Dir(c.ChannelDB), channeldb.OptionSetSyncFreelist(true),`
`53`	`54`	`channeldb.OptionReadOnly(true),`
`54`	`55`	`)`
`55`	`56`	`if err != nil {`
`@@ -73,7 +74,7 @@ func forceCloseChannels(extendedKey *hdkeychain.ExtendedKey,`
`73`	`74`	`return err`
`74`	`75`	`}`
`75`	`76`	`api := &btc.ExplorerAPI{BaseURL: cfg.APIURL}`
`76`		`- signer := &btc.Signer{`
	`77`	`+ signer := &lnd.Signer{`
`77`	`78`	`ExtendedKey: extendedKey,`
`78`	`79`	`ChainParams: chainParams,`
`79`	`80`	`}`
`@@ -103,7 +104,7 @@ func forceCloseChannels(extendedKey *hdkeychain.ExtendedKey,`
`103`	`104`	`}`
`104`	`105`
`105`	`106`	`// Create signed transaction.`
`106`		`- lc := &btc.LightningChannel{`
	`107`	`+ lc := &lnd.LightningChannel{`
`107`	`108`	`LocalChanCfg: channel.LocalChanCfg,`
`108`	`109`	`RemoteChanCfg: channel.RemoteChanCfg,`
`109`	`110`	`ChannelState: channel,`