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

New tutorial: TIA as gas token #386

Merged
merged 15 commits into from
Jun 5, 2024
Merged

Conversation

assafmo
Copy link
Contributor

@assafmo assafmo commented Jun 4, 2024

Summary by CodeRabbit

  • New Features
    • Added a comprehensive tutorial on building a sovereign gm-world rollup using Rollkit CLI and a local DA network, with TIA as the gas token. This tutorial includes steps for setting up the environment, running a local DA network, building the rollup, connecting to Celestia Mocha testnet via IBC, and executing transactions using TIA.

Copy link
Contributor

coderabbitai bot commented Jun 4, 2024

Walkthrough

The new tutorial file gm-world-tia-gas.md provides comprehensive guidance on creating a sovereign gm-world rollup using Rollkit CLI and a local DA network, with TIA as the gas token. It includes steps for setting up the environment, running a local DA network, building the rollup, establishing an IBC connection to Celestia Mocha testnet, and executing transactions.

Changes

Files Change Summary
tutorials/gm-world-tia-gas.md Added a detailed tutorial on building a sovereign gm-world rollup using Rollkit CLI and a local DA network, with TIA as the gas token.

Poem

In the world of code, a tale unfolds,
With TIA as gas, a story bold.
Rollkit CLI, the path we tread,
To Celestia Mocha, we're being led.
Transactions flow, a seamless spree,
In the gm-world, sovereign and free.
🌐✨


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.

@assafmo assafmo marked this pull request as ready for review June 4, 2024 14:44
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: 1

Outside diff range and nitpick comments (5)
tutorials/gm-world-tia-gas.md (5)

62-62: Consider adding a comma after "simple" for better readability.

Tools
LanguageTool

[uncategorized] ~62-~62: 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...


66-66: Consider rephrasing to avoid wordiness. For example, "To run it, you need to have the jq command line tool installed."

Tools
LanguageTool

[style] ~66-~66: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...


85-85: Replace "going to be" with "will be" for a more assertive tone.

Tools
LanguageTool

[style] ~85-~85: Use ‘will’ instead of ‘going to’ if the following action is certain. (GOING_TO_WILL)
Context: ...however, if we assume our first channel is going to be an ICS-20 transfer channel to Celest...


123-123: Avoid repetitive phrasing. Consider rephrasing to "Next, we'll establish an IBC connection between our rollup and the Celestia Mocha testnet."

Tools
LanguageTool

