Add Grpc gateway annotations

proto/cosmos/auth/query.proto

@@ -3,6 +3,7 @@ package cosmos.auth;
 
 import "gogoproto/gogo.proto";
 import "google/protobuf/any.proto";
+import "google/api/annotations.proto";
 import "cosmos/auth/auth.proto";
 import "cosmos_proto/cosmos.proto";
 
@@ -11,10 +12,14 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/auth/types";
 // Query creates service with Account and Parameters as rpc
 service Query{
     // Account returns account details based on address
-    rpc Account (QueryAccountRequest) returns (QueryAccountResponse) {}
+    rpc Account (QueryAccountRequest) returns (QueryAccountResponse) {
+      option (google.api.http).get = "/cosmos/auth/account/{address}";
+    }
 
     // Params queries all parameters
-    rpc Params (QueryParamsRequest) returns (QueryParamsResponse) {}
+    rpc Params (QueryParamsRequest) returns (QueryParamsResponse) {
+      option (google.api.http).get = "/cosmos/auth/params";
+    }
 }
 
 // QueryAccountRequest is request type for the Query/Account RPC method

proto/cosmos/bank/query.proto

@@ -4,22 +4,31 @@ package cosmos.bank;
 import "cosmos/query/pagination.proto";
 import "gogoproto/gogo.proto";
 import "cosmos/cosmos.proto";
+import "google/api/annotations.proto";
 
 option go_package = "github.com/cosmos/cosmos-sdk/x/bank/types";
 
 // Query provides defines the gRPC querier service
 service Query {
   // Balance queries the balance of a single coin for a single account
-  rpc Balance(QueryBalanceRequest) returns (QueryBalanceResponse) {}
+  rpc Balance(QueryBalanceRequest) returns (QueryBalanceResponse) {
+    option (google.api.http).get = "/cosmos/bank/balance/{address}/{denom}";
+  }
 
   // AllBalances queries the balance of all coins for a single account
-  rpc AllBalances(QueryAllBalancesRequest) returns (QueryAllBalancesResponse) {}
+  rpc AllBalances(QueryAllBalancesRequest) returns (QueryAllBalancesResponse) {
+    option (google.api.http).get = "/cosmos/bank/balances/{address}";
+  }
 
   // TotalSupply queries the total supply of all coins
-  rpc TotalSupply(QueryTotalSupplyRequest) returns (QueryTotalSupplyResponse) {}
+  rpc TotalSupply(QueryTotalSupplyRequest) returns (QueryTotalSupplyResponse) {
+    option (google.api.http).get = "/cosmos/bank/total-supply";
+  }
 
   // SupplyOf queries the supply of a single coin
-  rpc SupplyOf(QuerySupplyOfRequest) returns (QuerySupplyOfResponse) {}
+  rpc SupplyOf(QuerySupplyOfRequest) returns (QuerySupplyOfResponse) {
+    option (google.api.http).get = "/cosmos/bank/supply/{denom}";
+  }
 }
 
 // QueryBalanceRequest is the request type for the Query/Balance RPC method

proto/cosmos/distribution/query.proto

@@ -5,37 +5,56 @@ import "cosmos/query/pagination.proto";
 import "gogoproto/gogo.proto";
 import "cosmos/cosmos.proto";
 import "cosmos/distribution/distribution.proto";
+import "google/api/annotations.proto";
 
 option go_package = "github.com/cosmos/cosmos-sdk/x/distribution/types";
 
 // Query defines the gRPC querier service for distribution module
 service Query {
   // Params queries params of distribution module
-  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {}
+  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
+    option (google.api.http).get = "/cosmos/distribution/params";
+  }
 
   // ValidatorOutstandingRewards queries rewards of a validator address
-  rpc ValidatorOutstandingRewards(QueryValidatorOutstandingRewardsRequest) returns (QueryValidatorOutstandingRewardsResponse) {}
+  rpc ValidatorOutstandingRewards(QueryValidatorOutstandingRewardsRequest) returns (QueryValidatorOutstandingRewardsResponse) {
+    option (google.api.http).get = "/cosmos/distribution/{validator_address}/outstanding-rewards";
+  }
 
   // ValidatorCommission queries accumulated commission for a validator
-  rpc ValidatorCommission (QueryValidatorCommissionRequest) returns (QueryValidatorCommissionResponse) {}
+  rpc ValidatorCommission (QueryValidatorCommissionRequest) returns (QueryValidatorCommissionResponse) {
+    option (google.api.http).get = "/cosmos/distribution/{validator_address}/validator-commission";
+  }
 
   // ValidatorSlashes queries slash events of a validator
