There are two primary purposes of this repository.
- Provide the
bitcoind-json-rpc-types
crate for use in production software. - Provide tools to the community for integration testing code written in Rust that interacts with
the Bitcoin network. Primarily consumers of the
rust-bitcoin
library. And enable doing so against multiple versions of Bitcoin Core.
If you require a JSON RPC client in production software it is expected you write your own and only
use the bitcoind-json-rpc-types
crate in your dependency graph. Feel free to copy/steal/plagiarise
or otherwise enjoy yourself with anything in this repository - no attribution required.
Please do not use client
in production and raise bugs, issues, or feature requests.
json
: Rust types returned by the JSON-RPC API of Bitcoin Core (bitcoind-json-rpc-types
).regtest
: Runsbitcoind
regtest nodes.client
: A blocking JSON-RPC client used to testbitcoind-json-rpc-types
.integration_test
: Integration tests that useclient
andregtest
to testjson
.
I don't know who is using bitcoind
and/or rust-bitocincore-rpc
in the wild and I do not want to
disrupt them. As such bitcoind
was pulled in here with permission of the original author. Code
from rust-bitcoincore-rpc
was just shamelessy stolen. As such I have maintained the original
author's list and added my own name for accountability. All bugs are my own (tcharding).
This library should always compile with any combination of features on Rust 1.63.0.
Use Cargo-minimal.lock
to build the MSRV by copying to Cargo.lock
and building.