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 #383

Closed
wants to merge 1 commit into from

Conversation

yarikbratashchuk
Copy link
Contributor

@yarikbratashchuk yarikbratashchuk commented May 21, 2024

Overview

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated and restructured sidebar items for configuration guides to improve navigation and clarity.
    • Added new guides for:
      • Connecting to a local DA network.
      • Creating genesis for rollup chains.
      • Configuring DA chain block sync time.
      • Setting maximum pending blocks for DA submission.
    • Updated the tutorial for deploying rollups to Celestia and revised prerequisites.
    • Significant updates to the Wordle blockchain tutorial for better clarity and streamlined setup.
  • New Features

    • Introduced detailed guides on creating genesis configurations and connecting rollups to local DA networks.
  • Chores

    • Updated the igniteVersionTag to "v28.4.0".

Copy link
Contributor

coderabbitai bot commented May 21, 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 12 minutes and 31 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 f132888 and 5691e84.

Walkthrough

The changes primarily encompass updates to the .vitepress configuration, tutorials, and guides, focusing on streamlining and standardizing the sidebar items, updating constant values, and revising commands and instructions for Rollkit integration. Several new guides have been added, covering topics such as configuring DA block time and connecting to a Local DA network.

Changes

File Change Summary
.vitepress/config.ts Updated sidebar items and links for various configuration guides.
.vitepress/constants/constants.js Updated the igniteVersionTag from "v28.3.0" to "v28.4.0".
guides/connect-local-da.md Added a guide on connecting a rollup to a local DA network.
guides/create-genesis.md Added a guide on creating a genesis for a rollup chain using Rollkit.
guides/da-block-time.md Introduced guidance on configuring the DA chain block syncing time.
guides/max-pending-blocks.md Introduced guidance on configuring the maximum number of blocks pending DA submission.
public/install-gm-rollup.sh Updated the Git branch checkout command to use the tutorial-local-da-rollkit branch.
tutorials/celestia-da.md Renamed tutorial and adjusted commands to use Rollkit CLI and Ignite for deploying rollups.
tutorials/gm-world.md Updated installation and setup instructions for Rollkit, including transaction submission and querying steps.
tutorials/wordle.md Adjusted command descriptions and added new Rollkit setup commands for the Wordle blockchain tutorial.

Poem

In the world of Rollkit, we made a change,
Config and files now rearrange.
Sidebar links and guides to see,
Connecting DA in harmony.
Tutorials fresh, commands defined,
A streamlined path for all to find. 🐇✨


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

github-actions bot commented May 21, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://rollkit.github.io/docs-preview/./pr-383/
on branch main at 2024-06-14 14:07 UTC

@yarikbratashchuk
Copy link
Contributor Author

The version of the rollkit cli should be different after rollkit/rollkit#1680 is merged

@MSevey
Copy link
Contributor

MSevey commented May 23, 2024

The version of the rollkit cli should be different after rollkit/rollkit#1680 is merged

Does this work prior to 1680 being merged?
If not, let's mark this as draft and update it once 1680 is merged, otherwise I would imagine this would break the docs.

Copy link
Contributor

@MSevey MSevey left a comment

Choose a reason for hiding this comment

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

pending answer to previous question

@jcstein jcstein marked this pull request as draft May 24, 2024 16:48
@jcstein jcstein marked this pull request as draft May 24, 2024 16:48
Copy link
Member

@Manav-Aggarwal Manav-Aggarwal left a comment

Choose a reason for hiding this comment

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

@yarikbratashchuk to resolve this once ready to merge

@yarikbratashchuk yarikbratashchuk marked this pull request as ready for review June 12, 2024 17:09
@RollkitBot RollkitBot requested a review from MSevey June 12, 2024 17:10
@Manav-Aggarwal Manav-Aggarwal marked this pull request as draft June 12, 2024 17:12
@Manav-Aggarwal
Copy link
Member

Cannot see the preview: https://github.com/rollkit/docs/actions/runs/9486810092/job/26142007535?pr=383, please fix before making ready for review

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

Outside diff range and nitpick comments (1)
tutorials/wordle.md (1)

Line range hint 718-718: Use "five-letter" with a hyphen when used as a compound adjective.

