chore: replace the word rollup #600
Conversation
WalkthroughThis update systematically replaces the term "rollup" with "chain" across configuration files, documentation, guides, and navigation elements. It also simplifies the automatic review request configuration, updates sidebar navigation labels and links, and revises variable names and command examples in guides to align with the new terminology. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs/Guides
participant Config/Sidebar
User->>Docs/Guides: Reads documentation/guides
Docs/Guides-->>User: Presents info using "chain" terminology
User->>Config/Sidebar: Navigates sidebar
Config/Sidebar-->>User: Shows "chain" labels and links
User->>GitHub: Opens PR
GitHub-->>User: Assigns default reviewer group (simplified config)
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @tac0turtle, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request undertakes a significant terminology refactor, standardizing the use of 'chain' in place of 'rollup' throughout the project's documentation and related configurations. The aim is to enhance clarity and consistency in how the project's core concepts are communicated, making the guides and learning materials more intuitive for users and developers.
Highlights
- Terminology Standardization: I've systematically replaced the term 'rollup' with 'chain' across the project's documentation and configuration files to ensure consistent and precise language.
- Documentation Updates: This includes updates to sidebar navigation, guide titles, introductory texts, and descriptive content in various learning and deployment guides.
- Configuration and Code Snippet Alignment: I've adjusted code examples, variable names (e.g.,
KEY_NAME), and relayer configurations to reflect the new 'chain' terminology, ensuring functional consistency with the updated language.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
.vitepress/config.ts
Outdated
| text: "Rollkit: The First Sovereign Chain Framework", | ||
| link: "/blog/rollkit-the-first-sovereign-chain-framework", |
There was a problem hiding this comment.
The link for "Rollkit: The First Sovereign Chain Framework" has been updated to /blog/rollkit-the-first-sovereign-chain-framework, but the corresponding file blog/rollkit-the-first-sovereign-rollup-framework.md has not been renamed in this pull request. This will cause a broken link.
Please ensure the file is renamed as part of this PR to match the new link.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
guides/full-node.md (1)
68-77:--chain_idflag will be rejected – must be--chain-id
gmd startfollows Cobra’s kebab-case convention. Using an underscore will result in an “unknown flag” error.- --chain_id $CHAIN_ID \ + --chain-id $CHAIN_ID \
🧹 Nitpick comments (19)
.github/auto_request_review.yml (1)
1-4: Granularity & reviewer-count were removed—validate intentPrevious config enforced path-based routing and ≥3 reviewers; now every PR gets a single reviewer regardless of scope.
If coverage breadth or reviewer load balancing is still desired, consider re-introducing:reviewers: required_reviewers: 2 # or 3 groups: binarybuilders: - alice - bob files: docs/**: binarybuilderslearn/execution.md (1)
5-6: Tighten wording & drop dangling colonThe current phrasing is slightly clunky and ends with an unnecessary colon. A small rewrite improves readability and keeps the sentence self-contained:
-This means you can use a variety of Cosmos SDK or Reth compatible applications as the execution environment for your chain: +This means you can use any Cosmos SDK–compatible or Reth-compatible application as the execution environment for your chain.learn/config.md (1)
100-113: Examples still say “rollup” – update to match new terminologyThe descriptive text now talks about “your chain”, but both example values still contain “rollkit-chain/rollup”. For consistency with the renaming effort, adjust the examples:
-```yaml -chain_id: "my-rollkit-chain" -``` +```yaml +chain_id: "my-chain" +``` -`--chain_id <string>` -*Example:* `--chain_id "super_rollup_testnet_v1"` +`--chain_id <string>` +*Example:* `--chain_id "super_chain_testnet_v1"`guides/deploy-overview.md (1)
16-16: Minor punctuation nitConsider inserting a comma after “production use” for smoother flow.
-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. +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.learn/data-availability.md (2)
3-3: Fix grammatical errors and tighten wordingThe current sentence has an apostrophe misuse (“utilize's”) and awkward phrasing.
-Data availability (DA) is a core of Rollkit's. Rollkit utilize's data availability ensures that all transaction data and block information required to verify the chain's state is accessible to anyone running a node or light client. +Data availability (DA) is a core component of Rollkit. Rollkit utilizes data availability to ensure that all transaction data and block information required to verify the chain state is accessible to anyone running a node or light client.
21-21: Optional: add definite article for clarity- - Anyone can verify that the data is available and reconstruct the chain state, depending on the guarantees of the chosen DA layer. + - Anyone can verify that the data is available and reconstruct the chain state, depending on the guarantees of the chosen DA layer.(If you prefer “the chain state” over “chain state,” adjust accordingly.)
guides/da/celestia-da.md (2)
10-10: Use “between” when comparing two options-From the Rollkit perspective, there's no difference in posting blocks to Celestia's testnets or Mainnet Beta. +From the Rollkit perspective, there's no difference between posting blocks to Celestia's testnets and posting to Mainnet Beta.
130-134: Add missing article & tweak heading-## 🔥 Running your chain connected to Celestia light node +## 🔥 Running your chain connected to a Celestia light nodeThe body text is clear; only the heading needed the article.
guides/full-node.md (1)
26-26: Replace “lets” with “let’s” for grammatical correctness-Initialize the chain config for the full node, lets call it `FullNode` and set the chain ID to your chain ID: +Initialize the chain config for the full node—let’s call it `FullNode`—and set the chain ID to your chain ID:guides/create-genesis.md (2)
42-42: Indefinite article typo (“an gmd” → “a gmd”)-This (re)creates an `gmd` binary that will be used for the rest of the tutorials to run all the operations on the chain. +This (re)creates a `gmd` binary that will be used for the rest of the tutorials to run all the operations on the chain.
121-121: Past-tense mismatch – use “start the chain”-... add a genesis account, and started the chain. +... add a genesis account, and start the chain.guides/quick-start.md (1)
44-48: Grammar: “lets” → “let’s”-First lets start the local DA network: +First let’s start the local DA network:guides/da/local-da.md (1)
30-30: Smoother wording-Start your chain node with the following command, ensuring to include the DA address flag: +Start your chain node with the following command, ensuring that you include the DA address flag:guides/restart-chain.md (2)
7-10: Trim redundant wording in the opening paragraph“In order to restart your chain, you simply need to run …” can be shortened without losing meaning.
Keeping the docs concise makes key steps easier to scan.-In order to restart your chain, you simply need to run the `<your-binary>d start [...args]` -command for your chain. +To restart your chain, run `<your-binary>d start [...args]`.
101-102: Consistent terminologyThe closing sentence reads “restart your Rollkit chain”. Everywhere else we now say just “chain”.
Consider aligning for consistency:-🎊 Congrats! You've successfully restarted your Rollkit chain after running out of TIA. +🎊 Congrats! You've successfully restarted your chain after running out of TIA.guides/deploy/overview.md (1)
41-43: Minor style tweak – drop filler words“Before deploying your chain for production use you should fully understand …”
A comma after “use” improves readability:
-Before deploying your chain for production use you should fully understand +Before deploying your chain for production use, you should fully understandguides/execution/cosmwasm.md (1)
122-125:docker ps | grep wasmcan match multiple containersIf more than one container name includes “wasm”,
$CWwill be ambiguous.-CW=$(docker ps --format '{{.Names}}' | grep wasm) +CW=$(docker ps --format '{{.Names}}' | grep -m1 '^wasm--')Using
-m1or a stricter pattern guarantees a single, predictable match..vitepress/config.ts (1)
311-312: Long title – consider shortening“Use IBC token (TIA) as gas token in your chain” is a mouthful inside a sidebar.
Maybe “Use TIA as gas token” or similar? Keeps the menu neat on smaller screens.learn/transaction-flow.md (1)
34-35: Capitalisation nit“Add to Chain Block” – mid-sentence capital “Chain” looks odd.
- Sequencer->>DALayer: Add to Chain Block + Sequencer->>DALayer: Add to chain block
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (25)
.github/auto_request_review.yml(1 hunks).vitepress/config.ts(2 hunks)README.md(1 hunks)guides/cometbft-to-rollkit.md(1 hunks)guides/create-genesis.md(4 hunks)guides/da/celestia-da.md(4 hunks)guides/da/local-da.md(3 hunks)guides/deploy-overview.md(1 hunks)guides/deploy/overview.md(2 hunks)guides/evm/single.md(2 hunks)guides/execution/cosmwasm.md(7 hunks)guides/full-node.md(3 hunks)guides/gm-world.md(5 hunks)guides/quick-start.md(5 hunks)guides/restart-chain.md(5 hunks)guides/use-tia-for-gas.md(8 hunks)learn/about.md(2 hunks)learn/config.md(3 hunks)learn/data-availability.md(2 hunks)learn/execution.md(1 hunks)learn/sequencing/overview.md(1 hunks)learn/sequencing/single.md(2 hunks)learn/specs/block-manager.md(3 hunks)learn/specs/block-validity.md(3 hunks)learn/transaction-flow.md(3 hunks)
🧰 Additional context used
🧠 Learnings (7)
guides/da/celestia-da.md (2)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
guides/restart-chain.md (2)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
guides/full-node.md (2)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
guides/execution/cosmwasm.md (6)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
guides/create-genesis.md (10)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.strideinternal1.json:7-11
Timestamp: 2024-10-08T09:25:09.556Z
Learning: In the Hyperlane validator configuration file `validator.strideinternal1.json`, including the validator key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.strideinternal1.json:7-11
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the Hyperlane validator configuration file `validator.strideinternal1.json`, including the validator key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.localwasm.json:7-11
Timestamp: 2024-10-08T09:19:12.976Z
Learning: In the Hyperlane validator configuration file `validator.localwasm.json`, including the validator key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.localwasm.json:7-11
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the Hyperlane validator configuration file `validator.localwasm.json`, including the validator key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.strideinternal1.json:12-20
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the Hyperlane validator configuration file `validator.strideinternal1.json`, including the signer key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.strideinternal1.json:12-20
Timestamp: 2024-10-08T09:25:15.151Z
Learning: In the Hyperlane validator configuration file `validator.strideinternal1.json`, including the signer key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.localwasm.json:12-20
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the Hyperlane validator configuration file `validator.localwasm.json`, including the signer key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/validator.localwasm.json:12-20
Timestamp: 2024-10-08T09:21:19.799Z
Learning: In the Hyperlane validator configuration file `validator.localwasm.json`, including the signer key as plain text is intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
.vitepress/config.ts (8)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
guides/use-tia-for-gas.md (10)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-08T09:29:26.874Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
🪛 LanguageTool
learn/execution.md
[style] ~5-~5: Consider using a more concise synonym.
Context: ...xecution layer. This means you can use a variety of Cosmos SDK or Reth compatible applicati...
(A_VARIETY_OF)
guides/restart-chain.md
[style] ~8-~8: Consider a more concise word here.
Context: ... where you need to restart your chain. In order to restart your chain, you simply need to ...
(IN_ORDER_TO_PREMIUM)
[style] ~42-~42: This phrase is redundant. Consider writing “started”.
Context: ...additional flags that you used when you first started your chain. For example, if you used th...
(FIRST_BEGAN)
[style] ~91-~91: Consider a more concise word here.
Context: ..., you will need to increase the gas fee in order to avoid a Code: 19 error. See the [How ...
(IN_ORDER_TO_PREMIUM)
[style] ~98-~98: Consider a more concise word here.
Context: ... again {#reduce-gas-fee-restart-again} In order to save your TIA, we also recommend stoppi...
(IN_ORDER_TO_PREMIUM)
guides/quick-start.md
[style] ~80-~80: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1231 characters long)
Context: ...seful applications on Rollkit. Good luck!
(EN_EXCESSIVE_EXCLAMATION)
learn/about.md
[style] ~72-~72: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: ...ntioned above, Rollkit could be used in many different ways. From sovereign chains, to settlement l...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
[style] ~76-~76: Consider replacing ‘gives’ with a different word to let your writing stand out.
Context: ...with any execution environment Rollkit gives developers the flexibility to use pre-existing ABC...
(GIVE_TIME_STYLE)
🔇 Additional comments (17)
.github/auto_request_review.yml (1)
1-4: Confirmbinarybuildersteam slug existsIf the organisation does not have a team (or user) named exactly
binarybuilders, the bot will not be able to request a review and will fail silently. Double-check the slug or use the explicitorg/team-nameformat.learn/config.md (2)
357-358: LGTM – description aligns with new terminology
397-398: LGTM – wording looks correctlearn/specs/block-manager.md (3)
100-101: Term swap is correct – no further action
293-294: Good clarification of “NotFound” outcome
319-320: No inbound links to the old anchor foundA search across all Markdown files for
#out-of-order-rollup-blocks-on-dareturned no matches. There are no remaining intra-site links to update, so this change is safe to merge.README.md (1)
32-32: Update looks good – reflects new wordingguides/evm/single.md (2)
5-6: Text replacement is correct; no further issues
162-163: Consistent closing statement – 👍guides/cometbft-to-rollkit.md (1)
48-48: Text change looks goodTerminology swap is consistent with the broader doc update. No further action needed.
learn/sequencing/single.md (1)
3-3: Consistent terminology, no issuesThe “rollup” → “chain” replacement reads naturally and preserves meaning.
No further edits required.Also applies to: 22-23, 25-26
learn/specs/block-validity.md (1)
32-33: “Based chains” term might be ambiguous – please verifyThe phrase
based chainsisn’t widely used in the preceding docs. Did you intend “base chains” (as opposed to sovereign chains) or retain the original “based rollups” concept?
Clarifying this will avoid confusing readers.guides/restart-chain.md (1)
42-43: Flag name still contains “rollkit” – confirm it’s intentional
--rollkit.da.namespacesurvived the rollup→chain rename.
If the CLI flag itself is still spelled that way it’s fine; otherwise update the docs to avoid confusion..vitepress/config.ts (1)
291-293: No orphaned restart-rollup content remaining
Confirmed thatguides/restart-rollup.mdhas been removed and there are no references torestart-rollupin the codebase.guides/use-tia-for-gas.md (1)
225-226:rly q channels … | jq -r .channel_idis unlikely to work – adjust the JSON pathThe
rly q channelscommand (relayer v2.5.x) returns a structure whose channel identifiers live under.chains[].channels[].channel_id.
Piping directly to.channel_idwill returnnull, leavingCHANNEL_ID_ON_MOCHAempty and causing the subsequent transfer to fail.Example fix:
-CHANNEL_ID_ON_MOCHA="$(rly q channels mocha gm_chain | jq -r .channel_id | tail -1)" +CHANNEL_ID_ON_MOCHA="$(rly q channels mocha gm_chain \ + | jq -r '.chains[].channels[].channel_id' \ + | tail -1)"Please verify against your actual
rlyoutput.learn/about.md (2)
66-66: Restored sentence improves completeness – thanksThe previously-missing “bootstrap a validator set …” sentence is back and updated to “chain” terminology. Looks good.
24-24: Link Verification Complete – No Changes Needed
The URLhttps://blog.celestia.org/sovereign-rollup-chains/correctly resolves to the Celestia blog post titled “Rollups as Sovereign Chains” (published July 7, 2022). No update to the slug or anchor text is required.
| Now that you have an idea of how to interact with the chain with the rollkit CLI, let's look at the user interface (UI) application aspect of connecting a wallet to a chain. | ||
| Connecting your wallet to your rollup is as straightforward as connecting to any other blockchain. It assumes you have the [Keplr](https://www.keplr.app/) wallet extension installed in your browser. | ||
| Connecting your wallet to your chain is as straightforward as connecting to any other blockchain. It assumes you have the [Keplr](https://www.keplr.app/) wallet extension installed in your browser. | ||
| ## 🔗 Connecting your wallet | ||
| Kurtosis spun up a UI app alongside your rollup already, so to connect your Keplr wallet to the application, simply open your browser and go to [http://localhost:3000](https://localhost:3000). | ||
| Kurtosis spun up a UI app alongside your chain already, so to connect your Keplr wallet to the application, simply open your browser and go to [http://localhost:3000](https://localhost:3000). | ||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix the localhost URL – HTTPS will fail with a self-signed certificate
https://localhost:3000 will trigger browser security warnings (and often refuse to load) because no trusted TLS cert exists for localhost.
Use plain HTTP for local dev endpoints.
-Kurtosis spun up a UI app alongside your chain already, so to connect your Keplr wallet to the application, simply open your browser and go to [http://localhost:3000](https://localhost:3000).
+Kurtosis spun up a UI app alongside your chain already, so to connect your Keplr wallet to the application, simply open your browser and go to [http://localhost:3000](http://localhost:3000).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Now that you have an idea of how to interact with the chain with the rollkit CLI, let's look at the user interface (UI) application aspect of connecting a wallet to a chain. | |
| Connecting your wallet to your rollup is as straightforward as connecting to any other blockchain. It assumes you have the [Keplr](https://www.keplr.app/) wallet extension installed in your browser. | |
| Connecting your wallet to your chain is as straightforward as connecting to any other blockchain. It assumes you have the [Keplr](https://www.keplr.app/) wallet extension installed in your browser. | |
| ## 🔗 Connecting your wallet | |
| Kurtosis spun up a UI app alongside your rollup already, so to connect your Keplr wallet to the application, simply open your browser and go to [http://localhost:3000](https://localhost:3000). | |
| Kurtosis spun up a UI app alongside your chain already, so to connect your Keplr wallet to the application, simply open your browser and go to [http://localhost:3000](https://localhost:3000). | |
| Now that you have an idea of how to interact with the chain with the rollkit CLI, let's look at the user interface (UI) application aspect of connecting a wallet to a chain. | |
| Connecting your wallet to your chain is as straightforward as connecting to any other blockchain. It assumes you have the [Keplr](https://www.keplr.app/) wallet extension installed in your browser. | |
| ## 🔗 Connecting your wallet | |
| Kurtosis spun up a UI app alongside your chain already, so to connect your Keplr wallet to the application, simply open your browser and go to [http://localhost:3000](http://localhost:3000). |
🤖 Prompt for AI Agents
In guides/gm-world.md around lines 271 to 278, the URL for accessing the local
UI app uses HTTPS, which causes browser security warnings due to the lack of a
trusted TLS certificate for localhost. Change the URL from
https://localhost:3000 to http://localhost:3000 to use plain HTTP for local
development and avoid these issues.
| // SubmitBatchTxs submits a batch of transactions from to sequencer | ||
| // Id is the unique identifier for the chain | ||
| // Batch is the batch of transactions to submit | ||
| // returns an error if any from the sequencer | ||
| SubmitBatchTxs(ctx context.Context, req SubmitBatchTxsRequest) (*SubmitBatchTxsResponse, error) | ||
|
|
||
| // GetNextBatch returns the next batch of transactions from sequencer to | ||
| // Id is the unique identifier for the chain | ||
| // LastBatchHash is the cryptographic hash of the last batch received by the | ||
| // MaxBytes is the maximum number of bytes to return in the batch | ||
| // returns the next batch of transactions and an error if any from the sequencer | ||
| GetNextBatch(ctx context.Context, req GetNextBatchRequest) (*GetNextBatchResponse, error) | ||
|
|
||
| // VerifyBatch verifies a batch of transactions received from the sequencer | ||
| // Id is the unique identifier for the chain | ||
| // BatchHash is the cryptographic hash of the batch to verify | ||
| // returns a boolean indicating if the batch is valid and an error if any from the sequencer | ||
| VerifyBatch(ctx context.Context, req VerifyBatchRequest) (*VerifyBatchResponse, error) | ||
| } |
There was a problem hiding this comment.
Interface comments contain blank placeholders – clarify before publishing
Automated replace left multiple sentences incomplete:
// SubmitBatchTxs submits a batch of transactions from to sequencer
^ ^
// GetNextBatch returns the next batch of transactions from sequencer to
Readers have no idea from where / to where the batches flow, and identical gaps exist for Id descriptions.
Suggested patch:
-// SubmitBatchTxs submits a batch of transactions from to sequencer
+// SubmitBatchTxs submits a batch of transactions from the Rollkit chain
+// to the external sequencer.
…
-// GetNextBatch returns the next batch of transactions from sequencer to
+// GetNextBatch returns the next batch of transactions from the sequencer to
+// the Rollkit chain.
…
-// Id is the unique identifier for the chain
+// Id is the unique identifier for the Rollkit chain.Please review and fill all missing text to avoid confusing users.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // SubmitBatchTxs submits a batch of transactions from to sequencer | |
| // Id is the unique identifier for the chain | |
| // Batch is the batch of transactions to submit | |
| // returns an error if any from the sequencer | |
| SubmitBatchTxs(ctx context.Context, req SubmitBatchTxsRequest) (*SubmitBatchTxsResponse, error) | |
| // GetNextBatch returns the next batch of transactions from sequencer to | |
| // Id is the unique identifier for the chain | |
| // LastBatchHash is the cryptographic hash of the last batch received by the | |
| // MaxBytes is the maximum number of bytes to return in the batch | |
| // returns the next batch of transactions and an error if any from the sequencer | |
| GetNextBatch(ctx context.Context, req GetNextBatchRequest) (*GetNextBatchResponse, error) | |
| // VerifyBatch verifies a batch of transactions received from the sequencer | |
| // Id is the unique identifier for the chain | |
| // BatchHash is the cryptographic hash of the batch to verify | |
| // returns a boolean indicating if the batch is valid and an error if any from the sequencer | |
| VerifyBatch(ctx context.Context, req VerifyBatchRequest) (*VerifyBatchResponse, error) | |
| } | |
| // SubmitBatchTxs submits a batch of transactions from the Rollkit chain | |
| // to the external sequencer. | |
| // Id is the unique identifier for the chain | |
| // Batch is the batch of transactions to submit | |
| // returns an error if any from the sequencer | |
| SubmitBatchTxs(ctx context.Context, req SubmitBatchTxsRequest) (*SubmitBatchTxsResponse, error) | |
| // GetNextBatch returns the next batch of transactions from the sequencer to | |
| // the Rollkit chain. | |
| // Id is the unique identifier for the Rollkit chain. | |
| // LastBatchHash is the cryptographic hash of the last batch received by the | |
| // MaxBytes is the maximum number of bytes to return in the batch | |
| // returns the next batch of transactions and an error if any from the sequencer | |
| GetNextBatch(ctx context.Context, req GetNextBatchRequest) (*GetNextBatchResponse, error) | |
| // VerifyBatch verifies a batch of transactions received from the sequencer | |
| // Id is the unique identifier for the chain | |
| // BatchHash is the cryptographic hash of the batch to verify | |
| // returns a boolean indicating if the batch is valid and an error if any from the sequencer | |
| VerifyBatch(ctx context.Context, req VerifyBatchRequest) (*VerifyBatchResponse, error) | |
| } |
🤖 Prompt for AI Agents
In learn/sequencing/overview.md between lines 12 and 30, the interface comments
have incomplete placeholders that omit key details about the source and
destination of transaction batches and the description of the Id parameter.
Review each comment and fill in the missing information clearly specifying where
batches are submitted from and to, and provide a complete description for the Id
parameter to ensure the documentation is clear and informative before
publishing.
2 participants
Overview
remove the word rollup other than in links and the blog post
closes #499
Summary by CodeRabbit
Documentation
New Features