BDK wallet integration

[evanlinjin]

This is still WIP.

Architectural Decisions:

I decided to not use https://github.com/bitcoindevkit/bdk-ffi/tree/master as I wanted more flexibility with how wallets are persisted (right now). In the future we want to store utreexo proofs in the wallet, use chain.BlockChain as BDK's ChainOracle, etc. To do this, we should use bdk_chain structures directly and move away from bdk::Wallet (which bdk-ffi only supports).

How to build:

Run buildbdkgo.sh from the root dir:

$ ./buildbdkgo.sh

TODO:

- [ ] Figure out where to put libbdkgo static library and have it available for multiple targets.

• Have a better script for compiling static library.
• Expose method(s) for creating and signing transactions.
• Implement RPC interface for wallet stuff.

[evanlinjin]

The last remaining task is to expose BDK wallet commands via RPC. @kcalvinalvin will handle this!

[kcalvinalvin]

For the linter failing on generated files, you can apply the below to goclean.sh:

diff --git a/goclean.sh b/goclean.sh
index e77d580b..cadfaa7a 100755
--- a/goclean.sh
+++ b/goclean.sh
@@ -14,4 +14,5 @@ golangci-lint run --deadline=10m --disable-all \
 --enable=gofmt \
 --enable=vet \
 --enable=gosimple \
---enable=unconvert
+--enable=unconvert \
+--skip-dirs=bdkwallet/bdkgo # these are generated files

[kcalvinalvin]

Two initial requests for splitting up the PR for easier review/merging:

1: Could we make c9e4326 into a separate PR? It can be an immediate merge.
2: Could we make the code for generating the bindings a separate commit as well?

[evanlinjin]

@kcalvinalvin also mentioned to add doc comments to all exported Golang code.

[kcalvinalvin]

bdk wallet should be enabled by default. We should make users disable it if they don't want it.

diff --git a/config.go b/config.go
index ac7cb9e3..cebacb72 100644
--- a/config.go
+++ b/config.go
@@ -216,7 +216,7 @@ type config struct {
        RegisterAddressToWatchOnlyWallet                     []string `long:"registeraddresstowatchonlywallet" description:"Registers addresses to be watched to the watch only wallet. Must have --watchonlywallet enabled"`
        RegisterExtendedPubKeysToWatchOnlyWallet             []string `long:"registerextendedpubkeystowatchonlywallet" description:"Registers extended pubkeys to be watched to the watch only wallet. Must have --watchonlywallet enabled."`
        RegisterExtendedPubKeysWithAddrTypeToWatchOnlyWallet []string `long:"registerextendedpubkeyswithaddresstypetowatchonlywallet" description:"Registers extended pubkeys to be watched to the watch only wallet and let's the user override the hd type of the extended public key. Must have --watchonlywallet enabled. Format: '<extendedpubkey>:<address type>. Supported address types: '{p2pkh, p2wpkh, p2sh}'"`
-       BdkWallet                                            bool     `long:"bdkwallet" description:"Enable the BDK wallet."`
+       NoBdkWallet                                          bool     `long:"nobdkwallet" description:"Disable the BDK wallet."`
 
        // Electrum server options.
        ElectrumListeners    []string `long:"electrumlisteners" description:"Interface/port for the electrum server to listen to. (default 50001). Electrum server is only enabled when --watchonlywallet is enabled"`
diff --git a/server.go b/server.go
index 5b524a64..ee4ada32 100644
--- a/server.go
+++ b/server.go
@@ -3533,7 +3533,7 @@ func newServer(listenAddrs, agentBlacklist, agentWhitelist []string,
                }
        }
 
-       if cfg.BdkWallet {
+       if !cfg.NoBdkWallet {
                // Setup BDK wallet if it is enabled.
                s.bdkWallet, err = bdkwallet.NewManager(bdkwallet.ManagerConfig{
                        Chain:       s.chain,
diff --git a/utreexod.go b/utreexod.go
index 38981b22..479a53b0 100644
--- a/utreexod.go
+++ b/utreexod.go
@@ -185,7 +185,7 @@ func btcdMain(serverChan chan<- *server) error {
                        btcdLog.Error(err)
                        return err
                }
-               if walletDirExists && !cfg.BdkWallet {
+               if walletDirExists && cfg.NoBdkWallet {
                        err = fmt.Errorf("BDK wallet is disabled but this node has been previously "+
                                "started with BDK wallet enabled with walletdir of \"%v\". Please "+
                                "completely remove the walletdir to start the node without wallet.",

[kcalvinalvin]

Could we also add make clean and make all?

diff --git a/Makefile b/Makefile
index 3ae8d068..4f238250 100644
--- a/Makefile
+++ b/Makefile
@@ -16,3 +16,10 @@ build-utreexod: build-bdk ## Build utreexod with all features
 
 build-utreexod-without-bdk: ## Build utreexod without BDK wallet
        go build
+
+all: build-bdk build-utreexod
+
+clean:
+       rm utreexod
+       go clean
+       cargo clean