- Now let’s try to guess a five letter word:
+ Now let’s try to guess a five-letter word:
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a047e11 and e3ef814.

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 (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 (3)
  • .vitepress/constants/constants.js
  • guides/use-rollkit-cli
  • 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


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


1-1: null (MD023, heading-start-left)
Headings must start at the beginning of the line

guides/connect-local-da.md

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

guides/create-genesis.md

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

tutorials/celestia-da.md

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


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


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


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


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

tutorials/gm-world.md

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


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


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


68-68: 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/max-pending-blocks.md

[uncategorized] ~1-~1: The grammatical number of this noun doesn’t look right. Consider replacing it. (AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
Context: ... How to configure the maximum number of block pending DA submission The `--rollkit.m...

guides/create-genesis.md

[uncategorized] ~112-~112: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...is present in the root of your rollup directory and use therollkit` command for all o...

tutorials/gm-world.md

[uncategorized] ~150-~150: 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] ~157-~157: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ... just want to submit transaction from a high level perspective): ```bash rollkit tx bank ...

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


[uncategorized] ~52-~52: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ght means it’s a correct letter for the Wordle included in the wrong position. A grey ...


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


[grammar] ~122-~122: The word “setup” is a noun. The verb is spelled with a white space. (NOUN_VERB_CONFUSION)
Context: ... we first run the following command to setup our project for our new blockchain, wor...


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


[uncategorized] ~513-~513: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...the hash string of the current day. * Next we create a hash string of current day ...


[uncategorized] ~513-~513: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... day. * Next we create a hash string of current day and the Submitter. This allows us...


[uncategorized] ~518-~518: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... continue guessing a new wordle every day up to the max of 6 tries per day. * We ...


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


[uncategorized] ~559-~559: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...et up a local data availability network node run: ```bash-vue curl -sSL https://rol...


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


[uncategorized] ~754-~754: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...mblebun/wordle-cli). 4. You can improve current date to stick to a specific timezone. 5...


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

Additional comments not posted (11)
tutorials/celestia-da.md (3)

1-1: Update title to reflect the new tooling.


32-36: The command to install rollkit CLI is updated to reflect the new versioning. Ensure that the version tag is correct and matches the latest stable release.


132-132: The updated command to start the rollup node includes new flags for DA configuration. Ensure these flags are documented and their usage is clear in the context of Celestia.

tutorials/gm-world.md (4)

64-72: The output of the rollkit toml init command indicates a missing configuration. Ensure that the documentation guides the user on how to manually add the missing configuration.

Verification successful

The documentation does provide guidance on how to manually add the missing configuration in the rollkit.toml file. Specifically, it instructs the user to set the config_dir under the [chain] section to the ./.gm directory.

  • "Open the rollkit.toml file and under the [chain] section set config_dir to the ./.gm directory. Your rollkit.toml file should look like this:"

This confirms that the necessary instructions are present in the tutorial.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the guidance on adding missing configuration in `rollkit.toml`.

# Test: Search for additional instructions on manual configuration in the tutorial.
rg --type markdown $'Please put the chain.config_dir' tutorials/gm-world.md

Length of output: 182



Script:

#!/bin/bash
# Description: Verify the guidance on adding missing configuration in `rollkit.toml`.

# Test: Search for any additional instructions or sections related to `chain.config_dir` or `rollkit.toml` in the tutorial.
rg --type markdown 'chain.config_dir' tutorials/gm-world.md
rg --type markdown 'rollkit.toml' tutorials/gm-world.md

Length of output: 662

Tools
Markdownlint

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


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


34-36: Ensure the installation script uses the correct version tag for rollkit.

Verification successful

The installation script in tutorials/gm-world.md correctly references the rollkitLatestTag from .vitepress/constants/constants.js, which is set to "v0.13.3".

  • .vitepress/constants/constants.js:

    rollkitLatestTag: "v0.13.3",
  • tutorials/gm-world.md:

    curl -sSL https://rollkit.dev/install.sh | sh -s {{constants.rollkitLatestTag}}
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the version tag of `rollkit` CLI in the installation command.

# Test: Search for the version tag in constants.js and compare it with the installation command.
rg --type javascript $'rollkitLatestTag' .vitepress/constants/constants.js
rg --type bash $'install.sh' tutorials/gm-world.md

Length of output: 187



Script:

#!/bin/bash
# Description: Verify the version tag of `rollkit` CLI in the installation command.

# Test: Search for the version tag in constants.js and compare it with the installation command.
rg 'rollkitLatestTag' .vitepress/constants/constants.js
rg 'install.sh' tutorials/gm-world.md

Length of output: 204


57-58: The script to install the gm-world rollup is updated. Verify that this script correctly sets up the environment as described.

Verification successful

