Rollkit

A modular framework for rollups, with an ABCI-compatible client interface. For more in-depth information about Rollkit, please visit our website.

Using Rollkit

Rollkit CLI

The easiest way to use rollkit is via the rollkit CLI.

Requires Go version >= 1.22.

A cli tool that allows you to run different kinds of nodes for a rollkit network while also helping you generate the required configuration files

Install

To install rollkit, simply run the following command at the root of the rollkit repo

make install

The latest Rollkit is now installed. You can verify the installation by running:

rollkit version

TEST Before Quick Start Section

note: nodekit-relay & opstack-deployment need to be running for nodekit demo to work!

1.) Follow opstack-deployment README 2.) After getting SEQ running in step 1, run 'python main.py --cloudprovider="aws" seq-info' in the opstack-deployment repo to get SEQ chainID and uri. 3.) To monitor SEQ, cd into nodekit-seq and run './build/token-cli chain import'(enter info from step 2 here) and then do './build/token-cli chain watch' and click your chain. 4.) Enter chainID and uri info in state/executor.go #L37-38 & state/executor_test.go #L360-361 5.) Follow nodekit-relay, enter info in config.json(run rollkit local DA to keep it simple), and lastly run the relayer by doing go run main.go ./config.json

note: run rollkit local DA: curl -sSL https://rollkit.dev/install-local-da.sh | bash -s v0.2.0 in main dir

6.) Once all the info is set, run 'go test -v' in state repo. This will submit txs to SEQ which you can see by having done step 3 7.) After you see the submitted txs in SEQ, take that block height and input it for state/executor.go #L152 & #L250 AND state/executor_test.go #L383 8.) Do step 6 and all the information should be printed and work as expected. 9.) After you see everything work as expected, go onto next section (Quick Start w/NodKit)!

Notes(errors)

• To fix rollkit: command not found despite installing rollkit by docs, do below: export PATH="$HOME/go/bin:/rollkit:$PATH"

• export CGO_CFLAGS="-O -D__BLST_PORTABLE__" to fix Caught SIGILL in blst_cgo_init, consult /bindings/go/README.md.

Quick Start w/NodeKit

You can spin up a local rollkit network with the following command:

rollkit start

Explore the CLI documentation here

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.

Check out our tutorials on our website.

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.

Helpful commands

# Run unit tests
make test

# 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

Tools

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

Dependency graph

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

Audits

Date	Auditor	Version	Report
2024/01/12	Informal Systems	eccdd...bcb9d	informal-systems.pdf
2024/01/10	Binary Builders	eccdd...bcb9d	binary-builders.pdf