Skip to content
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

feat: docs restructuring, add deploy section, bring in v0.14.x #493

Merged
merged 20 commits into from
Nov 15, 2024
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
106 changes: 60 additions & 46 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ function nav() {
{ text: "Learn", link: "/learn/intro" },
{ text: "Tutorials", link: "/tutorials/quick-start" },
{ text: "How To Guides", link: "/guides/overview" },
{ text: "Testnets", link: "/testnets/cosmwasm-testnet" },
// { text: "Testnets", link: "/testnets/cosmwasm-testnet" },
{ text: "Blog", link: "/blog/overview" },
];
}
Expand Down Expand Up @@ -218,17 +218,7 @@ function sidebarHome() {
text: "Quick start guide",
link: "/tutorials/quick-start",
},
{
text: "Rollkit",
collapsed: true,
items: [
{
text: "GM world rollup",
link: "/tutorials/gm-world",
},
{ text: "Wordle app", link: "/tutorials/wordle" },
],
},
{ text: "Build a chain", link: "/tutorials/wordle" },
{
text: "DA",
collapsed: true,
Expand Down Expand Up @@ -273,18 +263,42 @@ function sidebarHome() {
text: "Execution",
collapsed: true,
items: [
{ text: "CosmWasm rollup", link: "/tutorials/cosmwasm" },
{
{ text: "CosmWasm", link: "/tutorials/cosmwasm" },
{
text: "EVM",
collapsed: true,
items: [
collapsed: true,
items: [
{ text: "Omni Octane EVM", link: "/tutorials/octane-evm" },
{ text: "BeaconKit EVM", link: "/tutorials/beaconkit" },
{ text: "Artela EVM++", link: "/tutorials/artela-evm-plus-plus" },
{ text: "Contract interaction", link: "/tutorials/evm-contract-interaction" },
]
},
],
{ text: "BeaconKit EVM", link: "/tutorials/beaconkit" },
{
text: "Artela EVM++",
link: "/tutorials/artela-evm-plus-plus",
},
{
text: "Contract interaction",
link: "/tutorials/evm-contract-interaction",
},
],
},
],
},
{
text: "Deploy your chain",
collapsed: true,
items: [
{
text: "Overview",
link: "/tutorials/deploy-overview",
},
{
text: "Docker Compose",
link: "/tutorials/docker-compose",
},
// {
// text: "Kurtosis",
// link: "/tutorials/kurtosis",
// },
],
},
],
},
Expand Down Expand Up @@ -350,32 +364,32 @@ function sidebarHome() {
text: "Integrations",
collapsed: true,
items: [
{
text: "Test and deploy cosmwasm smart-contracts",
link: "/guides/cw-orch",
},
{ text: "Add zkML to your EVM rollup", link: "/guides/zkml" },
{
text: "Add an IBC connection to your rollup",
link: "/guides/ibc-connection",
},
{
text: "Integrate Range with your rollup",
link: "/guides/rollkit-monitoring",
},
{
text: "Use IBC token (TIA) as gas token in your rollup",
link: "/guides/use-tia-for-gas",
},
],
},
{
text: "Test and deploy cosmwasm smart-contracts",
link: "/guides/cw-orch",
},
{ text: "Add zkML to your EVM rollup", link: "/guides/zkml" },
{
text: "Add an IBC connection to your rollup",
link: "/guides/ibc-connection",
},
{
text: "Integrate Range with your rollup",
link: "/guides/rollkit-monitoring",
},
{
text: "Use IBC token (TIA) as gas token in your rollup",
link: "/guides/use-tia-for-gas",
},
],
},
],
},
{
text: "Testnets",
collapsed: true,
items: [{ text: "CosmWasm Testnet", link: "/testnets/cosmwasm-testnet" }],
},
// {
// text: "Testnets",
// collapsed: true,
// items: [{ text: "CosmWasm Testnet", link: "/testnets/cosmwasm-testnet" }],
// },
{
text: "Blog",
collapsed: true,
Expand Down
6 changes: 3 additions & 3 deletions .vitepress/constants/constants.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ const constants = Object.freeze({
nodeVersion: "21.7.2",
yarnVersion: "1.22.19",

rollkitLatestTag: "v0.13.7",
rollkitLatestSha: "8deede4",
rollkitLatestTag: "v0.14.1",
rollkitLatestSha: "5a8693e",
rollkitCosmosSDKVersion: "v0.50.6-rollkit-v0.13.3-no-fraud-proofs",
rollkitIgniteAppVersion: "rollkit/v0.2.1",

localDALatestTag: "v0.3.1",
goSequencingLatestTag: "v0.4.0",
goSequencingLatestTag: "v0.4.1",
igniteVersionTag: "v28.5.3",
});
export default constants;
43 changes: 18 additions & 25 deletions guides/ignite-rollkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,6 @@ This will create the `gm` blockchain. Navigate to the blockchain directory:
cd gm
```

## Run a local Data Availability (DA) node {#run-local-da-node}

First, set up a local data availability network node:

```bash-vue
cd $HOME && curl -sSL https://rollkit.dev/install-local-da.sh | sh -s {{constants.localDALatestTag}}
```

This script builds and runs a DA node, which will listen on port `7980`.

## Run a local Sequencer node {#run-local-sequencer-node}

First, set up a local sequencer node:

```bash-vue
cd $HOME && curl -sSL https://rollkit.dev/install-local-sequencer.sh | sh -s {{constants.goSequencingLatestTag}} gm
```

This script builds and runs a local sequencer node, which will listen on port `50051`.

## Install Ignite App Rollkit {#install-ignite-app-rollkit}

In a new terminal window, you'll now install and run the Ignite App Rollkit.
Expand All @@ -70,6 +50,14 @@ Enhance your blockchain by adding Rollkit features. Use the following command:
ignite rollkit add
```

## Build your chain {#build-your-chain}

Build your chain using the following command:

```bash
ignite chain build
```

## Initialize Your Blockchain {#initialize-your-blockchain}

Before starting your blockchain, you need to initialize it with Rollkit support. Initialize the blockchain with Local DA as follows:
Expand All @@ -88,16 +76,21 @@ rollkit toml init

This will set up the Rollkit configuration file rollkit.toml, allowing you to use the Rollkit CLI for managing and running your blockchain.

## Start Your Rollup {#start-your-blockchain}
## Start your chain {#start-your-chain}

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.

Finally, start your rollup (blockchain) using the following command:
Start your chain using the following command:

```bash
rollkit start --rollkit.aggregator --rollkit.da_address http://localhost:7980
rollkit start --rollkit.aggregator --rollkit.sequencer_rollup_id gm
```

Your rollkit app is now up and running.
Your rollkit chain is now up and running.

## Summary

By following these steps, you've successfully installed Ignite, set up Local DA, integrated Rollkit features into your blockchain, and configured the Rollkit CLI.
By following these steps, you've successfully installed Ignite, integrated Rollkit features into your blockchain, and configured the Rollkit CLI to run your chain against a mock DA and mock sequencer.
20 changes: 20 additions & 0 deletions tutorials/deploy-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
description: This page provides an overview of some common ways to deploy rollups.
---

# Deploying Your Rollup

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.

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.

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

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

* [Deploy with Docker Compose](/tutorials/docker-compose)
<!-- * [Deploy with Kurtosis](/tutorials/kurtosis) -->
Loading
Loading