Skip to content

chore: remove mention of rollup #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: marko/sequencer_docs
Choose a base branch
from
Draft
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
2 changes: 1 addition & 1 deletion blog/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome to our blog! Here, you'll find a variety of articles on a range of topic

## Table of contents

- [Sovereign rollups on Bitcoin with Rollkit](/blog/sovereign-rollups-on-bitcoin)
- [Sovereign Applications on Bitcoin with Rollkit](/blog/sovereign-rollups-on-bitcoin)
- [Rollkit: The First Sovereign Rollup Framework](/blog/rollkit-the-first-sovereign-rollup-framework.md)

Stay tuned for more exciting content!
2 changes: 1 addition & 1 deletion guides/cometbft-to-rollkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ ignite rollkit init

## 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
4 changes: 2 additions & 2 deletions guides/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ db_path: "data"
### Chain ID

**Description:**
The unique identifier for your rollup chain. This ID is used to differentiate your network from others and is crucial for network communication and transaction validation.
The unique identifier for your chain. This ID is used to differentiate your network from others and is crucial for network communication and transaction validation.

**YAML:**
Set this in your configuration file at the top level:
Expand All @@ -109,7 +109,7 @@ chain_id: "my-rollkit-chain"

**Command-line Flag:**
`--chain_id <string>`
*Example:* `--chain_id "super_rollup_testnet_v1"`
*Example:* `--chain_id "super_testnet_v1"`
*Default:* `"rollkit"`
*Constant:* `FlagChainID`

Expand Down
58 changes: 15 additions & 43 deletions guides/create-genesis.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# How to create a genesis for your rollup
# How to create a genesis

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. Follow the steps below to initialize your chain, add a genesis account, and start the chain.

## 0. Pre-requisities
## Pre-requisities

For this guide you need to have a chain directory where you have created and built your chain.

Expand All @@ -12,48 +12,20 @@ If you don't have a chain directory yet, you can initialize a simple ignite chai
This guide will use the simple ignite chain created in linked guide. Make sure to update any relevant variables to match your chain.
:::

## 1. Setting variables
## Setting variables

First, set the necessary variables for your chain in the terminal, here is an example:

```sh
VALIDATOR_NAME=validator1
CHAIN_ID=gm
KEY_NAME=rollup-key
KEY_NAME=key
CHAINFLAG="--chain-id ${CHAIN_ID}"
TOKEN_AMOUNT="10000000000000000000000000stake"
STAKING_AMOUNT="1000000000stake"
```

## 2. Rebuild your chain

Ensure that `rollkit.toml` is present in the root of your rollup directory (if not, follow a [Guide](/guides/use-rollkit-cli) to set it up) and run the following command to (re)generate an entrypoint binary out of the code:

```sh
rollkit rebuild
```

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.

Ensure that the chain configuration directory is set correctly in the `rollkit.toml` file.

For example:

```sh
[chain]
config_dir = "/Users/you/.gm"
```

:::tip
You can always recreate the `rollkit.toml` file by deleting it and re-running the following command:

```sh
rollkit toml init
```

:::

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

Reset any existing chain data:

Expand All @@ -68,47 +40,47 @@ rm -rf $HOME/.$CHAIN_ID/config/gentx
rm $HOME/.$CHAIN_ID/config/genesis.json
```

## 4. Initializing the validator
## Initializing the validator

Initialize the validator with the chain ID you set:

```sh
rollkit init $VALIDATOR_NAME --chain-id $CHAIN_ID
```

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

Add a key to the keyring-backend:

```sh
rollkit keys add $KEY_NAME --keyring-backend test
```

## 6. Adding a genesis account
## Adding a genesis account

Add a genesis account with the specified token amount:

```sh
rollkit genesis add-genesis-account $KEY_NAME $TOKEN_AMOUNT --keyring-backend test
```

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

Set the staking amount in the genesis transaction:

```sh
rollkit genesis gentx $KEY_NAME $STAKING_AMOUNT --chain-id $CHAIN_ID --keyring-backend test
```

## 8. Collecting genesis transactions
## Collecting genesis transactions

Collect the genesis transactions:

```sh
rollkit genesis collect-gentxs
```

## 9. Configuring the genesis file
## Configuring the genesis file

Copy the centralized sequencer address into `genesis.json`:

Expand All @@ -118,16 +90,16 @@ PUB_KEY=$(jq -r '.pub_key' ~/.$CHAIN_ID/config/priv_validator_key.json)
jq --argjson pubKey "$PUB_KEY" '.consensus["validators"]=[{"address": "'$ADDRESS'", "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.$CHAIN_ID/config/genesis.json > temp.json && mv temp.json ~/.$CHAIN_ID/config/genesis.json
```

## 10. Starting the chain
## Starting the chain

Finally, start the chain with your start command.

For example, start the simple ignite chain with the following command:

```sh
rollkit start --rollkit.aggregator --rollkit.sequencer_rollup_id $CHAIN_ID
rollkit start --rollkit.aggregator
```

## 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 Rollkit CLI. Make sure `rollkit.toml` is present in the root of your rollup directory, and use the `rollkit` command for all operations.
By following these steps, you will set up the genesis, initialize the validator, add a genesis account, and started the chain. This guide provides a basic framework for configuring and starting your chain using your binary. Make sure `rollkit.toml` is present in the root of your chain directory, and use the `rollkit` command for all operations.
10 changes: 4 additions & 6 deletions guides/full-node.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Rollup Full Node Setup Guide
# Full Node Setup Guide

## Introduction

Expand All @@ -22,7 +22,7 @@ Let's set a terminal variable for the chain ID.
CHAIN_ID=gm
```

Initialize the chain config for the full node, lets call it `FullNode` and set the chain ID to your rollup chain ID:
Initialize the chain config for the full node, lets call it `FullNode` and set the chain ID to your chain ID:

```bash
{BINARY} init FullNode --chain-id=$CHAIN_ID
Expand All @@ -38,7 +38,7 @@ cp $HOME/.$CHAIN_ID/config/genesis.json $HOME/.${CHAIN_ID}_fn/config/genesis.jso

Identify the sequencer node's P2P address from its logs. It will look similar to:

```
```bash
1:55PM INF listening on address=/ip4/127.0.0.1/tcp/36656/p2p/12D3KooWJbD9TQoMSSSUyfhHMmgVY3LqCjxYFz8wQ92Qa6DAqtmh
```

Expand Down Expand Up @@ -72,12 +72,10 @@ rollkit start \
--grpc.address 127.0.0.1:9390 \
--p2p.laddr "0.0.0.0:46656" \
--api.address tcp://localhost:1318 \
--rollkit.sequencer_rollup_id gm
```

Key points about this command:

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

Expand All @@ -93,7 +91,7 @@ After starting your full node, you should see output similar to:
This output indicates that your full node is successfully connecting to the network and processing blocks.

:::tip
If your rollup uses EVM as an execution layar and you see an error like `datadir already used by another process`, it means you have to remove all the state from rollup data directory (`/root/.yourrollup_fn/data/`) and specify a different data directory for the EVM client.
If your chain uses EVM as an execution layer and you see an error like `datadir already used by another process`, it means you have to remove all the state from the data directory (`/root/.{binary_home}/data/`) and specify a different data directory for the EVM client.
:::

## Conclusion
Expand Down
5 changes: 2 additions & 3 deletions guides/ignite-rollkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ ignite rollkit init
To initialize the Rollkit CLI configuration, generate the `rollkit.toml` file by running the following command:

```bash
rollkit toml init
{APP_BINARY} init
```

This will set up the Rollkit configuration file rollkit.toml, allowing you to use the Rollkit CLI for managing and running your blockchain.
Expand All @@ -81,12 +81,11 @@ This will set up the Rollkit configuration file rollkit.toml, allowing you to us
Now you are ready to start your chain. We need to include 2 flags:

1. `--rollkit.aggregator` to signal that this node is the block producer
2. `--rollkit.sequencer_rollup_id gm` to share the chain ID with the sequencer.

Start your chain using the following command:

```bash
rollkit start --rollkit.aggregator --rollkit.sequencer_rollup_id gm
{APP_BINARY} start --rollkit.aggregator
```

Your rollkit chain is now up and running.
Expand Down
17 changes: 8 additions & 9 deletions guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,30 @@ description: This page provides a comprehensive overview of the how to guides av
# How To Guides

Welcome to the Rollkit guides section! Here, you'll find a wide range of guides
designed to help you understand and effectively use Rollkit, the first sovereign
rollup framework.
designed to help you understand and effectively use Rollkit.

Hopefully you've gone through some of the tutorials and are ready to dive
deeper. These guides will go into detail on some specific topics that will make
your life easier when developing with Rollkit.

In this section, you'll find:

* [Create genesis for your rollup](/guides/create-genesis)
* [Restart your rollup](/guides/restart-rollup)
* [Create genesis](/guides/create-genesis)
* [Restart your chain](/guides/restart-rollup)
* [Reset your chain's state](/guides/reset-state)
* [Turn your CometBFT app into a Rollkit app](/guides/cometbft-to-rollkit)
* [Use Ignite to create a Rollkit app](/guides/ignite-rollkit)
* EVM Rollups
* EVM Applications
* [EVM Based Sequencer Setup](/guides/evm-based)
* [EVM Single Sequencer Setup](/guides/evm-single-guide)
* Configuration
* [Config Settings](/guides/config)
* Integrations
* [Test and deploy cosmwasm smart-contracts](/guides/cw-orch)
* [Add zkML to your EVM rollup](/guides/zkml)
* [Add an IBC connection to your rollup](/guides/ibc-connection)
* [Integrate Range with your rollup](/guides/rollkit-monitoring)
* [Use IBC token (TIA) as gas token in your rollup](/guides/use-tia-for-gas)
* [Add zkML to your EVM](/guides/zkml)
* [Add an IBC connection](/guides/ibc-connection)
* [Integrate Range](/guides/rollkit-monitoring)
* [Use IBC token (TIA) as gas token](/guides/use-tia-for-gas)

## 💻 Support {#support}

Expand Down
38 changes: 15 additions & 23 deletions guides/restart-rollup.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# 🔄 How to restart your rollup
# 🔄 How to restart your Application

This guide will teach you how to restart your Rollkit rollup.
This guide will teach you how to restart your Application.

## Restart rollup
## Restart

This section covers the case where you need to restart your rollup.
This section covers the case where you need to restart your chain.

In order to restart your rollup, you simply need to run the `<your-binary>d start [...args]`
command for your rollup.
In order to restart your chain, you simply need to run the `<your-binary>d start [...args]`
command.

For example, if you ran the [quick start](../tutorials/quick-start.md) tutorial, you started your rollup with:
For example, if you ran the [quick start](../tutorials/quick-start.md) tutorial, you started your chain with:

```bash
rollkit start
{APP_BINARY} start
```

You would have see output similar to:
Expand All @@ -24,10 +24,10 @@ I[2024-10-17|14:52:12.845] executed block module=B
I[2024-10-17|14:52:12.846] indexed block events module=txindex height=7
```

If you need to restart your rollup, you can run the same command again:
If you need to restart your chain, you can run the same command again:

```bash
rollkit start
{APP_BINARY} start
```

You will see that the block height will continue from where it left off:
Expand All @@ -39,13 +39,13 @@ I[2024-10-17|14:52:13.845] executed block module=B
I[2024-10-17|14:52:13.845] indexed block events module=txindex height=8
```

It is important to include any additional flags that you used when you first started your rollup. For example, if you used the `--rollkit.da_namespace` flag, you will need to include that flag when restarting your rollup to ensure your rollup continues to publish blobs to the same namespace.
It is important to include any additional flags that you used when you first started your chain. For example, if you used the `--rollkit.da.namespace` flag, you will need to include that flag when restarting your chain to ensure your chain continues to publish blobs to the same namespace.

## Restart rollup after running out of funds
## Restart after running out of funds

This section covers the case that the node that
you are using to post blocks to your DA and consensus layer runs out of funds (tokens),
and you need to restart your rollup.
and you need to restart.

In this example, we're using Celestia's [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet/)
and running the [quick start](../tutorials/quick-start.md). In this example, our Celestia DA light node
Expand All @@ -58,7 +58,7 @@ error. This error is defined by Cosmos SDK as:
ErrTxInMempoolCache = Register(RootCodespace, 19, "tx already in mempool")
```

In order to get around this error, and the same error on other Rollkit rollups, you will need to re-fund your Celestia account and increase the gas fee. This will override the transaction that is stuck in the mempool.
In order to get around this error, and the same error on other applications, you will need to re-fund your Celestia account and increase the gas fee. This will override the transaction that is stuck in the mempool.

If you top up the balance of your node and don't increase the gas fee, you will still encounter the `Code: 19` error because there is a transaction (posting block to DA) that is duplicate to one that already exists. In order to get around this, you'll need to increase the gas fee and restart the chain.

Expand All @@ -82,20 +82,12 @@ cd $HOME && cd celestia-node
./cel-key list --keyring-backend test --node.type light --p2p.network <network>
```

### 🛑 Stopping your rollup {#stopping-your-rollup}

You can stop your rollup by using `Control + C` in your terminal where the node is running.

### ⛽ Increase the gas fee {#increase-gas-fee}

To reiterate, before restarting the chain, you will need to increase the gas fee in order to avoid a `Code: 19` error. See the [How to configure gas price](./gas-price.md) guide for more information.

### 🔁 Restarting your rollup {#restarting-your-rollup}

Follow the [restart rollup](#restart-rollup) section above.

### 🛢️ Reduce gas fee & restart again {#reduce-gas-fee-restart-again}

In order to save your TIA, we also recommend stopping the chain with `Control + C`, changing the gas fee back to the default (in our case, 8000 utia) and restarting the chain:

🎊 Congrats! You've successfully restarted your Rollkit rollup after running out of TIA.
🎊 Congrats! You've successfully restarted your chain after running out of TIA.
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ features:
link: /learn/about#why-rollkit
icon: ✨
- title: Optimize for your needs
details: Take full advantage of modularity by optimizing your rollup to your needs. Tailor your block production. Choose your VM. Pick your DA layer.
details: Take full advantage of modularity by optimizing your chain to your needs. Tailor your block production. Choose your VM. Pick your DA layer.
link: /learn/stack
icon: ⚙️
- title: Take Control
Expand Down
Loading