Quickstart Guide

Start mining within 2 minutes.

There is a video version of this tutorial: https://youtu.be/RW9PQ2osv3k

Installing the Orax client

Mining on PegNet requires mining machines to have at least 2Gb of memory.

Registering an account

In a terminal:

Linux
MacOS
Windows
Linux
$ ./orax-cli register
MacOS
$ ./orax-cli register
Windows
orax-cli.exe register

For the first time select the new account creation option. To create a new account you need:

  1. An email address.

  2. A Factoid address (looks like FA24PAtyZWWVAPm95ZCVpwyY6RYHeCMTiZt2v4VQAY8aBXMUZyeF) to receive your payouts. If you don't have an address we recommend to use this PegNet web wallet: https://factomatic.io/wallet/.

You will then be asked to provide an alias to register the machine you are currently using as a miner. That alias is a way for you to easily identify your different miners.

You are now registered in the Orax Pool with your first miner. You can sign-in on the Orax Pool website with the same credentials.

Starting mining

In a terminal:

Linux
MacOS
Windows
Linux
$ ./orax-cli mine
MacOS
$ ./orax-cli mine
Windows
orax-cli.exe mine

The very first time (only) that you launch your miner, two set-up operations will take place:

  1. The 1Gb map of the LXR hash (PegNet hashing function) will be generated. This operation is slow and can take between 5min and 30min. You will see the message

    Initializing LXRHash... printed out during that time.

  2. An initial assessment of your miner has hrate that runs for 1 minute.

You are now mining PEG! Log-in on the Orax Pool website to see your rewards and statistics (data is updated every block, so every 10 minutes).

Tip 1: benchmarking

You can use the bench command of the cli to evaluate the hash rate of a machine. This is convenient if you are trying to figure out your optimal config or comparing different machines. That command does not require any sign-in.

Tip 2: number of cores

By default orax-cli will use all the available cores of the machine for mining. You can limit the number of cores used by limiting the number of "subminers" adding the flag -n <nb of subminers> to your mine command.

Adding more miners

You can add more miners to your account by repeating the above instructions on different machines. When running the register command chose to login in with an existing account using your credentials. It will link the miner to your account and add up your rewards. You can see the list of all your miners here.

The register command can also be used in non-interactive mode when registering a miner with an already existing account, which is useful for automated deployment of miners (Ansible...). You just need to provide username (email), password and miner alias to the command:

$ ./orax-cli register -u <account email> -p <password> -a <miner alias>

Going further

We recommend using a process manager/supervisor to continuously run the mining command. See our tutorial to use systemd on Linux.