README.md

Polaris Integrated Cosmos Chain

Installation

From Binary

The easiest way to install a Cosmos-SDK Blockchain running Polaris is to download a pre-built binary. You can find the latest binaries on the releases page.

From Source

Step 1: Install Golang & Foundry

Go v1.20+ or higher is required for Polaris

1. Install Go 1.20+ from the official site or the method of your choice. Ensure that your GOPATH and GOBIN environment variables are properly set up by using the following commands:

   For Ubuntu:

   cd $HOME
   sudo apt-get install golang jq -y
   export PATH=$PATH:/usr/local/go/bin
   export PATH=$PATH:$(go env GOPATH)/bin

   For Mac:

   cd $HOME
   brew install go jq
   export PATH=$PATH:/opt/homebrew/bin/go
   export PATH=$PATH:$(go env GOPATH)/bin

2. Confirm your Go installation by checking the version:

   go version

Foundry is required for Polaris

3. Install Foundry:

   curl -L https://foundry.paradigm.xyz | bash

Step 2: Get Polaris source code

Clone the polaris repo from the official repo and check out the main branch for the latest stable release. Build the binary.

cd $HOME
git clone https://github.com/berachain/polaris
cd polaris
git checkout main
go run magefiles/setup/setup.go

Step 3: Build the Node Software

Run the following command to install polard to your GOPATH and build the node. polard is the node daemon and CLI for interacting with a polaris node.

mage install

Step 4: Verify your installation

Verify your installation with the following command:

polard version --long

A successful installation will return the following:

name: berachain
server_name: polard
version: <x.x.x>
commit: <Commit hash>
build_tags: netgo,ledger
go: go version go1.20.4 darwin/amd64

Running a Local Network

After ensuring dependecies are installed correctly, run the following command to start a local development network.

mage start

The network will have an Ethereum JSON-RPC server running at http://localhost:8545 and a Tendermint RPC server running at http://localhost:26657.