Nimiq Core implementation in Rust (core-rs)

Rust implementation of the Nimiq Blockchain Core

Nimiq is a frictionless payment protocol for the web.

This repository is Work in Progress and should only be used for testing purposes, it is not production ready yet. If you need a client implementation to run in a production environment, please use the JavaScript implementation instead.

Table of Contents

• Background
• Install
• Usage
• Contributing
• License

Background

• Nimiq White Paper: High-level introduction of the Nimiq payment protocol.
• Nimiq Developer Reference: Details of the protocol architecture.
• Testnet: Demo of the Nimiq ecosystem in a test version of the network.

Install

Besides Rust itself, the following packages are required to be able to compile this source code:

• gcc
• pkg-config
• libssl-dev (in Debian/Ubuntu) or openssl-dev (in Fedora/Red Hat)

Compiling the project is achieved through cargo:

git clone https://github.com/nimiq/core-rs
cd core-rs
cargo build

Usage

Once compiled, you can run the Nimiq Rust Client directly or through cargo run:

cargo run --bin nimiq

To display log output, set the RUST_LOG environment variable: RUST_LOG=nimiq=debug.

Contributing

If you'd like to contribute to the development of Nimiq please follow our Code of Conduct and Contributing Guidelines.

Small note: If editing the README, please conform to the standard-readme specification.

License

This project is under the Apache License 2.0.