Skip to content

INSTALL.md

Latest commit

 

History

History
106 lines (70 loc) · 2.41 KB

INSTALL.md

File metadata and controls

106 lines (70 loc) · 2.41 KB

Install nibid binaries

This guide will explain how to install the Nibiru Chain binary, nibid, onto your system.

Table of Contents

1. Update the system

On Ubuntu, start by updating your system

sudo apt update
sudo apt upgrade --yes

2. Install Golang

Steps described here: https://go.dev/doc/install

3. Install build requirements

Install make and gcc.

sudo apt install git build-essential ufw curl jq snapd --yes
wget -q -O - https://git.io/vQhTU | bash -s -- --version 1.16

After installed, open new terminal to properly load go

4. Clone the Nibiru Repository

cd $HOME
git clone https://github.com/NibiruChain/nibiru
cd nibiru

On this fresh clone of the repo, simply run

make build 
make install
make localnet

and open another terminal.

Upgrade

The scheduled mainnet upgrade to nibiru-2 is planned for

cd nibiru
git fetch tags
git checkout v0.0.1

Testnet

One the Nibiru binary has been installed, for further information on joining the testnet, head over to the testnet repo.

Mainnet

One the Nibiru binary has been installed, for further information on joining mainnet, head over to the mainnet repo.

Troubleshooting

A. If after steps 1-4 you don't have the nibid command, your go/bin directory may not be in your PATH yet. To do so, add the below to your .zshrc or .bash_profile

export PATH=$PATH:$(go env GOPATH)/bin

B. New commands you've made on the nibid doesn't show up. Your nibid probably just isn't updated again after the code changes, to recompile nibid run make install in the root

Contributing

The code for nibid is located in the /cmd/nibid folder.

In addition to the commands available within that folder, nibid pulls in cli subcommands from the modules e.g. /x/perps/cli

After updating the code run

make build
make install

To see all the commands available just add --help to the end.

Example:

nibid --help
nibid query --help
nibid tx --help
nibid query perp --help