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
4 changes: 2 additions & 2 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,6 @@ function sidebarHome() {
text: "About Rollkit",
link: "/learn/about",
},
{ text: "Transaction flow", link: "/learn/transaction-flow" },
{ text: "Configuration", link: "/learn/config" },
{
text: "Data Availability",
link: "/learn/data-availability",
Expand Down Expand Up @@ -219,6 +217,8 @@ function sidebarHome() {
{ text: "Store", link: "/learn/specs/store" },
],
},
{ text: "Transaction flow", link: "/learn/transaction-flow" },
{ text: "Configuration", link: "/learn/config" },
],
},
{
Expand Down
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Makefile for docs

.PHONY: testlink

testlink:
lychee -b . --verbose --exclude '%23.*' './**/*.md'
9 changes: 5 additions & 4 deletions guides/cometbft-to-rollkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ import constants from '../.vitepress/constants/constants.js'

This guide assumes you have a CometBFT app set up and [Ignite CLI](https://docs.ignite.com) installed.

:::warning
This tutorial is currently being updated to reflect the latest changes using the rollkit ignite app.
Please check back later for the updated version.
:::

## Install Rollkit {#install-rollkit}

You need to install Rollkit in your CometBFT app. Open a terminal in the directory where your app is located and run the following command:
Expand All @@ -36,10 +41,6 @@ Run the following command to initialize Rollkit:
ignite rollkit init
```

:::warning
This tutorial is being currently update to reflect the latest changes using the rollkit ignite app.
Please check back later for the updated version.
:::

<!-- TODO: update

Expand Down
20 changes: 10 additions & 10 deletions guides/create-genesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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
## Pre-requisities

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

Expand All @@ -25,7 +25,7 @@ TOKEN_AMOUNT="10000000000000000000000000stake"
STAKING_AMOUNT="1000000000stake"
```

## 2. Rebuild your chain
## Rebuild your chain

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:

Expand All @@ -41,7 +41,7 @@ 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 chain.

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

Reset any existing chain data:

Expand All @@ -56,47 +56,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
gmd 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
gmd 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
gmd 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
gmd 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
gmd genesis collect-gentxs
```

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

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

Expand All @@ -106,7 +106,7 @@ 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.

Expand Down
Loading