heimdall

module
v1.0.4-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 14, 2024 License: GPL-3.0

README

Heimdall

Go Report Card CircleCI GolangCI

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

Install from source

Make sure you have go1.11+ already installed

Install
$ make install
Init-heimdall
$ heimdalld init
$ heimdalld init --chain=mainnet        Will init with genesis.json for mainnet
$ heimdalld init --chain=mumbai         Will init with genesis.json for mumbai
$ heimdalld init --chain=amoy           Will init with genesis.json for amoy
Run-heimdall
$ heimdalld start
Usage
$ heimdalld start                       Will start for mainnet by default
$ heimdalld start --chain=mainnet       Will start for mainnet
$ heimdalld start --chain=mumbai        Will start for mumbai
$ heimdalld start --chain=amoy          Will start for amoy
$ heimdalld start --chain=local         Will start for local with NewSelectionAlgoHeight = 0
Run rest server
$ heimdalld rest-server 
Run bridge
$ heimdalld bridge 
Develop using Docker

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

docker build -t heimdall .
docker run heimdall
Documentation

Latest docs are here

Directories

Path Synopsis
app
params
Package params defines the simulation parameters in the simapp.
Package params defines the simulation parameters in the simapp.
client/rest
nolint
nolint
types/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
client/rest
nolint
nolint
bor
client/rest
Package classification HiemdallRest API
Package classification HiemdallRest API
cmd
nolint
client/rest
nolint
nolint
client/rest
nolint
nolint
client/rest
nolint
nolint
tx
nolint
nolint
cmd
contracts
gov
client/rest
nolint
nolint
types
nolint
nolint
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
scripts
Package simulation implements a full fledged Heimdall application used for executing simulation test suites.
Package simulation implements a full fledged Heimdall application used for executing simulation test suites.
client/rest
nolint
nolint
types
noalias
noalias
client/rest
nolint
nolint
client/rest
nolint
nolint
rest
Package rest provides HTTP types and primitives for REST requests validation and responses handling.
Package rest provides HTTP types and primitives for REST requests validation and responses handling.
Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces apps versioning information based on flags passed at compile time.
Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces apps versioning information based on flags passed at compile time.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL