feat(bank/v2): create module boilerplate #21559
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package cosmos.bank.module.v2; | ||
|
|
||
| import "cosmos/app/v1alpha1/module.proto"; | ||
|
|
||
| option go_package = "cosmossdk.io/x/bank/v2/types/module"; | ||
|
|
||
| // Module is the config object of the bank module. | ||
| message Module { | ||
| option (cosmos.app.v1alpha1.module) = { | ||
| go_import: "cosmossdk.io/x/bank/v2" | ||
| }; | ||
|
|
||
| // authority defines the custom module authority. If not set, defaults to the governance module. | ||
| string authority = 1; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| syntax = "proto3"; | ||
| package cosmos.bank.v2; | ||
|
There was a problem hiding this comment. Directory structure does not match package declaration. According to the static analysis tool, files with the package Toolsbuf
|
||
|
|
||
| option go_package = "cosmossdk.io/x/bank/v2/types"; | ||
|
|
||
| // Params defines the parameters for the bank/v2 module. | ||
| message Params {} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| syntax = "proto3"; | ||
| package cosmos.bank.v2; | ||
|
|
||
| import "gogoproto/gogo.proto"; | ||
| import "cosmos/bank/v2/bank.proto"; | ||
| import "amino/amino.proto"; | ||
|
|
||
| option go_package = "cosmossdk.io/x/bank/v2/types"; | ||
|
|
||
| // GenesisState defines the bank/v2 module's genesis state. | ||
| message GenesisState { | ||
| // params defines all the parameters of the module. | ||
| Params params = 1 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true]; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| syntax = "proto3"; | ||
| package cosmos.bank.v2; | ||
|
|
||
| import "gogoproto/gogo.proto"; | ||
| import "google/api/annotations.proto"; | ||
| import "cosmos/query/v1/query.proto"; | ||
| import "amino/amino.proto"; | ||
| import "cosmos/bank/v2/bank.proto"; | ||
|
|
||
| option go_package = "cosmossdk.io/x/bank/v2/types"; | ||
|
|
||
| // Query defines the gRPC querier service. | ||
| service Query { | ||
| // Params queries the parameters of x/bank module. | ||
| rpc Params(QueryParamsRequest) returns (QueryParamsResponse) { | ||
| option (cosmos.query.v1.module_query_safe) = true; | ||
| option (google.api.http).get = "/cosmos/bank/v2/params"; | ||
| } | ||
| } | ||
|
|
||
| // QueryParamsRequest defines the request type for querying x/bank/v2 parameters. | ||
| message QueryParamsRequest {} | ||
|
|
||
| // QueryParamsResponse defines the response type for querying x/bank/v2 parameters. | ||
| message QueryParamsResponse { | ||
| // params provides the parameters of the bank module. | ||
| Params params = 1 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true]; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| syntax = "proto3"; | ||
| package cosmos.bank.v2; | ||
|
|
||
| import "gogoproto/gogo.proto"; | ||
|
There was a problem hiding this comment. Issue: Missing import file. The import statement for Please verify the existence of the Toolsbuf
|
||
| import "cosmos/bank/v2/bank.proto"; | ||
| import "cosmos_proto/cosmos.proto"; | ||
| import "cosmos/msg/v1/msg.proto"; | ||
| import "amino/amino.proto"; | ||
|
|
||
| option go_package = "cosmossdk.io/x/bank/v2/types"; | ||
|
|
||
| // Msg defines the bank Msg service. | ||
| service Msg { | ||
| option (cosmos.msg.v1.service) = true; | ||
|
|
||
| // UpdateParams defines a governance operation for updating the x/bank/v2 module parameters. | ||
| // The authority is defined in the keeper. | ||
| rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse) {} | ||
| } | ||
|
|
||
| // MsgUpdateParams is the Msg/UpdateParams request type. | ||
| message MsgUpdateParams { | ||
| option (cosmos.msg.v1.signer) = "authority"; | ||
|
|
||
julienrbrt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // authority is the address that controls the module (defaults to x/gov unless overwritten). | ||
| string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; | ||
|
|
||
| // params defines the x/bank parameters to update. | ||
| // NOTE: All parameters must be supplied. | ||
| Params params = 2 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true]; | ||
| } | ||
|
|
||
| // MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message. | ||
| message MsgUpdateParamsResponse {} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <!-- | ||
| Guiding Principles: | ||
| Changelogs are for humans, not machines. | ||
| There should be an entry for every single version. | ||
| The same types of changes should be grouped. | ||
| Versions and sections should be linkable. | ||
| The latest version comes first. | ||
| The release date of each version is displayed. | ||
| Mention whether you follow Semantic Versioning. | ||
| Usage: | ||
| Change log entries are to be added to the Unreleased section under the | ||
| appropriate stanza (see below). Each entry should ideally include a tag and | ||
| the Github issue reference in the following format: | ||
| * (<tag>) [#<issue-number>] Changelog message. | ||
| Types of changes (Stanzas): | ||
| "Features" for new features. | ||
| "Improvements" for changes in existing functionality. | ||
| "Deprecated" for soon-to-be removed features. | ||
| "Bug Fixes" for any bug fixes. | ||
| "API Breaking" for breaking exported APIs used by developers building on SDK. | ||
| Ref: https://keepachangelog.com/en/1.0.0/ | ||
| --> | ||
|
|
||
| # Changelog | ||
|
|
||
| ## [Unreleased] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
julienrbrt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| # `x/bank/v2` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| package bankv2 | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| autocliv1 "cosmossdk.io/api/cosmos/autocli/v1" | ||
| "cosmossdk.io/x/bank/v2/types" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/version" | ||
| ) | ||
|
|
||
| // AutoCLIOptions implements the autocli.HasAutoCLIConfig interface. | ||
| func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { | ||
| return &autocliv1.ModuleOptions{ | ||
| Query: &autocliv1.ServiceCommandDescriptor{ | ||
| Service: types.Query_serviceDesc.ServiceName, | ||
| RpcCommandOptions: []*autocliv1.RpcCommandOptions{ | ||
| { | ||
| RpcMethod: "Params", | ||
| Use: "params", | ||
| Short: "Query current bank/v2 parameters", | ||
| }, | ||
| }, | ||
| }, | ||
| Tx: &autocliv1.ServiceCommandDescriptor{ | ||
| Service: types.Msg_serviceDesc.ServiceName, | ||
| EnhanceCustomCommand: true, | ||
| RpcCommandOptions: []*autocliv1.RpcCommandOptions{ | ||
| { | ||
| RpcMethod: "UpdateParams", | ||
| Use: "update-params-proposal <params>", | ||
| Short: "Submit a proposal to update bank module params. Note: the entire params must be provided.", | ||
| Example: fmt.Sprintf(`%s tx bank update-params-proposal '{ }'`, version.AppName), | ||
| PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "params"}}, | ||
| GovProposal: true, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Ensure correct integration of bank/v2 module in the application configuration.
The configuration for
bankv2types.ModuleNameandbankmodulev2.Modulehas been added to the application's module configuration. This is a crucial part of integrating the new module into the application, ensuring it is loaded and configured correctly at runtime.bankv2types.ModuleNameandbankmodulev2.Moduleare correctly defined and that they integrate seamlessly with the rest of the application.Given the complexity and importance of this integration, consider adding more detailed unit tests to cover the new configurations and ensure they do not disrupt existing functionalities.
Would you like me to help draft some unit tests for this new module configuration?
Also applies to: 291-292