A Go Implementation of the Polkadot Host
Gossamer is an implementation of the Polkadot Host: a framework used to build and run nodes for different blockchain protocols that are compatible with the Polkadot ecosystem. The core of the Polkadot Host is the wasm runtime which handles the logic of the chain.
Gossamer includes node implementations for major blockchains within the Polkadot ecosystem and simplifies building node implementations for other blockchains. Runtimes built with Substrate can plug their runtime into Gossamer to create a node implementation in Go.
For more information about Gossamer, the Polkadot ecosystem, and how to use Gossamer to build and run nodes for various blockchain protocols within the Polkadot ecosystem, check out the Gossamer Docs.
Get Started
Prerequisites
install go version >=1.17
Installation
get the ChainSafe/gossamer repository:
git clone [email protected]:ChainSafe/gossamer
cd gossamer
build gossamer command:
make gossamer
Troubleshooting for Apple Silicon users
If you are facing the following problem with the wasmer:
undefined: cWasmerImportObjectT
undefined: cWasmerImportFuncT
undefined: cWasmerValueTag
Make sure you have the following Golang enviroment variables:
- GOARCH="amd64"
- CGO_ENABLED="1"
use go env to see all the Golang enviroment variables
use go env -w ENV_NAME=ENV_VALUE to set the new value
Run Development Node
To initialise a development node:
./bin/gossamer --chain dev init
To start the development node:
./bin/gossamer --chain dev
The development node is configured to produce a block every slot and to finalise a block every round (as there is only one authority, alice.)
Run Gossamer Node
The gossamer node runs by default as an authority with 9 authorites set at genesis. The built-in keys, corresponding to the authorities, that are available for the node are alice, bob, charlie, dave, eve, ferdie, george, and ian.
To initialise a gossamer node:
./bin/gossamer --chain gssmr init
To start the gossamer node:
./bin/gossamer --chain gssmr --key alice
Note: If you only run one gossamer node, the node will not build blocks every slot or finalize blocks; it will appear that the node is doing nothing, but it is actually waiting for a slot to build a block. This is because there are 9 authorities set, so at least 6 of the authorities should be run for a functional network. If you wish to reduce the number of authorities, you can modify the genesis file in chain/gssmr/genesis-spec.json.
Run Kusama Node
Kusama is currently supported as a full node, ie. it can sync the chain but not act as an authority.
To initialise a kusama node:
./bin/gossamer --chain kusama init
To start the kusama node:
./bin/gossamer --chain kusama
The node may not appear to do anything for the first minute or so (it's bootstrapping to the network.) If you wish to see what is it doing in this time, you can turn on debug logs in chain/gssmr/config.toml:
[log]
network = "debug"
After it's finished bootstrapping, the node should begin to sync.
Run Polkadot Node
Polkadot is currently supported as a full node, ie. it can sync the chain but not act as an authority.
To initialise a polkadot node:
./bin/gossamer --chain polkadot init
To start the polkadot node:
./bin/gossamer --chain polkadot
Contribute
- Check out Contributing Guidelines and our code style document
- Have questions? Say hi on Discord!
Donate
Our work on gossamer is funded by grants. If you'd like to donate, you can send us ETH or DAI at the following address: 0x764001D60E69f0C3D0b41B0588866cFaE796972c
ChainSafe Security Policy
Reporting a Security Bug
We take all security issues seriously, if you believe you have found a security issue within a ChainSafe project please notify us immediately. If an issue is confirmed, we will take all necessary precautions to ensure a statement and patch release is made in a timely manner.
Please email us a description of the flaw and any related information (e.g. reproduction steps, version) to security at chainsafe dot io.
License
GNU Lesser General Public License v3.0