The script install-gm-rollup.sh correctly sets up the environment by cloning the repository, checking out the appropriate branch, and running the initialization script.

  • The script clones the gm repository from GitHub.
  • It checks out the tutorial-local-da branch.
  • It runs the init.sh script to build and configure the rollup chain.

This confirms that the script performs the described actions.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the setup script for `gm-world` rollup.

# Test: Search for the script in the repository to ensure it performs the described actions.
rg --type bash $'install-gm-rollup.sh' tutorials/gm-world.md

Length of output: 88



Script:

#!/bin/bash
# Description: Verify the setup script for `gm-world` rollup.

# Test: Search for the script in the repository to ensure it performs the described actions.
rg 'install-gm-rollup.sh'

# If the script is found, display its contents for verification.
if [ -f "$(rg --files install-gm-rollup.sh)" ]; then
  cat "$(rg --files install-gm-rollup.sh)"
fi

Length of output: 338



Script:

#!/bin/bash
# Description: Download and display the contents of the `install-gm-rollup.sh` script from the URL.

# Download the script
curl -sSL https://rollkit.dev/install-gm-rollup.sh -o /tmp/install-gm-rollup.sh

# Display the contents of the script for verification
cat /tmp/install-gm-rollup.sh

Length of output: 413

Tools
Markdownlint

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


160-160: The transaction command syntax is updated. Confirm that all flags and parameters are correctly documented and match the rollkit CLI's capabilities.

.vitepress/config.ts (1)

258-319: The sidebar configuration has been extensively updated to reflect the new guides and links. Ensure all links are valid and lead to the intended pages.

Verification successful

All the guide links in the sidebar configuration resolve to valid markdown files in the repository.

  • /guides/use-rollkit-cli
  • /guides/connect-local-da
  • /guides/create-genesis
  • /guides/restart-rollup
  • /guides/full-and-sequencer-node
  • /guides/gas-price
  • /guides/max-pending-blocks
  • /guides/da-block-time
  • /guides/block-times
  • /guides/lazy-sequencing
  • /guides/cw-orch
  • /guides/zkml
  • /guides/ibc-connection
  • /guides/rollkit-monitoring
  • /guides/use-tia-for-gas
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the validity of new guide links in the sidebar configuration.

# Test: Check each link to ensure it resolves to a valid page.
rg --type markdown $'/guides/' .vitepress/config.ts

Length of output: 808



Script:

#!/bin/bash
# Description: Verify the existence of markdown files for each guide link in the sidebar configuration.

# List of guide links to verify
links=(
  "/guides/use-rollkit-cli"
  "/guides/connect-local-da"
  "/guides/create-genesis"
  "/guides/restart-rollup"
  "/guides/full-and-sequencer-node"
  "/guides/gas-price"
  "/guides/max-pending-blocks"
  "/guides/da-block-time"
  "/guides/block-times"
  "/guides/lazy-sequencing"
  "/guides/cw-orch"
  "/guides/zkml"
  "/guides/ibc-connection"
  "/guides/rollkit-monitoring"
  "/guides/use-tia-for-gas"
)

# Check if each link has a corresponding markdown file
for link in "${links[@]}"; do
  # Convert link to relative file path
  filepath="${link#/}.md"
  if ! fd --full-path "$filepath"; then
    echo "Missing file for link: $link"
  fi
done

Length of output: 2307

tutorials/wordle.md (3)

169-184: Ensure the version tag rollkit/v0.2.0 is correct and available before proceeding with installation commands.

Verification successful

The version tag rollkit/v0.2.0 is correct and available.

  • The tag rollkit/v0.2.0 exists in the repository and is ready for use.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the availability of the specified version tag for Rollkit.

# Test: Search for the version tag in the repository. Expect: The tag should exist.
gh api repos/ignite/apps/releases | jq '.[] | select(.tag_name == "rollkit/v0.2.0")'

Length of output: 86



Script:

#!/bin/bash
# Description: Verify the availability of the specified version tag for Rollkit.

# Test: List all tags in the repository to check if the specified tag exists.
gh api repos/ignite/apps/tags | jq '.[] | select(.name == "rollkit/v0.2.0")'

Length of output: 538


582-582: Confirm that the rollkit start command is correctly configured with the necessary flags and parameters.

Verification successful

The rollkit start command with the specified parameters is correctly configured in the documentation files tutorials/wordle.md and tutorials/gm-world.md.

  • tutorials/wordle.md
  • tutorials/gm-world.md
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Check if the rollkit start command is set up correctly in the script.

