Skip to content

Commit eba488f

Browse files
committed
Remove all the mentions of the wordl tutorial
1 parent ec4c866 commit eba488f

File tree

5 files changed

+73
-92
lines changed

5 files changed

+73
-92
lines changed

guides/reset-state.md

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Some reason you might need to reset the state of your chain are:
1414

1515
## Prerequisites
1616

17-
In order to complete this guide, you will need to have completed either the [quick start tutorial](/tutorials/quick-start.md) or the [build our chain tutorial](/tutorials/wordle.md).
17+
In order to complete this guide, you will need to have completed either the [quick start tutorial](/tutorials/quick-start.md) or the [build our chain tutorial](/tutorials/gm-world.md).
1818

1919
## Quick Start
2020

@@ -50,64 +50,84 @@ ${BINARY} unsafe-clean
5050

5151
When you launch your chain again with `rollkit start` your `.rollkit` directory will be re-created and you will see your chain starting at block height 1 again.
5252

53-
## Wordle
53+
## gm-world
5454

55-
When you ran your wordle chain in the [build your chain tutorial](/tutorials/wordle.md), it created a `.wordle` directory.
55+
When you ran your gm-world chain in the [build your chain tutorial](/tutorials/gm-world.md), it created a `.gm` directory in your `$HOME` directory.
5656

5757
This directory will look like the following:
5858

5959
```bash
60-
tree $HOME/.wordle
60+
tree $HOME/.gm
6161

6262
├── config
6363
│   ├── app.toml
6464
│   ├── client.toml
6565
│   ├── config.toml
6666
│   ├── genesis.json
6767
│   ├── gentx
68-
│   │   └── gentx-6e46bd1f53acead98b43e63fcf2bd5435499350d.json
68+
│   │   └── gentx-418077c64f0cf5824c24487c9cce38241de677cd.json
6969
│   ├── node_key.json
70-
│   └── priv_validator_key.json
70+
│   ├── priv_validator_key.json
71+
│   └── rollkit.yaml
7172
├── data
7273
│   ├── application.db
7374
│   │   ├── 000001.log
7475
│   │   ├── CURRENT
7576
│   │   ├── LOCK
7677
│   │   ├── LOG
7778
│   │   └── MANIFEST-000000
79+
│   ├── cache
80+
│   │   ├── data
81+
│   │   │   ├── da_included.gob
82+
│   │   │   ├── hashes.gob
83+
│   │   │   ├── items_by_hash.gob
84+
│   │   │   └── items_by_height.gob
85+
│   │   └── header
86+
│   │   ├── da_included.gob
87+
│   │   ├── hashes.gob
88+
│   │   ├── items_by_hash.gob
89+
│   │   └── items_by_height.gob
7890
│   ├── priv_validator_state.json
7991
│   ├── rollkit
8092
│   │   ├── 000001.sst
8193
│   │   ├── 000001.vlog
8294
│   │   ├── DISCARD
8395
│   │   ├── KEYREGISTRY
8496
│   │   └── MANIFEST
85-
│   └── snapshots
86-
│   └── metadata.db
87-
│   ├── 000001.log
88-
│   ├── CURRENT
89-
│   ├── LOCK
90-
│   ├── LOG
91-
│   └── MANIFEST-000000
97+
│   ├── snapshots
98+
│   │   └── metadata.db
99+
│   │   ├── 000001.log
100+
│   │   ├── CURRENT
101+
│   │   ├── LOCK
102+
│   │   ├── LOG
103+
│   │   └── MANIFEST-000000
104+
│   └── tx_index.db
105+
│   ├── 000001.log
106+
│   ├── CURRENT
107+
│   ├── LOCK
108+
│   ├── LOG
109+
│   └── MANIFEST-000000
92110
└── keyring-test
93-
├── 4a90e750914792c2d7f98775c13a588d9d304bd0.address
94-
├── 53dab037ac3bd380f4a9192b2c6eedbe95fce180.address
111+
├── 87af99a184613860ee9563be57a9fb4e7b25acb8.address
95112
├── alice.info
96-
└── bob.info
113+
├── bob.info
114+
└── e24d9eeca2d24193bdd98ed9116ff70f8a2e2b5e.address
97115
```
98116

99-
The directories you need to delete to reset your state are in the `.wordle/data` directory.
117+
The directories you need to delete to reset your state are in the `./data` directory.
100118

101119
```bash
102-
$HOME/.wordle/data/application.db
103-
$HOME/.wordle/data/rollkit
104-
$HOME/.wordle/data/snapshots
120+
$HOME/.gm/data/application.db
121+
$HOME/.gm/data/rollkit
122+
$HOME/.gm/data/snapshots
123+
$HOME/.gm/data/cache
124+
105125
```
106126

107127
You can delete them with the following command:
108128

109129
```bash
110-
rollkit tendermint unsafe-reset-all
130+
gmd tendermint unsafe-reset-all
111131
```
112132

