-
Notifications
You must be signed in to change notification settings - Fork 52
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
Conversation
WalkthroughThe new tutorial file Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this 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
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
There was a problem hiding this 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
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.
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>
There was a problem hiding this 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
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.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this 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
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
There was a problem hiding this 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.
There was a problem hiding this 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
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
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. |
Summary by CodeRabbit
gm-world
rollup using Rollkit CLI and a local DA network, withTIA
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 usingTIA
.