-  rpc ValidatorSlashes (QueryValidatorSlashesRequest) returns (QueryValidatorSlashesResponse) {}
+  rpc ValidatorSlashes (QueryValidatorSlashesRequest) returns (QueryValidatorSlashesResponse) {
+    option (google.api.http).get = "/cosmos/distribution/{validator_address}/validator-slashes/{starting_height}/{ending_height}/{pagination.key}/{pagination.offset}/{pagination.limit}/{pagination.count_total}";
+  }
 
   // DelegationRewards the total rewards accrued by a delegation
-  rpc DelegationRewards (QueryDelegationRewardsRequest) returns (QueryDelegationRewardsResponse) {}
+  rpc DelegationRewards (QueryDelegationRewardsRequest) returns (QueryDelegationRewardsResponse) {
+    option (google.api.http).get = "/cosmos/distribution/{delegator_address}/{validator_address}/rewards";
+  }
 
   // DelegationTotalRewards the total rewards accrued by a each validator
-  rpc DelegationTotalRewards (QueryDelegationTotalRewardsRequest) returns (QueryDelegationTotalRewardsResponse) {}
+  rpc DelegationTotalRewards (QueryDelegationTotalRewardsRequest) returns (QueryDelegationTotalRewardsResponse) {
+    option (google.api.http).get = "/cosmos/distribution/{delegator_address}/total-rewards";
+  }
 
   // DelegatorValidators queries the validators of a delegator
-  rpc DelegatorValidators (QueryDelegatorValidatorsRequest) returns (QueryDelegatorValidatorsResponse) {}
+  rpc DelegatorValidators (QueryDelegatorValidatorsRequest) returns (QueryDelegatorValidatorsResponse) {
+    option (google.api.http).get = "/cosmos/distribution/{delegator_address}/validators";
+  }
 
   // DelegatorWithdrawAddress queries withdraw address of a delegator
-  rpc DelegatorWithdrawAddress (QueryDelegatorWithdrawAddressRequest) returns (QueryDelegatorWithdrawAddressResponse) {}
+  rpc DelegatorWithdrawAddress (QueryDelegatorWithdrawAddressRequest) returns (QueryDelegatorWithdrawAddressResponse) {
+    option (google.api.http).get = "/cosmos/distribution/withdraw-address/{delegator_address}";
+  }
 
   // CommunityPool queries the community pool coins
-  rpc CommunityPool (QueryCommunityPoolRequest) returns (QueryCommunityPoolResponse) {}
+  rpc CommunityPool (QueryCommunityPoolRequest) returns (QueryCommunityPoolResponse) {
+    option (google.api.http).get = "/cosmos/distribution/community-pool";
+  }
 }
 
 // QueryParamsRequest is the request type for the Query/Params RPC method

scripts/protocgen.sh

@@ -10,12 +10,29 @@ for dir in $proto_dirs; do
   --gocosmos_out=plugins=interfacetype+grpc,\
 Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types:. \
   $(find "${dir}" -maxdepth 1 -name '*.proto')
+
+  # command to generate gRPC gateway
+  protoc \
+  -I "proto" \
+  -I "third_party/proto" \
+  --grpc-gateway_out=logtostderr=true:. \
+  $(find "${dir}" -maxdepth 1 -name '*.proto')
+
+  # TODO
+  # command to generate swagger doc
+  # protoc \
+  # -I "proto" \
+  # -I "third_party/proto" \
+  # --swagger_out=logtostderr=true:. \
+  # $(find "${dir}" -maxdepth 1 -name '*.proto')
 done
 
 # generate codec/testdata proto code
 protoc -I "proto" -I "third_party/proto" -I "testutil/testdata" --gocosmos_out=plugins=interfacetype+grpc,\
 Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types:. ./testutil/testdata/proto.proto
 
+# protoc -I "proto" -I "third_party/proto" -I/usr/local/include -I. -I$GOPATH/src -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis --grpc-gateway_out=logtostderr=true:. proto/cosmos/bank/query.proto
+
 # move proto files to the right places
 cp -r github.com/cosmos/cosmos-sdk/* ./
 rm -rf github.com

third_party/proto/google/api/annotations.proto

@@ -0,0 +1,31 @@
+// Copyright (c) 2015, Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/api/http.proto";
+import "google/protobuf/descriptor.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationsProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+extend google.protobuf.MethodOptions {
+  // See `HttpRule`.
+  HttpRule http = 72295728;
+}