Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

IDEX Staking Replicator

Discord GitHub GitHub issues

Twitter Follow


IDEX Staking Replicator is software that enables the IDEX community to stake IDEX tokens, serve parts of the IDEX production infrastructure, and earn fees for participation. Replicator is an all-new, lightweight staking client featuring lower resource requirements and dramatically improved stability. For complete coverage, motivation, and details of operation, see our most recent post on Replicator Staking.

  • To get a Staking Key and get started with Replicator staking, visit the staking page in the IDEX web client. All status and earnings information is now available through the web client.
  • For details on implementing an IDEX API consumer that uses Replicators, see the IDEX API documentation.

Replicator replaces the legacy IDEXd staking client. Replicator is available immediately and replaces IDEXd earning staking credits starting on 2020-12-21 00:00 UTC.

Table of Contents



In order to participate in the IDEX Replicator staking program, you must have a wallet that holds a minimum of 5,000 IDEX. There is no incubation period. Any wallet with 5,000 IDEX or more is immediately eligible.

Hardware / VPS

Replicator is designed to run on a computer or inexpensive VPS that is continually connected to the internet with a stable IP address and inbound connectivity. It requires at minimum:

  • 1 GB memory
  • 2 GB storage

The least expensive tier of many cloud computing providers meets these requirements.


Staking Replicator is distributed as a Docker image and has very few dependencies. While it should run in any environment where Docker is supported, the following configuration is recommended by IDEX at launch:

Getting Started

Docker provides first-rate installation documentation, but we've collected the key steps to get up and running here. Start with a freshly installed copy of Ubuntu 20.04.

Note: Existing IDEXd stakers already have Docker configured. Skip ahead to Start Replicator to get started in under a minute.

A note on users

Some cloud computing providers, such as Digital Ocean, set up new Ubuntu 20.04 instances with only the root user account configured. We recommend running Replicator as a regular user account rather than root. When you first log in, run whoami to check which user you are currently acting as. If the response is root, follow Digital Ocean's instructions on adding a user and adding sudo privileges in order to run Replicator.

Log out and log in to the new, non-root user account before proceeding.

Install Docker

  1. Add Docker’s official GPG key

    curl -fsSL | sudo apt-key add -
  2. Add the stable Docker repository

    sudo add-apt-repository "deb [arch=amd64] $(lsb_release -cs) stable"
  3. Update packages

    sudo apt-get update
  4. Install the Docker Engine packages

    sudo apt-get install docker-ce docker-ce-cli
  5. Add your user to the docker group to avoid permissions issues

    sudo usermod -aG docker ${USER}
  6. Log out and log back in and docker commands will be available from the prompt.

  7. Verify that Docker Engine is installed correctly by running the hello-world image

    docker run hello-world

Start Replicator

  1. Download the Replicator start script

    wget ""
  2. Enable script permissions

    chmod a+x
  3. Run the start script to get started


The start script will prompt for a Staking Key, which can be found on the Replicator Staking page.

A note on connectivity

In order to serve data to IDEX API users, Replicator must be reachable from the public internet. Most home and office connections are not publicly reachable by default, so you may need to take steps like opening up specific ports on your router. Replicator requires public TCP access to port 8081 and has limits on how frequently a node can change IP addresses.

We recommend running Replicator on an always-on, connected machine or a cloud-hosted compute instance.

Managing Replicator

Replicator is designed to require minimal maintenance once live. All status and earnings information is available on the Replicator Staking page.

Examining logs

Activity and Error logs are available in the idex-staking-replicator/logs directory.

tail -f idex-staking-replicator/logs/activity.log

Stopping Replicator

Replicator can be taken offline via Docker.

docker stop staking-replicator

Re-running the script will bring Replicator back online.

Upgrading Replicator

Replicator includes an automatic update mechanism to keep it up to date without intervention. To manually upgrade, stop and restart Replicator.

Customizing Replicator's configuration

Replicator includes minimal configuration options by design, but it is possible to set a custom configuration file. Create a file idex-staking-replicator/conf/config.env.

Settings include:

  • Setting an API_KEY makes it unnecessary to supply an Staking Key on start.
  • If port 8081 is unavailable, a custom port may be specified via IDEX_STAKING_SERVER_PORT.


Disk space

Replicator limits the size of the three log files it writes to 50 MB each. No other data is written to disk by Replicator itself.

Follow these recommendations to reclaim disk space lost to common causes.

Ubuntu Kernel Updates

If you are running Ubuntu (as recommended), automatic kernel updates are likely enabled. These updates leave old kernels behind in /usr/src/, which can be cleaned up with sudo apt-get autoremove. To automate this, set up the following cron job:

crontab -e

Add line:

0 0 * * * sudo apt-get -y autoremove

This runs the command every day at midnight.

Replicator Updates

Replicator includes an automatic update mechanism, which can leave behind unused Docker images. Unused Docker images can be removed by running docker image prune.

Getting Help and Reporting Issues

For questions about getting started and help if you're stuck, please reach out to our team on Discord.

If you believe you have identified a bug in Replicator, please file an issue.


IDEX Replicator Client is released under the MIT License.