Skip to content

Commit 84860e8

Browse files
MSeveyyarikbratashchuk
MSevey
and
yarikbratashchuk
authored
feat: docs restructuring, add deploy section, bring in v0.14.x (#493)
* chore: remove Rollkit has menu section and update naming Remove GM tutorial, add language around choosing DA and Execution * feat: create deploy your rollup section Remove kurtosis from wordle tutorial. Rename wordle tutorial in menu to build your rollup. Create overview for deployments sections. Create docker compose deployment tutorial. Create kurtosis deployment tutorial. Refactor tutorials to reduce duplication. * chore: bump rollkit version and sha to v0.14.0 * chore: various updates while debugging * chore: update menu titles * chore: change rollup to chain and adjust capitalzation * chore: clean up rollup vs chain usage in wordle tutorial * chore: bump rollkit to v0.14.1-rc.0 * feat: update ignite app how to guide * fix: clean up wordle tutorial * fix: docker compose turtorial * chore: edit kurtosis disclaimer * chore: remove kurtosis tutorial * chore: bump rollkit version * build: bump versions --------- Co-authored-by: Yarik Bratashchuk <[email protected]>
1 parent 668ed5c commit 84860e8

File tree

7 files changed

+733
-521
lines changed

7 files changed

+733
-521
lines changed

‎.vitepress/config.ts

Lines changed: 60 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ function nav() {
174174
{ text: "Learn", link: "/learn/intro" },
175175
{ text: "Tutorials", link: "/tutorials/quick-start" },
176176
{ text: "How To Guides", link: "/guides/overview" },
177-
{ text: "Testnets", link: "/testnets/cosmwasm-testnet" },
177+
// { text: "Testnets", link: "/testnets/cosmwasm-testnet" },
178178
{ text: "Blog", link: "/blog/overview" },
179179
];
180180
}
@@ -218,17 +218,7 @@ function sidebarHome() {
218218
text: "Quick start guide",
219219
link: "/tutorials/quick-start",
220220
},
221-
{
222-
text: "Rollkit",
223-
collapsed: true,
224-
items: [
225-
{
226-
text: "GM world rollup",
227-
link: "/tutorials/gm-world",
228-
},
229-
{ text: "Wordle app", link: "/tutorials/wordle" },
230-
],
231-
},
221+
{ text: "Build a chain", link: "/tutorials/wordle" },
232222
{
233223
text: "DA",
234224
collapsed: true,
@@ -273,18 +263,42 @@ function sidebarHome() {
273263
text: "Execution",
274264
collapsed: true,
275265
items: [
276-
{ text: "CosmWasm rollup", link: "/tutorials/cosmwasm" },
277-
{
266+
{ text: "CosmWasm", link: "/tutorials/cosmwasm" },
267+
{
278268
text: "EVM",
279-
collapsed: true,
280-
items: [
269+
collapsed: true,
270+
items: [
281271
{ text: "Omni Octane EVM", link: "/tutorials/octane-evm" },
282-
{ text: "BeaconKit EVM", link: "/tutorials/beaconkit" },
283-
{ text: "Artela EVM++", link: "/tutorials/artela-evm-plus-plus" },
284-
{ text: "Contract interaction", link: "/tutorials/evm-contract-interaction" },
285-
]
286-
},
287-
],
272+
{ text: "BeaconKit EVM", link: "/tutorials/beaconkit" },
273+
{
274+
text: "Artela EVM++",
275+
link: "/tutorials/artela-evm-plus-plus",
276+
},
277+
{
278+
text: "Contract interaction",
279+
link: "/tutorials/evm-contract-interaction",
280+
},
281+
],
282+
},
283+
],
284+
},
285+
{
286+
text: "Deploy your chain",
287+
collapsed: true,
288+
items: [
289+
{
290+
text: "Overview",
291+
link: "/tutorials/deploy-overview",
292+
},
293+
{
294+
text: "Docker Compose",
295+
link: "/tutorials/docker-compose",
296+
},
297+
// {
298+
// text: "Kurtosis",
299+
// link: "/tutorials/kurtosis",
300+
// },
301+
],
288302
},
289303
],
290304
},
@@ -350,32 +364,32 @@ function sidebarHome() {
350364
text: "Integrations",
351365
collapsed: true,
352366
items: [
353-
{
354-
text: "Test and deploy cosmwasm smart-contracts",
355-
link: "/guides/cw-orch",
356-
},
357-
{ text: "Add zkML to your EVM rollup", link: "/guides/zkml" },
358-
{
359-
text: "Add an IBC connection to your rollup",
360-
link: "/guides/ibc-connection",
361-
},
362-
{
363-
text: "Integrate Range with your rollup",
364-
link: "/guides/rollkit-monitoring",
365-
},
366-
{
367-
text: "Use IBC token (TIA) as gas token in your rollup",
368-
link: "/guides/use-tia-for-gas",
369-
},
370-
],
371-
},
367+
{
368+
text: "Test and deploy cosmwasm smart-contracts",
369+
link: "/guides/cw-orch",
370+
},
371+
{ text: "Add zkML to your EVM rollup", link: "/guides/zkml" },
372+
{
373+
text: "Add an IBC connection to your rollup",
374+
link: "/guides/ibc-connection",
375+
},
376+
{
377+
text: "Integrate Range with your rollup",
378+
link: "/guides/rollkit-monitoring",
379+
},
380+
{
381+
text: "Use IBC token (TIA) as gas token in your rollup",
382+
link: "/guides/use-tia-for-gas",
383+
},
384+
],
385+
},
372386
],
373387
},
374-
{
375-
text: "Testnets",
376-
collapsed: true,
377-
items: [{ text: "CosmWasm Testnet", link: "/testnets/cosmwasm-testnet" }],
378-
},
388+
// {
389+
// text: "Testnets",
390+
// collapsed: true,
391+
// items: [{ text: "CosmWasm Testnet", link: "/testnets/cosmwasm-testnet" }],
392+
// },
379393
{
380394
text: "Blog",
381395
collapsed: true,

‎.vitepress/constants/constants.js

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

7-
rollkitLatestTag: "v0.13.7",
8-
rollkitLatestSha: "8deede4",
7+
rollkitLatestTag: "v0.14.1",
8+
rollkitLatestSha: "5a8693e",
99
rollkitCosmosSDKVersion: "v0.50.6-rollkit-v0.13.3-no-fraud-proofs",
1010
rollkitIgniteAppVersion: "rollkit/v0.2.1",
1111

1212
localDALatestTag: "v0.3.1",
13-
goSequencingLatestTag: "v0.4.0",
13+
goSequencingLatestTag: "v0.4.1",
1414
igniteVersionTag: "v28.5.3",
1515
});
1616
export default constants;

