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

Update to use rollkit cli instead of <binary>d #394

Merged
merged 2 commits into from
Jun 14, 2024
Merged

Conversation

yarikbratashchuk
Copy link
Contributor

@yarikbratashchuk yarikbratashchuk commented Jun 14, 2024

Summary by CodeRabbit

  • New Features

    • Added new guides on connecting to local DA, creating rollup genesis, configuring DA block sync time, setting max pending blocks, and using Rollkit CLI.
  • Documentation

    • Updated sidebar navigation with renamed and reordered guide topics.
    • Refined tutorials for Celestia DA and GM world rollup with updated dependencies and commands.
    • Enhanced Wordle tutorial with new Rollkit setup instructions.
  • Chores

    • Updated igniteVersionTag to v28.4.0.
    • Modified installation script branch in install-gm-rollup.sh.

Generate rollkit.toml as a separate step

Update wordle to use rollkit cli and latest ignite

Celestia DA with a rollkit CLI

Wordle tut with a rollkit CLI

Guide on connecting to local da

Update How-To titles

Add rollkit cli how to guide

Add how to create a genesis config

Change heading for celestia-da tutorial

Use --no-module for scaffolding

Separate config section in how-to guides

Max pending blocks guide

Fix broken .vitepress

Update tutorials/wordle.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update guides/max-pending-blocks.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update guides/connect-local-da.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update guides/create-genesis.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Add language specifier for fenced code

Update tutorials/celestia-da.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Add a blank line above the heading for proper Markdown formatting

Fix formatting

Markdown adjustments

Fix unterminated str literal

Fix

Update guides/create-genesis.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update tutorials/gm-world.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update tutorials/gm-world.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update guides/create-genesis.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update guides/create-genesis.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Add md extension to a use-rollkit-cli guide

Update guides/connect-local-da.md

Co-authored-by: joshcs.eth <[email protected]>

Update .vitepress/config.ts

Co-authored-by: joshcs.eth <[email protected]>

Update guides/connect-local-da.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/connect-local-da.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/create-genesis.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/max-pending-blocks.md

Co-authored-by: joshcs.eth <[email protected]>

Update tutorials/celestia-da.md

Co-authored-by: joshcs.eth <[email protected]>

Update tutorials/celestia-da.md

Co-authored-by: joshcs.eth <[email protected]>

Update tutorials/celestia-da.md

Co-authored-by: joshcs.eth <[email protected]>

Update tutorials/gm-world.md

Co-authored-by: joshcs.eth <[email protected]>

Update tutorials/gm-world.md

Co-authored-by: joshcs.eth <[email protected]>

Update guides/use-rollkit-cli.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

coderabbitai bot commented Jun 14, 2024

Warning

Rate limit exceeded

@yarikbratashchuk has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 1 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 02e9a0e and 282f205.

Walkthrough

The recent changes primarily focus on updating the sidebar navigation structure in .vitepress/config.ts, upgrading the igniteVersionTag, and adding several new guide files related to Rollkit CLI usage, local DA connection, genesis creation, and configuration options. These updates streamline the setup and configuration process for Rollup blockchains, ensuring better guidance and improved functionality.

Changes

Files/Groups Change Summaries
.vitepress/config.ts Updated sidebar navigation structure: text and link changes for various guides.
.vitepress/constants/constants.js Updated igniteVersionTag from "v28.3.0" to "v28.4.0".
guides/connect-local-da.md New guide on connecting a rollup to a local DA network for testing and development.
guides/create-genesis.md New guide on creating genesis for a rollup chain using Rollkit CLI.
guides/da-block-time.md New guide on configuring DA chain block syncing time.
guides/max-pending-blocks.md New guide introducing --rollkit.max_pending_blocks flag for setting max pending blocks.
guides/use-rollkit-cli.md Comprehensive guide on using Rollkit CLI for rollup project management.
public/install-gm-rollup.sh Script now checks out tutorial-local-da-rollkit branch from the remote repository.
tutorials/celestia-da.md Renaming "GM world rollup" to "rollup" and updating related commands for Rollkit deployment on Celestia DA.
tutorials/gm-world.md Updates to Rollkit installation, configuration, and command execution for the rollup blockchain.
tutorials/wordle.md Command syntax updates, integration of Rollkit app, and adjustment in steps for setting up a Wordle blockchain.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant User
    participant Rollkit CLI
    participant Local DA Network
    participant Rollup Chain

    User ->> Rollkit CLI: init rollkit.toml
    Rollkit CLI ->> Rollkit CLI: Generate rollkit.toml file
    User ->> Rollkit CLI: start --config rollkit.toml
    Rollkit CLI ->> Local DA Network: Connect to DA network
    Rollkit CLI ->> Rollup Chain: Initialize and start rollup
    User ->> Rollup Chain: Submit transactions
    Rollup Chain ->> Rollkit CLI: Process transactions
    Rollkit CLI ->> Local DA Network: Post data for availability
    Rollkit CLI ->> User: Confirm rollup running
