Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 1 addition & 18 deletions .github/auto_request_review.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,3 @@
reviewers:
defaults:
- jcstein
- rollkit
groups:
rollkit:
- Manav-Aggarwal
- tzdybal
- gupadhyaya
- tuxcanfly
- yarikbratashchuk
files:
".github/**":
- jcstein
- rollkit
options:
ignore_draft: true
ignored_keywords:
- WIP
number_of_reviewers: 3
- binarybuilders
8 changes: 4 additions & 4 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,8 @@ function sidebarHome() {
link: "/guides/full-node",
},
{
text: "Restart your rollup",
link: "/guides/restart-rollup",
text: "Restart your chain",
link: "/guides/restart-chain",
},
{
text: "Reset your chain's state",
Expand All @@ -300,15 +300,15 @@ function sidebarHome() {
link: "/guides/cometbft-to-rollkit",
},
{
text: "Create genesis for your rollup",
text: "Create genesis for your chain",
link: "/guides/create-genesis",
},
{
text: "Metrics",
link: "/guides/metrics",
},
{
text: "Use IBC token (TIA) as gas token in your rollup",
text: "Use IBC token (TIA) as gas token in your chain",
link: "/guides/use-tia-for-gas",
},
],
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please ensure you review the detailed Contribution Guidelines above before makin

## Directory Structure

* /guides: Step-by-step instructions to help users build their own rollups with Rollkit.
* /guides: Step-by-step instructions to help users build their own chains with Rollkit.
* /learn: Technical reference materials, such as configuration options and details about the Rollkit stack.
* /blog: Blog posts for the Rollkit blog.
<!-- * /guides [WIP]: In-depth articles that cover specific topics in detail. -->
Expand Down
2 changes: 1 addition & 1 deletion guides/cometbft-to-rollkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Please check back later for the updated version.

## Initialize Rollkit CLI Configuration {#initialize-rollkit-cli-configuration}

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.
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 chain.

To create the `rollkit.toml` configuration, use this command:

Expand Down
10 changes: 5 additions & 5 deletions guides/create-genesis.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to create a genesis for your rollup
# How to create a genesis for your chain

This guide will walk you through the process of setting up a genesis for your rollup. Follow the steps below to initialize your rollup chain, add a genesis account, and start the chain.
This guide will walk you through the process of setting up a genesis for your chain. Follow the steps below to initialize your chain, add a genesis account, and start the chain.

## 0. Pre-requisities

Expand All @@ -19,7 +19,7 @@ First, set the necessary variables for your chain in the terminal, here is an ex
```sh
VALIDATOR_NAME=validator1
CHAIN_ID=gm
KEY_NAME=rollup-key
KEY_NAME=chain-key
CHAINFLAG="--chain-id ${CHAIN_ID}"
TOKEN_AMOUNT="10000000000000000000000000stake"
STAKING_AMOUNT="1000000000stake"
Expand All @@ -39,7 +39,7 @@ Once completed, run the following command to ensure that the `/Users/you/.gm` di
ignite rollkit init
```

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.
This (re)creates an `gmd` binary that will be used for the rest of the tutorials to run all the operations on the chain.

## 3. Resetting existing genesis/chain data

Expand Down Expand Up @@ -118,4 +118,4 @@ gmd start --rollkit.node.aggregator --chain_id $CHAIN_ID

## Summary

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.
By following these steps, you will set up the genesis for your chain, initialize the validator, add a genesis account, and started the chain. This guide provides a basic framework for configuring and starting your chain using the gm-world binary. Make sure you initialized your chain correctly, and use the `gmd` command for all operations.
22 changes: 11 additions & 11 deletions guides/da/celestia-da.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import constants from '../../.vitepress/constants/constants.js'

## 🌞 Introduction {#introduction}

This tutorial serves as a comprehensive guide for deploying your rollup on Celestia's data availability (DA) network. From the Rollkit perspective, there's no difference in posting blocks to Celestia's testnets or Mainnet Beta.
This tutorial serves as a comprehensive guide for deploying your chain on Celestia's data availability (DA) network. From the Rollkit perspective, there's no difference in posting blocks to Celestia's testnets or Mainnet Beta.

Before proceeding, ensure that you have completed the [gm-world](/guides/gm-world.md) tutorial, which covers installing the Testapp CLI and running a rollup against a local DA network.
Before proceeding, ensure that you have completed the [gm-world](/guides/gm-world.md) tutorial, which covers installing the Testapp CLI and running a chain against a local DA network.

## 🪶 Running a Celestia light node

Before you can start your rollup node, you need to initiate, sync, and fund a light node on one of Celestia's networks on a compatible version:
Before you can start your chain node, you need to initiate, sync, and fund a light node on one of Celestia's networks on a compatible version:

Find more information on how to run a light node in the [Celestia documentation](https://celestia.org/run-a-light-node/#start-up-a-node).

Expand Down Expand Up @@ -42,7 +42,7 @@ Celestia Node Version: {{constants.celestiaNodeMainnetTag}}

The main difference lies in how you fund your wallet address: using testnet TIA or [TIA](https://docs.celestia.org/learn/tia#overview-of-tia) for Mainnet Beta.

After successfully starting a light node, it's time to start posting the batches of blocks of data that your rollup generates to Celestia.
After successfully starting a light node, it's time to start posting the batches of blocks of data that your chain generates to Celestia.

## 🏗️ Prerequisites {#prerequisites}

Expand Down Expand Up @@ -127,9 +127,9 @@ port 26658:
DA_ADDRESS=http://localhost:26658
```

## 🔥 Running your rollup connected to Celestia light node
## 🔥 Running your chain connected to Celestia light node

Finally, let's initiate the rollup node with all the flags:
Finally, let's initiate the chain node with all the flags:

```bash
gmd start \
Expand All @@ -140,16 +140,16 @@ gmd start \
--rollkit.da.address $DA_ADDRESS
```

Now, the rollup is running and posting blocks (aggregated in batches) to Celestia. You can view your rollup by using your namespace or account on one of Celestia's block explorers.
Now, the chain is running and posting blocks (aggregated in batches) to Celestia. You can view your chain by using your namespace or account on one of Celestia's block explorers.

For example, [here on Celenium for Arabica](https://arabica.celenium.io/).

Other explorers:

- [Arabica testnet](https://docs.celestia.org/how-to-guides/arabica-devnet#explorers)
- [Mocha testnet](https://docs.celestia.org/how-to-guides/mocha-testnet#explorers)
- [Mainnet Beta](https://docs.celestia.org/how-to-guides/mainnet#explorers)
- [Arabica testnet](https://docs.celestia.org/how-to-guides/arabica-devnet)
- [Mocha testnet](https://docs.celestia.org/how-to-guides/mocha-testnet)
- [Mainnet Beta](https://docs.celestia.org/how-to-guides/mainnet)

## 🎉 Next steps

Congratulations! You've built a local rollup that posts data to Celestia's DA layer. Well done! Now, go forth and build something great! Good luck!
Congratulations! You've built a local chain that posts data to Celestia's DA layer. Well done! Now, go forth and build something great! Good luck!
12 changes: 6 additions & 6 deletions guides/da/local-da.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ curl -sSL https://rollkit.dev/install-local-da.sh | bash -s {{constants.localDAL

This script will build and run the node, which will then listen on port `7980`.

## Configuring your rollup to connect to the local DA network
## Configuring your chain to connect to the local DA network

To connect your rollup to the local DA network, you need to pass the `--rollkit.da.address` flag with the local DA node address.
To connect your chain to the local DA network, you need to pass the `--rollkit.da.address` flag with the local DA node address.

## Run your rollup
## Run your chain

Start your rollup node with the following command, ensuring to include the DA address flag:
Start your chain node with the following command, ensuring to include the DA address flag:

::: code-group

Expand All @@ -43,7 +43,7 @@ Start your rollup node with the following command, ensuring to include the DA ad

:::

You should see the following log message indicating that your rollup is connected to the local DA network:
You should see the following log message indicating that your chain is connected to the local DA network:

```shell
11:07AM INF NewLocalDA: initialized LocalDA module=local-da
Expand All @@ -53,4 +53,4 @@ You should see the following log message indicating that your rollup is connecte

## Summary

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. You can find more information on running the local-da binary [here](https://github.com/rollkit/rollkit/blob/main/da/cmd/local-da/README.md)
By following these steps, you will set up a local DA network node and configure your chain to post data to it. This setup is useful for testing and development in a controlled environment. You can find more information on running the local-da binary [here](https://github.com/rollkit/rollkit/blob/main/da/cmd/local-da/README.md)
14 changes: 7 additions & 7 deletions guides/deploy-overview.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
description: This page provides an overview of some common ways to deploy rollups.
description: This page provides an overview of some common ways to deploy chains.
---

# Deploying Your Rollup
# Deploying Your Chain

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.
One of the benefits of building chains with Rollkit is the flexibility you have as a developer to choose things like the DA layer, the settlement scheme, and the execution environment.

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.
The challenge that comes with this flexibility is that there are more services that now need to be deployed and managed while running your chain.

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.
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 chains than using various bash scripts.

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.
In this section, you'll see a few examples of how you can deploy your chain environment with all your services running in a more production-ready way.

:::warning Disclaimer
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.
These examples are for educational purposes only. Before deploying your chain for production use you should fully understand the services you are deploying and your choice in deployment method.
:::

* [Deploy with Docker Compose](/guides/deploy/local.md)
16 changes: 8 additions & 8 deletions guides/deploy/overview.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
description: This page provides an overview of some common ways to deploy rollups.
description: This page provides an overview of some common ways to deploy chains.
---

# 🚀 Deploying Your Rollup
# 🚀 Deploying Your Chain

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.
One of the benefits of building chains with Rollkit is the flexibility you have as a developer to choose things like the DA layer, the settlement scheme, and the execution environment.

You can learn more about Rollkit architecture [here](/learn/specs/overview.md).

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.
The challenge that comes with this flexibility is that there are more services that now need to be deployed and managed while running your chain.

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.
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 chains than using various bash scripts.

## 🏗️ Deployment Scales

Depending on your needs and the stage of your rollup development, there are different deployment approaches you can take:
Depending on your needs and the stage of your chain development, there are different deployment approaches you can take:

### 🏠 Local Development
For development and testing purposes, you can deploy your rollup locally using containerized environments. This approach provides:
For development and testing purposes, you can deploy your chain locally using containerized environments. This approach provides:
- Quick iteration and testing
- No external dependencies
- Full control over the environment
Expand All @@ -39,7 +39,7 @@ Choose the deployment approach that matches your current needs:
* [🌐 Testnet Deployment](./testnet.md) - Deploy on testnet with external DA networks

:::warning Disclaimer
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.
These examples are for educational purposes only. Before deploying your chain for production use you should fully understand the services you are deploying and your choice in deployment method.
:::

## 🎉 Next Steps
Expand Down
4 changes: 2 additions & 2 deletions guides/evm/single.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

This guide covers how to set up and run the Single Sequencer implementation of Rollkit EVM rollups. This implementation provides a centralized approach to transaction sequencing while using EVM as the execution layer.
This guide covers how to set up and run the Single Sequencer implementation of Rollkit EVM chains. This implementation provides a centralized approach to transaction sequencing while using EVM as the execution layer.

## Prerequisites

Expand Down Expand Up @@ -159,4 +159,4 @@ INF block marked as DA included blockHash=XXXX blockHeight=XX module=BlockManage

## Conclusion

You've now set up and configured the Single Sequencer implementation of Rollkit EVM rollups. This implementation provides a centralized approach to transaction sequencing while using EVM as the execution layer.
You've now set up and configured the Single Sequencer implementation of Rollkit EVM chains. This implementation provides a centralized approach to transaction sequencing while using EVM as the execution layer.
20 changes: 10 additions & 10 deletions guides/execution/cosmwasm.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🗞️ CosmWasm rollup
# 🗞️ CosmWasm chain

<!-- markdownlint-disable MD033 -->
<script setup>
Expand Down Expand Up @@ -28,7 +28,7 @@ this tutorial.

## 💻 CosmWasm dependency {#dependencies}

As with the [GM Rollup](/guides/gm-world.md), we use [kurtosis](https://docs.kurtosis.com/) to help with managing all the services we need to run. You can [install kurtosis here](https://docs.kurtosis.com/install).
As with the [GM Chain](/guides/gm-world.md), we use [kurtosis](https://docs.kurtosis.com/) to help with managing all the services we need to run. You can [install kurtosis here](https://docs.kurtosis.com/install).

Once installed, you can verify the installation by running:

Expand All @@ -42,9 +42,9 @@ CLI Version: 0.90.1
To see the engine version (provided it is running): kurtosis engine status
```

## 🚀 Starting your rollup {#start-your-rollup}
## 🚀 Starting your chain {#start-your-chain}

Now that we have kurtosis installed, we can launch our CosmWasm rollup along with the local DA by running the following command:
Now that we have kurtosis installed, we can launch our CosmWasm chain along with the local DA by running the following command:

```bash
kurtosis run github.com/rollkit/cosmwasm@v0.2.0
Expand Down Expand Up @@ -98,7 +98,7 @@ c71b0308616d wasm grpc-addr: 9290/tcp -> http://127.0.0.1:9290 RUNNI
rpc-laddr: 36657/tcp -> http://127.0.0.1:36657
```

Kurtosis has successfully launched the CosmWasm rollup and the local DA network. You can see the services running in docker as well:
Kurtosis has successfully launched the CosmWasm chain and the local DA network. You can see the services running in docker as well:

```bash
docker ps
Expand All @@ -115,16 +115,16 @@ d532fc82579f traefik:2.10.6 "/bin/sh -c 'mkdir -…" 39
7700c0b72195 timberio/vector:0.31.0-debian "/bin/sh -c 'printf …" 39 minutes ago Up 39 minutes kurtosis-logs-aggregator
```

We can see the CosmWasm rollup running in container `wasm--c71b0308616d40ad919ad24c3d14f35b` and the local DA network running in container `local-da--96d04bc472c9455d88d046128fbdefa6`.
We can see the CosmWasm chain running in container `wasm--c71b0308616d40ad919ad24c3d14f35b` and the local DA network running in container `local-da--96d04bc472c9455d88d046128fbdefa6`.

Let's hold on to the container name for the CosmWasm rollup, as we will need it later.
Let's hold on to the container name for the CosmWasm chain, as we will need it later.

```bash
CW=$(docker ps --format '{{.Names}}' | grep wasm)
echo $CW
```

You can verify the rollup is running by checking the logs:
You can verify the chain is running by checking the logs:

```bash
docker logs $CW
Expand All @@ -142,7 +142,7 @@ docker logs $CW
...
```

Good work so far, we have a Rollup node, DA network node, now we can move onto the contract deployment.
Good work so far, we have a Chain node, DA network node, now we can move onto the contract deployment.

## 📒 Contract deployment on CosmWasm with Rollkit {#contract-deployment-on-cosmwasm}

Expand Down Expand Up @@ -195,7 +195,7 @@ This will place the optimized Wasm bytecode at `artifacts/cw_nameservice.wasm`.

Let's now deploy our smart contract!

We will need to do this in the docker container that the CosmWasm rollup is running. So first let's move the compiled contract to the container:
We will need to do this in the docker container that the CosmWasm chain is running. So first let's move the compiled contract to the container:

```bash
docker cp artifacts/cw_nameservice.wasm $CW:/root/cw_nameservice.wasm
Expand Down
Loading
Loading