docs: improve documentation about authority in protos (#14531)
This commit is contained in:
@@ -13,8 +13,8 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/auth/types";
|
||||
service Msg {
|
||||
option (cosmos.msg.v1.service) = true;
|
||||
|
||||
// UpdateParams defines a governance operation for updating the x/auth module
|
||||
// parameters. The authority is hard-coded to the x/gov module account.
|
||||
// UpdateParams defines a (governance) operation for updating the x/auth module
|
||||
// parameters. The authority defaults to the x/gov module account.
|
||||
//
|
||||
// Since: cosmos-sdk 0.47
|
||||
rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
|
||||
@@ -27,7 +27,7 @@ message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/x/auth/MsgUpdateParams";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// 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/auth parameters to update.
|
||||
|
||||
@@ -77,7 +77,7 @@ message MsgMultiSendResponse {}
|
||||
message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// authority is the address that controls the module (defaults to x/gov unless overwritten).
|
||||
string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
||||
option (amino.name) = "cosmos-sdk/x/bank/MsgUpdateParams";
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ service Msg {
|
||||
message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// 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/consensus parameters to update.
|
||||
|
||||
@@ -51,7 +51,7 @@ message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/x/crisis/MsgUpdateParams";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// authority is the address that controls the module (defaults to x/gov unless overwritten).
|
||||
string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
||||
|
||||
// constant_fee defines the x/crisis parameter.
|
||||
|
||||
@@ -149,7 +149,7 @@ message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/distribution/MsgUpdateParams";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// 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/distribution parameters to update.
|
||||
@@ -174,7 +174,7 @@ message MsgCommunityPoolSpend {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/distr/MsgCommunityPoolSpend";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// authority is the address that controls the module (defaults to x/gov unless overwritten).
|
||||
string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
||||
string recipient = 2;
|
||||
repeated cosmos.base.v1beta1.Coin amount = 3 [
|
||||
|
||||
@@ -156,7 +156,7 @@ message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/x/gov/v1/MsgUpdateParams";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// 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/gov parameters to update.
|
||||
|
||||
@@ -14,7 +14,7 @@ service Msg {
|
||||
option (cosmos.msg.v1.service) = true;
|
||||
|
||||
// UpdateParams defines a governance operation for updating the x/mint module
|
||||
// parameters. The authority is hard-coded to the x/gov module account.
|
||||
// parameters. The authority is defaults to the x/gov module account.
|
||||
//
|
||||
// Since: cosmos-sdk 0.47
|
||||
rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
|
||||
@@ -27,7 +27,7 @@ message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/x/mint/MsgUpdateParams";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// 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/mint parameters to update.
|
||||
|
||||
@@ -20,7 +20,7 @@ service Msg {
|
||||
rpc Unjail(MsgUnjail) returns (MsgUnjailResponse);
|
||||
|
||||
// UpdateParams defines a governance operation for updating the x/slashing module
|
||||
// parameters. The authority is hard-coded to the x/gov module account.
|
||||
// parameters. The authority defaults to the x/gov module account.
|
||||
//
|
||||
// Since: cosmos-sdk 0.47
|
||||
rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
|
||||
@@ -51,7 +51,7 @@ message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/x/slashing/MsgUpdateParams";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// 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/slashing parameters to update.
|
||||
|
||||
@@ -186,7 +186,7 @@ message MsgUpdateParams {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/x/staking/MsgUpdateParams";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// 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/staking parameters to update.
|
||||
//
|
||||
|
||||
@@ -33,7 +33,7 @@ message MsgSoftwareUpgrade {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/MsgSoftwareUpgrade";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// authority is the address that controls the module (defaults to x/gov unless overwritten).
|
||||
string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
||||
|
||||
// plan is the upgrade plan.
|
||||
@@ -52,7 +52,7 @@ message MsgCancelUpgrade {
|
||||
option (cosmos.msg.v1.signer) = "authority";
|
||||
option (amino.name) = "cosmos-sdk/MsgCancelUpgrade";
|
||||
|
||||
// authority is the address of the governance account.
|
||||
// authority is the address that controls the module (defaults to x/gov unless overwritten).
|
||||
string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user