JAM-Protocol

JAM Protocol Implementation

A Go implementation of the Polkadot JAM Protocol, built by the New-JAMneration team.

Project Status

• ✅ Milestone 1 (M1) — Passed. See our on-chain attestation.

Table of Contents

• Documentation
• Getting Started
  • Prerequisites
  • Clone the repository
  • Install dependencies
  • Run
  • Build
• Testing
• Conformance & Fuzzing
• Operations
• Contributing
• License

Documentation

Our development documentation is maintained on HackMD for real-time collaboration and easy updates.

This is our mindmap link: JAM Mindmap

If you want to update the mindmap, you can go to the JAM-mindmap repository.

Access Documentation

• Full documentation index: READMERef/INDEX.md
• Main documentation: HackMD Development Guide
• Development documentation: Github Document
• Requires team member access - please contact project maintainers if you need access

Getting Started

Prerequisites

• Go 1.25.5+
• Rust toolchain — required to build the VRF submodule (see the Rust VRF Compile Guide)
• make and a POSIX shell
• (Optional) Docker — for release builds and fuzz-target runs

Clone the repository

This project uses git submodules (Rust-VRF and test-data vectors), so clone with submodules:

git clone --recurse-submodules https://github.com/New-JAMneration/JAM-Protocol.git

If you already cloned without --recurse-submodules:

git submodule update --init --recursive

Install dependencies

go mod tidy

Run the JAM Protocol

make run

Build the JAM Protocol

make build

Testing

Test jam-test-vectors

Run single test:

make test-jam-test-vectors mode=safrole size=full

make test-jam-test-vectors-trace mode=safrole

Run all:

make test-jam-test-vectors

make test-jam-test-vectors-trace

Conformance & Fuzzing

We continuously validate the node against the JAM Conformance fuzz protocol. See the Fuzz Validation guide for vectors, trace, socket, and CI steps.

Operations

• Release and Publish: see the release and publish guide.
• Rust Submodule: for compiling and using the Rust library, see the Rust VRF Compile Guide.
• Encoder/Decoder: for details of the encoder and decoder, see the Encoder & Decoder guide.

Contributing

• Coding Style: our codebase follows the Google Go Style Guide for consistent and maintainable code.
• Code Formatting: we use gofmt to maintain consistent code formatting. See the commands here.
• Commit Message: please stick to the Semantic Commit Messages when submitting a commit.
• Pull Request: before creating a pull request, please rebase (instead of merging) your branch onto the target branch. Also, follow these instructions to link your PR to the assigned ticket's issue.

License

Licensed under the Apache License 2.0.