Repolode
Submit
nimiq

nimiq/core-rs-albatross

Rust implementation of the Nimiq Proof-of-Stake blockchain node, based on the Albatross consensus algorithm.

View on GitHubWebsite
Stars
172
Forks
74
Open issues
96
Last commit
8 hours ago

What is it?

Nimiq is a payment protocol for the web, and this repository contains the Rust implementation of its Proof-of-Stake network built on the Albatross consensus algorithm. It runs the client software that nodes use to join the Mainnet or the Testnet, validate blocks and participate in consensus.

The client can run in several roles: light nodes that sync quickly with minimal storage, full nodes that keep the complete recent state, and history nodes that store the full chain history, optionally with indexing. Validators can run on full or history nodes to produce blocks. Nodes are configured through a TOML file and expose a JSON-RPC interface on port 8648 and metrics on port 9100.

The project provides Docker images, detailed hardware requirements for each node type, and instructions for connecting to the Testnet with a faucet for test funds. It is licensed under Apache 2.0.

Key features

  • 01Runs light, full and history node types with different storage and sync trade-offs.
  • 02Supports validator operation for block production on full or history nodes.
  • 03Exposes a JSON-RPC interface for interacting with the network.
  • 04Configurable through a TOML file, with a sample configuration provided.
  • 05Ships Docker images and a Testnet option with a faucet for test funds.

Use cases

  • Running a Nimiq Proof-of-Stake node on the Mainnet or Testnet.
  • Operating a validator to produce blocks on the Nimiq network.
  • Hosting a history node that serves full chain data to services.
  • Building applications that query the network via JSON-RPC.

Quick start

  1. 1

    Install Rust and the build packages (clang, cmake, libssl-dev, pkg-config) from the README

  2. 2

    Clone the repository and build the project with cargo

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

    Install the client onto your system

    cargo install --path client/
  4. 4

    Run the client (generates a sample configuration file on first run)

    cargo run --release --bin nimiq-client

Things to know

  • Requires a Rust toolchain plus system packages such as clang, cmake and OpenSSL to compile.
  • History nodes need a special genesis configuration file on first start and require at least 1TB of storage.
  • Validators need at least 16GB RAM and a configuration setup before running.

Topics

#blockchain#proof-of-stake#rust#cryptography#consensus#json-rpc

FAQ

What is core-rs-albatross?
Rust implementation of the Nimiq Proof-of-Stake blockchain node, based on the Albatross consensus algorithm. Nimiq is a payment protocol for the web, and this repository contains the Rust implementation of its Proof-of-Stake network built on the Albatross consensus algorithm. It runs the client software that nodes use to join the Mainnet or the Testnet, validate blocks and participate in consensus.
Is core-rs-albatross free to use? What license does it have?
core-rs-albatross is open source under the Other license. Check the license terms before using it in commercial products.
Is core-rs-albatross still maintained?
Actively maintained. The last commit to core-rs-albatross was on Nov 6, 2026.
What can I use core-rs-albatross for?
Running a Nimiq Proof-of-Stake node on the Mainnet or Testnet. Operating a validator to produce blocks on the Nimiq network. Hosting a history node that serves full chain data to services. Building applications that query the network via JSON-RPC.
How do I install core-rs-albatross?
Install Rust and the build packages (clang, cmake, libssl-dev, pkg-config) from the README Clone the repository and build the project with cargo: git clone https://github.com/nimiq/core-rs-albatross cd core-rs-albatross cargo build --release Install the client onto your system: cargo install --path client/ Run the client (generates a sample configuration file on first run): cargo run --release --bin nimiq-client
Where can I get core-rs-albatross?
The source code and installation instructions are on GitHub: https://github.com/nimiq/core-rs-albatross

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects