2018-07-31 18:48:32 -07:00
|
|
|
package gov
|
|
|
|
|
|
|
|
import (
|
2018-11-13 15:45:37 -08:00
|
|
|
"fmt"
|
|
|
|
|
2018-09-13 11:17:32 -07:00
|
|
|
"github.com/cosmos/cosmos-sdk/codec"
|
2018-07-31 18:48:32 -07:00
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
|
|
|
)
|
|
|
|
|
2018-09-12 00:41:09 -07:00
|
|
|
// query endpoints supported by the governance Querier
|
|
|
|
const (
|
2018-11-13 15:45:37 -08:00
|
|
|
QueryParams = "params"
|
2018-09-12 00:41:09 -07:00
|
|
|
QueryProposals = "proposals"
|
|
|
|
QueryProposal = "proposal"
|
|
|
|
QueryDeposits = "deposits"
|
|
|
|
QueryDeposit = "deposit"
|
|
|
|
QueryVotes = "votes"
|
|
|
|
QueryVote = "vote"
|
|
|
|
QueryTally = "tally"
|
2018-11-13 15:45:37 -08:00
|
|
|
|
|
|
|
ParamDeposit = "deposit"
|
|
|
|
ParamVoting = "voting"
|
|
|
|
ParamTallying = "tallying"
|
2018-09-12 00:41:09 -07:00
|
|
|
)
|
|
|
|
|
2018-08-03 12:55:00 -07:00
|
|
|
func NewQuerier(keeper Keeper) sdk.Querier {
|
2018-11-21 01:54:51 -08:00
|
|
|
return func(ctx sdk.Context, path []string, req abci.RequestQuery) ([]byte, sdk.Error) {
|
2018-08-03 12:55:00 -07:00
|
|
|
switch path[0] {
|
2018-11-13 15:45:37 -08:00
|
|
|
case QueryParams:
|
|
|
|
return queryParams(ctx, path[1:], req, keeper)
|
2018-09-12 00:41:09 -07:00
|
|
|
case QueryProposals:
|
|
|
|
return queryProposals(ctx, path[1:], req, keeper)
|
|
|
|
case QueryProposal:
|
2018-08-03 12:55:00 -07:00
|
|
|
return queryProposal(ctx, path[1:], req, keeper)
|
2018-09-12 00:41:09 -07:00
|
|
|
case QueryDeposits:
|
2018-08-03 12:55:00 -07:00
|
|
|
return queryDeposits(ctx, path[1:], req, keeper)
|
2018-09-12 00:41:09 -07:00
|
|
|
case QueryDeposit:
|
|
|
|
return queryDeposit(ctx, path[1:], req, keeper)
|
|
|
|
case QueryVotes:
|
2018-08-03 12:55:00 -07:00
|
|
|
return queryVotes(ctx, path[1:], req, keeper)
|
2018-09-12 00:41:09 -07:00
|
|
|
case QueryVote:
|
|
|
|
return queryVote(ctx, path[1:], req, keeper)
|
|
|
|
case QueryTally:
|
2018-08-03 12:55:00 -07:00
|
|
|
return queryTally(ctx, path[1:], req, keeper)
|
|
|
|
default:
|
|
|
|
return nil, sdk.ErrUnknownRequest("unknown gov query endpoint")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
func queryParams(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
2018-11-13 15:45:37 -08:00
|
|
|
switch path[0] {
|
|
|
|
case ParamDeposit:
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, keeper.GetDepositParams(ctx))
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-11-13 15:45:37 -08:00
|
|
|
}
|
|
|
|
return bz, nil
|
|
|
|
case ParamVoting:
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, keeper.GetVotingParams(ctx))
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-11-13 15:45:37 -08:00
|
|
|
}
|
|
|
|
return bz, nil
|
|
|
|
case ParamTallying:
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, keeper.GetTallyParams(ctx))
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-11-13 15:45:37 -08:00
|
|
|
}
|
|
|
|
return bz, nil
|
|
|
|
default:
|
2018-11-21 01:54:51 -08:00
|
|
|
return nil, sdk.ErrUnknownRequest(fmt.Sprintf("%s is not a valid query request path", req.Path))
|
2018-11-13 15:45:37 -08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
// Params for queries:
|
|
|
|
// - 'custom/gov/proposal'
|
|
|
|
// - 'custom/gov/deposits'
|
|
|
|
// - 'custom/gov/tally'
|
|
|
|
// - 'custom/gov/votes'
|
2018-08-03 12:55:00 -07:00
|
|
|
type QueryProposalParams struct {
|
2018-11-06 23:33:18 -08:00
|
|
|
ProposalID uint64
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
// creates a new instance of QueryProposalParams
|
|
|
|
func NewQueryProposalParams(proposalID uint64) QueryProposalParams {
|
|
|
|
return QueryProposalParams{
|
|
|
|
ProposalID: proposalID,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-08-31 15:22:37 -07:00
|
|
|
// nolint: unparam
|
2018-11-21 01:54:51 -08:00
|
|
|
func queryProposal(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
2018-08-03 12:55:00 -07:00
|
|
|
var params QueryProposalParams
|
2018-11-21 01:54:51 -08:00
|
|
|
err := keeper.cdc.UnmarshalJSON(req.Data, ¶ms)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrUnknownRequest(sdk.AppendMsgToErr("incorrectly formatted request data", err.Error()))
|
2018-08-03 12:55:00 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
proposal := keeper.GetProposal(ctx, params.ProposalID)
|
|
|
|
if proposal == nil {
|
2018-10-19 09:55:20 -07:00
|
|
|
return nil, ErrUnknownProposal(DefaultCodespace, params.ProposalID)
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
2018-08-22 00:10:11 -07:00
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, proposal)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-08-22 00:10:11 -07:00
|
|
|
}
|
|
|
|
return bz, nil
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
|
|
|
|
2018-08-03 12:55:00 -07:00
|
|
|
// Params for query 'custom/gov/deposit'
|
|
|
|
type QueryDepositParams struct {
|
2018-11-06 23:33:18 -08:00
|
|
|
ProposalID uint64
|
2018-08-03 12:55:00 -07:00
|
|
|
Depositer sdk.AccAddress
|
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
// creates a new instance of QueryDepositParams
|
|
|
|
func NewQueryDepositParams(proposalID uint64, depositer sdk.AccAddress) QueryDepositParams {
|
|
|
|
return QueryDepositParams{
|
|
|
|
ProposalID: proposalID,
|
|
|
|
Depositer: depositer,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-08-31 15:22:37 -07:00
|
|
|
// nolint: unparam
|
2018-11-21 01:54:51 -08:00
|
|
|
func queryDeposit(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
2018-08-03 12:55:00 -07:00
|
|
|
var params QueryDepositParams
|
2018-11-21 01:54:51 -08:00
|
|
|
err := keeper.cdc.UnmarshalJSON(req.Data, ¶ms)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrUnknownRequest(sdk.AppendMsgToErr("incorrectly formatted request data", err.Error()))
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
2018-08-03 12:55:00 -07:00
|
|
|
|
|
|
|
deposit, _ := keeper.GetDeposit(ctx, params.ProposalID, params.Depositer)
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, deposit)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-08-22 00:10:11 -07:00
|
|
|
}
|
|
|
|
return bz, nil
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
|
|
|
|
2018-08-03 12:55:00 -07:00
|
|
|
// Params for query 'custom/gov/vote'
|
|
|
|
type QueryVoteParams struct {
|
2018-11-06 23:33:18 -08:00
|
|
|
ProposalID uint64
|
2018-08-03 12:55:00 -07:00
|
|
|
Voter sdk.AccAddress
|
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
// creates a new instance of QueryVoteParams
|
|
|
|
func NewQueryVoteParams(proposalID uint64, voter sdk.AccAddress) QueryVoteParams {
|
|
|
|
return QueryVoteParams{
|
|
|
|
ProposalID: proposalID,
|
|
|
|
Voter: voter,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-08-31 15:22:37 -07:00
|
|
|
// nolint: unparam
|
2018-11-21 01:54:51 -08:00
|
|
|
func queryVote(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
2018-08-03 12:55:00 -07:00
|
|
|
var params QueryVoteParams
|
2018-11-21 01:54:51 -08:00
|
|
|
err := keeper.cdc.UnmarshalJSON(req.Data, ¶ms)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrUnknownRequest(sdk.AppendMsgToErr("incorrectly formatted request data", err.Error()))
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
2018-08-03 12:55:00 -07:00
|
|
|
|
|
|
|
vote, _ := keeper.GetVote(ctx, params.ProposalID, params.Voter)
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, vote)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-08-22 00:10:11 -07:00
|
|
|
}
|
|
|
|
return bz, nil
|
2018-08-03 12:55:00 -07:00
|
|
|
}
|
|
|
|
|
2018-08-31 15:22:37 -07:00
|
|
|
// nolint: unparam
|
2018-11-21 01:54:51 -08:00
|
|
|
func queryDeposits(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
|
|
|
var params QueryProposalParams
|
|
|
|
err := keeper.cdc.UnmarshalJSON(req.Data, ¶ms)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrUnknownRequest(sdk.AppendMsgToErr("incorrectly formatted request data", err.Error()))
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
2018-08-03 12:55:00 -07:00
|
|
|
|
|
|
|
var deposits []Deposit
|
|
|
|
depositsIterator := keeper.GetDeposits(ctx, params.ProposalID)
|
|
|
|
for ; depositsIterator.Valid(); depositsIterator.Next() {
|
|
|
|
deposit := Deposit{}
|
2018-11-04 18:28:38 -08:00
|
|
|
keeper.cdc.MustUnmarshalBinaryLengthPrefixed(depositsIterator.Value(), &deposit)
|
2018-08-03 12:55:00 -07:00
|
|
|
deposits = append(deposits, deposit)
|
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, deposits)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-08-22 00:10:11 -07:00
|
|
|
}
|
|
|
|
return bz, nil
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
// nolint: unparam
|
|
|
|
func queryTally(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
|
|
|
var params QueryProposalParams
|
|
|
|
err := keeper.cdc.UnmarshalJSON(req.Data, ¶ms)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrUnknownRequest(sdk.AppendMsgToErr("incorrectly formatted request data", err.Error()))
|
|
|
|
}
|
|
|
|
|
|
|
|
proposalID := params.ProposalID
|
|
|
|
|
|
|
|
proposal := keeper.GetProposal(ctx, proposalID)
|
|
|
|
if proposal == nil {
|
|
|
|
return nil, ErrUnknownProposal(DefaultCodespace, proposalID)
|
|
|
|
}
|
|
|
|
|
|
|
|
var tallyResult TallyResult
|
|
|
|
|
|
|
|
if proposal.GetStatus() == StatusDepositPeriod {
|
|
|
|
tallyResult = EmptyTallyResult()
|
|
|
|
} else if proposal.GetStatus() == StatusPassed || proposal.GetStatus() == StatusRejected {
|
|
|
|
tallyResult = proposal.GetTallyResult()
|
|
|
|
} else {
|
|
|
|
// proposal is in voting period
|
|
|
|
_, tallyResult = tally(ctx, keeper, proposal)
|
|
|
|
}
|
|
|
|
|
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, tallyResult)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
|
|
|
}
|
|
|
|
return bz, nil
|
2018-08-03 12:55:00 -07:00
|
|
|
}
|
|
|
|
|
2018-08-31 15:22:37 -07:00
|
|
|
// nolint: unparam
|
2018-11-21 01:54:51 -08:00
|
|
|
func queryVotes(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
|
|
|
var params QueryProposalParams
|
|
|
|
err := keeper.cdc.UnmarshalJSON(req.Data, ¶ms)
|
2018-08-22 00:10:11 -07:00
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrUnknownRequest(sdk.AppendMsgToErr("incorrectly formatted request data", err.Error()))
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
2018-08-03 12:55:00 -07:00
|
|
|
|
|
|
|
var votes []Vote
|
|
|
|
votesIterator := keeper.GetVotes(ctx, params.ProposalID)
|
|
|
|
for ; votesIterator.Valid(); votesIterator.Next() {
|
|
|
|
vote := Vote{}
|
2018-11-04 18:28:38 -08:00
|
|
|
keeper.cdc.MustUnmarshalBinaryLengthPrefixed(votesIterator.Value(), &vote)
|
2018-08-03 12:55:00 -07:00
|
|
|
votes = append(votes, vote)
|
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, votes)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-08-22 00:10:11 -07:00
|
|
|
}
|
|
|
|
return bz, nil
|
2018-08-03 12:55:00 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// Params for query 'custom/gov/proposals'
|
|
|
|
type QueryProposalsParams struct {
|
2018-11-06 23:33:18 -08:00
|
|
|
Voter sdk.AccAddress
|
|
|
|
Depositer sdk.AccAddress
|
|
|
|
ProposalStatus ProposalStatus
|
|
|
|
Limit uint64
|
2018-08-03 12:55:00 -07:00
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
// creates a new instance of QueryProposalsParams
|
|
|
|
func NewQueryProposalsParams(status ProposalStatus, limit uint64, voter, depositer sdk.AccAddress) QueryProposalsParams {
|
|
|
|
return QueryProposalsParams{
|
|
|
|
Voter: voter,
|
|
|
|
Depositer: depositer,
|
|
|
|
ProposalStatus: status,
|
|
|
|
Limit: limit,
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|
2018-08-03 12:55:00 -07:00
|
|
|
}
|
|
|
|
|
2018-08-31 15:22:37 -07:00
|
|
|
// nolint: unparam
|
2018-11-21 01:54:51 -08:00
|
|
|
func queryProposals(ctx sdk.Context, path []string, req abci.RequestQuery, keeper Keeper) ([]byte, sdk.Error) {
|
|
|
|
var params QueryProposalsParams
|
|
|
|
err := keeper.cdc.UnmarshalJSON(req.Data, ¶ms)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrUnknownRequest(sdk.AppendMsgToErr("incorrectly formatted request data", err.Error()))
|
2018-08-17 00:40:30 -07:00
|
|
|
}
|
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
proposals := keeper.GetProposalsFiltered(ctx, params.Voter, params.Depositer, params.ProposalStatus, params.Limit)
|
2018-08-17 00:40:30 -07:00
|
|
|
|
2018-11-21 01:54:51 -08:00
|
|
|
bz, err := codec.MarshalJSONIndent(keeper.cdc, proposals)
|
|
|
|
if err != nil {
|
|
|
|
return nil, sdk.ErrInternal(sdk.AppendMsgToErr("could not marshal result to JSON", err.Error()))
|
2018-08-17 00:40:30 -07:00
|
|
|
}
|
2018-08-22 00:10:11 -07:00
|
|
|
return bz, nil
|
2018-07-31 18:48:32 -07:00
|
|
|
}
|