R4R: Implement fee distribution RESTful endpoints

PENDING.md

@@ -6,6 +6,7 @@ BREAKING CHANGES
   * [\#3284](https://github.com/cosmos/cosmos-sdk/issues/3284) Rename the `name`
   field to `from` in the `base_req` body.
   * [\#3485](https://github.com/cosmos/cosmos-sdk/pull/3485) Error responses are now JSON objects.
+  * [\#3477][distribution] endpoint changed "all_delegation_rewards" -> "delegator_total_rewards"
 
 * Gaia CLI  (`gaiacli`)
   - [#3399](https://github.com/cosmos/cosmos-sdk/pull/3399) Add `gaiad validate-genesis` command to facilitate checking of genesis files
@@ -25,6 +26,7 @@ BREAKING CHANGES
 FEATURES
 
 * Gaia REST API
+  * [\#2358](https://github.com/cosmos/cosmos-sdk/issues/2358) Add distribution module REST interface
 
 * Gaia CLI  (`gaiacli`)
   * [\#3429](https://github.com/cosmos/cosmos-sdk/issues/3429) Support querying
@@ -37,6 +39,7 @@ FEATURES
 
 * SDK
   * \#3270 [x/staking] limit number of ongoing unbonding delegations /redelegations per pair/trio
+  * [\#3477][distribution] new query endpoint "delegator_validators"
 
 * Tendermint
 
@@ -53,6 +56,7 @@ IMPROVEMENTS
   (auto gas) to work with generate only.
 
 * Gaia CLI  (`gaiacli`)
+  * [\#3476](https://github.com/cosmos/cosmos-sdk/issues/3476) New `withdraw-all-rewards` command to withdraw all delegations rewards for delegators.
 
 * Gaia
   * [\#3418](https://github.com/cosmos/cosmos-sdk/issues/3418) Add vesting account

client/lcd/swagger-ui/swagger.yaml

@@ -18,7 +18,7 @@ tags:
   - name: ICS23
     description: Slashing module APIs
   - name: ICS24
-    description: WIP - Fee distribution module APIs
+    description: Fee distribution module APIs
   - name: version
     description: Query app version
 schemes:
@@ -1846,9 +1846,9 @@ paths:
                 type: string
         500:
           description: Internal Server Error
-  /distribution/pool:
+  /distribution/outstanding_rewards:
     get:
-      summary: Fee distribution pool
+      summary: Fee distribution outstanding rewards
       tags:
         - ICS24
       produces:
@@ -1857,7 +1857,9 @@ paths:
         200:
           description: OK
           schema:
-            $ref: "#/definitions/FeePool"
+            type: array
+            items:
+              $ref: "#/definitions/Coin"
         500:
           description: Internal Server Error
 definitions:
@@ -2198,7 +2200,7 @@ definitions:
       power:
         type: string
         example: "1000"
-      accum:
+      proposer_priority:
         type: string
         example: "1000"
   TextProposal:
@@ -2367,36 +2369,12 @@ definitions:
         type: string
       shares_dst:
         type: string
-  FeePool:
-    type: object
-    properties:
-      community_pool:
-        type: array
-        items:
-          $ref: "#/definitions/Coin"
-      val_accum:
-        $ref: "#/definitions/TotalAccum"
-      val_pool:
-        type: array
-        items:
-          $ref: "#/definitions/Coin"
-  TotalAccum:
-    type: object
-    properties:
-      update_height:
-        type: integer
-      accum:
-        type: string
   ValidatorDistInfo:
     type: object
     properties:
       operator_addr:
         $ref: "#/definitions/ValidatorAddress"
-      fee_pool_withdrawal_height:
-        type: integer
-      del_accum:
-        $ref: "#/definitions/TotalAccum"
-      del_pool:
+      self_bond_rewards:
         type: array
         items:
           $ref: "#/definitions/Coin"

cmd/gaia/cmd/gaiacli/main.go

@@ -25,7 +25,7 @@ import (
 	at "github.com/cosmos/cosmos-sdk/x/auth"
 	auth "github.com/cosmos/cosmos-sdk/x/auth/client/rest"
 	bank "github.com/cosmos/cosmos-sdk/x/bank/client/rest"
-	dist "github.com/cosmos/cosmos-sdk/x/distribution"
+	dist "github.com/cosmos/cosmos-sdk/x/distribution/client/rest"
 	gv "github.com/cosmos/cosmos-sdk/x/gov"
 	gov "github.com/cosmos/cosmos-sdk/x/gov/client/rest"
 	sl "github.com/cosmos/cosmos-sdk/x/slashing"
@@ -35,6 +35,7 @@ import (
 
 	authcmd "github.com/cosmos/cosmos-sdk/x/auth/client/cli"
 	bankcmd "github.com/cosmos/cosmos-sdk/x/bank/client/cli"
+	distcmd "github.com/cosmos/cosmos-sdk/x/distribution"
 	distClient "github.com/cosmos/cosmos-sdk/x/distribution/client"
 	govClient "github.com/cosmos/cosmos-sdk/x/gov/client"
 	slashingClient "github.com/cosmos/cosmos-sdk/x/slashing/client"
@@ -65,7 +66,7 @@ func main() {
 	// TODO: Make the lcd command take a list of ModuleClient
 	mc := []sdk.ModuleClients{
 		govClient.NewModuleClient(gv.StoreKey, cdc),
-		distClient.NewModuleClient(dist.StoreKey, cdc),
+		distClient.NewModuleClient(distcmd.StoreKey, cdc),
 		stakingClient.NewModuleClient(st.StoreKey, cdc),
 		slashingClient.NewModuleClient(sl.StoreKey, cdc),
 	}
@@ -161,6 +162,7 @@ func registerRoutes(rs *lcd.RestServer) {
 	tx.RegisterRoutes(rs.CliCtx, rs.Mux, rs.Cdc)
 	auth.RegisterRoutes(rs.CliCtx, rs.Mux, rs.Cdc, at.StoreKey)
 	bank.RegisterRoutes(rs.CliCtx, rs.Mux, rs.Cdc, rs.KeyBase)
+	dist.RegisterRoutes(rs.CliCtx, rs.Mux, rs.Cdc, distcmd.StoreKey)
 	staking.RegisterRoutes(rs.CliCtx, rs.Mux, rs.Cdc, rs.KeyBase)
 	slashing.RegisterRoutes(rs.CliCtx, rs.Mux, rs.Cdc, rs.KeyBase)
 	gov.RegisterRoutes(rs.CliCtx, rs.Mux, rs.Cdc)

x/distribution/alias.go

@@ -23,9 +23,10 @@ type (
 	FeeCollectionKeeper = types.FeeCollectionKeeper
 
 	// querier param types
-	QueryValidatorCommissionParams = keeper.QueryValidatorCommissionParams
-	QueryValidatorSlashesParams    = keeper.QueryValidatorSlashesParams
-	QueryDelegationRewardsParams   = keeper.QueryDelegationRewardsParams
+	QueryValidatorCommissionParams   = keeper.QueryValidatorCommissionParams
+	QueryValidatorSlashesParams      = keeper.QueryValidatorSlashesParams
+	QueryDelegationRewardsParams     = keeper.QueryDelegationRewardsParams
+	QueryDelegatorWithdrawAddrParams = keeper.QueryDelegatorWithdrawAddrParams
 )
 
 const (
@@ -49,12 +50,14 @@ var (
 	NewMsgWithdrawDelegatorReward     = types.NewMsgWithdrawDelegatorReward
 	NewMsgWithdrawValidatorCommission = types.NewMsgWithdrawValidatorCommission
 
-	NewKeeper                         = keeper.NewKeeper
-	NewQuerier                        = keeper.NewQuerier
-	NewQueryValidatorCommissionParams = keeper.NewQueryValidatorCommissionParams
-	NewQueryValidatorSlashesParams    = keeper.NewQueryValidatorSlashesParams
-	NewQueryDelegationRewardsParams   = keeper.NewQueryDelegationRewardsParams
-	DefaultParamspace                 = keeper.DefaultParamspace
+	NewKeeper                           = keeper.NewKeeper
+	NewQuerier                          = keeper.NewQuerier
+	NewQueryValidatorCommissionParams   = keeper.NewQueryValidatorCommissionParams
+	NewQueryValidatorSlashesParams      = keeper.NewQueryValidatorSlashesParams
+	NewQueryDelegationRewardsParams     = keeper.NewQueryDelegationRewardsParams
+	NewQueryDelegatorParams             = keeper.NewQueryDelegatorParams
+	NewQueryDelegatorWithdrawAddrParams = keeper.NewQueryDelegatorWithdrawAddrParams
+	DefaultParamspace                   = keeper.DefaultParamspace
 
 	RegisterCodec       = types.RegisterCodec
 	DefaultGenesisState = types.DefaultGenesisState

x/distribution/client/cli/query.go

@@ -10,6 +10,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	distr "github.com/cosmos/cosmos-sdk/x/distribution"
+	"github.com/cosmos/cosmos-sdk/x/distribution/client/common"
 	"github.com/cosmos/cosmos-sdk/x/distribution/types"
 )
 
@@ -21,34 +22,10 @@ func GetCmdQueryParams(queryRoute string, cdc *codec.Codec) *cobra.Command {
 		Short: "Query distribution params",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cliCtx := context.NewCLIContext().WithCodec(cdc)
-
-			route := fmt.Sprintf("custom/%s/params/community_tax", queryRoute)
-			retCommunityTax, err := cliCtx.QueryWithData(route, []byte{})
-			if err != nil {
-				return err
-			}
-
-			route = fmt.Sprintf("custom/%s/params/base_proposer_reward", queryRoute)
-			retBaseProposerReward, err := cliCtx.QueryWithData(route, []byte{})
+			params, err := common.QueryParams(cliCtx, queryRoute)
 			if err != nil {
 				return err
 			}
-
-			route = fmt.Sprintf("custom/%s/params/bonus_proposer_reward", queryRoute)
-			retBonusProposerReward, err := cliCtx.QueryWithData(route, []byte{})
-			if err != nil {
-				return err
-			}
-
-			route = fmt.Sprintf("custom/%s/params/withdraw_addr_enabled", queryRoute)
-			retWithdrawAddrEnabled, err := cliCtx.QueryWithData(route, []byte{})
-			if err != nil {
-				return err
-			}
-
-			params := NewPrettyParams(retCommunityTax, retBaseProposerReward,
-				retBonusProposerReward, retWithdrawAddrEnabled)
-
 			return cliCtx.PrintOutput(params)
 		},
 	}
@@ -90,13 +67,7 @@ func GetCmdQueryValidatorCommission(queryRoute string, cdc *codec.Codec) *cobra.
 				return err
 			}
 
-			bz, err := cdc.MarshalJSON(distr.NewQueryValidatorCommissionParams(validatorAddr))
-			if err != nil {
-				return err
-			}
-
-			route := fmt.Sprintf("custom/%s/validator_commission", queryRoute)
-			res, err := cliCtx.QueryWithData(route, bz)
+			res, err := common.QueryValidatorCommission(cliCtx, cdc, queryRoute, validatorAddr)
 			if err != nil {
 				return err
 			}
@@ -159,42 +130,18 @@ func GetCmdQueryDelegatorRewards(queryRoute string, cdc *codec.Codec) *cobra.Com
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cliCtx := context.NewCLIContext().WithCodec(cdc)
 
-			delegatorAddr, err := sdk.AccAddressFromBech32(args[0])
-			if err != nil {
-				return err
-			}
-
-			var (
-				route  string
-				params distr.QueryDelegationRewardsParams
-				result sdk.DecCoins
-			)
-
-			if len(args) == 1 {
-				// query for all rewards
-				params = distr.NewQueryDelegationRewardsParams(delegatorAddr, nil)
-				route = fmt.Sprintf("custom/%s/all_delegation_rewards", queryRoute)
-			} else {
+			valAddr := ""
+			if len(args) == 2 {
 				// query for rewards from a particular validator
-				validatorAddr, err := sdk.ValAddressFromBech32(args[1])
-				if err != nil {
-					return err
-				}
-
-				params = distr.NewQueryDelegationRewardsParams(delegatorAddr, validatorAddr)
-				route = fmt.Sprintf("custom/%s/delegation_rewards", queryRoute)
-			}
-
-			bz, err := cdc.MarshalJSON(params)
-			if err != nil {
-				return err
+				valAddr = args[1]
 			}
 
-			resp, err := cliCtx.QueryWithData(route, bz)
+			resp, err := common.QueryRewards(cliCtx, cdc, queryRoute, args[0], valAddr)
 			if err != nil {
 				return err
 			}
 
+			var result sdk.DecCoins
 			cdc.MustUnmarshalJSON(resp, &result)
 			return cliCtx.PrintOutput(result)
 		},

x/distribution/client/cli/tx.go

@@ -16,6 +16,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authtxb "github.com/cosmos/cosmos-sdk/x/auth/client/txbuilder"
 
+	"github.com/cosmos/cosmos-sdk/x/distribution/client/common"
 	"github.com/cosmos/cosmos-sdk/x/distribution/types"
 )
 
@@ -89,7 +90,39 @@ func GetCmdWithdrawRewards(cdc *codec.Codec) *cobra.Command {
 	return cmd
 }
 
-// GetCmdDelegate implements the delegate command.
+// command to withdraw all rewards
+func GetCmdWithdrawAllRewards(cdc *codec.Codec, queryRoute string) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "withdraw-all-rewards [delegator-addr]",
+		Short: "withdraw all delegations rewards for a delegator",
+		Args:  cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+
+			txBldr := authtxb.NewTxBuilderFromCLI().WithTxEncoder(utils.GetTxEncoder(cdc))
+			cliCtx := context.NewCLIContext().
+				WithCodec(cdc).
+				WithAccountDecoder(cdc)
+
+			delAddr := cliCtx.GetFromAddress()
+			msgs, err := common.WithdrawAllDelegatorRewards(cliCtx, cdc, queryRoute, delAddr)
+			if err != nil {
+				return err
+			}
+
+			if cliCtx.GenerateOnly {
+				return utils.PrintUnsignedStdTx(os.Stdout, txBldr, cliCtx, msgs, false)
+			}
+
+			// build and sign the transaction, then broadcast to Tendermint
+			return utils.CompleteAndBroadcastTxCLI(txBldr, cliCtx, msgs)
+		},
+	}
+	cmd.Flags().String(flagOnlyFromValidator, "", "only withdraw from this validator address (in bech)")
+	cmd.Flags().Bool(flagIsValidator, false, "also withdraw validator's commission")
+	return cmd
+}
+
+// command to replace a delegator's withdrawal address
 func GetCmdSetWithdrawAddr(cdc *codec.Codec) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "set-withdraw-addr [withdraw-addr]",