docs: Improve docs for vote query (#17501)

This commit is contained in:
Matt, Park 2023-08-22 19:43:30 +09:00 committed by GitHub
parent 222d28e179
commit 27210f0e62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 13 additions and 13 deletions

View File

@ -576,8 +576,8 @@ type Module struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// blocked_module_accounts_override configures exceptional module accounts which should be blocked from receiving funds.
// If left empty it defaults to the list of account names supplied in the auth module configuration as
// blocked_module_accounts_override configures exceptional module accounts which should be blocked from receiving
// funds. If left empty it defaults to the list of account names supplied in the auth module configuration as
// module_account_permissions
BlockedModuleAccountsOverride []string `protobuf:"bytes,1,rep,name=blocked_module_accounts_override,json=blockedModuleAccountsOverride,proto3" json:"blocked_module_accounts_override,omitempty"`
// authority defines the custom module authority. If not set, defaults to the governance module.

View File

@ -38,6 +38,7 @@ type QueryClient interface {
// Proposals queries all proposals based on given status.
Proposals(ctx context.Context, in *QueryProposalsRequest, opts ...grpc.CallOption) (*QueryProposalsResponse, error)
// Vote queries voted information based on proposalID, voterAddr.
// Due to how we handle state, this query would error for proposals that has already been finished.
Vote(ctx context.Context, in *QueryVoteRequest, opts ...grpc.CallOption) (*QueryVoteResponse, error)
// Votes queries votes of a given proposal.
Votes(ctx context.Context, in *QueryVotesRequest, opts ...grpc.CallOption) (*QueryVotesResponse, error)
@ -140,6 +141,7 @@ type QueryServer interface {
// Proposals queries all proposals based on given status.
Proposals(context.Context, *QueryProposalsRequest) (*QueryProposalsResponse, error)
// Vote queries voted information based on proposalID, voterAddr.
// Due to how we handle state, this query would error for proposals that has already been finished.
Vote(context.Context, *QueryVoteRequest) (*QueryVoteResponse, error)
// Votes queries votes of a given proposal.
Votes(context.Context, *QueryVotesRequest) (*QueryVotesResponse, error)

View File

@ -1,4 +1,4 @@
syntax="proto3";
syntax = "proto3";
package cosmos.accounts.v1;
option go_package = "cosmossdk.io/x/accounts/v1";
option go_package = "cosmossdk.io/x/accounts/v1";

View File

@ -1,11 +1,7 @@
syntax="proto3";
syntax = "proto3";
package cosmos.accounts.v1;
option go_package = "cosmossdk.io/x/accounts/v1";
option go_package = "cosmossdk.io/x/accounts/v1";
// Query defines the Query service for the x/accounts module.
service Query {}

View File

@ -1,8 +1,7 @@
syntax="proto3";
syntax = "proto3";
package cosmos.accounts.v1;
option go_package = "cosmossdk.io/x/accounts/v1";
option go_package = "cosmossdk.io/x/accounts/v1";
// Msg defines the Msg service for the x/accounts module.
service Msg {}

View File

@ -23,6 +23,7 @@ service Query {
}
// Vote queries voted information based on proposalID, voterAddr.
// Due to how we handle state, this query would error for proposals that has already been finished.
rpc Vote(QueryVoteRequest) returns (QueryVoteResponse) {
option (google.api.http).get = "/cosmos/gov/v1beta1/proposals/{proposal_id}/votes/{voter}";
}

View File

@ -927,6 +927,7 @@ type QueryClient interface {
// Proposals queries all proposals based on given status.
Proposals(ctx context.Context, in *QueryProposalsRequest, opts ...grpc.CallOption) (*QueryProposalsResponse, error)
// Vote queries voted information based on proposalID, voterAddr.
// Due to how we handle state, this query would error for proposals that has already been finished.
Vote(ctx context.Context, in *QueryVoteRequest, opts ...grpc.CallOption) (*QueryVoteResponse, error)
// Votes queries votes of a given proposal.
Votes(ctx context.Context, in *QueryVotesRequest, opts ...grpc.CallOption) (*QueryVotesResponse, error)
@ -1027,6 +1028,7 @@ type QueryServer interface {
// Proposals queries all proposals based on given status.
Proposals(context.Context, *QueryProposalsRequest) (*QueryProposalsResponse, error)
// Vote queries voted information based on proposalID, voterAddr.
// Due to how we handle state, this query would error for proposals that has already been finished.
Vote(context.Context, *QueryVoteRequest) (*QueryVoteResponse, error)
// Votes queries votes of a given proposal.
Votes(context.Context, *QueryVotesRequest) (*QueryVotesResponse, error)