cyberflamego / core-rs-albatross

Rust implementation of the Albatross protocol

Nimiq 2.0 implementation in Rust

Rust implementation of the Nimiq 2.0 blockchain node

Nimiq is a frictionless payment protocol for the web.

This repository is currently under development. It contains the implementation of the Nimiq 2.0 protocol: a Proof-of-stake blockchain based on the Albatross consensus algorithm.

Nimiq 2.0 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 development network, please refer to the Devnet section.

Table of Contents

• Background
• System requirements
• Installation
• Usage
• Configuration
• Devnet
• Contributing
• License

Background

• Nimiq 2.0 Portal: General information and high level details of the Nimiq 2.0 blockchain
• Nimiq Albatross White Paper: White paper describing the consensus algorithm used in Nimiq 2.0
• Nimiq 2.0 migration process: Migration process from Nimiq 1.0 to 2.0
• Nimiq 1.0 Developer Reference: Details of the protocol architecture.
• Nimiq 1.0 JavaScript implementation: Nimiq 1.0 implementation

System requirements

• 64-bit computing architecture.
• File systems with sparse file support.

Installation

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

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

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 +nightly 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 +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 it directly from git:

cargo +nightly 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.

Devnet

The development network is currently in release-candidate phase rc2. Its main purpose is to invite all developers to exercise and test the Nimiq 2.0 client, filing and reporting any issues through our GitHub repository.

Clients can connect to the Devnet via the seed node located at

/dns4/seed1.v2.nimiq-testnet.com/tcp/8443/ws

And get funds to experiment with it (for example, by becoming a validator) using the Devnet Faucet:

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

For a full list of supported and non-supported functionality, please refer to the Nimiq 2.0 Devnet project.

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.