‎guides/ignite-rollkit.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -30,26 +30,6 @@ This will create the `gm` blockchain. Navigate to the blockchain directory:
3030
cd gm
3131
```
3232

33-
## Run a local Data Availability (DA) node {#run-local-da-node}
34-
35-
First, set up a local data availability network node:
36-
37-
```bash-vue
38-
cd $HOME && curl -sSL https://rollkit.dev/install-local-da.sh | sh -s {{constants.localDALatestTag}}
39-
```
40-
41-
This script builds and runs a DA node, which will listen on port `7980`.
42-
43-
## Run a local Sequencer node {#run-local-sequencer-node}
44-
45-
First, set up a local sequencer node:
46-
47-
```bash-vue
48-
cd $HOME && curl -sSL https://rollkit.dev/install-local-sequencer.sh | sh -s {{constants.goSequencingLatestTag}} gm
49-
```
50-
51-
This script builds and runs a local sequencer node, which will listen on port `50051`.
52-
5333
## Install Ignite App Rollkit {#install-ignite-app-rollkit}
5434

5535
In a new terminal window, you'll now install and run the Ignite App Rollkit.
@@ -70,6 +50,14 @@ Enhance your blockchain by adding Rollkit features. Use the following command:
7050
ignite rollkit add
7151
```
7252

53+
## Build your chain {#build-your-chain}
54+
55+
Build your chain using the following command:
56+
57+
```bash
58+
ignite chain build
59+
```
60+
7361
## Initialize Your Blockchain {#initialize-your-blockchain}
7462

7563
Before starting your blockchain, you need to initialize it with Rollkit support. Initialize the blockchain with Local DA as follows:
@@ -88,16 +76,21 @@ rollkit toml init
8876

8977
This will set up the Rollkit configuration file rollkit.toml, allowing you to use the Rollkit CLI for managing and running your blockchain.
9078

91-
## Start Your Rollup {#start-your-blockchain}
79+
## Start your chain {#start-your-chain}
80+
81+
Now you are ready to start your chain. We need to include 2 flags:
82+
83+
1. `--rollkit.aggregator` to signal that this node is the block producer
84+
2. `--rollkit.sequencer_rollup_id gm` to share the chain ID with the sequencer.
9285

93-
Finally, start your rollup (blockchain) using the following command:
86+
Start your chain using the following command:
9487

9588
```bash
96-
rollkit start --rollkit.aggregator --rollkit.da_address http://localhost:7980
89+
rollkit start --rollkit.aggregator --rollkit.sequencer_rollup_id gm
9790
```
9891

99-
Your rollkit app is now up and running.
92+
Your rollkit chain is now up and running.
10093

10194
## Summary
10295

103-
By following these steps, you've successfully installed Ignite, set up Local DA, integrated Rollkit features into your blockchain, and configured the Rollkit CLI.
96+
By following these steps, you've successfully installed Ignite, integrated Rollkit features into your blockchain, and configured the Rollkit CLI to run your chain against a mock DA and mock sequencer.

‎tutorials/deploy-overview.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
description: This page provides an overview of some common ways to deploy rollups.
3+
---
4+
5+
# Deploying Your Rollup
6+
7+
One of the benefits of building rollups with Rollkit is the flexibility you have as a developer to choose things like the DA layer, the settlement scheme, and the execution environment.
8+
9+
The challenge that comes with this flexibility is that there are more services that now need to be deployed and managed while running your rollup.
10+
11+
In the tutorials so far, you've seen various helper scripts used to make things easier. While great for tutorials, there are better ways to deploy and manage rollups than using various bash scripts.
12+
13+
In this section, you'll see a few examples of how you can deploy your rollup environment with all your services running in a more production-ready way.
14+
15+
:::warning Disclaimer
16+
These examples are for educational purposes only. Before deploying your rollup for production use you should fully understand the services you are deploying and your choice in deployment method.
17+
:::
18+
19+
* [Deploy with Docker Compose](/tutorials/docker-compose)
20+
<!-- * [Deploy with Kurtosis](/tutorials/kurtosis) -->

0 commit comments

Comments
 (0)