EXP-189: replace homegrown Bitcoin RPC for bitcoind-json-rpc-types

[storopoli]

Description

Replacing our homegrown solution with an off-the-shelf crate,
bitcoind-json-rpc-types(https://crates.io/crates/bitcoind-json-rpc-types).

Also tried to improve all the docstrings of the functions that I had to touch.

I gave up going full rust-bitcoin and replacing all u64s with proper bitcoin::Amount and bitcoin::absolute::Height.
This PR is huge as it is. I'll open a new ticket.

We have 4 kinds of traits for clients that somehow interface with the bitcoin blockchain/node:

1. BitcoinReader: these only consume stuff from the blockchain.
2. BitcoinBroadcaster: can broadcast things to the blockchain (for now only has the send_raw_transaction).
3. BitcoinSigner: the one that signs, i.e. has the private keys.
4. BitcoinWallet: could be a watch-only wallet that only has Xpubs.

Right now I don't see a huge advantage in that, hence I'll move that to a ticket.

I also got rid of a bunch of custom types and tried to use the ones bitcoind-json-rpc-types provided, and if not possible I've create some new types following the convention of bitcoind-json-rpc-types. These might be upstreamed later as a PR to it. These are:

• ListUnspent: the result of the call listunspent
• ListTransactions: the result of call listtransactions
• SignRawTransactionWithWallet: the result of call signtransactionwithwallet

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature/Enhancement (non-breaking change which adds functionality or enhances an existing one)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Refactor

Checklist

• I have performed a self-review of my code.
• I have commented my code where necessary.
• I have updated the documentation if needed.
• My changes do not introduce new warnings.
• I have added tests that prove my changes are effective or that my feature works.
• New and existing tests pass with my changes.

Related Issues

EXP-189
Closes #81.

[codecov]

Codecov Report

Attention: Patch coverage is 72.00000% with 175 lines in your changes missing coverage. Please review.

Project coverage is 58.20%. Comparing base (cedf7a9) to head (51cc522).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
crates/btcio/src/rpc/types.rs	54.76%	57 Missing ⚠️
crates/btcio/src/test_utils.rs	55.23%	47 Missing ⚠️
crates/btcio/src/rpc/error.rs	0.00%	32 Missing ⚠️
crates/btcio/src/rpc/client.rs	92.00%	18 Missing ⚠️
crates/btcio/src/reader/query.rs	0.00%	7 Missing ⚠️
sequencer/src/main.rs	0.00%	4 Missing ⚠️
crates/btcio/src/broadcaster/task.rs	92.85%	2 Missing ⚠️
crates/btcio/src/writer/config.rs	0.00%	2 Missing ⚠️
crates/btcio/src/writer/task.rs	0.00%	2 Missing ⚠️
crates/btcio/src/broadcaster/handle.rs	0.00%	1 Missing ⚠️
... and 3 more

@@            Coverage Diff             @@
##           master     #251      +/-   ##
==========================================
+ Coverage   56.53%   58.20%   +1.67%     
==========================================
  Files         132      133       +1     
  Lines       14223    14404     +181     
==========================================
+ Hits         8041     8384     +343     
+ Misses       6182     6020     -162     

Files with missing lines	Coverage Δ
crates/btcio/src/broadcaster/state.rs	97.26% <100.00%> (+1.09%)	⬆️
crates/db/src/types.rs	95.45% <100.00%> (-4.55%)	⬇️
crates/rocksdb-store/src/broadcaster/db.rs	99.46% <100.00%> (ø)
crates/storage/src/ops/l1tx_broadcast.rs	87.93% <100.00%> (+0.43%)	⬆️
crates/btcio/src/broadcaster/handle.rs	45.45% <0.00%> (ø)
crates/btcio/src/writer/builder.rs	97.98% <98.43%> (+0.13%)	⬆️
crates/btcio/src/writer/signer.rs	98.27% <90.00%> (-1.73%)	⬇️
sequencer/src/l1_reader.rs	0.00% <0.00%> (ø)
crates/btcio/src/broadcaster/task.rs	88.17% <92.85%> (+0.23%)	⬆️
crates/btcio/src/writer/config.rs	0.00% <0.00%> (ø)
... and 7 more

... and 1 file with indirect coverage changes

[storopoli]

@bewakes can you help me debug what's going with the functional tests?

[storopoli]

Ok we are hitting paritytech/jsonrpsee#888 which exactly mentions bitcoind rpc server.
Let's go back to reqwest. Wasted a lot of time thinking that "I" was doing something stupid but in fact it was a mess of jsonrpsee not wanting to deviate from the spec and bitcoind not adhering to the spec.

Theoretically this is fixed in bitcoin/bitcoin#27101 but I cannot see from the release notes which version this was included.
It's better to be safe with reqwest since we don't know which bitcoin core version the user will eventually want to use.

[storopoli]

Ok this is ready for the reviews.

I have no idea why some functional tests are failing.
I made the API WAY MORE STRICTER with the types that it gets from the underlying bitcoind RPC with proper deserialization into rust-bitcoin types that do some checking under the hood for correctness.

[delbonis]

Generally looks good. Possibly could be using the storage ops interface in one place but I'm not completely sure.

[delbonis]

Looks good, minor comments.

[storopoli]

@delbonis all tests are now passing (thanks to @bewakes).
I've addressed all comments from last review round.