/core-rs-albatross

Rust implementation of the Albatross protocol

Primary LanguageRustOtherNOASSERTION

Nimiq Proof-of-Stake

nimiq

Rust implementation of the Nimiq Proof-of-Stake blockchain.

Build Status dependency status

Nimiq is a frictionless payment protocol for the web.

This repository is currently under development. It contains the implementation of the Nimiq Proof-of-Stake protocol based on the Albatross consensus algorithm.

Nimiq Proof-of-Stake was conceived with performance in mind without sacrificing security.

Currently, the protocol can be exercised in an environment aimed for developers where bugs are expected to happen. For more detailed information about how to connect and use the testnet network, please refer to the Testnet section.

Table of Contents

Background

System requirements

  • 64-bit computing architecture.
  • File systems with sparse file support.
  • It is highly recommended to run a clock synchronization protocol such as NTP. This is needed for properly accept blocks according to the timestamp and it is specially important for validators in order to produce blocks in the expected timestamps.

Installation

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

  • clang
  • cmake
  • libssl-dev (in Debian/Ubuntu) or openssl-devel (in Fedora/Red Hat)
  • pkg-config
  • protobuf-compiler

After installing the previous packages, compiling the project is achieved through cargo:

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

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

cargo build --release

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

cargo install --path client/

Alternatively, you can install it directly from git:

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

Usage

After installation, you can run the client directly, like this:

nimiq-client

Configuration

By default the client will look for a configuration file in $HOME/.nimiq/client.toml. In order to create this file yourself, you can use the example config file as follow:

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.

If you want to direcly specify your own configuration file when running the client, you can do so as follow:

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

Please take a look at the client.example.toml for all the configuration options.

Testnet

The testnet network is currently in a phase open to the general public to use. Its main purpose is to invite everyone to exercise and test the Nimiq Proof-of-Stake functionality and we invite people to file and report any issues through our GitHub repository.

Getting funds

There are two ways of getting funds:

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "address=NQXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX" https://faucet.pos.nimiq-testnet.com/tapit

Becoming a validator

Check this guide for steps on becoming a validator.

Contributing

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

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

License

This project is licensed under the Apache License 2.0.