Skip to content
Official Rust implementation of the Nimiq protocol
Branch: master
Clone or download
faberto and jgraef Readme: update example.toml link. (#28)
Text was correct but underlying link did not point to the correct file.
Latest commit e9b741c May 27, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix Markdown issue in Contributing Guidelines Feb 5, 2019
accounts Remove gitlab badge May 24, 2019
beserial Remove gitlab badge May 24, 2019
block-production Remove gitlab badge May 24, 2019
blockchain Remove gitlab badge May 24, 2019
client Remove gitlab badge May 24, 2019
collections Remove gitlab badge May 24, 2019
consensus Remove gitlab badge May 24, 2019
database Remove gitlab badge May 24, 2019
docs
fixed-unsigned Remove gitlab badge May 24, 2019
hash Remove gitlab badge May 24, 2019
key-derivation Remove gitlab badge May 24, 2019
keys Remove gitlab badge May 24, 2019
lib Remove gitlab badge May 24, 2019
libargon2-sys Remove gitlab badge May 24, 2019
macros Remove gitlab badge May 24, 2019
mempool Remove gitlab badge May 24, 2019
messages Remove gitlab badge May 24, 2019
metrics-server Remove gitlab badge May 24, 2019
mnemonic Remove gitlab badge May 24, 2019
network-primitives Remove gitlab badge May 24, 2019
network Update tungstenite dependencies May 24, 2019
primitives Fix standalone compilation of primitives crate May 24, 2019
rpc-server Remove gitlab badge May 24, 2019
scripts Script to calculate crate publish order May 1, 2019
utils Remove gitlab badge May 24, 2019
.coveralls.yml Add coveralls Jul 3, 2018
.gitignore Polished client UX: May 1, 2019
.gitlab-ci.yml New coverage based on manual kcov invocation Nov 15, 2018
.travis.yml Revert travis config to test on nightly channel Apr 16, 2019
Cargo.toml Moving account, block, transaction into their own crates Feb 14, 2019
LICENSE.md
README.md Readme: update example.toml link. (#28) May 27, 2019

README.md

Nimiq Core implementation in Rust (core-rs)

nimiq

Rust implementation of the Nimiq Blockchain Core

Nimiq is a frictionless payment protocol for the web.

This repository is Work in Progress and is currently in beta-testing phase. If you need a reliable client implementation to run in a production environment, please use the JavaScript implementation instead. Only use this if you can tolerate bugs and want to help with beta-testing the Nimiq Rust implementation.

The Nimiq Rust client comes without wallet and can currently not be used to send transactions. As a back-bone node it is more performant than the JavaScript implementation though.

Table of Contents

Background

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)

From crates.io

To download from crates.io, compile and install the client:

cargo +nightly install nimiq-client

The binary will be installed in your Cargo directory, which is usually at $HOME/.cargo/bin, and should be available in your $PATH.

From Git

Compiling the project is achieved through cargo:

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

Note that this will build it in debug mode, which is not as performant. To get the most speed out of the client, build it in release mode:

cargo +nightly build --release

If you want to install the client onto your system (into $HOME/.cargo/bin), run:

cargo +nightly install --path client/

Alternatively you can install directly from git:

cargo +nightly install --git https://github.com/nimiq/core-rs.git

After installing the client you can use it as if you had downloaded it from crates.io.

Usage

Configuration

By default the client will look for a configuration file in $HOME/.nimiq/client.config. You need to create this file yourself:

nimiq-client                                                   # Run the client. This will create the example config file.
cp $HOME/.nimiq/client.example.toml $HOME/.nimiq/client.toml   # Create your config from the example.
nano $HOME/.nimiq/client.toml                                  # Edit the config. Explanations are included in the file.

You can also specify your own configuration file:

nimiq-client -c path/to/client.toml

Take a look at client/client.example.toml for all the configuration options.

From crates.io

If you installed the client from crates.io, you can just run it with:

nimiq-client

From Git

To run the Nimiq Rust Client from the downloaded sources:

cd core-rs/client
cargo run

Dependencies and binaries will be downloaded and compiled automatically by Cargo.

If you want to use the release build:

cd core-rs/client
cargo run --release

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.

You can’t perform that action at this time.