⚠️ This repository is archived and no longer maintained

This repository was used for the legacy Heimdall implementation on Polygon. Following the Heimdall migration, this codebase is now deprecated and will no longer receive updates or support.

➡️ The new Heimdall implementation is available at: https://github.com/0xPolygon/heimdall-v2

Please refer to the new repository for all future development, issues, and documentation.

Heimdall

Validator node for Matic Network. It uses peppermint, customized Tendermint.

Install from source

Make sure you have Go v1.20+ already installed.

Install

bashCopy
$ make install

Init Heimdall

bashCopy
$ heimdalld init
$ heimdalld init --chain=mainnet        Will init with genesis.json for mainnet
$ heimdalld init --chain=amoy           Will init with genesis.json for amoy

Run Heimdall

bashCopy
$ heimdalld start

Usage

bashCopy
$ heimdalld start                       Will start for mainnet by default
$ heimdalld start --chain=mainnet       Will start for mainnet
$ heimdalld start --chain=amoy          Will start for amoy
$ heimdalld start --chain=local         Will start for local with NewSelectionAlgoHeight = 0

Run rest server

bashCopy
$ heimdalld rest-server

Run bridge

bashCopy
$ heimdalld bridge

Develop using Docker

You can build and run Heimdall using the included Dockerfile in the root directory:

bashCopy
docker build -t heimdall .
docker run heimdall

Documentation

Latest docs are here.