Skip to content

Commit 3a3e45a

Browse files
authored
Merge branch 'main' into hyperlane
2 parents 9d18118 + d535b60 commit 3a3e45a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+6500
-3952
lines changed

.github/dependabot.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
open-pull-requests-limit: 10
8+
labels:
9+
- T:dependencies
10+
# Group all patch updates into a single PR
11+
groups:
12+
patch-updates:
13+
applies-to: version-updates
14+
update-types:
15+
- "patch"
16+
- package-ecosystem: npm
17+
directory: "/"
18+
schedule:
19+
interval: weekly
20+
open-pull-requests-limit: 10
21+
labels:
22+
- T:dependencies
23+
# Group all patch updates into a single PR
24+
groups:
25+
patch-updates:
26+
applies-to: version-updates
27+
update-types:
28+
- "patch"

.github/workflows/auto_review_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
jobs:
88
auto-add-reviewer:
99
name: Auto add reviewer to PR
10-
uses: rollkit/.github/.github/workflows/reusable_housekeeping.yml@v0.3.0
10+
uses: rollkit/.github/.github/workflows/reusable_housekeeping.yml@v0.4.1
1111
secrets: inherit
1212
permissions:
1313
issues: write

.github/workflows/build.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Build VitePress Site
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
- name: Setup Node
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: 18
18+
cache: yarn # or pnpm / npm
19+
- name: Install dependencies
20+
run: yarn install # or pnpm install / npm ci
21+
- name: Build with VitePress
22+
run: yarn docs:build # or pnpm docs:build / npm docs:build

.github/workflows/deploy.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,23 @@ jobs:
2626
runs-on: ubuntu-latest
2727
steps:
2828
- name: Checkout
29-
uses: actions/checkout@v3
29+
uses: actions/checkout@v4
3030
with:
3131
fetch-depth: 0 # Not needed if lastUpdated is not enabled
3232
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
3333
- name: Setup Node
34-
uses: actions/setup-node@v3
34+
uses: actions/setup-node@v4
3535
with:
3636
node-version: 18
3737
cache: yarn # or pnpm / npm
3838
- name: Setup Pages
39-
uses: actions/configure-pages@v3
39+
uses: actions/configure-pages@v5
4040
- name: Install dependencies
4141
run: yarn install # or pnpm install / npm ci
4242
- name: Build with VitePress
4343
run: yarn docs:build # or pnpm docs:build / npm docs:build
4444
- name: Deploy to GitHub Pages
45-
uses: peaceiris/actions-gh-pages@v3
45+
uses: peaceiris/actions-gh-pages@v4
4646
with:
4747
github_token: ${{ secrets.GITHUB_TOKEN }}
4848
publish_dir: ./.vitepress/dist

.github/workflows/preview.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
name: Deploy PR previews
22

33
on:
4+
# This workflow requires pull_request and won't work with pull_request_target
5+
# due to github permissions
46
pull_request:
57
types:
68
- opened
@@ -16,10 +18,10 @@ jobs:
1618
permissions: write-all
1719
steps:
1820
- name: Checkout
19-
uses: actions/checkout@v3
21+
uses: actions/checkout@v4
2022

2123
- name: Setup Node
22-
uses: actions/setup-node@v3
24+
uses: actions/setup-node@v4
2325
with:
2426
node-version: 18
2527
cache: yarn

.vitepress/config.ts