# Test: Search for the rollkit start command in the script and check its parameters. Expect: Correct configuration.
grep "rollkit start --rollkit.aggregator --rollkit.da_address https://localhost:7980" ~/wordle/startup_script.sh

Length of output: 199



Script:

#!/bin/bash
# Description: Search for the rollkit start command in the entire repository and check its parameters.

# Test: Search for the rollkit start command in the repository and check its configuration.
rg "rollkit start --rollkit.aggregator --rollkit.da_address https://localhost:7980"

Length of output: 282


562-562: Verify that the install-local-da.sh script exists at the specified URL before running the command.

Verification successful

The install-local-da.sh script is available at the specified URL, as confirmed by the HTTP 200 OK response.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Check if the install-local-da.sh script is available at the specified URL.

# Test: Attempt to fetch the script. Expect: HTTP 200 OK response.
curl -o /dev/null -s -w "%{http_code}\n" https://rollkit.dev/install-local-da.sh

Length of output: 86

tutorials/wordle.md Outdated Show resolved Hide resolved
tutorials/wordle.md Show resolved Hide resolved
guides/da-block-time.md Show resolved Hide resolved
guides/max-pending-blocks.md Outdated Show resolved Hide resolved
guides/connect-local-da.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
tutorials/celestia-da.md Show resolved Hide resolved
tutorials/celestia-da.md Outdated Show resolved Hide resolved
tutorials/gm-world.md Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
@yarikbratashchuk yarikbratashchuk marked this pull request as ready for review June 14, 2024 09:16
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: 9

Outside diff range and nitpick comments (3)
tutorials/gm-world.md (1)

Line range hint 151-151: Add a comma after "local" for better readability.

- For convenience we export two of our keys like this:
+ For convenience, we export two of our keys like this:
tutorials/wordle.md (2)

Line range hint 748-748: Consider rephrasing "prior to" to a more direct expression to enhance clarity.

- You can hash the word prior to submitting it to the chain,
+ You can hash the word before submitting it to the chain,

Line range hint 748-748: Encourage consistent terminology and clarity in future development suggestions.

- You can improve current date to stick to a specific timezone.
+ You can enhance the handling of dates to adhere to a specific timezone.
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e3ef814 and 09286b9.