[style] ~123-~123: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_GOING_TO_VB)
Context: ...net using IBC {#ibc-to-celestia} Next, we're going to create an IBC connection between our ro...


[style] ~123-~123: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...will allow us to send TIA to our rollup in order to use it as a gas token. Install the IBC...


123-123: Consider rephrasing to avoid wordiness. For example, "This will enable us to use TIA as the gas token on our rollup."

Tools
LanguageTool

[style] ~123-~123: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_GOING_TO_VB)
Context: ...net using IBC {#ibc-to-celestia} Next, we're going to create an IBC connection between our ro...


[style] ~123-~123: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...will allow us to send TIA to our rollup in order to use it as a gas token. Install the IBC...

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 22dc1e3 and d99b8e7.

Files selected for processing (1)
  • tutorials/gm-world-tia-gas.md (1 hunks)
Additional context used
LanguageTool
tutorials/gm-world-tia-gas.md

[uncategorized] ~62-~62: 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...


[style] ~66-~66: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...


[style] ~85-~85: Use ‘will’ instead of ‘going to’ if the following action is certain. (GOING_TO_WILL)
Context: ...however, if we assume our first channel is going to be an ICS-20 transfer channel to Celest...


[style] ~123-~123: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_GOING_TO_VB)
Context: ...net using IBC {#ibc-to-celestia} Next, we're going to create an IBC connection between our ro...


[style] ~123-~123: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...will allow us to send TIA to our rollup in order to use it as a gas token. Install the IBC...

Markdownlint
tutorials/gm-world-tia-gas.md

233-233: null (MD034, no-bare-urls)
Bare URL used

tutorials/gm-world-tia-gas.md Outdated Show resolved Hide resolved
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 (1)
tutorials/gm-world-tia-gas.md (1)

9-9: Ensure the tutorial introduction is clear and engaging.

Consider adding a brief overview of what "sovereign rollup" and "TIA" are, to make the introduction more informative for beginners.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d99b8e7 and 65126f2.

Files selected for processing (1)
  • tutorials/gm-world-tia-gas.md (1 hunks)
Additional context used
LanguageTool
tutorials/gm-world-tia-gas.md

[uncategorized] ~62-~62: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...are your rollup blockchain. To make it simple we will download a repository with a `g...


[style] ~66-~66: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...


[uncategorized] ~67-~67: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... terminal: ::: warning In order to run it you need to have the jq command line to...


[style] ~85-~85: Use ‘will’ instead of ‘going to’ if the following action is certain. (GOING_TO_WILL)
Context: ...however, if we assume our first channel is going to be an ICS-20 transfer channel to Celest...


[style] ~123-~123: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_GOING_TO_VB)
Context: ...net using IBC {#ibc-to-celestia} Next, we're going to create an IBC connection between our ro...


[style] ~123-~123: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...will allow us to send TIA to our rollup in order to use it as a gas token. Install the IBC...

Additional comments not posted (1)
tutorials/gm-world-tia-gas.md (1)

233-233: Update the link to use Markdown syntax.

- [Mocha Testnet Faucet Instructions](https://docs.celestia.org/nodes/mocha-testnet#mocha-testnet-faucet).
+ [Mocha Testnet Faucet Instructions](https://docs.celestia.org/nodes/mocha-testnet#mocha-testnet-faucet)

Likely invalid or redundant comment.

tutorials/gm-world-tia-gas.md Show resolved Hide resolved
tutorials/gm-world-tia-gas.md Outdated Show resolved Hide resolved
tutorials/gm-world-tia-gas.md Outdated Show resolved Hide resolved
tutorials/gm-world-tia-gas.md Outdated Show resolved Hide resolved
tutorials/gm-world-tia-gas.md Outdated Show resolved Hide resolved
assafmo and others added 6 commits June 4, 2024 18:16
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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 65126f2 and 9e1e625.

Files selected for processing (1)
  • tutorials/gm-world-tia-gas.md (1 hunks)
Additional context used
LanguageTool
tutorials/gm-world-tia-gas.md

[style] ~67-~67: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...all the jq command line tool to run it. In order to run it, you need to have the jq command...


[style] ~124-~124: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...will allow us to send TIA to our rollup in order to use it as a gas token. Install the IBC...

Additional comments not posted (2)
tutorials/gm-world-tia-gas.md (2)

9-9: Ensure all links are clickable using Markdown syntax.

- Unlike the [quick start guide](https://rollkit.dev/tutorials/quick-start), this tutorial provides a more practical approach to understanding sovereign rollup development using `TIA` as the gas token.
+ Unlike the [quick start guide](https://rollkit.dev/tutorials/quick-start), this tutorial provides a more practical approach to understanding sovereign rollup development using `TIA` as the gas token.

Likely invalid or redundant comment.


232-232: Use Markdown syntax for external links to enhance readability.

- [Mocha Testnet Faucet Instructions](https://docs.celestia.org/nodes/mocha-testnet#mocha-testnet-faucet).
+ [Mocha Testnet Faucet Instructions](https://docs.celestia.org/nodes/mocha-testnet#mocha-testnet-faucet).

Likely invalid or redundant comment.

tutorials/gm-world-tia-gas.md Show resolved Hide resolved
tutorials/gm-world-tia-gas.md Outdated Show resolved Hide resolved
tutorials/gm-world-tia-gas.md Outdated Show resolved Hide resolved
tutorials/gm-world-tia-gas.md Show resolved Hide resolved
assafmo and others added 2 commits June 4, 2024 22:47
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9e1e625 and 90a1a83.

Files selected for processing (1)
  • tutorials/gm-world-tia-gas.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • tutorials/gm-world-tia-gas.md

@assafmo assafmo changed the title Tutorial: TIA as gas token New tutorial: TIA as gas token Jun 4, 2024
Copy link
Member

@gupadhyaya gupadhyaya left a comment

Choose a reason for hiding this comment

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

looks good otherwise. nice work.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 90a1a83 and 229029e.

Files selected for processing (1)
  • tutorials/gm-world-tia-gas.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • tutorials/gm-world-tia-gas.md

@gupadhyaya gupadhyaya enabled auto-merge June 5, 2024 11:37
@gupadhyaya gupadhyaya merged commit 33364e4 into rollkit:main Jun 5, 2024
1 of 2 checks passed
@assafmo
Copy link
Contributor Author

assafmo commented Jun 5, 2024

Thanks for merging @gupadhyaya! I have some changes that I want to add to make the IBC section a bit more robust. I'll submit another PR later.

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