Lines changed: 85 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ export default withMermaid({
106106
"script",
107107
{
108108
src: "https://platform.twitter.com/widgets.js",
109-
async: true,
109+
async: true,
110110
},
111111
],
112112
],
@@ -188,26 +188,26 @@ function sidebarHome() {
188188
{
189189
text: "Overview",
190190
collapsed: true,
191-
items: [
192-
{ text: "Introduction", link: "/learn/intro" },
191+
items: [
192+
{ text: "Introduction", link: "/learn/intro" },
193193
{ text: "About Rollkit", link: "/learn/about" },
194-
],
195-
},
196-
{
194+
],
195+
},
196+
{
197197
text: "Technical details",
198-
collapsed: true,
199-
items: [
198+
collapsed: true,
199+
items: [
200200
{ text: "Rollkit stack", link: "/learn/stack" },
201201
{ text: "Transaction flow", link: "/learn/transaction-flow" },
202-
],
203-
},
204-
{
205-
text: "Resources",
206-
collapsed: true,
207-
items: [
202+
],
203+
},
204+
{
205+
text: "Resources",
206+
collapsed: true,
207+
items: [
208208
{ text: "Technical specifications", link: "/learn/specifications" },
209-
],
210-
},
209+
],
210+
},
211211
],
212212
},
213213
{
@@ -226,7 +226,6 @@ function sidebarHome() {
226226
text: "GM world rollup",
227227
link: "/tutorials/gm-world",
228228
},
229-
{ text: "GM world frontend", link: "/tutorials/gm-world-frontend" },
230229
{ text: "Wordle app", link: "/tutorials/wordle" },
231230
],
232231
},
@@ -238,15 +237,28 @@ function sidebarHome() {
238237
text: "Celestia",
239238
link: "/tutorials/celestia-da",
240239
},
240+
{
241+
text: "Avail",
242+
link: "/tutorials/avail-da",
243+
},
241244
],
242245
},
243246
{
244247
text: "Execution",
245248
collapsed: true,
246249
items: [
247250
{ text: "CosmWasm rollup", link: "/tutorials/cosmwasm" },
248-
{ text: "Polaris EVM rollup", link: "/tutorials/polaris-evm" },
249-
],
251+
{
252+
text: "EVM",
253+
collapsed: true,
254+
items: [
255+
{ text: "Omni Octane EVM", link: "/tutorials/octane-evm" },
256+
{ text: "BeaconKit EVM", link: "/tutorials/beaconkit" },
257+
{ text: "Artela EVM++", link: "/tutorials/artela-evm-plus-plus" },
258+
{ text: "Contract interaction", link: "/tutorials/evm-contract-interaction" },
259+
]
260+
},
261+
],
250262
},
251263
],
252264
},
@@ -255,46 +267,74 @@ function sidebarHome() {
255267
collapsed: true,
256268
items: [
257269
{
270+
text: "Use the Rollkit CLI",
271+
link: "/guides/use-rollkit-cli",
272+
},
273+
{
274+
text: "Connect to a local DA",
275+
link: "/guides/connect-local-da",
276+
},
277+
{
278+
text: "Create genesis for your rollup",
279+
link: "/guides/create-genesis",
280+
},
281+
{
282+
text: "Restart your rollup",
283+
link: "/guides/restart-rollup",
284+
},
285+
{
286+
text: "Run a rollup full node",
287+
link: "/guides/full-node",
288+
},
289+
{
290+
text: "Configuration",
291+
collapsed: true,
258292
items: [
259293
{
260-
text: "How to restart your rollup",
261-
link: "/guides/restart-rollup",
294+
text: "Configure gas price",
295+
link: "/guides/gas-price",
262296
},
263297
{
264-
text: "How to run as a full and sequencer node",
265-
link: "/guides/full-and-sequencer-node",
298+
text: "Configure max pending blocks",
299+
link: "/guides/max-pending-blocks",
266300
},
267301
{
268-
text: "How to configure gas price",
269-
link: "/guides/gas-price",
302+
text: "Configure DA chain block sync time",
303+
link: "/guides/da-block-time",
270304
},
271305
{
272-
text: "How to change speed of block production",
306+
text: "Change speed of block production",
273307
link: "/guides/block-times",
274308
},
275309
{
276-
text: "How to use lazy sequencing (aggregation)",
310+
text: "Use lazy sequencing (aggregation)",
277311
link: "/guides/lazy-sequencing",
278312
},
279-
{
280-
text: "How to test and deploy smart-contracts",
281-
link: "/guides/cw-orch",
282-
},
283-
{ text: "How to add zkML to your rollup", link: "/guides/zkml" },
284-
{
285-
text: "How to add an IBC connection to your rollup",
286-
link: "/guides/ibc-connection",
287-
},
288-
{
289-
text: "How to integrate Range with your rollup",
290-
link: "/guides/rollkit-monitoring",
291-
},
292-
{
293-
text: "How to use IBC token (TIA) as gas token in your rollup",
294-
link: "/guides/use-tia-for-gas",
295-
},
296313
],
297314
},
315+
{
316+
text: "Integrations",
317+
collapsed: true,
318+
items: [
319+
{
320+
text: "Test and deploy cosmwasm smart-contracts",
321+
link: "/guides/cw-orch",
322+
},
323+
{ text: "Add zkML to your EVM rollup", link: "/guides/zkml" },
324+
{
325+
text: "Add an IBC connection to your rollup",
326+
link: "/guides/ibc-connection",
327+
},
328+
{
329+
text: "Integrate Range with your rollup",
330+
link: "/guides/rollkit-monitoring",
331+
},
332+
{
333+
text: "Use IBC token (TIA) as gas token in your rollup",
334+
link: "/guides/use-tia-for-gas",
335+
},
336+
],
337+
},
298338
],
299339
},
300340
{
@@ -314,7 +354,7 @@ function sidebarHome() {
314354
{
315355
text: "Rollkit: The First Sovereign Rollup Framework",
316356
link: "/blog/rollkit-the-first-sovereign-rollup-framework",
317-
}
357+
},
318358
],
319359
},
320360
];

