11# Rollkit
22
3- A modular framework for rollups, with an ABCI-compatible client interface. For more in-depth information about Rollkit, please visit our [ website] ( https://rollkit.dev ) .
3+ A modular framework for rollups, with an ABCI-compatible client interface. For more in-depth information about Rollkit, please visit our [ website] [ docs ] .
44
55<!-- markdownlint-disable MD013 -->
66[ ![ build-and-test] ( https://github.com/rollkit/rollkit/actions/workflows/test.yml/badge.svg )] ( https://github.com/rollkit/rollkit/actions/workflows/test.yml )
@@ -10,14 +10,17 @@ A modular framework for rollups, with an ABCI-compatible client interface. For m
1010[ ![ GoDoc] ( https://godoc.org/github.com/rollkit/rollkit?status.svg )] ( https://godoc.org/github.com/rollkit/rollkit )
1111<!-- markdownlint-enable MD013 -->
1212
13- ## Rollkit CLI
13+ ## Using Rollkit
14+ ### Rollkit CLI
15+
16+ The easiest way to use rollkit is via the rollkit CLI.
1417
1518Requires Go version >= 1.21.
1619
1720A cli tool that allows you to run different kinds of nodes for a rollkit network
1821while also helping you generate the required configuration files
1922
20- ### Install
23+ #### Install
2124
2225To install ` rollkit ` , simply run the following command at the root of the
2326rollkit repo
@@ -32,78 +35,45 @@ The latest Rollkit is now installed. You can verify the installation by running:
3235rollkit version
3336```
3437
38+ #### Quick Start
39+
40+ You can spin up a local rollkit network with the following command:
41+
42+ ``` bash
43+ rollkit start
44+ ```
45+
3546Explore the CLI documentation [ here] ( ./cmd/rollkit/docs/rollkit.md )
3647
3748## Building with Rollkit
3849
3950While Rollkit is a modular framework that aims to be compatible with a wide
4051range of data availability layers, settlement layers, and execution
41- environments, the most supported development environment is building on Celestia
42- as a data availability layer.
43-
44- ### Building on Celestia
45-
46- You can build Rollkit rollups with [ local-celestia-devnet] ( https://github.com/rollkit/local-celestia-devnet ) ,
47- [ arabica devnet] ( https://docs.celestia.org/nodes/arabica-devnet ) and
48- [ mocha testnet] ( https://docs.celestia.org/nodes/mocha-testnet ) and
49- [ mainnet beta] ( https://docs.celestia.org/nodes/mainnet ) .
50-
51- #### Compatibility
52-
53- | network | rollkit | celestia-node | celestia-app |
54- | --------------------- | ------- | ------------- | ------------ |
55- | local-celestia-devnet | v0.13.0 | v0.13.1 | v1.7.0 |
56- | arabica | v0.13.0 | v0.13.1 | v1.7.0 |
57- | mocha | v0.13.0 | v0.13.1 | v1.7.0 |
58- | mainnet | v0.13.0 | v0.13.1 | v1.7.0 |
59-
60- <!-- markdownlint-disable MD013 -->
61- | rollkit/cosmos-sdk | rollkit/cometbft | rollkit |
62- | -| -| -|
63- | [ v0.50.5-rollkit-v0.13.0-no-fraud-proofs] ( https://github.com/rollkit/cosmos-sdk/releases/tag/v0.50.5-rollkit-v0.13.0-no-fraud-proofs ) | v0.38.5| [ v0.13.0] ( https://github.com/rollkit/rollkit/releases/tag/v0.13.0 ) |
64- <!-- markdownlint-enable MD013 -->
65-
66- #### Local development environment
67-
68- The Rollkit v0.13.0 release is compatible with the
69- [ local-celestia-devnet] ( https://github.com/rollkit/local-celestia-devnet ) [ v0.13.1] ( https://github.com/rollkit/local-celestia-devnet/releases/tag/v0.13.1 )
70- release. This version combination is compatible with celestia-app
71- [ v1.7.0] ( https://github.com/celestiaorg/celestia-app/releases/tag/v1.7.0 )
72- and celestia-node
73- [ v0.13.1] ( https://github.com/celestiaorg/celestia-node/releases/tag/v0.13.1 ) .
52+ environments.
7453
75- #### Arabica devnet and Mocha testnet
54+ Check out our tutorials on our [ website ] [ docs ] .
7655
77- The Rollkit v0.13.0 release is compatible with
78- [ arabica-11] ( https://docs.celestia.org/nodes/arabica-devnet/ ) devnet
79- [ mocha-4] ( https://docs.celestia.org/nodes/mocha-testnet/ ) testnet which are running
80- celestia-app
81- [ v1.7.0] ( https://github.com/celestiaorg/celestia-app/releases/tag/v1.7.0 )
82- and celestia-node
83- [ v0.13.1] ( https://github.com/celestiaorg/celestia-node/releases/tag/v0.13.1 ) .
8456
85- #### Celestia mainnet
86-
87- The Rollkit v0.13.0 release is compatible with [ mainnet-beta] ( https://docs.celestia.org/nodes/mainnet/ )
88- which is running celestia-app
89- [ v1.7.0] ( https://github.com/celestiaorg/celestia-app/releases/tag/v1.7.0 )
90- and celestia-node
91- [ v0.13.1] ( https://github.com/celestiaorg/celestia-node/releases/tag/v0.13.1 ) .
57+ ## Contributing
9258
93- #### Cometbft v0.37.x and Cosmos-SDK v0.47.x
59+ We welcome your contributions! Everyone is welcome to contribute, whether it's
60+ in the form of code, documentation, bug reports, feature
61+ requests, or anything else.
9462
95- The Rollkit v0.10.7 release is compatible with Cometbft v0.37.2 and Cosmos-SDK
96- v0.47.6. However, this version is no longer supported for future developments and
97- it is recommended to use Rollkit v0.13.x.
63+ If you're looking for issues to work on, try looking at the
64+ [ good first issue list] ( https://github.com/rollkit/rollkit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 ) .
65+ Issues with this tag are suitable for a new external contributor and is a great
66+ way to find something you can help with!
9867
99- ### Tools
68+ See
69+ [ the contributing guide] ( https://github.com/rollkit/rollkit/blob/main/CONTRIBUTING.md )
70+ for more details.
10071
101- 1 . Install [ golangci-lint] ( https://golangci-lint.run/welcome/install/ )
102- 1 . Install [ markdownlint] ( https://github.com/DavidAnson/markdownlint )
103- 1 . Install [ hadolint] ( https://github.com/hadolint/hadolint )
104- 1 . Install [ yamllint] ( https://yamllint.readthedocs.io/en/stable/quickstart.html )
72+ Please join our
73+ [ Community Discord] ( https://discord.com/invite/YsnTPcSfWQ )
74+ to ask questions, discuss your ideas, and connect with other contributors.
10575
106- ## Helpful commands
76+ ### Helpful commands
10777
10878``` sh
10979# Run unit tests
@@ -120,38 +90,24 @@ make proto-lint
12090
12191```
12292
123- ## Contributing
124-
125- We welcome your contributions! Everyone is welcome to contribute, whether it's
126- in the form of code, documentation, bug reports, feature
127- requests, or anything else.
128-
129- If you're looking for issues to work on, try looking at the
130- [ good first issue list] ( https://github.com/rollkit/rollkit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 ) .
131- Issues with this tag are suitable for a new external contributor and is a great
132- way to find something you can help with!
133-
134- See
135- [ the contributing guide] ( https://github.com/rollkit/rollkit/blob/main/CONTRIBUTING.md )
136- for more details.
93+ ### Tools
13794
138- Please join our
139- [ Community Discord] ( https://discord.com/invite/YsnTPcSfWQ )
140- to ask questions, discuss your ideas, and connect with other contributors.
95+ 1 . Install [ golangci-lint] ( https://golangci-lint.run/welcome/install/ )
96+ 1 . Install [ markdownlint] ( https://github.com/DavidAnson/markdownlint )
97+ 1 . Install [ hadolint] ( https://github.com/hadolint/hadolint )
98+ 1 . Install [ yamllint] ( https://yamllint.readthedocs.io/en/stable/quickstart.html )
14199
142100## Dependency graph
143101
144102To see our progress and a possible future of Rollkit visit our [ Dependency
145103Graph] ( https://github.com/rollkit/rollkit/blob/main/specs/src/specs/rollkit-dependency-graph.md ) .
146104
147- ## Code of Conduct
148-
149- See our Code of Conduct [ here] ( https://docs.celestia.org/community/coc ) .
150-
151105## Audits
152106
153107| Date | Auditor | Version | Report |
154108| ------------| -----------------------------------------------| -------------------------------------------------------------------------------------| ---------------------------------------------------------|
155109| 2024/01/12 | [ Informal Systems] ( https://informal.systems/ ) | [ eccdd...bcb9d] ( https://github.com/rollkit/rollkit/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d ) | [ informal-systems.pdf] ( specs/audit/informal-systems.pdf ) |
156110| 2024/01/10 | [ Binary Builders] ( https://binary.builders/ ) | [ eccdd...bcb9d] ( https://github.com/rollkit/rollkit/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d ) | [ binary-builders.pdf] ( specs/audit/binary-builders.pdf ) |
157111
112+
113+ [ docs ] : https://rollkit.dev
0 commit comments