test(sim): add sim genesis state for custom modules #1759
Conversation
WalkthroughThe recent updates involve refining the Cosmos SDK modules by enhancing exported entities, reorganizing imports, and implementing the Changes
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? TipsChat with CodeRabbit Bot (
|
k-yang
changed the title
![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: 0
Configuration used: CodeRabbit UI
Files selected for processing (11)
- x/devgas/v1/module.go (7 hunks)
- x/devgas/v1/simulation/genesis.go (1 hunks)
- x/inflation/module.go (2 hunks)
- x/inflation/simulation/genesis.go (1 hunks)
- x/perp/v2/module/module.go (2 hunks)
- x/perp/v2/simulation/genesis.go (1 hunks)
- x/spot/module.go (2 hunks)
- x/spot/simulation/genesis.go (1 hunks)
- x/sudo/simulation/genesis.go (1 hunks)
- x/tokenfactory/module.go (7 hunks)
- x/tokenfactory/simulation/genesis.go (1 hunks)
Additional comments: 23
x/perp/v2/simulation/genesis.go (1)
- 14-24: The
RandomizedGenStatefunction correctly initializes a default genesis state, marshals it into JSON, and assigns it to the simulation state. The use ofpanicandMustMarshalJSONis appropriate here as this code is for simulation setup where failures are critical and should stop execution.x/sudo/simulation/genesis.go (1)
- 14-22: The
RandomizedGenStatefunction in thesudomodule correctly introduces arootAddressto randomize the genesis state. The use ofpanicandMustMarshalJSONis appropriate for simulation setup code.x/spot/simulation/genesis.go (1)
- 23-34: The
RandomizedGenStatefunction correctly initializes a default genesis state for thespotmodule, marshals it into JSON, and assigns it to the simulation state. The use ofMustMarshalJSONensures proper error handling for simulation setup.x/devgas/v1/simulation/genesis.go (1)
- 24-46: The
RandomizedGenStatefunction for thedevgasmodule correctly generates a randomdeveloperFeeShareand uses it to initialize the genesis state. The use ofGetOrGeneratefor parameter generation andMustMarshalJSONfor marshaling is appropriate for simulation setup.x/tokenfactory/simulation/genesis.go (1)
- 23-44: The
RandomizedGenStatefunction for thetokenfactorymodule correctly generates a randomdenomCreationGasConsumeand uses it to initialize the genesis state. The use ofGetOrGeneratefor parameter generation andMustMarshalJSONfor marshaling is appropriate for simulation setup.x/inflation/simulation/genesis.go (1)
- 15-47: The
RandomizedGenStatefunction for theinflationmodule initializes the genesis state with hardcoded values for simulation purposes. The use ofpanicandMustMarshalJSONfor error handling is appropriate for simulation setup.x/inflation/module.go (1)
- 157-158: The
GenerateGenesisStatefunction in theinflationmodule has been correctly updated to accept asimStateparameter and call theRandomizedGenStatefunction from thesimulationpackage, aligning with the PR objectives to set up simulation genesis states.x/spot/module.go (1)
- 161-162: The
GenerateGenesisStatefunction has been correctly added to thespotmodule'sAppModule, and the module now implements theAppModuleSimulationinterface, which is in line with the PR objectives for simulation enhancements.x/perp/v2/module/module.go (1)
- 175-176: The
GenerateGenesisStatefunction has been correctly added to theperpmodule'sAppModule, and the module now implements theAppModuleSimulationinterface, which aligns with the PR objectives for simulation enhancements.x/tokenfactory/module.go (7)
23-31: The import of
simtypesand renaming of module references totypesare consistent with the PR objectives to set up simulation genesis state for modules.51-51: The reference to
ModuleNamehas been correctly updated to use thetypespackage.70-85: The
RegisterInterfacesandDefaultGenesisfunctions have been updated to use thetypespackage. Ensure that thetypespackage contains the correct implementations for these functions.Verification successful
The shell script output confirms that the
typespackage in thex/tokenfactorydirectory contains theRegisterInterfacesandDefaultGenesisfunctions. TheRegisterInterfacesfunction is located incodec.go, and theDefaultGenesisfunction is ingenesis.go.
- The
RegisterInterfacesfunction is correctly implemented in thetypespackage.- The
DefaultGenesisfunction is also present and correctly implemented in thetypespackage.Based on the provided output, the changes to the
RegisterInterfacesandDefaultGenesisfunctions to use thetypespackage are verified to be correct.* 96-108: The `RegisterGRPCGatewayRoutes`, `GetTxCmd`, and `GetQueryCmd` functions have been updated to use the `types` package. Ensure that the `types` package contains the correct implementations for these functions.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the types package. rg --type go 'func RegisterInterfaces' 'x/tokenfactory/types' rg --type go 'func DefaultGenesis' 'x/tokenfactory/types'Length of output: 284
Verification successful
The review comment is concerned with the updates to the
RegisterGRPCGatewayRoutes,GetTxCmd, andGetQueryCmdfunctions to use thetypespackage. The shell script output confirms the presence of the necessary functions in the respective packages:
RegisterQueryHandlerClientis found inx/tokenfactory/types/query.pb.gw.go.NewTxCmdis found inx/tokenfactory/cli/tx.go.NewQueryCmdis found inx/tokenfactory/cli/query.go.Based on the script output, the functions are correctly located in their respective packages, which aligns with the changes mentioned in the review comment.
* 148-151: The `RegisterServices` function has been updated to use the `types` package. Ensure that the `types` package contains the correct implementations for these functions.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the types package. rg --type go 'func RegisterQueryHandlerClient' 'x/tokenfactory/types' rg --type go 'func NewTxCmd' 'x/tokenfactory/cli' rg --type go 'func NewQueryCmd' 'x/tokenfactory/cli'Length of output: 434
Verification successful
The shell script output confirms that the
typespackage contains the necessary functionsRegisterMsgServerandRegisterQueryServer. These functions are defined intx.pb.goandquery.pb.gorespectively within thex/tokenfactory/typesdirectory.
RegisterMsgServeris present inx/tokenfactory/types/tx.pb.go.RegisterQueryServeris present inx/tokenfactory/types/query.pb.go.Based on this information, the review comment has been addressed correctly.
* 167-167: The `InitGenesis` function has been updated to use the `types` package. Ensure that the `types` package contains the correct implementations for this function.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the types package. rg --type go 'func RegisterMsgServer' 'x/tokenfactory/types' rg --type go 'func RegisterQueryServer' 'x/tokenfactory/types'Length of output: 302
Verification successful
The
InitGenesisfunction is indeed present within thekeeperpackage of thetokenfactorymodule, as indicated by the output of the script. This confirms that thetypespackage is being used correctly in the context of theInitGenesisfunction within thetokenfactorymodule.* 180-192: New simulation-related functions `GenerateGenesisState`, `RegisterStoreDecoder`, and `WeightedOperations` have been added. Ensure that these functions are correctly implemented and align with the simulation setup objectives.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the types package. rg --type go 'func InitGenesis' 'x/tokenfactory/keeper'Length of output: 55
Script:
#!/bin/bash # Search for the InitGenesis function within the types package of the tokenfactory module. rg --type go 'func InitGenesis' 'x/tokenfactory/types'Length of output: 54
Script:
#!/bin/bash # Search for the InitGenesis function definition in the keeper package of the tokenfactory module. rg --type go 'func \(.*Keeper\) InitGenesis'Length of output: 155
Verification successful
The
RandomizedGenStatefunction exists in thex/tokenfactory/simulationpackage, confirming that theGenerateGenesisStatemethod inAppModuleis correctly implemented by calling this function.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the simulation package. rg --type go 'func RandomizedGenState' 'x/tokenfactory/simulation'Length of output: 163
x/devgas/v1/module.go (7)
14-23: The import of
simtypesand renaming of module references totypesare consistent with the PR objectives to set up simulation genesis state for modules.41-41: The reference to
ModuleNamehas been correctly updated to use thetypespackage.60-78: The
RegisterInterfacesandDefaultGenesisfunctions have been updated to use thetypespackage. Ensure that thetypespackage contains the correct implementations for these functions.Verification successful
The shell script output confirms that the
typespackage contains theRegisterInterfacesfunction inx/devgas/v1/types/codec.goand theDefaultGenesisStatefunction inx/devgas/v1/types/genesis.go. These functions are correctly implemented and available for use in themodule.gofile as indicated by the changes.
* 86-98: The `RegisterGRPCGatewayRoutes`, `GetTxCmd`, and `GetQueryCmd` functions have been updated to use the `types` package. Ensure that the `types` package contains the correct implementations for these functions.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the types package. rg --type go 'func RegisterInterfaces' 'x/devgas/v1/types' rg --type go 'func DefaultGenesisState' 'x/devgas/v1/types'Length of output: 282
Verification successful
The shell script output confirms the presence of the functions
RegisterQueryHandlerClient,NewTxCmd, andGetQueryCmdin the respective packages as referenced in the code snippet fromx/devgas/v1/module.go. Thetypespackage contains theRegisterQueryHandlerClientfunction, and theclipackage contains bothNewTxCmdandGetQueryCmdfunctions.
RegisterQueryHandlerClientis found inx/devgas/v1/types/query.pb.gw.go.NewTxCmdis found inx/devgas/v1/client/cli/tx.go.GetQueryCmdis found inx/devgas/v1/client/cli/query.go.Based on this information, the review comment is verified as the functions are correctly implemented in their respective packages.
* 143-147: The `RegisterServices` function has been updated to use the `types` package. Ensure that the `types` package contains the correct implementations for these functions.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the types package. rg --type go 'func RegisterQueryHandlerClient' 'x/devgas/v1/types' rg --type go 'func NewTxCmd' 'x/devgas/v1/client/cli' rg --type go 'func GetQueryCmd' 'x/devgas/v1/client/cli'Length of output: 444
Verification successful
The shell script output confirms that the
typespackage contains theRegisterMsgServerfunction and thekeeperpackage contains theNewQuerierfunction. These functions are correctly implemented in their respective packages as indicated by the presence of their definitions in thetx.pb.goandgrpc_query.gofiles.
RegisterMsgServeris found inx/devgas/v1/types/tx.pb.go.NewQuerieris found inx/devgas/v1/keeper/grpc_query.go.Based on this information, the review comment has been addressed correctly.
* 162-162: The `InitGenesis` function has been updated to use the `types` package. Ensure that the `types` package contains the correct implementations for this function.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the types package. rg --type go 'func RegisterMsgServer' 'x/devgas/v1/types' rg --type go 'func NewQuerier' 'x/devgas/v1/keeper'Length of output: 261
- 180-191: New simulation-related functions
GenerateGenesisState,RegisterStoreDecoder, andWeightedOperationshave been added. Ensure that these functions are correctly implemented and align with the simulation setup objectives.Verification successful
The
RandomizedGenStatefunction is present in thex/devgas/v1/simulationpackage, which confirms that theGenerateGenesisStatemethod in theAppModuleis correctly implemented by calling this function.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the necessary functions are present in the simulation package. rg --type go 'func RandomizedGenState' 'x/devgas/v1/simulation'Length of output: 157
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- CHANGELOG.md (1 hunks)
Additional comments: 2
CHANGELOG.md (2)
89-89: The version bump for
google.golang.org/protobufis correctly documented. This is a routine update likely for improvements or security patches.81-92: The rest of the changelog entries within the hunk are consistent and provide the necessary information about the changes and dependency updates.
| @@ -81,10 +81,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
| * [#1728](https://github.com/NibiruChain/nibiru/pull/1728) - test(devgas-cli): CLI tests for devgas txs | |||
| * [#1735](https://github.com/NibiruChain/nibiru/pull/1735) - test(sim): fix simulation tests | |||
| * [#1754](https://github.com/NibiruChain/nibiru/pull/1754) - refactor(decode-base64): clean code improvements and fn docs | |||
| * [#1736](https://github.com/NibiruChain/nibiru/pull/1736) - test(sim): add sim genesis state for all cusom modules | |||
There was a problem hiding this comment.
The entry for PR #1736 is missing a description of the changes made. It's important for the changelog to include a brief summary of each change for clarity.
* [#1736](https://github.com/NibiruChain/nibiru/pull/1736) - test(sim): add sim genesis state for all cusom modules
+ * [#1736](https://github.com/NibiruChain/nibiru/pull/1736) - test(sim): add sim genesis state for all custom modules. This change sets up the simulation genesis state for various custom modules within the Nibiru blockchain framework, enhancing the simulation capabilities for testing.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.
| * [#1736](https://github.com/NibiruChain/nibiru/pull/1736) - test(sim): add sim genesis state for all cusom modules | |
| * [#1736](https://github.com/NibiruChain/nibiru/pull/1736) - test(sim): add sim genesis state for all custom modules. This change sets up the simulation genesis state for various custom modules within the Nibiru blockchain framework, enhancing the simulation capabilities for testing. |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1759 +/- ##
==========================================
- Coverage 73.46% 73.43% -0.03%
==========================================
Files 195 194 -1
Lines 15449 15459 +10
==========================================
+ Hits 11350 11353 +3
- Misses 3437 3444 +7
Partials 662 662
|
Purpose / Abstract
Scaffolds the simulation genesis state for Nibiru's custom modules. I decided to go with a breadth approach (multiple modules) instead of a depth approach (a single module) for the sim genesis state because the code was repetitive so it would be easier to review.
Helps towards closing #1736.
Summary by CodeRabbit
New Features
Improvements
Documentation
Dependency Updates
google.golang.org/protobuffrom version 1.31.0 to 1.32.0.