feat: update gm tutorial parts 2 testnet and 3 mainnet #290
Conversation
WalkthroughThe updates across various scripts and tutorials reflect a shift towards numeric consistency, improved command structures for initializing and starting blockchain networks, and refined instructions for deploying to Celestia's ecosystems. Modifications include changes in numbering formats, enhanced genesis account management, the introduction of restart scripts, and the addition of a warning message in tutorials. Changes
Assessment against linked issues
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.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (8)
- .vitepress/config.ts (1 hunks)
- scripts/gm/init-local.sh (1 hunks)
- scripts/gm/init-mainnet.sh (2 hunks)
- scripts/gm/init-testnet.sh (2 hunks)
- tutorials/full-and-sequencer-node.md (2 hunks)
- tutorials/gm-world-mainnet.md (2 hunks)
- tutorials/gm-world-testnet.md (6 hunks)
- tutorials/gm-world.md (4 hunks)
Files skipped from review due to trivial changes (5)
- .vitepress/config.ts
- tutorials/full-and-sequencer-node.md
- tutorials/gm-world-mainnet.md
- tutorials/gm-world-testnet.md
- tutorials/gm-world.md
Additional comments: 11
scripts/gm/init-testnet.sh (5)
- 17-18: Ensure that the RPC endpoint URL is correct and accessible. If the endpoint changes, this script will need to be updated accordingly.
Verification successful
The output from the
curl --headcommand indicates that the RPC endpointhttps://rpc.celestia-arabica-11.com/blockis accessible and returns a200 OKstatus, which means the endpoint is currently operational and the script should be able to retrieve the DA Layer block height from this endpoint.* 34-35: The commands for adding genesis accounts have been updated to the new format. Confirm that the `gmd genesis add-genesis-account` command works as expected with the `--keyring-backend test` flag.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the accessibility of the RPC endpoint. curl --head https://rpc.celestia-arabica-11.com/blockLength of output: 939
38-38: The
gmd genesis gentxcommand has been updated. Ensure that the genesis transaction is created correctly with the new command.47-47: The script now includes a command to add the centralized sequencer address to
genesis.json. Verify that thejqcommand correctly formats the JSON and that themvcommand successfully replaces the original file without errors.Verification successful
The verification script successfully created a mock
genesis.jsonfile and used a placeholder for the$PUB_KEYvariable. Thejqcommand was then executed with these mock values, and the output was verified to be correctly formatted JSON. Additionally, themvcommand was used to replace the mockgenesis.jsonwithtemp.json, and the final output confirms that themvcommand worked as expected.Based on the output provided, the
jqcommand correctly formats the JSON, and themvcommand successfully replaces the original file without errors.* 56-56: The `gmd start` command has been updated with new parameters. Confirm that the chain starts correctly with these parameters and that there are no errors in the console output.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the jq command formats the JSON correctly and mv command works. jq --argjson pubKey "$PUB_KEY" '.consensus["validators"]=[{"address": "'$ADDRESS'", "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.gm/config/genesis.json > temp.json cat temp.json # This should show the correct JSON format.Length of output: 354
Script:
#!/bin/bash # Create a mock genesis.json file echo '{"consensus": {"validators": []}}' > genesis.json # Define a placeholder JSON object for $PUB_KEY PUB_KEY='{"type":"tendermint/PubKeyEd25519","value":"sOmEeNcOdEdPuBlIcKeY=="}' # Execute the jq command with the mock values jq --argjson pubKey "$PUB_KEY" '.consensus["validators"]=[{"address": "some_address", "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' genesis.json > temp.json # Output the result to verify correct JSON formatting cat temp.json # Verify the mv command by replacing the mock genesis.json with temp.json mv temp.json genesis.json # Output the new genesis.json to verify the mv command worked cat genesis.jsonLength of output: 985
scripts/gm/init-mainnet.sh (5)
- 17-18: Confirm that the RPC endpoint for the mainnet is correct and that the
curlcommand successfully retrieves the DA Layer start height.Verification successful
The output from the
curl --head https://rpc.lunaroasis.net/blockcommand indicates that the RPC endpoint is accessible and returns a200 OKstatus, which means the request has succeeded. The headers also show standard response fields and no errors, suggesting that the endpoint is functioning correctly.Based on this information, the RPC endpoint for the mainnet is correct, and the
curlcommand in theinit-mainnet.shscript should successfully retrieve the DA Layer start height.* 34-35: The commands for adding genesis accounts have been updated. Verify that the `gmd genesis add-genesis-account` command functions correctly with the `--keyring-backend test` flag.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the accessibility of the mainnet RPC endpoint. curl --head https://rpc.lunaroasis.net/blockLength of output: 1377
38-38: The
gmd genesis gentxcommand has been updated. Ensure that the genesis transaction is created correctly with the new command.47-47: The script now includes a command to add the centralized sequencer address to
genesis.json. Verify that thejqcommand correctly formats the JSON and that themvcommand successfully replaces the original file without errors.Verification successful
The verification script successfully created the necessary directories and dummy
genesis.jsonfile. It then executed thejqcommand with dummy values for$PUB_KEYand$ADDRESS, which formatted the JSON as intended. The output confirms that thejqcommand produced the correct JSON structure intemp.json. Following this, themvcommand successfully replaced the originalgenesis.jsonfile withtemp.json, as indicated by the message "mv command executed successfully."Based on the output, we can conclude that the
jqcommand correctly formats the JSON and that themvcommand successfully replaces the original file without errors.* 49-53: The creation of `restart-mainnet.sh` is a new addition. Ensure that the file is created correctly and that the `gmd start` command within it includes all necessary flags and parameters.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the jq command formats the JSON correctly and mv command works. jq --argjson pubKey "$PUB_KEY" '.consensus["validators"]=[{"address": "'$ADDRESS'", "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.gm/config/genesis.json > temp.json cat temp.json # This should show the correct JSON format.Length of output: 354
Script:
#!/bin/bash # Set dummy but valid values for PUB_KEY and ADDRESS PUB_KEY='{"type":"tendermint/PubKeyEd25519","value":"sOmEdUmMyKeY=="}' ADDRESS='sOmEdUmMyAdDrEsS' # Verify the jq command formats the JSON correctly and mv command works. jq --argjson pubKey "$PUB_KEY" --arg address "$ADDRESS" '.consensus["validators"]=[{"address": $address, "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.gm/config/genesis.json > temp.json # Check if the jq command was successful by checking the existence and content of temp.json if [ -s temp.json ]; then echo "jq command executed successfully. Content of temp.json:" cat temp.json # Now verify if the mv command can replace the original file without errors mv temp.json ~/.gm/config/genesis.json && echo "mv command executed successfully." else echo "jq command failed to produce output." fiLength of output: 574
Script:
#!/bin/bash # Create a dummy genesis.json file with a basic structure echo '{"consensus": {"validators": []}}' > ~/.gm/config/genesis.json # Set dummy but valid values for PUB_KEY and ADDRESS PUB_KEY='{"type":"tendermint/PubKeyEd25519","value":"sOmEdUmMyKeY=="}' ADDRESS='sOmEdUmMyAdDrEsS' # Verify the jq command formats the JSON correctly and mv command works. jq --argjson pubKey "$PUB_KEY" --arg address "$ADDRESS" '.consensus["validators"]=[{"address": $address, "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.gm/config/genesis.json > temp.json # Check if the jq command was successful by checking the existence and content of temp.json if [ -s temp.json ]; then echo "jq command executed successfully. Content of temp.json:" cat temp.json # Now verify if the mv command can replace the original file without errors mv temp.json ~/.gm/config/genesis.json && echo "mv command executed successfully." else echo "jq command failed to produce output." fiLength of output: 731
Script:
#!/bin/bash # Create the necessary directories for the genesis.json file mkdir -p ~/.gm/config/ # Create a dummy genesis.json file with a basic structure echo '{"consensus": {"validators": []}}' > ~/.gm/config/genesis.json # Set dummy but valid values for PUB_KEY and ADDRESS PUB_KEY='{"type":"tendermint/PubKeyEd25519","value":"sOmEdUmMyKeY=="}' ADDRESS='sOmEdUmMyAdDrEsS' # Verify the jq command formats the JSON correctly and mv command works. jq --argjson pubKey "$PUB_KEY" --arg address "$ADDRESS" '.consensus["validators"]=[{"address": $address, "pub_key": $pubKey, "power": "1000", "name": "Rollkit Sequencer"}]' ~/.gm/config/genesis.json > temp.json # Check if the jq command was successful by checking the existence and content of temp.json if [ -s temp.json ]; then echo "jq command executed successfully. Content of temp.json:" cat temp.json # Now verify if the mv command can replace the original file without errors mv temp.json ~/.gm/config/genesis.json && echo "mv command executed successfully." else echo "jq command failed to produce output." fiLength of output: 1024
scripts/gm/init-local.sh (1)
- 87-87: The
gmd startcommand in therestart-local.shscript now includes the--minimum-gas-prices="0.025stake"flag. Verify that the chain starts correctly with this new parameter.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (5)
- tutorials/cosmwasm.md (1 hunks)
- tutorials/full-and-sequencer-node.md (2 hunks)
- tutorials/polaris-evm.md (1 hunks)
- tutorials/recipe-book.md (1 hunks)
- tutorials/wordle.md (1 hunks)
Files skipped from review due to trivial changes (3)
- tutorials/cosmwasm.md
- tutorials/polaris-evm.md
- tutorials/wordle.md
Files skipped from review as they are similar to previous changes (1)
- tutorials/full-and-sequencer-node.md
Additional comments: 2
tutorials/recipe-book.md (2)
3-5: The addition of the warning message at the beginning of the tutorial is clear and visible. This is a good practice to inform users about the current state of the documentation.
3-5: Please ensure that the warning message is accurate and reflects the current state of the tutorial. If the tutorial is no longer under construction, the warning should be updated or removed to avoid confusion.
Verification successful
To verify the current state of the "Recipe Book rollup" tutorial and whether it is still under construction, we can check the most recent commits to the
tutorials/recipe-book.mdfile. This will help us determine if there have been any updates that might indicate the tutorial's completion.
The most recent commit to the
tutorials/recipe-book.mdfile is titled "feat: add construction signs" and was made byjoshcs.eth ᵍᵐ2 minutes ago. This suggests that the warning message about the tutorial being under construction was recently added, which implies that the tutorial is indeed still under construction.Based on this information, the warning message in the
tutorials/recipe-book.mdfile is accurate and reflects the current state of the tutorial.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify if the tutorial is still under construction or if it can be considered complete. # This would typically involve checking with the documentation team or the latest commits related to this file. # Since we cannot execute such actions, this is a placeholder for the verification process. echo "Verify the current state of the 'Recipe Book rollup' tutorial with the documentation team."Length of output: 196
Script:
#!/bin/bash # Check the most recent commits to the tutorials/recipe-book.md file git log -n 5 --pretty=format:"%h - %s (%an, %ar)" -- tutorials/recipe-book.mdLength of output: 483
and context to what they are in docs resolves remainder of #282 Co-Authored-By: Daniel Olshansky <[email protected]>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- tutorials/gm-world-mainnet.md (2 hunks)
- tutorials/gm-world-testnet.md (6 hunks)
Files skipped from review as they are similar to previous changes (2)
- tutorials/gm-world-mainnet.md
- tutorials/gm-world-testnet.md
jcstein
changed the title
Overview
Resolves #282
PREVIEW ARABICA
PREVIEW MAINNET
Checklist
Summary by CodeRabbit
Summary by CodeRabbit