Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.81 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.81 KB
Raw

Rust RPC client for Groestlcoin Core JSON-RPC

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

This git package compiles into two crates.

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

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

Usage

Given below is an example of how to connect to the Groestlcoin Core JSON-RPC for a Groestlcoin 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 1441 and the node is set up to accept RPC connections.

extern crate groestlcoincore_rpc;

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

fn main() {

    let rpc = Client::new("http://localhost:1441",
                          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 Groestlcoin Core Versions

The following versions are officially supported and automatically tested:

  • 2.18.2
  • 2.19.1
  • 2.20.1
  • 2.21.0

Minimum Supported Rust Version (MSRV)

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