fix: tuts discrepancies #403
Conversation
WalkthroughThe recent updates encompass changes to the 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 (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- tutorials/gm-world.md (4 hunks)
- tutorials/wordle.md (2 hunks)
Additional context used
LanguageTool
tutorials/gm-world.md
[uncategorized] ~147-~147: A comma is probably missing here. (MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
Context: ...e1LJWzTMDjwdt"}' type: local ``` For convenience we export two of our keys like this: `...
[uncategorized] ~154-~154: 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 ...
[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...
[uncategorized] ~104-~104: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...p ``` You should see an output of help commands meaning Ignite was installed successful...
[uncategorized] ~119-~119: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...Cosmos-SDK version of Foundry or Hardhat but specifically designed to build blockcha...
[uncategorized] ~147-~147: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...mportant file isapp.gothat contains type definition of the blockchain and functi...
[style] ~269-~269: 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] ~504-~504: 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] ~504-~504: 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] ~509-~509: 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] ~534-~534: 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] ~645-~645: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... then get a response with a transaction hash as shown here: ```bash code: 0 codespa...
[grammar] ~716-~716: 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] ~746-~746: ‘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] ~752-~752: 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] ~754-~754: 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...
Markdownlint
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 specifiedtutorials/wordle.md
759-759: 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
Gitleaks
tutorials/gm-world.md
150-151: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
151-152: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
Additional comments not posted (6)
tutorials/gm-world.md (3)
Line range hint
157-180: Correct the transaction command to align with the new key orderThe transaction command has been updated to reflect the new key order, ensuring that the transaction is initiated from the correct sender to the intended recipient.
147-147: Grammar Improvement: Add a comma after introductory phraseConsider adding a comma after "For convenience" for better readability and grammatical correctness.
- For convenience we export two of our keys like this: + For convenience, we export two of our keys like this:Tools
LanguageTool
[uncategorized] ~147-~147: A comma is probably missing here. (MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
Context: ...e1LJWzTMDjwdt"}' type: local ``` For convenience we export two of our keys like this: `...
Line range hint
200-224: Validate updated balance queries and amountsThe changes to the balance queries and the amounts displayed after transactions need to be verified to ensure they reflect the updated transaction logic correctly.
Verification successful
Validate updated balance queries and amounts
The balance amounts for
$KEY1and$KEY2have been successfully extracted and match the expected values in the tutorial.
- Receiver’s balance shows an increase to
42069stake.- Sender’s balance shows
99957931stake.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the updated balance queries and amounts. # Test: Search for balance queries and amounts. Expect: Only updated queries and amounts should be present. rg --type markdown $'rollkit query bank balances'Length of output: 162
Script:
#!/bin/bash # Description: Extract lines containing balance amounts for $KEY1 and $KEY2 # Extract lines containing balance amounts for $KEY1 rg --type markdown -A 3 'rollkit query bank balances \$KEY1' tutorials/gm-world.md # Extract lines containing balance amounts for $KEY2 rg --type markdown -A 3 'rollkit query bank balances \$KEY2' tutorials/gm-world.mdLength of output: 303
Script:
#!/bin/bash # Description: Extract lines containing balance amounts for $KEY1 and $KEY2 with extended range # Extract lines containing balance amounts for $KEY1 rg --type markdown -A 10 'rollkit query bank balances \$KEY1' tutorials/gm-world.md # Extract lines containing balance amounts for $KEY2 rg --type markdown -A 10 'rollkit query bank balances \$KEY2' tutorials/gm-world.mdLength of output: 538
tutorials/wordle.md (3)
566-567: Streamline command for initializing and building Rollkit chain configurationThe consolidation of the initialization command with the build command simplifies the setup process, making it more efficient.
Line range hint
759-759: Consider shortening line length for better readabilityThe line length in some parts of the document exceeds the recommended limit, which could affect readability and maintainability of the markdown file.
- This installs Ignite CLI in your local machine. This tutorial uses a macOS but it should work for Windows. For Windows users, check out the Ignite docs on installation for Windows machines. + This installs Ignite CLI in your local machine. This tutorial uses a macOS but it should work for Windows. For details, refer to the Ignite installation guide for Windows.
Line range hint
155-155: Fix table formatting in MarkdownThe markdown table formatting is incorrect and might cause rendering issues. Ensure that each row in the table ends with a pipe (
|) for consistent formatting.- | File/directory | Purpose | - | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | app/ | Files that wire together the blockchain. The most important file is `app.go` that contains type definition of the blockchain and functions to create and initialize it. | + | File/directory | Purpose | + | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | app/ | Files that wire together the blockchain. The most important file is `app.go` that contains type definition of the blockchain and functions to create and initialize it. | + | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Summary by CodeRabbit