From 62da823314787642d494c11f5738e73f901197ba Mon Sep 17 00:00:00 2001 From: rhuairahrighairigh Date: Sat, 14 Mar 2020 01:16:45 +0000 Subject: [PATCH] add untested rest --- x/committee/client/rest/query.go | 397 +++++++++++++++++++++++++++++++ x/committee/client/rest/rest.go | 29 +++ x/committee/client/rest/tx.go | 110 +++++++++ x/committee/module.go | 3 +- 4 files changed, 538 insertions(+), 1 deletion(-) create mode 100644 x/committee/client/rest/query.go create mode 100644 x/committee/client/rest/rest.go create mode 100644 x/committee/client/rest/tx.go diff --git a/x/committee/client/rest/query.go b/x/committee/client/rest/query.go new file mode 100644 index 00000000..e7c2be72 --- /dev/null +++ b/x/committee/client/rest/query.go @@ -0,0 +1,397 @@ +package rest + +import ( + "errors" + "fmt" + "net/http" + + "github.com/gorilla/mux" + + "github.com/cosmos/cosmos-sdk/client/context" + "github.com/cosmos/cosmos-sdk/types/rest" + + "github.com/kava-labs/kava/x/committee/client" + "github.com/kava-labs/kava/x/committee/types" +) + +func registerQueryRoutes(cliCtx context.CLIContext, r *mux.Router) { + r.HandleFunc(fmt.Sprintf("/%s/committees", types.ModuleName), queryCommitteesHandlerFn(cliCtx)).Methods("GET") + r.HandleFunc(fmt.Sprintf("/%s/committees/{%s}", types.ModuleName, RestCommitteeID), queryCommitteeHandlerFn(cliCtx)).Methods("GET") + r.HandleFunc(fmt.Sprintf("/%s/committees/{%s}/proposals", types.ModuleName, RestCommitteeID), queryProposalsHandlerFn(cliCtx)).Methods("GET") + r.HandleFunc(fmt.Sprintf("/%s/proposals/{%s}", types.ModuleName, RestProposalID), queryProposalHandlerFn(cliCtx)).Methods("GET") + r.HandleFunc(fmt.Sprintf("/%s/proposals/{%s}/proposer", types.ModuleName, RestProposalID), queryProposerHandlerFn(cliCtx)).Methods("GET") + r.HandleFunc(fmt.Sprintf("/%s/proposals/{%s}/tally", types.ModuleName, RestProposalID), queryTallyOnProposalHandlerFn(cliCtx)).Methods("GET") + r.HandleFunc(fmt.Sprintf("/%s/proposals/{%s}/votes", types.ModuleName, RestProposalID), queryVotesOnProposalHandlerFn(cliCtx)).Methods("GET") + //r.HandleFunc(fmt.Sprintf("/%s/proposals/{%s}/votes/{%s}", types.ModuleName, RestProposalID, RestVoter), queryVoteHandlerFn(cliCtx)).Methods("GET") + //r.HandleFunc(fmt.Sprintf("/%s/parameters/{%s}", types.ModuleName, RestParamsType), queryParamsHandlerFn(cliCtx)).Methods("GET") +} + +// ---------- Committees ---------- + +func queryCommitteesHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + // Parse the query height + cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) + if !ok { + return + } + + // Query + res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/%s", types.ModuleName, types.QueryCommittees), nil) + if err != nil { + rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + return + } + + // Write response + cliCtx = cliCtx.WithHeight(height) + rest.PostProcessResponse(w, cliCtx, res) + } +} + +func queryCommitteeHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + // Parse the query height + cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) + if !ok { + return + } + + // Prepare params for querier + vars := mux.Vars(r) + if len(vars[RestCommitteeID]) == 0 { + err := errors.New("committeeID required but not specified") + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + committeeID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestCommitteeID]) + if !ok { + return + } + bz, err := cliCtx.Codec.MarshalJSON(types.NewQueryProposalParams(committeeID)) + if err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + + // Query + res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/%s", types.ModuleName, types.QueryCommittee), bz) + if err != nil { + rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + return + } + + // Write response + cliCtx = cliCtx.WithHeight(height) + rest.PostProcessResponse(w, cliCtx, res) + } +} + +// ---------- Proposals ---------- + +func queryProposalsHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + // Parse the query height + cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) + if !ok { + return + } + + // Prepare params for querier + vars := mux.Vars(r) + if len(vars[RestCommitteeID]) == 0 { + err := errors.New("committeeID required but not specified") + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + committeeID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestCommitteeID]) + if !ok { + return + } + bz, err := cliCtx.Codec.MarshalJSON(types.NewQueryProposalParams(committeeID)) + if err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + + // Query + res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/%s", types.ModuleName, types.QueryProposals), bz) + if err != nil { + rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + return + } + + // Write response + cliCtx = cliCtx.WithHeight(height) + rest.PostProcessResponse(w, cliCtx, res) + } +} + +func queryProposalHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + // Parse the query height + cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) + if !ok { + return + } + + // Prepare params for querier + vars := mux.Vars(r) + if len(vars[RestProposalID]) == 0 { + err := errors.New("proposalID required but not specified") + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + proposalID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestProposalID]) + if !ok { + return + } + bz, err := cliCtx.Codec.MarshalJSON(types.NewQueryProposalParams(proposalID)) + if err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + + // Query + res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/%s", types.ModuleName, types.QueryProposals), bz) + if err != nil { + rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + return + } + + // Write response + cliCtx = cliCtx.WithHeight(height) + rest.PostProcessResponse(w, cliCtx, res) + } +} + +func queryProposerHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + // Parse the query height + cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) + if !ok { + return + } + + // Prepare params for querier + vars := mux.Vars(r) + proposalID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestProposalID]) + if !ok { + return + } + + // Query + res, err := client.QueryProposer(cliCtx, proposalID) + if err != nil { + rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + return + } + + // Write response + rest.PostProcessResponse(w, cliCtx, res) + } +} + +// ---------- Votes ---------- + +func queryVotesOnProposalHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + // Parse the query height + cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) + if !ok { + return + } + + // Prepare params for querier + vars := mux.Vars(r) + if len(vars[RestProposalID]) == 0 { + err := errors.New("proposalID required but not specified") + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + proposalID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestProposalID]) + if !ok { + return + } + bz, err := cliCtx.Codec.MarshalJSON(types.NewQueryProposalParams(proposalID)) + if err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + + // Query + res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/%s", types.ModuleName, types.QueryVotes), bz) + if err != nil { + rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + return + } + + // TODO should add this feature back + // var proposal types.Proposal + // if err := cliCtx.Codec.UnmarshalJSON(res, &proposal); err != nil { + // rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + // return + // } + + // // For inactive proposals we must query the txs directly to get the votes + // // as they're no longer in state. + // propStatus := proposal.Status + // if !(propStatus == types.StatusVotingPeriod || propStatus == types.StatusDepositPeriod) { + // res, err = gcutils.QueryVotesByTxQuery(cliCtx, params) + // } else { + // res, _, err = cliCtx.QueryWithData("custom/gov/votes", bz) + // } + + // if err != nil { + // rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + // return + // } + + // Write response + cliCtx = cliCtx.WithHeight(height) + rest.PostProcessResponse(w, cliCtx, res) + } +} + +// func queryVoteHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { +// return func(w http.ResponseWriter, r *http.Request) { +// vars := mux.Vars(r) +// strProposalID := vars[RestProposalID] +// bechVoterAddr := vars[RestVoter] + +// if len(strProposalID) == 0 { +// err := errors.New("proposalId required but not specified") +// rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) +// return +// } + +// proposalID, ok := rest.ParseUint64OrReturnBadRequest(w, strProposalID) +// if !ok { +// return +// } + +// if len(bechVoterAddr) == 0 { +// err := errors.New("voter address required but not specified") +// rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) +// return +// } + +// voterAddr, err := sdk.AccAddressFromBech32(bechVoterAddr) +// if err != nil { +// rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) +// return +// } + +// cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) +// if !ok { +// return +// } + +// params := types.NewQueryVoteParams(proposalID, voterAddr) + +// bz, err := cliCtx.Codec.MarshalJSON(params) +// if err != nil { +// rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) +// return +// } + +// res, _, err := cliCtx.QueryWithData("custom/gov/vote", bz) +// if err != nil { +// rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) +// return +// } + +// var vote types.Vote +// if err := cliCtx.Codec.UnmarshalJSON(res, &vote); err != nil { +// rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) +// return +// } + +// // For an empty vote, either the proposal does not exist or is inactive in +// // which case the vote would be removed from state and should be queried for +// // directly via a txs query. +// if vote.Empty() { +// bz, err := cliCtx.Codec.MarshalJSON(types.NewQueryProposalParams(proposalID)) +// if err != nil { +// rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) +// return +// } + +// res, _, err = cliCtx.QueryWithData("custom/gov/proposal", bz) +// if err != nil || len(res) == 0 { +// err := fmt.Errorf("proposalID %d does not exist", proposalID) +// rest.WriteErrorResponse(w, http.StatusNotFound, err.Error()) +// return +// } + +// res, err = gcutils.QueryVoteByTxQuery(cliCtx, params) +// if err != nil { +// rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) +// return +// } +// } + +// rest.PostProcessResponse(w, cliCtx, res) +// } +// } + +func queryTallyOnProposalHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + // Parse the query height + cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) + if !ok { + return + } + + // Prepare params for querier + vars := mux.Vars(r) + if len(vars[RestProposalID]) == 0 { + err := errors.New("proposalID required but not specified") + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + proposalID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestProposalID]) + if !ok { + return + } + bz, err := cliCtx.Codec.MarshalJSON(types.NewQueryProposalParams(proposalID)) + if err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + + // Query + res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/%s/%s", types.ModuleName, types.QueryTally), bz) + if err != nil { + rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error()) + return + } + + // Write response + cliCtx = cliCtx.WithHeight(height) + rest.PostProcessResponse(w, cliCtx, res) + } +} + +// ---------- Params ---------- + +// func queryParamsHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { +// return func(w http.ResponseWriter, r *http.Request) { +// vars := mux.Vars(r) +// paramType := vars[RestParamsType] + +// cliCtx, ok := rest.ParseQueryHeightOrReturnBadRequest(w, cliCtx, r) +// if !ok { +// return +// } + +// res, height, err := cliCtx.QueryWithData(fmt.Sprintf("custom/gov/%s/%s", types.QueryParams, paramType), nil) +// if err != nil { +// rest.WriteErrorResponse(w, http.StatusNotFound, err.Error()) +// return +// } + +// cliCtx = cliCtx.WithHeight(height) +// rest.PostProcessResponse(w, cliCtx, res) +// } +// } diff --git a/x/committee/client/rest/rest.go b/x/committee/client/rest/rest.go new file mode 100644 index 00000000..8ff0a7b5 --- /dev/null +++ b/x/committee/client/rest/rest.go @@ -0,0 +1,29 @@ +package rest + +import ( + "github.com/gorilla/mux" + + "github.com/cosmos/cosmos-sdk/client/context" +) + +// REST Variable names +const ( + RestProposalID = "proposal-id" + RestCommitteeID = "committee-id" + RestVoter = "voter" + //RestProposalStatus = "status" + //RestNumLimit = "limit" +) + +// // ProposalRESTHandler defines a REST handler implemented in another module. The +// // sub-route is mounted on the governance REST handler. +// type ProposalRESTHandler struct { +// SubRoute string +// Handler func(http.ResponseWriter, *http.Request) +// } + +// RegisterRoutes - Central function to define routes that get registered by the main application +func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router /*, phs []ProposalRESTHandler*/) { + registerQueryRoutes(cliCtx, r) + registerTxRoutes(cliCtx, r /* , phs*/) +} diff --git a/x/committee/client/rest/tx.go b/x/committee/client/rest/tx.go new file mode 100644 index 00000000..20be14e6 --- /dev/null +++ b/x/committee/client/rest/tx.go @@ -0,0 +1,110 @@ +package rest + +import ( + "fmt" + "net/http" + + "github.com/gorilla/mux" + + "github.com/cosmos/cosmos-sdk/client/context" + sdk "github.com/cosmos/cosmos-sdk/types" + "github.com/cosmos/cosmos-sdk/types/rest" + "github.com/cosmos/cosmos-sdk/x/auth/client/utils" + + "github.com/kava-labs/kava/x/committee/types" +) + +func registerTxRoutes(cliCtx context.CLIContext, r *mux.Router /*, phs []ProposalRESTHandler*/) { + // propSubRtr := r.PathPrefix("/gov/proposals").Subrouter() + // for _, ph := range phs { + // propSubRtr.HandleFunc(fmt.Sprintf("/%s", ph.SubRoute), ph.Handler).Methods("POST") + // } + + r.HandleFunc(fmt.Sprintf("/%s/committees/{%s}/proposals", types.ModuleName, RestCommitteeID), postProposalHandlerFn(cliCtx)).Methods("POST") + r.HandleFunc(fmt.Sprintf("/%s/proposals/{%s}/votes", types.ModuleName, RestProposalID), postVoteHandlerFn(cliCtx)).Methods("POST") +} + +// PostProposalReq defines the properties of a proposal request's body. +type PostProposalReq struct { + BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"` + PubProposal types.PubProposal `json:"pub_proposal" yaml:"pub_proposal"` + Proposer sdk.AccAddress `json:"proposer" yaml:"proposer"` +} + +func postProposalHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + + // Parse and validate url params + vars := mux.Vars(r) + if len(vars[RestCommitteeID]) == 0 { + rest.WriteErrorResponse(w, http.StatusBadRequest, "committeeID required but not specified") + return + } + committeeID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestCommitteeID]) + if !ok { + return + } + + // Parse and validate http request body + var req PostProposalReq + if !rest.ReadRESTReq(w, r, cliCtx.Codec, &req) { + return + } + req.BaseReq = req.BaseReq.Sanitize() + if !req.BaseReq.ValidateBasic(w) { + return + } + if err := req.PubProposal.ValidateBasic(); err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + + // Create and return a StdTx + msg := types.NewMsgSubmitProposal(req.PubProposal, req.Proposer, committeeID) + if err := msg.ValidateBasic(); err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + utils.WriteGenerateStdTxResponse(w, cliCtx, req.BaseReq, []sdk.Msg{msg}) + } +} + +// PostVoteReq defines the properties of a vote request's body. +type PostVoteReq struct { + BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"` + Voter sdk.AccAddress `json:"voter" yaml:"voter"` +} + +func postVoteHandlerFn(cliCtx context.CLIContext) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + + // Parse and validate url params + vars := mux.Vars(r) + if len(vars[RestProposalID]) == 0 { + rest.WriteErrorResponse(w, http.StatusBadRequest, "proposalID required but not specified") + return + } + proposalID, ok := rest.ParseUint64OrReturnBadRequest(w, vars[RestProposalID]) + if !ok { + return + } + + // Parse and validate http request body + var req PostVoteReq + if !rest.ReadRESTReq(w, r, cliCtx.Codec, &req) { + return + } + req.BaseReq = req.BaseReq.Sanitize() + if !req.BaseReq.ValidateBasic(w) { + return + } + + // Create and return a StdTx + msg := types.NewMsgVote(req.Voter, proposalID) + if err := msg.ValidateBasic(); err != nil { + rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error()) + return + } + utils.WriteGenerateStdTxResponse(w, cliCtx, req.BaseReq, []sdk.Msg{msg}) + } +} diff --git a/x/committee/module.go b/x/committee/module.go index a1164407..e188049b 100644 --- a/x/committee/module.go +++ b/x/committee/module.go @@ -13,6 +13,7 @@ import ( abci "github.com/tendermint/tendermint/abci/types" "github.com/kava-labs/kava/x/committee/client/cli" + "github.com/kava-labs/kava/x/committee/client/rest" ) var ( @@ -51,7 +52,7 @@ func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error { // RegisterRESTRoutes registers the REST routes for the module. func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router) { - //rest.RegisterRoutes(ctx, rtr) + rest.RegisterRoutes(ctx, rtr) } // GetTxCmd returns the root tx command for the module.