https://github.com/rust-bitcoin/rust-bitcoincore-rpc

Rust RPC client library for the Bitcoin Core JSON-RPC API.
https://github.com/rust-bitcoin/rust-bitcoincore-rpc

Last synced: about 16 hours ago
JSON representation

Rust RPC client library for the Bitcoin Core JSON-RPC API.

• Host: GitHub
• URL: https://github.com/rust-bitcoin/rust-bitcoincore-rpc
• Owner: rust-bitcoin
• Created: 2018-11-12T16:06:22.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-14T19:44:57.000Z (3 months ago)
• Last Synced: 2024-10-18T22:11:59.935Z (27 days ago)
• Language: Rust
• Size: 698 KB
• Stars: 335
• Watchers: 17
• Forks: 247
• Open Issues: 87
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
[![Status](https://travis-ci.org/rust-bitcoin/rust-bitcoincore-rpc.png?branch=master)](https://travis-ci.org/rust-bitcoin/rust-bitcoincore-rpc)

# Rust RPC client for Bitcoin Core JSON-RPC 

This is a Rust RPC client library for calling the Bitcoin Core JSON-RPC API. It provides a layer of abstraction over 

[rust-jsonrpc](https://github.com/apoelstra/rust-jsonrpc) and makes it easier to talk to the Bitcoin JSON-RPC interface 

This git package compiles into two crates.

1. [bitcoincore-rpc](https://crates.io/crates/bitcoincore-rpc) - contains an implementation of an rpc client that exposes 

the Bitcoin Core JSON-RPC APIs as rust functions.

2. [bitcoincore-rpc-json](https://crates.io/crates/bitcoincore-rpc-json) -  contains rust data structures that represent 

the json responses from the Bitcoin Core JSON-RPC APIs. bitcoincore-rpc depends on this.

# Usage

Given below is an example of how to connect to the Bitcoin Core JSON-RPC for a Bitcoin Core node running on `localhost`

and print out the hash of the latest block.

It assumes that the node has password authentication setup, the RPC interface is enabled at port `8332` and the node

is set up to accept RPC connections. 

```rust

extern crate bitcoincore_rpc;

use bitcoincore_rpc::{Auth, Client, RpcApi};

fn main() {

    let rpc = Client::new("http://localhost:8332",

                          Auth::UserPass("".to_string(),

                                         "".to_string())).unwrap();

    let best_block_hash = rpc.get_best_block_hash().unwrap();

    println!("best block hash: {}", best_block_hash);

}

```

See `client/examples/` for more usage examples. 

# Supported Bitcoin Core Versions

The following versions are officially supported and automatically tested:

* 0.18.0

* 0.18.1

* 0.19.0.1

* 0.19.1

* 0.20.0

* 0.20.1

* 0.21.0

# Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on **Rust 1.56.1**.