Skip to content

Commit d11a712

Browse files
authored
fix: cleaning the docs (#595)
* remove unused images * add local-da setup instructions for quickstart guide * small fixes * fix create-genesis tutorial * fix the full node tutorial * remove duplicate DA docs * fix use TIA for gas * remove mentions of Rollkit CLI * removed fraud proof diagram * comment the not-updated part of the tutorial and leave a warning * remove stack for now * remove technical details section
1 parent dda588f commit d11a712

21 files changed

+76
-334
lines changed

.vitepress/config.ts

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -187,15 +187,8 @@ function sidebarHome() {
187187
text: "About Rollkit",
188188
link: "/learn/about",
189189
},
190-
{
191-
text: "Technical details",
192-
collapsed: true,
193-
items: [
194-
{ text: "Rollkit stack", link: "/learn/stack" },
195-
{ text: "Transaction flow", link: "/learn/transaction-flow" },
196-
{ text: "Configuration", link: "/learn/config" },
197-
],
198-
},
190+
{ text: "Transaction flow", link: "/learn/transaction-flow" },
191+
{ text: "Configuration", link: "/learn/config" },
199192
{
200193
text: "Data Availability",
201194
link: "/learn/data-availability",

guides/cometbft-to-rollkit.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ Run the following command to initialize Rollkit:
3636
ignite rollkit init
3737
```
3838

39+
:::warning
40+
This tutorial is being currently update to reflect the latest changes using the rollkit ignite app.
41+
Please check back later for the updated version.
42+
:::
43+
44+
<!-- TODO: update
45+
3946
## Initialize Rollkit CLI Configuration {#initialize-rollkit-cli-configuration}
4047
4148
Next, you'll need to initialize the Rollkit CLI configuration by generating the `rollkit.toml` file. This file is crucial for Rollkit to understand the structure of your rollup.
@@ -61,3 +68,5 @@ rollkit start --rollkit.aggregator <insert your flags>
6168
By following this guide, you've successfully converted your CometBFT app into a Rollkit app.
6269
6370
To learn more about how to config your DA, Sequencing, and Execution, please check out those tutorial sections.
71+
72+
-->

guides/create-genesis.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -27,38 +27,26 @@ STAKING_AMOUNT="1000000000stake"
2727

2828
## 2. Rebuild your chain
2929

30-
Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](/guides/gm-world.md) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:
30+
Ensure that `.gm` folder is present at `/Users/you/.gm` (if not, follow a [Guide](/guides/gm-world.md) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:
3131

3232
```sh
33-
rollkit rebuild
33+
make install
3434
```
3535

36-
This (re)creates an `entrypoint` binary in the root of your rollup directory. which is used to run all the operations on the rollup chain.
37-
38-
Ensure that the chain configuration directory is set correctly in the `rollkit.toml` file.
39-
40-
For example:
41-
42-
```sh
43-
[chain]
44-
config_dir = "/Users/you/.gm"
45-
```
46-
47-
:::tip
48-
You can always recreate the `rollkit.toml` file by deleting it and re-running the following command:
36+
Once completed, run the following command to ensure that the `/Users/you/.gm` directory is present:
4937

5038
```sh
51-
rollkit toml init
39+
ignite rollkit init
5240
```
5341

54-
:::
42+
This (re)creates an `gmd` binary that will be used for the rest of the tutorials to run all the operations on the rollup chain.
5543

5644
## 3. Resetting existing genesis/chain data
5745

5846
Reset any existing chain data:
5947

6048
```sh
61-
rollkit tendermint unsafe-reset-all
49+
gmd comet unsafe-reset-all
6250
```
6351

6452
Reset any existing genesis data:
@@ -73,39 +61,39 @@ rm $HOME/.$CHAIN_ID/config/genesis.json
7361
Initialize the validator with the chain ID you set:
7462

7563
```sh
76-
rollkit init $VALIDATOR_NAME --chain-id $CHAIN_ID
64+
gmd init $VALIDATOR_NAME --chain-id $CHAIN_ID
7765
```
7866

7967
## 5. Adding a key to keyring backend
8068

8169
Add a key to the keyring-backend:
8270

8371
```sh
84-
rollkit keys add $KEY_NAME --keyring-backend test
72+
gmd keys add $KEY_NAME --keyring-backend test
8573
```
8674

8775
## 6. Adding a genesis account
8876

8977
Add a genesis account with the specified token amount:
9078

9179
```sh
92-
rollkit genesis add-genesis-account $KEY_NAME $TOKEN_AMOUNT --keyring-backend test
80+
gmd genesis add-genesis-account $KEY_NAME $TOKEN_AMOUNT --keyring-backend test
9381
```
9482

9583
## 7. Setting the staking amount in the genesis transaction
9684

9785
Set the staking amount in the genesis transaction:
9886

9987
```sh
100-
rollkit genesis gentx $KEY_NAME $STAKING_AMOUNT --chain-id $CHAIN_ID --keyring-backend test
88+
gmd genesis gentx $KEY_NAME $STAKING_AMOUNT --chain-id $CHAIN_ID --keyring-backend test
10189
```
10290

10391
## 8. Collecting genesis transactions
10492

10593
Collect the genesis transactions:
10694

10795
```sh
108-
rollkit genesis collect-gentxs
96+
gmd genesis collect-gentxs
10997
```
11098

11199
## 9. Configuring the genesis file
@@ -125,9 +113,9 @@ Finally, start the chain with your start command.
125113
For example, start the simple ignite chain with the following command:
126114

127115
```sh
128-
rollkit start --rollkit.aggregator --rollkit.sequencer_rollup_id $CHAIN_ID
116+
gmd start --rollkit.node.aggregator --chain_id $CHAIN_ID
129117
```
130118

131119
## Summary
132120

133-
By following these steps, you will set up the genesis for your rollup, initialize the validator, add a genesis account, and started the chain. This guide provides a basic framework for configuring and starting your rollup using the Rollkit CLI. Make sure `rollkit.toml` is present in the root of your rollup directory, and use the `rollkit` command for all operations.
121+
By following these steps, you will set up the genesis for your rollup, initialize the validator, add a genesis account, and started the chain. This guide provides a basic framework for configuring and starting your rollup using the gm-world binary. Make sure you initialized your chain correctly, and use the `gmd` command for all operations.

guides/da/local-da.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import constants from '../../.vitepress/constants/constants.js'
99

1010
This tutorial serves as a comprehensive guide for using the [local-da](https://github.com/rollkit/local-da) with your chain.
1111

12-
Before proceeding, ensure that you have completed the [quick start](/guides/quick-start.md) or [build a chain](/guides/gm-world.md) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain.
12+
Before proceeding, ensure that you have completed the [build a chain](/guides/gm-world.md) tutorial, which covers setting-up, building and running your chain.
1313

1414
## Setting Up a Local DA Network
1515

guides/docker-compose.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,13 +210,13 @@ b9d5e80e81fb gm-world "gmd start --rollkit…" 27 minutes ago Up 9 secon
210210

211211
We can see the gm-world chain running in container `gm-world` and the local DA network running in container `local-da`.
212212

213-
Since our chain is running in a docker container, we want to enter the docker container to interact with it via the Rollkit CLI. We can do this by running:
213+
Since our chain is running in a docker container, we want to enter the docker container to interact with it via the command `gmd`. We can do this by running:
214214

215215
```bash
216216
docker exec -it gm-world sh
217217
```
218218

219-
Now that you are in the docker container, you can interact with the chain using the Rollkit CLI and the example commands you used in the [gm-world tutorial](/guides/gm-world.md).
219+
Now that you are in the docker container, you can interact with the chain using the `gmd` command and the example you used in the [gm-world tutorial](/guides/gm-world.md).
220220

221221
Once you are done interacting with your chain, you can exit out of your docker container with:
222222

@@ -235,4 +235,4 @@ docker compose down
235235

236236
## 🎉 Next steps
237237

238-
Congratulations again! You now know how to run your chain with docker compose and interact with it using the Rollkit CLI in the docker container.
238+
Congratulations again! You now know how to run your chain with docker compose and interact with it using the `gmd` command in the docker container.

guides/evm/single.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Before starting, ensure you have:
1818
### 1. Clone the Rollkit Repository
1919

2020
```bash
21-
git clone --depth 1 --branch v1.0.0-beta.1 https://github.com/rollkit/rollkit.git
21+
git clone --depth 1 --branch {{constants.rollkitLatestTag}} https://github.com/rollkit/rollkit.git
2222
cd rollkit
2323
```
2424

guides/full-node.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ This guide covers how to set up a full node to run alongside a sequencer node in
66

77
## Prerequisites
88

9-
Before starting, ensure you have:
9+
Before proceeding, ensure that you have completed the [build a chain](/guides/gm-world.md) tutorial, which covers setting-up, building and running your chain.
10+
11+
Ensure that you have:
1012

1113
- A local Data Availability (DA) network node running on port `7980`.
1214
- A Rollkit sequencer node running and posting blocks to the DA network.
13-
- The Rollkit CLI installed on your system.
1415

1516
## Setting Up Your Full Node
1617

@@ -25,7 +26,7 @@ CHAIN_ID=gm
2526
Initialize the chain config for the full node, lets call it `FullNode` and set the chain ID to your rollup chain ID:
2627

2728
```bash
28-
{BINARY} init FullNode --chain-id=$CHAIN_ID
29+
gmd init FullNode --chain-id $CHAIN_ID --home $HOME/.${CHAIN_ID}_fn
2930
```
3031

3132
Copy the genesis file from the sequencer node:
@@ -39,7 +40,7 @@ cp $HOME/.$CHAIN_ID/config/genesis.json $HOME/.${CHAIN_ID}_fn/config/genesis.jso
3940
Identify the sequencer node's P2P address from its logs. It will look similar to:
4041

4142
```
42-
1:55PM INF listening on address=/ip4/127.0.0.1/tcp/36656/p2p/12D3KooWJbD9TQoMSSSUyfhHMmgVY3LqCjxYFz8wQ92Qa6DAqtmh
43+
1:55PM INF listening on address=/ip4/127.0.0.1/tcp/7676/p2p/12D3KooWJbD9TQoMSSSUyfhHMmgVY3LqCjxYFz8wQ92Qa6DAqtmh module=p2p
4344
```
4445

4546
Create an environment variable with the P2P address:
@@ -64,20 +65,21 @@ Make sure to include these flags with your start command:
6465
Run your full node with the following command:
6566

6667
```bash
67-
rollkit start \
68+
gmd start \
6869
--rollkit.da.address http://127.0.0.1:7980 \
69-
--p2p.seeds $P2P_ID@127.0.0.1:26656 \
70+
--p2p.seeds $P2P_ID@127.0.0.1:7676 \
7071
--minimum-gas-prices 0stake \
7172
--rpc.laddr tcp://127.0.0.1:46657 \
7273
--grpc.address 127.0.0.1:9390 \
7374
--p2p.laddr "0.0.0.0:46656" \
7475
--api.address tcp://localhost:1318 \
75-
--rollkit.sequencer_rollup_id gm
76+
--chain_id $CHAIN_ID \
77+
--home $HOME/.${CHAIN_ID}_fn
7678
```
7779

7880
Key points about this command:
7981

80-
- `rollkit.sequencer_rollup_id` is generally the `$CHAIN_ID`, which is `gm` in this case.
82+
- `chain_id` is generally the `$CHAIN_ID`, which is `gm` in this case.
8183
- The ports and addresses are different from the sequencer node to avoid conflicts. Not everything may be necessary for your setup.
8284
- We use the `P2P_ID` environment variable to set the seed node.
8385

guides/gm-world.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,15 @@ ignite version
3939
```
4040

4141
```bash
42-
Ignite CLI version: v28.7.0
43-
Ignite CLI build date: 2025-01-15T08:23:41Z
44-
Ignite CLI source hash: 2f83cfe6114cfc58bd6add791143fe43963c1b5c
42+
Ignite CLI version: v29.2.0-dev
43+
Ignite CLI build date: undefined
44+
Ignite CLI source hash: undefined
4545
Ignite CLI config version: v1
46-
Cosmos SDK version: v0.50.11
46+
Cosmos SDK version: v0.53.0
47+
Buf.build version: undefined
4748
Your OS: darwin
4849
Your arch: arm64
49-
Your go version: go version go1.24.2 darwin/arm64
50-
Your uname -a: Darwin Markos-MacBook-Pro.local 24.3.0 Darwin Kernel Version 24.3.0: Thu Jan 2 20:24:16 PST 2025; root:xnu-11215.81.4~3/RELEASE_ARM64_T6000 arm64
51-
Your cwd: /Users/markobaricevic/code/CoTend/rollkit1/docs
52-
Is on Gitpod: false
50+
Your go version: go version go1.24.3 darwin/arm64
5351
```
5452

5553
## Generate your App {#generate-your-app}
@@ -91,7 +89,7 @@ This will create a `~/.gm` folder with all the necessary files to run a chain.
9189

9290
## Initialize Your Blockchain {#initialize-your-blockchain}
9391

94-
Before starting your blockchain, you need to initialize it with Rollkit support. Initialize the blockchain with Local DA as follows:
92+
Before starting your blockchain, you need to initialize it with Rollkit support. Initialize the blockchain as follows:
9593

9694
```bash
9795
ignite rollkit init
@@ -106,7 +104,7 @@ Now that we have our gm app generated and installed, we can launch our GM rollup
106104
First lets start the local DA network:
107105

108106
```bash
109-
curl -sSL https://rollkit.dev/install-local-da.sh | bash
107+
curl -sSL https://rollkit.dev/install-local-da.sh | bash -s {{constants.rollkitLatestTag}}
110108
```
111109

112110
you should see logs like:

guides/quick-start.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,31 @@ rollkit git sha: cd1970de
3636
To initialize a sovereign rollup node, execute the following command:
3737

3838
```bash
39-
testapp init --rollkit.node.aggregator --rollkit.signer.passphrase verysecretpass
39+
testapp init --rollkit.node.aggregator --rollkit.signer.passphrase secret
4040
```
4141

4242
## 🚀 Run your sovereign rollup node
4343

44+
Now that we have our testapp generated and installed, we can launch our rollup along with the local DA by running the following command:
45+
46+
First lets start the local DA network:
47+
48+
```bash
49+
curl -sSL https://rollkit.dev/install-local-da.sh | bash -s {{constants.rollkitLatestTag}}
50+
```
51+
52+
You should see logs like:
53+
54+
```bash
55+
4:58PM INF NewLocalDA: initialized LocalDA module=local-da
56+
4:58PM INF Listening on host=localhost maxBlobSize=1974272 module=da port=7980
57+
4:58PM INF server started listening on=localhost:7980 module=da
58+
```
59+
4460
To start a basic sovereign rollup node, execute:
4561

4662
```bash
47-
testapp start --rollkit.signer.passphrase verysecretpass
63+
testapp start --rollkit.signer.passphrase secret
4864
```
4965

5066
Upon execution, the CLI will output log entries that provide insights into the node's initialization and operation:

0 commit comments

Comments
 (0)