Loading

Poem

In realms of code where Rollkits play,
The guides are clearer every day.
The sidebar shifts, a newfound path,
To help devs steer their Rollkit craft.
With CLI tools and DA ties,
Rollups soar to boundless skies. 🚀🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 5

Outside diff range and nitpick comments (3)
guides/da-block-time.md (1)

Line range hint 16-16: Avoid multiple consecutive blank lines to maintain clean and consistent Markdown formatting.

- 
Tools
Markdownlint

3-3: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces

guides/max-pending-blocks.md (1)

Line range hint 16-16: Remove excess blank lines to ensure clean and consistent Markdown formatting.

- 
tutorials/celestia-da.md (1)

Line range hint 108-109: Remove exposed JSON Web Token to prevent unauthorized access risks.

Please ensure that all sensitive tokens are removed from public documentation to safeguard against security vulnerabilities.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3b5831a and 02e9a0e.

Files selected for processing (11)
  • .vitepress/config.ts (1 hunks)
  • .vitepress/constants/constants.js (1 hunks)
  • guides/connect-local-da.md (1 hunks)
  • guides/create-genesis.md (1 hunks)
  • guides/da-block-time.md (1 hunks)
  • guides/max-pending-blocks.md (1 hunks)
  • guides/use-rollkit-cli.md (1 hunks)
  • public/install-gm-rollup.sh (1 hunks)
  • tutorials/celestia-da.md (3 hunks)
  • tutorials/gm-world.md (6 hunks)
  • tutorials/wordle.md (11 hunks)
Files skipped from review due to trivial changes (4)
  • .vitepress/constants/constants.js
  • guides/connect-local-da.md
  • guides/create-genesis.md
  • public/install-gm-rollup.sh
Additional context used
Markdownlint
guides/da-block-time.md

3-3: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces

guides/max-pending-blocks.md

16-16: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

guides/use-rollkit-cli.md

71-71: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


24-24: Punctuation: ':' (MD026, no-trailing-punctuation)
Trailing punctuation in heading


57-57: Punctuation: ':' (MD026, no-trailing-punctuation)
Trailing punctuation in heading


70-70: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


70-70: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines

tutorials/celestia-da.md

55-55: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


58-58: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


67-67: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

tutorials/gm-world.md

69-69: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


69-69: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

tutorials/wordle.md

572-572: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


761-761: Expected: 80; Actual: 138 (MD013, line-length)
Line length


155-155: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe (MD055, table-pipe-style)
Table pipe style

LanguageTool
guides/use-rollkit-cli.md

[uncategorized] ~42-~42: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... where your chain configuration is. For GM World tutorial, rollkit.toml file loo...


[uncategorized] ~42-~42: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...onfiguration is. For GM World tutorial, rollkit.toml file looks like this: ...

tutorials/gm-world.md

[uncategorized] ~151-~151: A comma is probably missing here. (MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
Context: ...1lv8c1FWhLpqP"}' type: local ``` For convenience we export two of our keys like this: `...


[uncategorized] ~158-~158: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... flags, for now, we just want to submit transaction from a high-level perspective): ```bas...

tutorials/wordle.md

[style] ~35-~35: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ld) You do not have to do those guides in order to follow this Wordle tutorial, but doing ...


[style] ~77-~77: Consider using a more formal and expressive alternative to ‘amazing’. (AWESOME)
Context: ...--> ### 🔥 Ignite {#ignite} Ignite is an amazing CLI tool to help us get started buildin...


[uncategorized] ~91-~91: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ocal machine. This tutorial uses a macOS but it should work for Windows. For Windows...


[style] ~278-~278: Consider using “who” when you are referring to a person instead of an object. (THAT_WHO)
Context: ...submitter` is the address of the person that submitted the Wordle. The second type ...


