Skip to content

fix: quick start guide #578

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: quick start guide #578

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 18 additions & 5 deletions tutorials/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Quickly start a rollup node using the Rollkit CLI.
description: Quickly start a rollup node using the Testapp CLI.
---

<script setup>
Expand All @@ -8,9 +8,9 @@ import constants from '../.vitepress/constants/constants.js'

# Quick start guide

Welcome to Rollkit, a sovereign rollup framework! The easiest way to launch your sovereign rollup node is by using the Rollkit CLI.
Welcome to Rollkit, a sovereign rollup framework! The easiest way to launch your sovereign rollup node is by using the Testapp CLI.

## 📦 Install Rollkit (CLI)
## 📦 Install Testapp (CLI)

To install Rollkit, run the following command in your terminal:

Expand All @@ -21,17 +21,30 @@ curl -sSL https://rollkit.dev/install.sh | sh -s {{constants.rollkitLatestTag}}
Verify the installation by checking the Rollkit version:

```bash
rollkit version
testapp version
```

A successful installation will display the version number and its associated git commit hash.

```bash
rollkit version: v0.14.1
rollkit git sha: 888def92
```

## 🗂️ Initialize a sovereign rollup node

To initialize a sovereign rollup node, execute the following command:

```bash
testapp init --rollkit.node.aggregator --rollkit.signer.passphrase verysecretpass
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without the flags, the genesis.json file doesn't have a proposer_address generated. Maybe someone knows a better way to do it?

```

## 🚀 Run your sovereign rollup node

To start a basic sovereign rollup node, execute:

```bash
rollkit start
testapp start --rollkit.signer.passphrase verysecretpass
```

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