Chore: Update rollapp genesis docs #260
Conversation
WalkthroughThe changes are focused on testing scenarios for transferring tokens between a hub and a rollapp both pre- and post-genesis events. Adjustments include updates to test descriptions, pre-conditions, and expected results in the Changes
Sequence Diagram(s)None required; changes are primarily descriptive and organizational. Possibly related issues
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 (1)
- tests_spec/rollapp_genesis.md (1 hunks)
Additional context used
LanguageTool
tests_spec/rollapp_genesis.md
[uncategorized] ~5-~5: The abbreviation “i.e.” (= that is) requires two periods. (I_E)
Context: .../li>VFC should be created on hub (i.e erc20) Rollapp tokens with r...
Additional comments not posted (5)
tests_spec/rollapp_genesis.md (5)
5-5: This detailed update enhances clarity and aligns well with the linked test case.Tools
LanguageTool
[uncategorized] ~5-~5: The abbreviation “i.e.” (= that is) requires two periods. (I_E)
Context: .../li>VFC should be created on hub (i.e erc20) Rollapp tokens with r...
7-7: The updates provide clear and detailed information about the test scenario, including links to both EVM and Wasm test implementations.
9-9: The scenario is well-described, highlighting the failure conditions effectively. The links to the test cases are accurate.
11-11: The description is thorough, detailing both the scenario and the expected failure conditions, with accurate links to the test cases.
12-12: The scenario is clearly described, including the expected failure conditions, and the links to the test cases are correctly updated.
| @@ -2,11 +2,11 @@ | |||
|
|
|||
| | No | Scenario | Pre-condition | Pre-condition check | Expected result | Expected result check | Covered By | | |||
| |----|----------|---------------|---------------------|-----------------|-----------------------|------------| | |||
| | 1 | Rollapp genesis tokens on the hub upon channel creation | <ul> <li> Create relevant genesis accounts and metadata info </li> <li> Upon channel creation, trigger genesis events in both rollapp and hub (special tx) </li> </ul> | ✅ | <ul> <li> denometadata should be created </li> <li> VFC should be created on hub (i.e erc20) </li> <li> Rollapp tokens with relevant amount should be locked on the rollapp </li> <li> genesis accounts should have the relevant balance on the hub </li> </ul> | ✅ | [TestRollappGenesisEvent_EVM](../tests/rollapp_genesis_event_test.go#24) | | |||
| | 1 | Rollapp genesis tokens on the hub upon channel creation | <ul> <li> Create relevant genesis accounts and metadata info </li> <li> Upon channel creation, trigger genesis events in both rollapp and hub (special tx) </li> </ul> | ✅ | <ul> <li> denometadata should be created </li> <li> VFC should be created on hub (i.e erc20) </li> <li> Rollapp tokens with relevant amount should be locked on the rollapp </li> <li> genesis accounts should have the relevant balance on the hub </li> </ul> | ✅ | [TestRollappGenesisEvent_EVM](../tests/rollapp_genesis_event_test.go#26) | | |||
There was a problem hiding this comment.
Correct the abbreviation for clarity.
- VFC should be created on hub (i.e erc20)
+ VFC should be created on hub (i.e., erc20)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | 1 | Rollapp genesis tokens on the hub upon channel creation | <ul> <li> Create relevant genesis accounts and metadata info </li> <li> Upon channel creation, trigger genesis events in both rollapp and hub (special tx) </li> </ul> | ✅ | <ul> <li> denometadata should be created </li> <li> VFC should be created on hub (i.e erc20) </li> <li> Rollapp tokens with relevant amount should be locked on the rollapp </li> <li> genesis accounts should have the relevant balance on the hub </li> </ul> | ✅ | [TestRollappGenesisEvent_EVM](../tests/rollapp_genesis_event_test.go#26) | | |
| | 1 | Rollapp genesis tokens on the hub upon channel creation | <ul> <li> Create relevant genesis accounts and metadata info </li> <li> Upon channel creation, trigger genesis events in both rollapp and hub (special tx) </li> </ul> | ✅ | <ul> <li> denometadata should be created </li> <li> VFC should be created on hub (i.e., erc20) </li> <li> Rollapp tokens with relevant amount should be locked on the rollapp </li> <li> genesis accounts should have the relevant balance on the hub </li> </ul> | ✅ | [TestRollappGenesisEvent_EVM](../tests/rollapp_genesis_event_test.go#26) | |
Tools
LanguageTool
[uncategorized] ~5-~5: The abbreviation “i.e.” (= that is) requires two periods. (I_E)
Context: .../li>VFC should be created on hub (i.e erc20) Rollapp tokens with r...
Summary by CodeRabbit