heimdall-v2

module
v0.5.6 Latest Latest
Warning

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

Go to latest
Published: Jan 13, 2026 License: GPL-3.0

README

heimdall-v2

Consensus client of the Polygon PoS chain, using forks of cometBFT and cosmos-sdk.

Pre-requisites

Make sure you have go1.25+ already installed.

Build

$ make build

This will produce the binary heimdalld in the build directory.

Initialize heimdall

$ heimdalld init <MONIKER_NAME> --chain-id=<NETWORK_NAME>

You can skip --chain-id flag if you want to run this locally (it will default to heimdall-local). Otherwise, use heimdallv2-80002 for amoy, or heimdallv2-137 for mainnet. <MONIKER_NAME> is the name of your node, which can be any string you like.

This command will generate some folders and files in the heimdall home directory (default /var/lib/heimdall).

Run heimdall

$ heimdalld start

How to use the keyring

Instructions on how to import your validator private key into the keyring and use it to sign transactions.

Get your base64 encoded private key from:
/var/lib/heimdall/config/priv_validator_key.json

Convert the base64 encoded key to the hex encoded key:
echo "<PRIVATE_KEY_BASE64_ENCODED>" | base64 -d | xxd -p -c 256

Import the hex encoded key to your keyring:
heimdalld keys import-hex <KEY_NAME> <PRIVATE_KEY_HEX_ENCODED> --home <HOME_DIR_PATH>

When you first import a key into the keyring, you will be prompted for a password, which will be used every time you sign a transaction.

When running a tx command, specify the --from argument, by using the name of the key you have set above. Example:
heimdalld tx gov vote 1 yes --from <KEY_NAME>

Directories

Path Synopsis
api
heimdallv2/bor
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/chainmanager
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/checkpoint
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/clerk
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/milestone
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/sidetxs
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/stake
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/topup
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/types
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
heimdallv2/types/rest
Code generated by protoc-gen-go-pulsar.
Code generated by protoc-gen-go-pulsar.
bridge
client
cmd
heimdalld command
DONTCOVER
DONTCOVER
common
cli
hex
contracts
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
api
rest
Package rest provides HTTP types and primitives for REST requests validation and response handling.
Package rest provides HTTP types and primitives for REST requests validation and response handling.
Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces app 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 app versioning information based on flags passed at compile time.
x
bor
bor/testutil
Package testutil is a generated GoMock package.
Package testutil is a generated GoMock package.
bor/types
Package types is a reverse proxy.
Package types is a reverse proxy.
chainmanager/types
Package types is a reverse proxy.
Package types is a reverse proxy.
checkpoint/testutil
Package testutil is a generated GoMock package.
Package testutil is a generated GoMock package.
checkpoint/types
Package types is a reverse proxy.
Package types is a reverse proxy.
clerk/testutil
Package testutil is a generated GoMock package.
Package testutil is a generated GoMock package.
clerk/types
Package types is a reverse proxy.
Package types is a reverse proxy.
milestone/types
Package types is a reverse proxy.
Package types is a reverse proxy.
stake/testutil
Package testutil is a generated GoMock package.
Package testutil is a generated GoMock package.
stake/types
Package types is a reverse proxy.
Package types is a reverse proxy.
topup/testutil
Package testutil is a generated GoMock package.
Package testutil is a generated GoMock package.
topup/types
Package types is a reverse proxy.
Package types is a reverse proxy.

Jump to

Keyboard shortcuts

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