[style] ~543-~543: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...oins method to the BankKeeper interface in order to allow sending the reward to the right g...


[grammar] ~718-~718: When ‘five-letter’ is used as a modifier, it is usually spelled with a hyphen. (WORD_ESSAY_HYPHEN)
Context: ... for the day. Now let’s try to guess a five letter word: <!-- markdownlint-disable MD013 ...


[style] ~748-~748: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ... correct word. 2. You can hash the word prior to submitting it to the chain, ensuring ...


[style] ~756-~756: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...wordle every day at a specific time. 6. You can create a vue.js front-end with Igni...

Gitleaks
tutorials/celestia-da.md

108-109: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data. (jwt)

tutorials/gm-world.md

154-155: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)


155-156: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)

Additional comments not posted (7)
tutorials/gm-world.md (5)

91-91: It's good to specify the DA network address explicitly in the start command. This enhances clarity and ensures the correct network configuration.


57-58: The command to install the gm-world rollup is crucial. Ensure that the script https://rollkit.dev/install-gm-rollup.sh is available and up-to-date.

Verification successful

The script at the specified URL is reachable and contains the appropriate commands for downloading and setting up the GM tutorial rollup. The script clones a repository, checks out a specific branch, and runs an initialization script, which aligns with the intended purpose.

  • The URL is reachable and returns a valid script with a 200 HTTP status.
  • The script content is appropriate and up-to-date for the intended use.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check if the URL is reachable and returns a valid script.
curl -I https://rollkit.dev/install-gm-rollup.sh

Length of output: 1346



Script:

#!/bin/bash
# Download and display the content of the script to ensure it's appropriate and up-to-date.
curl -sSL https://rollkit.dev/install-gm-rollup.sh

Length of output: 352


35-36: Please ensure that the placeholder {{constants.rollkitLatestTag}} is correctly replaced during script execution.


131-131: Listing keys is a sensitive operation. Ensure that the rollkit keys list command handles keyring backend securely.


204-204: Ensure that the query command for checking balances is correctly implemented and returns the expected results.

.vitepress/config.ts (1)

258-319: The sidebar configuration has been extensively updated. Ensure that all links are valid and lead to the correct guides.

Verification successful

The initial script did not produce clear results, likely due to capturing commented lines and other irrelevant text. Let's refine the script to focus on actual links within the configuration.


The refined script provided useful information but showed that several internal links returned a status code of 000, indicating they might not be accessible. Let's further investigate these internal links to ensure they are correctly formed and accessible within the project structure.


The script successfully checked for the existence of the internal links as files within the project, and no missing files were reported. This indicates that the internal links in the sidebar configuration are correctly formed and accessible.

  • : All links in the sidebar configuration are valid and correctly formed.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check for broken links in the sidebar configuration.
grep 'link' .vitepress/config.ts | cut -d '"' -f 4 | xargs -I {} curl -o /dev/null --silent --head --write-out '%{http_code} : {}' {}

Length of output: 692



Script:

#!/bin/bash
# Extract actual links from the sidebar configuration in .vitepress/config.ts and check their status.
grep -oP '(?<=link: ")[^"]*' .vitepress/config.ts | xargs -I {} curl -o /dev/null --silent --head --write-out '%{http_code} : {}' {}

Length of output: 1226



Script:

#!/bin/bash
# Check if the internal links in the sidebar configuration exist as files within the project.
internal_links=$(grep -oP '(?<=link: "/)[^"]*' .vitepress/config.ts)
for link in $internal_links; do
  if [ ! -f "$link.md" ] && [ ! -f "$link/index.md" ]; then
    echo "Missing: $link"
  fi
done

Length of output: 3410

tutorials/wordle.md (1)

122-123: The command ignite scaffold chain wordle --no-module is used to scaffold a new blockchain. Ensure that this command is correctly implemented and documented in Ignite CLI.

guides/da-block-time.md Outdated Show resolved Hide resolved
guides/use-rollkit-cli.md Show resolved Hide resolved
tutorials/celestia-da.md Show resolved Hide resolved
tutorials/gm-world.md Show resolved Hide resolved
tutorials/gm-world.md Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants