docs: improve documentation about authority in protos (#14531)

This commit is contained in:
Julien Robert
2023-01-09 08:18:13 +00:00
committed by GitHub
parent 3fc4f33769
commit ecdedf5db4
35 changed files with 58 additions and 58 deletions
+1 -1
View File
@@ -892,7 +892,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/auth parameters to update.
//
+4 -4
View File
@@ -22,8 +22,8 @@ const _ = grpc.SupportPackageIsVersion7
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type MsgClient interface {
// 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
UpdateParams(ctx context.Context, in *MsgUpdateParams, opts ...grpc.CallOption) (*MsgUpdateParamsResponse, error)
@@ -50,8 +50,8 @@ func (c *msgClient) UpdateParams(ctx context.Context, in *MsgUpdateParams, opts
// All implementations must embed UnimplementedMsgServer
// for forward compatibility
type MsgServer interface {
// 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
UpdateParams(context.Context, *MsgUpdateParams) (*MsgUpdateParamsResponse, error)
+1 -1
View File
@@ -4049,7 +4049,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/bank parameters to update.
//
+1 -1
View File
@@ -1049,7 +1049,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/consensus parameters to update.
// VersionsParams is not included in this Msg because it is tracked
+1 -1
View File
@@ -1879,7 +1879,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// constant_fee defines the x/crisis parameter.
ConstantFee *v1beta1.Coin `protobuf:"bytes,2,opt,name=constant_fee,json=constantFee,proto3" json:"constant_fee,omitempty"`
+2 -2
View File
@@ -6798,7 +6798,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/distribution parameters to update.
//
@@ -6880,7 +6880,7 @@ type MsgCommunityPoolSpend struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
Recipient string `protobuf:"bytes,2,opt,name=recipient,proto3" json:"recipient,omitempty"`
Amount []*v1beta1.Coin `protobuf:"bytes,3,rep,name=amount,proto3" json:"amount,omitempty"`
+1 -1
View File
@@ -6429,7 +6429,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/gov parameters to update.
//
+1 -1
View File
@@ -892,7 +892,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/mint parameters to update.
//
+2 -2
View File
@@ -23,7 +23,7 @@ const _ = grpc.SupportPackageIsVersion7
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type MsgClient interface {
// 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
UpdateParams(ctx context.Context, in *MsgUpdateParams, opts ...grpc.CallOption) (*MsgUpdateParamsResponse, error)
@@ -51,7 +51,7 @@ func (c *msgClient) UpdateParams(ctx context.Context, in *MsgUpdateParams, opts
// for forward compatibility
type MsgServer interface {
// 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
UpdateParams(context.Context, *MsgUpdateParams) (*MsgUpdateParamsResponse, error)
+1 -1
View File
@@ -1731,7 +1731,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/slashing parameters to update.
//
+2 -2
View File
@@ -27,7 +27,7 @@ type MsgClient interface {
// and rewards again.
Unjail(ctx context.Context, in *MsgUnjail, opts ...grpc.CallOption) (*MsgUnjailResponse, error)
// 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
UpdateParams(ctx context.Context, in *MsgUpdateParams, opts ...grpc.CallOption) (*MsgUpdateParamsResponse, error)
@@ -68,7 +68,7 @@ type MsgServer interface {
// and rewards again.
Unjail(context.Context, *MsgUnjail) (*MsgUnjailResponse, error)
// 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
UpdateParams(context.Context, *MsgUpdateParams) (*MsgUpdateParamsResponse, error)
+1 -1
View File
@@ -7605,7 +7605,7 @@ type MsgUpdateParams struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// params defines the x/staking parameters to update.
//
+2 -2
View File
@@ -1670,7 +1670,7 @@ type MsgSoftwareUpgrade struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
// plan is the upgrade plan.
Plan *Plan `protobuf:"bytes,2,opt,name=plan,proto3" json:"plan,omitempty"`
@@ -1747,7 +1747,7 @@ type MsgCancelUpgrade struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// authority is the address of the governance account.
// authority is the address that controls the module (defaults to x/gov unless overwritten).
Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
}