Planq Mainnet
This is a detailed documentation for setting up a full node on Planq mainnet planq_7070-2
.
Pre-requisites
Supported OS
We officially support macOS, Windows, and Linux only. Other platforms may work but there is no guarantee. We will extend our support to other operating systems after we have stabilised our current architecture.
Prepare your machine
To run Planq Mainnet nodes, you will need a machine with the following minimum requirements to run different types of nodes:
Pruned node (setting pruning=everything)
Storage: ~25G*
RAM: 4 GB (LevelDB) or 64G RAM (RocksDB)***
CPU: 4-core
Default full node (setting pruning=default)
Storage: ~1.5T**
RAM: 4 GB (LevelDB) or 64G RAM (RocksDB)***
CPU: 4-core
Archive node (setting pruning=nothing)
Storage: ~2.8T**
RAM: 4 GB (LevelDB) or 64G RAM (RocksDB)***
CPU: 4-core
*Only in case state-sync enabled. ** e.g. Note that size of snapshots from Snapshot will keep growing. *** Note that during a state-sync the node might require higher RAM than 3GB but, returns to normal after state-sync has finished.
Note that all depends on the type of node you are running and settings will vary depending on your usage.
Step 1. Get the Planq Mainnet binary
Remarks:
The following is the minimal setup for a validator node / full node.
To simplify the following step, we will be using Linux (Intel x86) for illustration. Binaries for Mac (Intel x86 / M1) and Windows
To install released Planq Mainnet binaries from github:
Afterward, you can check the version of
planqd
by
Step 2. Configure planqd
planqd
Step 2-0 (Optional) Clean up the old blockchain data
If you have joined
planq_7077-1
before, you would have to clean up the old blockchain data and start over again, it can be done by running:and remove the old genesis file by
Before kick-starting your node, we will have to configure your node so that it connects to the Planq mainnet:
Step 2-1 Initialize planqd
planqd
First of all, you can initialize planqd by:
This
moniker
will be the displayed id of your node when connected to Planq Chain network.When providing the moniker value, make sure you drop the square brackets since they are not needed. The example below shows how to initialize a node named
pegasus-node
:
Note:
Depending on your planqd home setting, the planqd configuration will be initialized to that home directory. To simply the following steps, we will use the default planqd home directory
~/.planqd/
for illustration.You can also put the
planqd
to your binary path and run it byplanqd
Step 2-2 Configure planqd
Download and replace the Planq Mainnet
genesis.json
by:Verify sha256sum checksum of the downloaded
genesis.json
. You should seeOK!
if the sha256sum checksum matches.
NOTE
For Mac environment, sha256sum
was not installed by default. In this case, you may setup sha256sum
with this command:
For network configuration, in
~/.planqd/config/config.toml
, validator nodes need to modify the configurations ofseed
,create_empty_blocks_interval
andtimeout_commit
If you would like to build an archive node that allows you to query all the historical block data - kindly update the pruning setting to
"nothing"
by
NOTE
For Mac environment, if jq
is missing, you may install it by: brew install jq
Step 3. Run everything
CAUTION
This page only shows the minimal setup for validator / full node.
Furthermore, you may want to run full nodes as sentries (see Tendermint), restrict your validator connections to only connect to your full nodes, test secure storage of validator keys etc.
Once planqd
has been configured, we are ready to start the ode and sync the blockchain data:
Start planqd, e.g.:
Remarks:
If you see errors saying too many files opened...
, then you need to set a higher number for maximum open file descriptors in your OS.
If you are on OSX or Linux, then the following could be useful:
(Optional for Linux) Start planqd with systemd service, e.g.:
Example: /etc/systemd/system/planqd.service created by script
It should begin fetching blocks from the other peers.
You can query the node syncing status by
If the above command returns
false
, It means that your node is fully synced; otherwise, it returnstrue
and implies your node is still catching up.One can check the current block height by querying the public full node by:
and you can check your node's progress (in terms of block height) by
Last updated