Matic CLI

🏗 A CLI to setup and manage Matic validator nodes

Installation

npm install -g @maticnetwork/matic-cli

Please make sure you have installed following dependencies:

• Git
• Node/npm v10.17.0 (or higher)
• Go 1.13+
• Rabbitmq (Latest stable version)
• Solc v0.5.11 (https://solidity.readthedocs.io/en/v0.5.3/installing-solidity.html#binary-packages)
• Ganache CLI (https://www.npmjs.com/package/ganache-cli)

Usage

Create new directory for the setup:

$ mkdir localnet
$ cd localnet

Check commands

matic-cli

To setup 1 node local network

This will setup Heimdall and Bor.

matic-cli setup localnet

It will ask you several questions:

Please enter Bor chain id - You can keep the default one (15001) or change it to any numeric id
Please enter Heimdall chain id - You can keep the default one (heimdall-15001) or change it to a regex (heimdall-<numeric id>)
Please enter Bor branch or tag - v0.2.5
Please enter Heimdall branch or tag - v0.2.1-mumbai
Please enter Contracts branch or tag - Keep the default branch (v0.3.0-backport)

After the setup is done, follow these steps:

Start ganache

bash ganache-start.sh

Start heimdall

bash heimdall-start.sh

Start heimdall bridge

bash heimdall-bridge-start.sh

Start heimdall rest server

bash heimdall-server-start.sh

Setup bor

bash bor-setup.sh

Start bor

bash bor-start.sh

To setup multi-node local network

matic-cli setup devnet

It will ask you several questions:

Please enter Bor chain id - You can keep the default one (15001) or change it to any numeric id
Please enter Heimdall chain id - You can keep the default one (heimdall-15001) or change it to a regex (heimdall-<numeric id>)
Please enter Bor branch or tag - v0.2.5
Please enter Heimdall branch or tag - v0.2.1-mumbai
Please enter Contracts branch or tag - Keep the default branch (v0.3.0-backport)
Please enter number of validator nodes - Input the number of validator nodes you want to run
Please enter number of non-validator nodes - Input the number of sentry nodes you want to run
Please enter ETH url - http://ganache:9545
Please select devnet type - docker (for docker setup)

After the setup is done, follow these steps:

Start ganache

bash docker-ganache-start.sh

Start all heimdall instances (it will run all services - rabbitmq, heimdall, bridge, server)

bash docker-heimdall-start-all.sh

Setup bor

bash docker-bor-setup.sh

Start bor

bash docker-bor-start-all.sh

Logs

Logs will be at logs/ folder

SSH to docker containers through tmux

For Heimdall

bash docker-heimdall-tmux.sh

For Bor

bash docker-bor-tmux.sh

Clean Setup Remove the localnet folder and you can start the process once again

License

MIT