The Ergo Reference Client (Node)#
The Ergo Node is the core software that connects to the Ergo P2P network, validates transactions and blocks, and maintains a copy of the entire blockchain. Running a node is crucial for the network's decentralization and security. This page outlines the installation options and resources for the Ergo reference client.
Alternatives
If you're simply looking for a secure place to store your ERG, see the wallets page. Some wallets like Satergo offer an integrated option to install and run a full node.
Installing the Ergo Reference Client
Minimum Requirements & Pre-requisites
Java
An Ergo node requires a JDK/JRE version >= 9 installed on your system. We recommend using Oracle Java SE or SDKMAN for Unix-based systems:
curl -s "https://get.sdkman.io" | bash
sdk install java 11.0.13.8.1-amzn
Hardware
The minimum hardware requirements are approximately ~20GB of storage for the blockchain and ~8GB of RAM for handling the initial sync. Due to potentially intensive disk I/O during sync, we recommend having at least 4-6GB of RAM available for the node process and using a fast SSD. Running with the -Xmx4G
flag on the JVM is advised.
Modes of operation
Ergo node offers various Modes of Operation for user flexibility. For quick sync and full node security, consider setting up a Pruned Full Node.
Full Archival Node
This mode stores the entire blockchain history. To install from scratch, refer to the manual install page for detailed instructions.
Pruned Full Node
Bootstrap a pruned full node using a verified UTXO set snapshot and NiPoPoWs. This feature allows you to achieve full node security on standard hardware within minutes, eliminating the need to download and validate most of the historical blockchain data.
Light Full Node
This mode only holds the root digest of the state dictionary and checks full blocks or a suffix of the blockchain, depending on the blocksToKeep
setting (History Pruning).
Per device
Android
Sync the entire Ergo blockchain on your mobile device!
Raspberri Pi
Run a node on a Raspberry Pi!
Developer Resources
Get setup on Testnet
Alternatively, if you want to get started on the testnet, there is a dedicated testnet setup guide available.
Use Docker
For more convenience, Docker provides a streamlined way to install and run the Ergo Node. Refer to the Docker guide for instructions on setting up the node using Docker.
Toolkits
- Explorer & Node Bundles: Access pre-packaged bundles that include an Ergo Node and an explorer for easy setup.
- Ergosphere: Ergosphere is an Umbrel-like solution that simplifies the setup of self-hosted Ergo services. Please note that it is currently in the BETA stage.
- Ergode (ergo-node) is an Ergo node implementation in TypeScript, targeting web and native runtimes.
Resources
- To get an overview of live nodes on the Ergo network, you can visit ergonodes.net.
- Node Frequently Asked Questions: Find answers to common questions about the Ergo Node.
- Modes of Operation: Learn about the different modes of operation available for the Ergo Node.
- Node APIs: Explore the APIs provided by the Ergo Node for interacting with the blockchain.
- Node Configuration: Details on configuring the node via the
application.conf
file. - Node Protocol Details: Information on the underlying network protocol.