diff --git a/.github/auto_request_review.yml b/.github/auto_request_review.yml index 9c75a330c..3dc371d02 100644 --- a/.github/auto_request_review.yml +++ b/.github/auto_request_review.yml @@ -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 diff --git a/.vitepress/config.ts b/.vitepress/config.ts index ad5de4909..fe457091f 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -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", @@ -300,7 +300,7 @@ function sidebarHome() { link: "/guides/cometbft-to-rollkit", }, { - text: "Create genesis for your rollup", + text: "Create genesis for your chain", link: "/guides/create-genesis", }, { @@ -308,7 +308,7 @@ function sidebarHome() { 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", }, ], diff --git a/README.md b/README.md index 22955e597..b2c5a55a0 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/guides/cometbft-to-rollkit.md b/guides/cometbft-to-rollkit.md index bf6386d36..5cc9f6f58 100644 --- a/guides/cometbft-to-rollkit.md +++ b/guides/cometbft-to-rollkit.md @@ -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: diff --git a/guides/create-genesis.md b/guides/create-genesis.md index 26d4dd809..c1d2dd7db 100644 --- a/guides/create-genesis.md +++ b/guides/create-genesis.md @@ -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 @@ -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" @@ -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 @@ -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. diff --git a/guides/da/celestia-da.md b/guides/da/celestia-da.md index 126e0a6a0..063204586 100644 --- a/guides/da/celestia-da.md +++ b/guides/da/celestia-da.md @@ -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). @@ -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} @@ -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 \ @@ -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! diff --git a/guides/da/local-da.md b/guides/da/local-da.md index 682b9d565..4c6893e4f 100644 --- a/guides/da/local-da.md +++ b/guides/da/local-da.md @@ -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 @@ -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 @@ -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) diff --git a/guides/deploy-overview.md b/guides/deploy-overview.md index 4e4f54421..3c59f45de 100644 --- a/guides/deploy-overview.md +++ b/guides/deploy-overview.md @@ -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) diff --git a/guides/deploy/overview.md b/guides/deploy/overview.md index aee4dc3dc..4ff203b99 100644 --- a/guides/deploy/overview.md +++ b/guides/deploy/overview.md @@ -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 @@ -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 diff --git a/guides/evm/single.md b/guides/evm/single.md index 140f7df27..4796671be 100644 --- a/guides/evm/single.md +++ b/guides/evm/single.md @@ -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 @@ -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. diff --git a/guides/execution/cosmwasm.md b/guides/execution/cosmwasm.md index c99247637..1f3fbc788 100644 --- a/guides/execution/cosmwasm.md +++ b/guides/execution/cosmwasm.md @@ -1,4 +1,4 @@ -# 🗞ïļ CosmWasm rollup +# 🗞ïļ CosmWasm chain