Unleash the power of Bitcoin Core into bdk-cli

rajarshimaitra commented 2 years ago

Description

fixes #62 fixes #76

This PR does the following

Bump bdk version to 0.19.
Opens up some basic bitcoin-core commands via a new sub-command bdk-cli node <command> [<args>]. The API of the node commands are kept very similar to bitcoin-cli api. This allows us to control the auto deployed backend node via regtest-* features from bdk-cli itself.
The Integration tests are written with std::Command from rust. That can be used to simulate various wallet transaction situations with bdk-cli, like #87.
These apis are also exposed in repl mode so now bdk-cli can have real time communication between a backend and a wallet in repl shell itself. Which can be very useful for quick runs of different testing conditions.

Notes to the reviewers

@sandipndev @krtk6160. This is the PR you guys can start working on top of to simulate the intended test situations. At least with bitcoind it can be done with all existing toolings. For LND some other wrapper needes to be built.

@notmandatory let me know what you think about the whole framework.

Also looking for more integration test ideas too add into.

basic node usage looks like this

$ ./target/debug/bdk-cli node --help
bdk-cli-node 0.5.0
Regtest Node mode

USAGE:
    bdk-cli node <SUBCOMMAND>

FLAGS:
    -h, --help       
            Prints help information

    -V, --version    
            Prints version information

SUBCOMMANDS:
    generate         Generate blocks
    getbalance       Get Wallet balance
    getinfo          Get info
    getnewaddress    Get new address from node's test wallet
    help             Prints this message or the help of the given subcommand(s)
    sendtoaddress    Send to an external wallet address

Checklists

All Submissions:

[x] I've signed all my commits
[x] I followed the contribution guidelines
[x] I ran cargo fmt and cargo clippy before committing

New Features:

[x] I've added tests for the new feature
[x] I've added docs for the new feature
[x] I've updated CHANGELOG.md

notmandatory commented 2 years ago

Hey @rajarshimaitra concept ACK! but I need to focus on the next bdk release (taproot!) so won't be able to do a through review until that's out.

rajarshimaitra commented 2 years ago

Ya thanks @notmandatory no issues.. I opened this early for discussion.. This can wait till other major things are done..

rajarshimaitra commented 2 years ago

Done some major refactoring.
Updated all the pending dependencies.
Updated to bdk v0.19.0
Broken down the commits into smaller chunks for easier review
Refactored the existing Backend struct
Backend now can be both bitcoind and electrum
Some minor update in the integration testing..

@notmandatory this PR is now ready for review..

Edit: The tests failure is due to version conflicts in bdk ocuring from bdk-reserves.. Working on a fix for that.. The PR can be code reviewed in the mean time..

rajarshimaitra commented 2 years ago

Updated the PR doc..

The current test failure at cargo build --features reserves,electrum --locked fixes with https://github.com/weareseba/bdk-reserves/pull/5

rajarshimaitra commented 2 years ago

Opened an alternate version of the same PR in #102.

Not closing this one yet, in case we need to revert back to previous crate structure..

rajarshimaitra commented 2 years ago

Closing this as we are moving ahead with #102

bitcoindevkit / bdk-cli