.vitepress/constants/constants.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ const constants = Object.freeze({
44
nodeVersion: "21.7.2",
55
yarnVersion: "1.22.19",
66

7-
rollkitLatestTag: "v0.13.3",
8-
rollkitLatestSha: "45b1573",
7+
rollkitLatestTag: "v0.13.8",
8+
rollkitLatestSha: "6a33192",
99
rollkitCosmosSDKVersion: "v0.50.6-rollkit-v0.13.3-no-fraud-proofs",
10+
rollkitIgniteAppVersion: "v0.2.1",
1011

11-
localDALatestTag: "v0.2.0",
12+
localDALatestTag: "v0.3.1",
1213

13-
igniteVersionTag: "v28.3.0",
14+
igniteVersionTag: "v28.4.0",
1415
});
1516
export default constants;

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Deploy](https://github.com/rollkit/docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/rollkit/docs/actions/workflows/deploy.yml)
2+
13
# Rollkit Documentation Site
24

35
Welcome to the official documentation repository for Rollkit.

guides/block-times.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ If you have gone through both the [GM world](./gm-world) and the
44
[Full and sequencer node rollup setup](./full-and-sequencer-node)
55
already, you're now ready to experiment with faster block times.
66

7-
In your `gmd start [args...]` command, you will need to add a flag
7+
In your `rollkit start [args...]` command, you will need to add a flag
88
and then the argument for block time.
99

1010
The flag is:
@@ -19,8 +19,8 @@ Here is an example:
1919

2020
```bash
2121
# start the chain
22-
gmd start [existing flags...] // [!code --]
23-
gmd start [existing flags...] --rollkit.block_time 1s // [!code ++]
22+
rollkit start [existing flags...] // [!code --]
23+
rollkit start [existing flags...] --rollkit.block_time 1s // [!code ++]
2424
```
2525

2626
In the above example, we've changed it to one second blocks.
@@ -33,5 +33,5 @@ Alternatively, you could slow your rollup down to 30 seconds:
3333
Or speed it up even more, to sub-second block times (100 milliseconds):
3434

3535
```bash
36-
--rollkit.block_time 0.1ms
36+
--rollkit.block_time 100ms
3737
```

guides/connect-local-da.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# How to connect a rollup to a local DA network
2+
3+
<!-- markdownlint-disable MD033 -->
4+
<script setup>
5+
import constants from '../.vitepress/constants/constants.js'
6+
</script>
7+
8+
This guide provides a quick and straightforward method to start a local Data Availability (DA) network and configure your rollup to post data to it.
9+
10+
## Setting Up a Local DA Network
11+
12+
To set up a local DA network node on your machine, run the following script to install and start the local DA node:
13+
14+
```bash-vue
15+
curl -sSL https://rollkit.dev/install-local-da.sh | bash -s {{constants.localDALatestTag}}
16+
```
17+
18+
This script will build and run the node, which will then listen on port `7980`.
19+
20+
## Configuring your rollup to connect to the local DA network
21+
22+
To connect your rollup to the local DA network, you need to pass the `--rollkit.da_address` flag with the local DA node address.
23+
24+
## Run your rollup
25+
26+
Start your rollup node with the following command, ensuring to include the DA address flag:
27+
28+
```bash
29+
rollkit start \
30+
--rollkit.da_address http://localhost:7980 \
31+
<other-flags>
32+
```
33+
34+
## Summary
35+
36+
By following these steps, you will set up a local DA network node and configure your rollup to post data to it. This setup is useful for testing and development in a controlled environment.

0 commit comments

Comments
 (0)