Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.81 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.81 KB
Raw

Status

Rust RPC client for Kaon Core JSON-RPC

This is a Rust RPC client library for calling the Kaon Core JSON-RPC API. It provides a layer of abstraction over rust-jsonrpc and makes it easier to talk to the Kaon JSON-RPC interface

This git package compiles into two crates.

  1. kaon-rpc - contains an implementation of an rpc client that exposes the Kaon Core JSON-RPC APIs as rust functions.

  2. kaon-rpc-json - contains rust data structures that represent the json responses from the Kaon Core JSON-RPC APIs. kaon-rpc depends on this.

Usage

Given below is an example of how to connect to the Kaon Core JSON-RPC for a Kaon 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.

extern crate kaon_rpc;

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

fn main() {

    let rpc = Client::new("http://localhost:8332",
                          Auth::UserPass("<FILL RPC USERNAME>".to_string(),
                                         "<FILL RPC PASSWORD>".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/Kaon Core Versions

The following versions are officially supported and automatically tested:

  • 1.0.0
  • 1.0.1
  • 1.1.1

Minimum Supported Rust Version (MSRV)

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