README
¶
Rollkit
Rollkit is the first sovereign application framework. For more in-depth information about Rollkit, please visit our website.
Using Rollkit
Example Implementation: TestApp CLI
The easiest way to understand how to use Rollkit is by exploring our example implementation, TestApp.
Requires Go version >= 1.22.
TestApp is a CLI tool that demonstrates how to run different kinds of nodes using the Rollkit framework. It serves as a reference implementation and helps you understand how to build your own Rollkit-based blockchain.
Install
To install the example testapp, simply run the following command at the root of the
rollkit repo:
make install
The latest TestApp example is now installed. You can verify the installation by running:
testapp version
Quick Start
You can spin up a local TestApp network (powered by Rollkit) with the following command:
testapp start
Building with Rollkit
Rollkit is the first sovereign application framework that allows you to launch a sovereign, customizable blockchain as easily as a smart contract. TestApp serves as a reference implementation to help you get started with your own Rollkit-based blockchain.
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
- Install golangci-lint
- Install markdownlint
- Install hadolint
- Install yamllint
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 |
Directories
¶
| Path | Synopsis |
|---|---|
|
This pkg defines a set of sequencer configurations that can be used out of the box.
|
This pkg defines a set of sequencer configurations that can be used out of the box. |
|
core
module
|
|
|
da
module
|
|
|
execution
|
|
|
evm
module
|
|
|
pkg
|
|
|
signer/file
File Remote Signer implements the Signer interface using a file to store the keys.
|
File Remote Signer implements the Signer interface using a file to store the keys. |
|
signer/noop
Noop remote signer implements the Signer interface using a no-op signer.
|
Noop remote signer implements the Signer interface using a no-op signer. |
|
sequencers
|
|
|
based
module
|
|
|
single
module
|
|
|
test
|
|