113-
When you launch your chain again with your `rollkit start <flags>` command, these data directories will be re-created and you will see your chain starting at block height 1 again.
133+
When you launch your chain again with your `gmd start <flags>` command, these data directories will be re-created and you will see your chain starting at block height 1 again.

learn/building-and-deploying-a-rollup.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

tutorials/da/local-da.md

Lines changed: 3 additions & 3 deletions
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](/tutorials/quick-start) or [build a chain](/tutorials/wordle) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain.
12+
Before proceeding, ensure that you have completed the [quick start](/tutorials/quick-start) or [build a chain](/tutorials/gm-world.md) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain.
1313

1414
## Setting Up a Local DA Network
1515

@@ -35,11 +35,11 @@ Start your rollup node with the following command, ensuring to include the DA ad
3535
{BINARY} start --rollkit.da.address http://localhost:7980
3636
```
3737

38-
```sh [Wordle Chain]
38+
```sh [gm-world Chain]
3939
{BINARY} start \
4040
--rollkit.aggregator \
4141
--rollkit.da.address http://localhost:7980 \
42-
--rollkit.sequencer_rollup_id wordle
42+
--rollkit.sequencer_rollup_id gmd
4343
```
4444

4545
:::

tutorials/da/overview.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ The [DA interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L1
1919
```go
2020
// DA defines very generic interface for interaction with Data Availability layers.
2121
type DA interface {
22-
// MaxBlobSize returns the max blob size
23-
MaxBlobSize(ctx context.Context) (uint64, error)
24-
2522
// Get returns Blob for each given ID, or an error.
2623
//
2724
// Error should be returned if ID is not formatted properly, there is no Blob for given ID or any other client-level
@@ -61,7 +58,7 @@ type DA interface {
6158

6259
## Mock DA {#mock-da}
6360

64-
You might have noticed that we did not define any DA layer during the [quick start](../quick-start.md) or [build a chain](../wordle.md) tutorials. This is because we used a mock DA layer that is built into Rollkit.
61+
You might have noticed that we did not define any DA layer during the [quick start](../quick-start.md) or [build a chain](/tutorials/gm-world.md) tutorials. This is because we used a mock DA layer that is built into Rollkit.
6562

6663
If you revisit the logs from those tutorials, you will see one of the first lines being:
6764

tutorials/docker-compose.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🐳 Docker Compose
22

3-
This tutorial is going to show you how to deploy the [wordle chain](/tutorials/wordle.md) using Docker Compose.
3+
This tutorial is going to show you how to deploy the [gm-world chain](/tutorials/gm-world.md) using Docker Compose.
44

55
You can learn more about Docker Compose [here](https://docs.docker.com/compose/).
66

@@ -17,7 +17,7 @@ import constants from '../.vitepress/constants/constants.js'
1717

1818
## 💻 Pre-requisites {#prerequisites}
1919

20-
Make sure you have your wordle chain ready by completing [the Build your chain tutorial](/tutorials/wordle.md).
20+
Make sure you have your gm-world chain ready by completing [the Build your chain tutorial](/tutorials/gm-world.md).
2121

2222
## 🛠️ Dependencies {#dependencies}
2323

@@ -46,11 +46,11 @@ To save time, we can use their respective Dockerfiles:
4646
* [local-da Dockerfile](https://github.com/rollkit/local-da/blob/main/Dockerfile)
4747
* [local-sequencer Dockerfile](https://github.com/rollkit/go-sequencing/blob/main/Dockerfile)
4848

49-
This will allow us to focus on how we can run the wordle chain with Docker Compose.
49+
This will allow us to focus on how we can run the gm-world chain with Docker Compose.
5050

5151
### 🐳 Dockerfile {#dockerfile}
5252

53-
First, we need to create a Dockerfile for our wordle chain. Create a new file called `Dockerfile` in the root of the `wordle` directory and add the following code:
53+
First, we need to create a Dockerfile for our gm-world chain. Create a new file called `Dockerfile` in the root of the `gm` directory and add the following code:
5454

5555
```dockerfile-vue
5656
# Stage 1: Install ignite CLI and rollkit
@@ -110,9 +110,9 @@ COPY --from=base /go/bin/rollkit /usr/bin
110110
COPY --from=base /app/entrypoint ./entrypoint
111111
COPY --from=base /app/rollkit.toml ./rollkit.toml
112112
113-
# Copy the $HOME/.wordle directory from the build stage.
113+
# Copy the $HOME/.gm directory from the build stage.
114114
# This directory contains all your chain config.
115-
COPY --from=base /root/.wordle /root/.wordle
115+
COPY --from=base /root/.gm /root/.gm
116116
117117
# Ensure the entrypoint script is executable
118118
RUN chmod +x ./entrypoint
@@ -121,16 +121,16 @@ RUN chmod +x ./entrypoint
121121
# CMD tail -f /dev/null
122122
123123
ENTRYPOINT [ "rollkit" ]
124-
CMD [ "start", "--rollkit.aggregator", "--rollkit.sequencer_rollup_id", "wordle"]
124+
CMD [ "start", "--rollkit.aggregator", "--rollkit.sequencer_rollup_id", "gmd"]
125125
126126
```
127127

128-
This Dockerfile sets up the environment to build the chain and run the wordle node. It then sets up the runtime environment to run the chain. This allows you as the developer to modify any files, and then simply rebuild the Docker image to run the new chain.
128+
This Dockerfile sets up the environment to build the chain and run the gm-world node. It then sets up the runtime environment to run the chain. This allows you as the developer to modify any files, and then simply rebuild the Docker image to run the new chain.
129129

130130
Build the docker image by running the following command:
131131

132132
```bash
133-
docker build -t wordle .
133+
docker build -t gm-world .
134134
```
135135

136136
You can then see the built image by running:
@@ -143,23 +143,23 @@ You should see the following output:
143143

144144
```bash
145145
REPOSITORY TAG IMAGE ID CREATED SIZE
146-
wordle latest 5d3533c1ea1c 8 seconds ago 443MB
146+
gm-world latest 5d3533c1ea1c 8 seconds ago 443MB
147147
```
148148

149149
### 🐳 Docker Compose file {#docker-compose-file}
150150

151151
Next we need to create our `compose.yaml` file for docker compose to use.
152152

153-
In the root of the `wordle` directory, create a new file called `compose.yaml` and add the following code:
153+
In the root of the `gm` directory, create a new file called `compose.yaml` and add the following code:
154154

155155
```yml-vue
156156
services:
157-
# Define the wordle chain service
158-
wordle:
157+
# Define the gm-world chain service
158+
gm-world:
159159
# Set the name of the docker container for ease of use
160-
container_name: wordle
160+
container_name: gm-world
161161
# Use the image we just built
162-
image: wordle
162+
image: gm-world
163163
# Used for networking between the two services
164164
network_mode: host
165165
# The command config is used for launching the chain once the Docker container is running
@@ -172,7 +172,7 @@ services:
172172
"--rollkit.sequencer_address",
173173
"0.0.0.0:50051",
174174
"--rollkit.sequencer_rollup_id",
175-
"wordle",
175+
"gm",
176176
]
177177
# Ensures the local-da service is up and running before starting the chain
178178
depends_on:
@@ -197,32 +197,32 @@ services:
197197
ghcr.io/rollkit/go-sequencing:{{constants.goSequencingLatestTag}}
198198
# Set the name of the docker container for ease of use
199199
container_name: local-sequencer
200-
# Start the sequencer with the listen all flag and the rollup id set to wordle
201-
command: ["-listen-all", "-rollup-id=wordle"]
200+
# Start the sequencer with the listen all flag and the rollup id set to gm
201+
command: ["-listen-all", "-rollup-id=gm"]
202202
# Publish the ports to connect
203203
ports:
204204
- "50051:50051"
205205
```
206206

207-
We now have all we need to run the wordle chain and connect to a local DA node.
207+
We now have all we need to run the gm-world chain and connect to a local DA node.
208208

209-
### 🚀 Run Wordle chain {#run-wordle-chain}
209+
### 🚀 Run gm-world chain {#run-gm-world-chain}
210210

211-
Run your wordle chain by running the following command:
211+
Run your gm-world chain by running the following command:
212212

213213
```bash
214214
docker compose up
215215
```
216216

217217
You'll see logs of your chain being output.
218218

219-
Congratulations! You have successfully run the wordle chain with Docker Compose.
219+
Congratulations! You have successfully run the gm-world chain with Docker Compose.
220220

221221
## 🚀 Interacting with the chain {#interacting-with-the-chain}
222222

223223
Since we are using docker images, we can interact with the chain by entering the docker container.
224224

225-
You can see the docker containers running with the wordle chain and the local DA node by running the following command:
225+
You can see the docker containers running with the gm-world chain and the local DA node by running the following command:
226226

227227
```bash
228228
docker ps
@@ -232,20 +232,20 @@ You should see output like the following:
232232

233233
```bash
234234
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
235-
86f9bfa5b6d2 wordle "rollkit start --rol…" 7 minutes ago Up 3 seconds wordle
235+
86f9bfa5b6d2 gm-world "rollkit start --rol…" 7 minutes ago Up 3 seconds gm-world
236236
67a2c3058e01 local-sequencer "local-sequencer -li…" 11 minutes ago Up 3 seconds 0.0.0.0:50051->50051/tcp local-sequencer
237237
dae3359665f8 local-da "local-da -listen-all" 2 hours ago Up 3 seconds 0.0.0.0:7980->7980/tcp local-da
238238
```
239239

240-
We can see the wordle chain running in container `wordle` and the local DA network running in container `local-da`.
240+
We can see the gm-world chain running in container `gm-world` and the local DA network running in container `local-da`.
241241

242242
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:
243243

244244
```bash
245-
docker exec -it wordle sh
245+
docker exec -it gm-world sh
246246
```
247247

248-
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 [Wordle tutorial](/tutorials/wordle#interacting-with-the-chain).
248+
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](/tutorials/gm-world.md).
249249

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

0 commit comments

Comments
 (0)