Matic CLI

🏗 A CLI to setup and manage Matic validator nodes

Installation (Host Machine)

Please make sure you have installed following dependencies:

Build Essentials
```
sudo apt install build-essential
```

Node v10.17.0

curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
nvm install 10.17.0

Go 1.18+

wget https://raw.githubusercontent.com/maticnetwork/node-ansible/master/go-install.sh
bash go-install.sh --remove
bash go-install.sh

Docker (https://docs.docker.com/engine/install/ubuntu/, https://docs.docker.com/engine/install/linux-postinstall/)
Solc v0.5.16
```
sudo snap install solc
```

Python 2

sudo apt install python2
alias python="/usr/bin/python2"

Installation (Remote Machine)

Please make sure you have installed following dependencies:

Go 1.18+
Rabbitmq
```
sudo apt install rabbitmq-server
```
Npm (Only required on ganache remote machine)
```
sudo apt update
sudo apt install nodejs npm
```
Ganache CLI (Only required on ganache remote machine)
```
sudo npm install -g ganache-cli
```

Usage

git clone https://github.com/maticnetwork/matic-cli.git
npm i
mkdir devnet
cd devnet

Setup a local network interactively

../bin/matic-cli setup devnet -i

Alternatively, setup a local network with a template configuration file

../bin/matic-cli setup devnet -c ../configs/devnet/docker-setup-config.yaml

You can find more details about configuration options here.

To setup multi-node local network (via docker)

It will ask you several questions (default values are provided):

Please enter Bor chain id - Input the bor chain id you want
Please enter Heimdall chain id - Input the heimdall chain id you want
Please enter Bor docker tag - Input the bor tag you want to deploy
Please enter Heimdall docker tag - Input the heimdall tag you want to deploy
Please enter Contracts branch - Input the contracts branch
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 - Input the eth url to use
Please select devnet type - docker

Notes:

We have provided the default values where ever so to ensure smooth functioning of the process

After the setup is done, follow these steps for local docker deployment:

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

To setup multi-node remote network

It will ask you several questions:

Please enter Bor chain id - Input the bor chain id you want
Please enter Heimdall chain id - Input the heimdall chain id you want
Please enter Bor docker tag - Input the bor tag you want to deploy
Please enter Heimdall docker tag - Input the heimdall tag you want to deploy
Please enter Contracts branch - Input the contracts branch
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 - Input the eth url to use
Please select devnet type - remote
Please enter comma separated hosts/IPs - Enter the IPs