[![Build](https://github.com/nimiq-community/rust-client/actions/workflows/build.yml/badge.svg)](https://github.com/nimiq-community/rust-client/actions/workflows/build.yml)
[![Crates.io](https://img.shields.io/crates/v/nimiq_rpc.svg)](https://crates.io/crates/nimiq_rpc)
# Nimiq Rust Client

> Rust implementation of the Nimiq RPC client specs.

## About

A Nimiq RPC client library in Rust. This client library implements the [Nimiq RPC specification](https://github.com/nimiq/core-js/wiki/JSON-RPC-API).
The client uses the `jsonrpsee` library to handle JSON-RPC 2.0 requests and responses. For more information about this
library see the [jsonrpsee HTTP client documentation](https://docs.rs/jsonrpsee-http-client/0.20.0/jsonrpsee_http_client/).

## Usage

``` rust
use nimiq_rpc::Client;

#[tokio::main]
async fn main() {
	let client = Client::new("http://seed-host.com:8648/".to_string());
	// If your node uses credentials
	let client = Client::new_with_credentials("http://seed-host.com:8648/".to_string(), "user".to_string(), "password".to_string());
	
	println!("{:?}", client.accounts().await.unwrap());
	println!("{:?}", client.block_number().await.unwrap());
	println!("{:?}", client.hashrate().await.unwrap());
	println!("{:?}", client.log("*", "log").await.unwrap());
}
```

## Documentation

[Docs.rs link](https://docs.rs/nimiq_rpc) to the official crate documentation. And check out the [Nimiq RPC specs](https://github.com/nimiq/core-js/wiki/JSON-RPC-API) for details.

## Installation

Add the [crate](https://crates.io/crates/nimiq_rpc) to your `Cargo.toml` file.

## Contributions

This implementation was originally contributed by [Eligioo](https://github.com/eligioo/).

Please send your contributions as pull requests.
Refer to the [issue tracker](https://github.com/nimiq-community/rust-client/issues) for ideas.

## License

[Apache 2.0](LICENSE.md)