Building with Rollkit ​

While Rollkit is a modular framework that aims to be compatible with a wide range of data availability layers, settlement layers, and execution environments, the most supported development environment is building on Celestia as a data availability layer.

Building from source ​

Dependencies ​

• Requires Go version >= 1.19

To build:

git clone https://github.com/rollkit/rollkit.git
cd rollkit 
go build -v ./...

Building on Celestia ​

There are currently 2 ways to build on Celestia:

1. Using a local development environment with local-celestia-devnet
2. Using the Arabica or Mocha Celestia testnets*

Compatibility ​

Local Development Environment ​

The Rollkit v0.9.0 release is compatible with the local-celestia-devnet oolong release. This version combination is compatible with celestia-app v1.0.0-rc7 and celestia-node v0.11.0-rc8.

Arabica devnet and Mocha testnet ​

The Rollkit v0.9.0 release is compatible with Arabica devnet which is running celestia-app v1.0.0-rc7 and celestia-node v0.11.0-rc8.

Testing ​

1. Install golangci-lint
2. Install markdownlint
3. Install hadolint
4. Install yamllint

Helpful Commands ​

# Run unit tests
make test-unit

# Run unit tests with the data race detector
make test-unit-race

# Run tests with and without the data race detector
make test-all

# Generate protobuf files (requires Docker)
make proto-gen

# Run linters (requires golangci-lint, markdownlint, hadolint, and yamllint)
make lint

# Lint protobuf files (requires Docker and buf)
make proto-lint

Contributing ​

We welcome your contributions! Everyone is welcome to contribute, whether it's in the form of code, documentation, bug reports, feature requests, or anything else.

If you're looking for issues to work on, try looking at the Good First Issues on GitHub. Issues with this tag are suitable for a new external contributor and is a great way to find something you can help with!

See the Contributing Guide for more details.

Please join our Community Telegram to ask questions, discuss your ideas, and connect with other contributors.

Dependency Graph ​

To see our progress and a possible future of Rollkit visit our Dependency Graph.