Skip to content

Commit 3c27267

Browse files
authored
README: add section with clearer compatibility and development steps (cosmos#1011)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. --> ## Overview Added a section to the README to make it more explicit as to which versions rollkit is compatible with with celestia and how to use the local devnet vs arabica and mocha. <!-- Please provide an explanation of the PR, including the appropriate context, background, goal, and rationale. If there is an issue with this information, please provide a tl;dr and link the issue. --> ## Checklist <!-- Please complete the checklist to ensure that the PR is ready to be reviewed. IMPORTANT: PRs should be left in Draft until the below checklist is completed. --> - [x] New and updated code has appropriate documentation - [x] New and updated code has new and/or updated testing - [x] Required CI checks are passing - [x] Visual proof for any user facing features like CLI or documentation updates - [x] Linked issues closed with keywords
1 parent c695de5 commit 3c27267

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

Makefile

+6
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ lint:
3333

3434
.PHONY: lint
3535

36+
## fmt: Run fixes for linters. Currently only markdownlint.
37+
fmt:
38+
@echo "--> Formatting markdownlint"
39+
@markdownlint --config .markdownlint.yaml '**/*.md' -f
40+
.PHONY: fmt
41+
3642
## test-unit: Running unit tests
3743
test-unit:
3844
@echo "--> Running unit tests"

README.md

+38
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,44 @@ cd rollkit
2020
go build -v ./...
2121
```
2222

23+
## Building With Rollkit
24+
25+
While Rollkit is a modular framework that aims to be compatible with a wide
26+
range of data availability layers, settlement layers, and execution
27+
environments, the most supported development environment is building on Celestia
28+
as a data availability layer.
29+
30+
### Building On Celestia
31+
32+
There are currently 2 ways to build on Celestia:
33+
34+
1. Using a local development environment with [local-celestia-devnet](https://github.com/rollkit/local-celestia-devnet)
35+
1. Using the Arabica or Mocha Celestia testnet
36+
37+
#### Local Development Environment
38+
39+
The current Rollkit v0.8.1 release is compatible with the
40+
[local-celestia-devnet](https://github.com/rollkit/local-celestia-devnet)
41+
v0.10.4 release. This version combination is compatible with
42+
[celesita-app](https://github.com/celestiaorg/celestia-app) v0.13.3 and
43+
[celestia-node](https://github.com/celestiaorg/celestia-node) v0.10.4.
44+
45+
For more information see the [release
46+
notes](https://github.com/rollkit/local-celestia-devnet/releases/tag/v0.10.4)
47+
for v0.10.4 of local-celestia-devnet.
48+
49+
#### Arabica and Mocha Testnets
50+
51+
> :warning: **Rollkit v0.8.1 is not compatible with latest releases of Arabica and Mocha.** :warning:
52+
53+
Arabica compatibility is currently under development on the `arabica` branch of
54+
the rollkit repo. If you are need to test or build on Arabica, please reach out
55+
the Rollkit team and track the progress of the `arabica` branch and the
56+
v0.8.2-rcx releases.
57+
58+
The key updates to making Rollkit compatible with Arabica and Mocha are making
59+
Rollkit compatible with celestia-app v1.0.0-rcX and celestia-node v0.11.0-rcX.
60+
2361
### Tools
2462

2563
1. Install [golangci-lint](https://golangci-lint.run/usage/install/)

0 commit comments

Comments
 (0)