Rollkit
A modular framework for rollups, with an ABCI-compatible client interface. For more in-depth information about Rollkit, please visit our website.
Building From Source
Requires Go version >= 1.19.
To build:
git clone https://github.com/rollkit/rollkit.git
cd rollkit
go build -v ./...
- Install golangci-lint
- Install markdownlint
- Install hadolint
- 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 issue list. 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 Discord 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.
Code of Conduct
See our Code of Conduct here.