JAM Protocol Implemetation

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

• Main documentation: HackMD Development Guide
• Development documentation: Github Document
• Requires team member access - please contact project maintainers if you need access

Set up

To install the libraries:

go mod tidy

Start the JAM Protocol

make run

Compile the JAM Protocol

make build

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

Release and Publish

You can find the release and publish guide here.

Rust Submodule Guide

For instructions on compiling and using the Rust library, please refer to this guide.

Encoder/Decoder

For details of encoder and decoder, please refer to this guide.

Coding Style

Our codebase follows the Google Go Style Guide for consistent and maintainable code.

Following these guidelines helps maintain code quality and ensures consistency across the project.

Code Formatting

We use gofmt to maintain consistent code formatting. Here are the commands you can use.

Commit massage

Please stick to here when you are going to submit a commit.

Pull Request

Before creating a pull request, please rebase (instead of merging) your branch onto the branch you want to merge into.

Also, follow these instructions to link your PR to the assigned ticket’s issue.