Files selected for processing (7)
  • .vitepress/config.ts (1 hunks)
  • guides/connect-local-da.md (1 hunks)
  • guides/create-genesis.md (1 hunks)
  • guides/max-pending-blocks.md (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 (2)
  • guides/connect-local-da.md
  • guides/max-pending-blocks.md
Additional context used
LanguageTool
guides/create-genesis.md

[uncategorized] ~28-~28: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...tions on the rollup chain. Ensure that chain configuration directory is set correctl...


[uncategorized] ~94-~94: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...yers it will different set of flags (in case of Celestia check out the tutorial [her...


[uncategorized] ~112-~112: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...is present in the root of your rollup directory and use therollkit` command for all o...

tutorials/gm-world.md

[uncategorized] ~54-~54: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...are your rollup blockchain. To make it simple we will download a repository with a `g...


[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: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ... just want to submit transaction from a high level perspective): ```bash rollkit tx bank ...

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

Additional comments not posted (3)
.vitepress/config.ts (1)

258-319: Ensure sidebar links are correctly updated and consistent with the new documentation structure.

The sidebar configuration seems well-organized and matches the new documentation structure. Good job on maintaining clarity and accessibility.

tutorials/wordle.md (2)

169-184: Ensure that the Rollkit version mentioned matches the latest stable release to avoid potential compatibility issues.

#!/bin/bash
# Description: Verify the current version of Rollkit in the repository.

# Test: Check the latest tag in the repository. Expect: The latest tag matches v0.2.0.
git tag | grep rollkit | sort -V | tail -n 1

686-686: Ensure proper error handling in the transaction submission command to prevent submission of invalid data.

- rollkit tx wordle submit-guess 12345 --from wordle-key --keyring-backend test --chain-id wordle -b async -y
+ rollkit tx wordle submit-guess "guess" --from wordle-key --keyring-backend test --chain-id wordle -b async -y

Likely invalid or redundant comment.

tutorials/wordle.md Show resolved Hide resolved
tutorials/wordle.md Show resolved Hide resolved
guides/create-genesis.md Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
tutorials/celestia-da.md Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
guides/use-rollkit-cli Outdated Show resolved Hide resolved
@MSevey
Copy link
Contributor

MSevey commented Jun 14, 2024

The preview doesn't seem to have updated. Did you verify this built locally?

guides/connect-local-da.md Outdated Show resolved Hide resolved
.vitepress/config.ts Outdated Show resolved Hide resolved
guides/connect-local-da.md Outdated Show resolved Hide resolved
guides/connect-local-da.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/create-genesis.md Outdated Show resolved Hide resolved
guides/use-rollkit-cli Outdated Show resolved Hide resolved
guides/use-rollkit-cli Outdated Show resolved Hide resolved
guides/use-rollkit-cli Outdated Show resolved Hide resolved
tutorials/celestia-da.md Outdated Show resolved Hide resolved
tutorials/celestia-da.md Outdated Show resolved Hide resolved
tutorials/celestia-da.md Outdated Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

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

first pass, mostly suggestions for sentence case in titles, instead of title case. needs to be applied, then I will review all of the copy more carefully.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 09286b9 and f132888.

Files selected for processing (3)
  • guides/create-genesis.md (1 hunks)
  • guides/use-rollkit-cli.md (1 hunks)
  • tutorials/gm-world.md (6 hunks)
Files not summarized due to errors (2)
  • guides/use-rollkit-cli.md: Error: Server error. Please try again later.
  • tutorials/gm-world.md: Error: Server error. Please try again later.
Additional context used
LanguageTool
guides/use-rollkit-cli.md

[uncategorized] ~42-~42: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...n.go. 4. Open the rollkit.tomlfile and under the[chain]section, setconfi...

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: You might be missing the article “a” here. (AI_EN_LECTOR_MISSING_DETERMINER_A)
Context: ... flags, for now, we just want to submit transaction from a high-level perspective): ```bas...

Markdownlint
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/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

Gitleaks
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 (6)
guides/use-rollkit-cli.md (1)

15-16: Ensure the command uses the correct tag for installation.

guides/create-genesis.md (2)

7-16: Ensure that the example variables are universally applicable or clearly marked as placeholders.


89-89: Consider using jq to handle JSON operations safely and efficiently.

- jq --argjson pubKey "$PUB_KEY" '.consensus["validators"]=[{"address": "'$ADDRESS'", "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.rollup/config/genesis.json > temp.json && mv temp.json ~/.rollup/config/genesis.json
+ ADDRESS=$(jq -r '.address' ~/.rollup/config/priv_validator_key.json)
+ PUB_KEY=$(jq -r '.pub_key' ~/.rollup/config/priv_validator_key.json)
+ jq --argjson pubKey "$PUB_KEY" '.consensus.validators += [{"address": $ADDRESS, "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.rollup/config/genesis.json | sponge ~/.rollup/config/genesis.json

Likely invalid or redundant comment.

tutorials/gm-world.md (3)

35-36: Verify that the installation script is up-to-date and correctly points to the latest version.

Verification successful

The installation script URL https://rollkit.dev/install.sh is present in multiple files, including tutorials/gm-world.md. It uses a placeholder {{constants.rollkitLatestTag}} to dynamically insert the latest version tag. This indicates that the script is designed to fetch the latest version correctly.

  • tutorials/quick-start.md
  • tutorials/gm-world.md
  • guides/use-rollkit-cli.md
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that the installation script points to the latest version.
rg --type bash "curl -sSL https://rollkit.dev/install.sh" ./scripts/installation.sh

Length of output: 114



Script:

#!/bin/bash
# Verify that the installation script points to the latest version.
rg --type sh "curl -sSL https://rollkit.dev/install.sh" .

Length of output: 59



Script:

#!/bin/bash
# Verify that the installation script points to the latest version by searching for the URL pattern in all files.
rg "https://rollkit.dev/install.sh" .

Length of output: 356


161-161: Ensure that the transaction command syntax is correct and aligns with the latest CLI documentation.


204-204: Confirm that querying balances via Rollkit CLI is correctly implemented and documented.

guides/use-rollkit-cli.md Show resolved Hide resolved
guides/use-rollkit-cli.md Show resolved Hide resolved
guides/use-rollkit-cli.md Outdated Show resolved Hide resolved
guides/create-genesis.md Show resolved Hide resolved
@yarikbratashchuk
Copy link
Contributor Author

The preview doesn't seem to have updated. Did you verify this built locally?

Yes I did, something's off

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>
@jcstein
Copy link
Member

jcstein commented Jun 14, 2024

:pepehands:

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.

4 participants