gossamer

(★ 454)

🕸️ Go Implementation of the Polkadot Host

File Explorer

Download Latest Version (.zip)

- pre-push
- - bug_report.md
  - config.yml
  - epic.md
  - implementation.md
  - investigation_or_research.md
  - software_design.md
- - build.yml
  - checks.yml
  - copyright.yml
  - devnet.yml
  - dispatch-baremetal.yml
  - docker-grandpa.yml
  - docker-js.yml
  - docker-network.yml
  - docker-rpc.yml
  - docker-stress.yml
  - docs.yml
  - fuzz.yml
  - integration-tests.yml
  - labels.yml
  - mocks.yml
  - release.yml
  - unit-tests.yml
  - zombienet.yml
- CODE_OF_CONDUCT.md
- CODE_STYLE.md
- CODEOWNERS
- dependabot.yml
- labels.yml
- PULL_REQUEST_TEMPLATE.md
- - chain-spec-raw.json
  - defaults.go
- - chain-spec-raw.json
  - defaults.go
- - chain-spec-raw.json
  - defaults.go
- - chain-spec-raw.json
  - defaults.go
- - defaults.go
  - westend-dev-spec-raw.json
  - westend-dev-spec.json
- - default.go
  - westend-local-spec-raw.json
  - westend-local-spec.json
- - main.go
  - README.md
- - main.go
- config.go
- toml.go
- version.go
- - docker-compose.yml
- - docker-compose.yml
- alice.Dockerfile
- alice.node.key
- bob.Dockerfile
- docker-compose-substrate.yml
- docker-compose.yml
- go.mod
- go.sum
- README.md
- substrate_alice.Dockerfile
- substrate_bob.Dockerfile
- - grafana.ini
- - prometheus.yml
- - 404.html
  - CNAME
  - index.md
- - index.md
- .gitignore
- CONTRIBUTING.md
- mkdocs.yml
- - errors.go
  - helpers_test.go
  - interfaces.go
  - messages.go
  - messages_integration_test.go
  - messages_test.go
  - mock_runtime_instance_test.go
  - mock_state_test.go
  - mocks_generate_test.go
  - mocks_test.go
  - service.go
  - service_integration_test.go
  - service_test.go
- - block_import.go
  - block_import_test.go
  - digest.go
  - digest_integration_test.go
  - helpers_test.go
  - interfaces.go
  - mock_epoch_state_test.go
  - mock_grandpa_test.go
  - mock_telemetry_test.go
  - mocks_generate_test.go
  - README.md
- - block_announce.go
  - block_announce_integration_test.go
  - block_announce_test.go
  - config.go
  - config_test.go
  - connmgr.go
  - connmgr_integration_test.go
  - discovery.go
  - discovery_integration_test.go
  - errors.go
  - gossip.go
  - gossip_integration_test.go
  - helpers_test.go
  - host.go
  - host_integration_test.go
  - inbound.go
  - interfaces.go
  - light.go
  - light_integration_test.go
  - mdns_integration_test.go
  - message.go
  - message_cache.go
  - message_cache_integration_test.go
  - message_test.go
  - mock_block_state_test.go
  - mock_stream_test.go
  - mock_syncer_test.go
  - mock_telemetry_test.go
  - mock_transaction_handler_test.go
  - mock_warp_sync_provider_test.go
  - mocks_generate_test.go
  - notifee.go
  - notifications.go
  - notifications_test.go
  - peersdata.go
  - README.md
  - request_response.go
  - service.go
  - service_integration_test.go
  - state.go
  - stream_manager.go
  - stream_manager_integration_test.go
  - sync.go
  - sync_test.go
  - transaction.go
  - transaction_integration_test.go
  - utils.go
  - utils_test.go
  - warp_sync.go
  - warp_sync_test.go
- - constants.go
  - errors.go
  - handler.go
  - peerset.go
  - peerset_test.go
  - peerstate.go
  - peerstate_test.go
  - test_helpers.go
- - dot_up_codec.go
  - dot_up_codec_test.go
  - helpers.go
  - helpers_test.go
  - http.go
  - http_integration_test.go
  - http_test.go
  - interfaces.go
  - mock_digesthandler_test.go
  - mock_network_test.go
  - mock_telemetry_test.go
  - mocks_generate_test.go
  - mocks_test.go
  - service.go
  - service_test.go
  - websocket_integration_test.go
- - base.go
  - base_test.go
  - block.go
  - block_data.go
  - block_data_test.go
  - block_finalisation.go
  - block_finalisation_test.go
  - block_notify.go
  - block_notify_test.go
  - block_race_test.go
  - block_test.go
  - epoch.go
  - epoch_test.go
  - grandpa.go
  - grandpa_changes.go
  - grandpa_test.go
  - hashtoblockmap.go
  - hashtoblockmap_test.go
  - helpers_test.go
  - initialize.go
  - inmemory_storage.go
  - inmemory_storage_test.go
  - inmemory_tries.go
  - inmemory_tries_test.go
  - interfaces.go
  - mock_counter_test.go
  - mock_gauge_test.go
  - mocks_database_test.go
  - mocks_generate_test.go
  - mocks_runtime_test.go
  - mocks_test.go
  - offline_pruner.go
  - service.go
  - service_integration_test.go
  - slot.go
  - slot_test.go
  - storage_notify.go
  - storage_notify_test.go
  - storage_state.go
  - test_helpers.go
  - transaction.go
  - transaction_test.go
- - block_importer.go
  - configuration.go
  - fullsync.go
  - fullsync_test.go
  - message.go
  - message_integration_test.go
  - message_test.go
  - mock_block_state_maker.go
  - mock_importer.go
  - mock_request_maker.go
  - mocks_generate_test.go
  - mocks_test.go
  - peer_view.go
  - request_queue.go
  - service.go
  - state_request_provider.go
  - state_request_provider_test.go
  - state_sync.go
  - unready_blocks.go
  - unready_blocks_test.go
  - warp_sync.go
  - warp_sync_test.go
  - worker_pool.go
- - service.go
  - service_test.go
- - afg_applying_forced_authority_set_change.go
  - afg_applying_scheduled_authority_set_change.go
  - afg_authority_set.go
  - afg_finalized_blocks_up_to.go
  - afg_received.go
  - block_import.go
  - interfaces.go
  - mailer.go
  - mailer_test.go
  - noop.go
  - notify_finalized.go
  - prepared_block_for_proposing.go
  - system_connected.go
  - system_interval.go
  - telemetry.go
  - txpool_import.go
- - account.go
  - authority.go
  - authority_test.go
  - babe.go
  - babe_digest.go
  - babe_digest_test.go
  - babe_test.go
  - block.go
  - block_data.go
  - block_data_test.go
  - block_test.go
  - body.go
  - body_test.go
  - consensus_digest.go
  - consensus_digest_test.go
  - digest.go
  - digest_test.go
  - equivocation.go
  - equivocation_test.go
  - extrinsic.go
  - grandpa.go
  - grandpa_test.go
  - header.go
  - header_test.go
  - inherents.go
  - inherents_test.go
  - system.go
  - tx.go
- build_spec.go
- build_spec_integration_test.go
- build_spec_test.go
- config.go
- config_test.go
- errors.go
- helpers_test.go
- import.go
- import_integration_test.go
- import_test.go
- interfaces.go
- mock_block_state_test.go
- mock_node_builder_test.go
- mock_service_builder_test.go
- mock_telemetry_test.go
- mocks_generate_test.go
- mocks_test.go
- node.go
- node_integration_test.go
- node_test.go
- services.go
- services_integration_test.go
- services_test.go
- test_utils.go
- utils.go
- utils_integration_test.go
- utils_test.go
- - block_rules.go
  - client.go
  - client_test.go
  - mocks_generate_test.go
  - notification_pinning.go
  - notification_pinning_test.go
- - cost_lru.go
  - cost_lru_test.go
- - database.go
  - database_test.go
  - pebble.go
  - pebble_batch.go
  - pebble_iterator.go
  - pebble_test.go
  - table.go
  - table_batch.go
- - hash_db.go
- - address.go
  - logger.go
  - logger_mock_test.go
  - matchers_test.go
  - mocks_generate_test.go
  - option_test.go
  - options.go
  - run.go
  - run_test.go
  - server.go
  - server_test.go
- - kvdb.go
  - kvdb_test.go
- - caller.go
  - caller_test.go
  - format.go
  - global.go
  - global_test.go
  - helpers_test.go
  - level.go
  - level_test.go
  - log.go
  - log_test.go
  - logger.go
  - logger_test.go
  - options.go
  - patch.go
  - patch_test.go
  - race_test.go
  - settings.go
- - memory_db.go
  - memory_db_test.go
- - interfaces.go
  - metrics.go
  - metrics_test.go
- - interfaces.go
  - logger_mock_test.go
  - matchers_test.go
  - mocks_generate_test.go
  - runner_mock_test.go
  - server.go
  - server_test.go
  - service.go
  - service_test.go
  - settings.go
  - settings_test.go
- - pubip.go
  - pubip_test.go
  - README.md
- - saturating.go
  - saturating_test.go
- - babe.go
  - babe_integration_test.go
  - build.go
  - build_integration_test.go
  - crypto.go
  - crypto_test.go
  - epoch.go
  - epoch_handler.go
  - epoch_handler_integration_test.go
  - epoch_handler_test.go
  - epoch_integration_test.go
  - epoch_test.go
  - errors.go
  - errors_test.go
  - helpers_test.go
  - interfaces.go
  - mock_block_state_test.go
  - mock_state_test.go
  - mock_storage_state_test.go
  - mock_telemetry_test.go
  - mocks_generate_test.go
  - secondary.go
  - secondary_integration_test.go
  - secondary_test.go
  - slot.go
  - slot_test.go
  - state.go
  - types.go
  - verify.go
  - verify_integration_test.go
  - verify_test.go
- - blocktree.go
  - blocktree_test.go
  - errors.go
  - hashtoruntime.go
  - hashtoruntime_test.go
  - helpers_test.go
  - leaves.go
  - mocks_generate_test.go
  - mocks_test.go
  - node.go
  - node_test.go
- - address.go
  - common.go
  - common_test.go
  - db_keys.go
  - hash.go
  - hash_test.go
  - hasher.go
  - hasher_test.go
  - network.go
  - network_test.go
  - peekable.go
  - well_known_keys.go
- - interfaces.go
  - keypair.go
  - keypair_test.go
  - sig_verifier.go
  - sig_verifier_test.go
  - transcript.go
- - genesis.go
  - genesis_test.go
  - helpers.go
  - helpers_test.go
  - keys.go
  - pallet.go
  - pallet_test.go
- - commits_tracker.go
  - commits_tracker_test.go
  - errors.go
  - finalisation.go
  - finalisation_integration_test.go
  - grandpa.go
  - grandpa_integration_test.go
  - helpers_integration_test.go
  - helpers_unit_test.go
  - interfaces.go
  - message.go
  - message_handler.go
  - message_handler_integration_test.go
  - message_handler_test.go
  - message_integration_test.go
  - message_tracker.go
  - message_tracker_integration_test.go
  - message_tracker_test.go
  - mock_ephemeral_service_test.go
  - mock_telemetry_test.go
  - mocks_block_state_test.go
  - mocks_generate_test.go
  - mocks_runtime_test.go
  - mocks_test.go
  - neighbor_tracker.go
  - neighbor_tracker_test.go
  - network.go
  - network_integration_test.go
  - round_integration_test.go
  - state.go
  - types.go
  - types_test.go
  - vote_message.go
  - vote_message_integration_test.go
  - vote_message_test.go
  - votes_tracker.go
  - votes_tracker_test.go
- - basic_keystore.go
  - basic_keystore_test.go
  - encrypt.go
  - encrypt_test.go
  - generic_keystore.go
  - generic_keystore_test.go
  - helpers.go
  - helpers_test.go
  - interfaces.go
  - keyring.go
  - keyring_test.go
  - keystore.go
- - os.go
- - math.go
  - math_test.go
- - constants.go
  - genesis.go
  - genesis_test.go
  - interface.go
  - interfaces.go
  - invalid_transaction.go
  - memory.go
  - mocks_generate_test.go
  - mocks_test.go
  - test_helpers.go
  - transaction_validity.go
  - transaction_validity_test.go
  - types.go
  - types_test.go
  - unknown_transaction.go
  - version.go
  - version_test.go
- - interfaces.go
  - mocks_generate_test.go
  - mocks_test.go
  - services.go
  - services_test.go
- - pool.go
  - pool_test.go
  - priority_queue.go
  - priority_queue_integration_test.go
  - priority_queue_test.go
  - types.go
  - types_test.go
- - utils.go
  - utils_test.go
- - bitfield.go
  - bitfield_test.go
  - bridge_state.go
  - bridge_state_test.go
  - context.go
  - context_test.go
  - dummy_chain_test.go
  - environment_test.go
  - lib.go
  - lib_test.go
  - logger.go
  - past_rounds.go
  - README
  - report.go
  - round.go
  - round_test.go
  - timer.go
  - timer_test.go
  - vote_graph.go
  - vote_graph_test.go
  - voter.go
  - voter_lifecycle_test.go
  - voter_set.go
  - voter_set_test.go
  - voter_test.go
  - voting_round.go
  - weights.go
- - decode.go
  - decode_test.go
  - encode.go
  - encode_test.go
  - errors.go
  - README.md
  - result.go
  - result_example_test.go
  - result_test.go
  - scale.go
  - scale_test.go
  - uint128.go
  - uint128_test.go
  - varying_data_type.go
  - varying_data_type_example_test.go
  - varying_data_type_nested_test.go
  - varying_data_type_test.go
- - db_getter_mocks_test.go
  - errors.go
  - layout.go
  - layout_test.go
  - mocks_generate_test.go
  - trie.go
- - create_snapshot.go
  - go.mod
  - go.sum
  - README.md
- - common_p2p.go
- - README.md
  - retrieve_block.go
  - retrieve_block_test.go
- - retrieve_state.go
- - network_integration_test.go
- - empty.go
  - package-lock.json
  - package.json
  - start_polkadotjs_test.go
  - test.js
  - test_transaction.js
- - empty.go
  - rpc_00_test.go
  - rpc_01-system_test.go
  - rpc_02-author_test.go
  - rpc_03-chain_test.go
  - rpc_04-offchain_test.go
  - rpc_05-state_test.go
  - rpc_06-engine_test.go
  - rpc_07-payment_test.go
  - rpc_08-contracts_test.go
  - rpc_09-babe_test.go
  - system_integration_test.go
- - errors.go
  - grandpa_test.go
  - helpers.go
  - network_test.go
  - stress_test.go
- - empty.go
  - sync_test.go
- - build.go
  - common.go
  - framework.go
  - genesis_two_auths_secondaryvrf_0_9_10.json
  - gossamer_utils.go
  - writer.go
- - 0001-basic-network.toml
  - 0001-basic-network.zndsl
  - 0002-basic-network.toml
  - 0002-basic-network.zndsl
.deepsource.toml
.dockerignore
.gitattributes
.gitignore
.golangci.yml
.releaserc
CHANGELOG.md
codecov.yml
copyright.txt
docker-compose.yml
Dockerfile
Dockerfile.development
go.mod
go.sum
LICENSE
Makefile
README.md

# Installation Guide

1. Get the code

git clone https://github.com/ChainSafe/gossamer

Downloads the entire project code from GitHub to your computer.

cd gossamer

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f devnet/cross-client/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

cd devnet

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

4. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make gossamer

Compiles the code based on the generated build configuration to produce an executable.

make install

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

gossamer

File Explorer

# Installation Guide

2. Docker

3. Go

4. Make

Today's picks

Was this content helpful?

Recent Feedback

gossamer

File Explorer

# Installation Guide

2. Docker

3. Go

4. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README