Merge pull request tendermint#198 from kogisin/kogisin/197-naming-con…

…sistency feat: change naming for consistency in public proposals
jaybxyz · Oct 27, 2021 · dea1446 · dea1446
2 parents 4a8eadd + 4235393
commit dea1446
Show file tree

Hide file tree

Showing 24 changed files with 453 additions and 739 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 
 # Farming Module
 
-A farming module is a Cosmos SDK module that implements farming functionality, which provides farming rewards to participants called farmers. A primary use case is to use this module to provide incentives for liquidity pool investors for their pool participation. 
+The farming module is a Cosmos SDK module that implements farming functionality, which provides farming rewards to participants called farmers. A primary use case is to use this module to provide incentives for liquidity pool investors for their pool participation. 
 
 ⚠ **Farming module v1 is in active development** ⚠ 
 - see the [main](https://github.com/tendermint/farming/tree/main) branch for the latest 

diff --git a/app/app.go b/app/app.go
@@ -319,7 +319,7 @@ func NewFarmingApp(
 		AddRoute(paramproposal.RouterKey, params.NewParamChangeProposalHandler(app.ParamsKeeper)).
 		AddRoute(distrtypes.RouterKey, distr.NewCommunityPoolSpendProposalHandler(app.DistrKeeper)).
 		AddRoute(upgradetypes.RouterKey, upgrade.NewSoftwareUpgradeProposalHandler(app.UpgradeKeeper)).
-		AddRoute(farmingtypes.RouterKey, farming.NewPublicPlanProposal(app.FarmingKeeper))
+		AddRoute(farmingtypes.RouterKey, farming.NewPublicPlanProposalHandler(app.FarmingKeeper))
 
 	govKeeper := govkeeper.NewKeeper(
 		appCodec, keys[govtypes.StoreKey], app.GetSubspace(govtypes.ModuleName), app.AccountKeeper, app.BankKeeper,

diff --git a/client/docs/statik/statik.go b/client/docs/statik/statik.go
diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml
@@ -1392,6 +1392,7 @@ paths:
         url: 'https://github.com/tendermint/farming/tree/main/docs/How-To/cli#plan'
   '/cosmos/farming/v1beta1/rewards/{farmer}':
     get:
+      summary: Rewards returns rewards for a farmer
       description: Returns all rewards coins that corresponds to the farmer
       operationId: Rewards
       responses:
@@ -1417,6 +1418,9 @@ paths:
                     method
 
                     signatures required by gogoproto.
+            description: >-
+              QueryRewardsResponse is the response type for the Query/Rewards
+              RPC method.
         '400':
           description: Bad Request
           schema: {}
@@ -1631,6 +1635,7 @@ paths:
           https://github.com/tendermint/farming/tree/main/docs/How-To/cli#rewards
   '/cosmos/farming/v1beta1/stakings/{farmer}':
     get:
+      summary: Stakings returns all stakings by a farmer.
       description: >-
         Returns all stakings (staked and queued coins) that corresponds to the
         farmer
@@ -1675,6 +1680,9 @@ paths:
                     method
 
                     signatures required by gogoproto.
+            description: >-
+              QueryStakingsResponse is the response type for the Query/Stakings
+              RPC method.
         '400':
           description: Bad Request
           schema: {}
@@ -1889,6 +1897,7 @@ paths:
           https://github.com/tendermint/farming/tree/main/docs/How-To/cli#stakings
   '/cosmos/farming/v1beta1/total_stakings/{staking_coin_denom}':
     get:
+      summary: TotalStakings returns total staking amount for a staking coin denom
       description: Returns total stakings that corresponds to the staking_coin_denom
       operationId: TotalStakings
       responses:
@@ -1899,6 +1908,9 @@ paths:
             properties:
               amount:
                 type: string
+            description: >-
+              QueryTotalStakingsResponse is the response type for the
+              Query/TotalStakings RPC method.
         '400':
           description: Bad Request
           schema: {}
@@ -2664,6 +2676,9 @@ definitions:
 
             NOTE: The amount field is an Int which implements the custom method
             signatures required by gogoproto.
+    description: >-
+      QueryRewardsResponse is the response type for the Query/Rewards RPC
+      method.
   cosmos.farming.v1beta1.QueryStakingsResponse:
     type: object
     properties:
@@ -2695,11 +2710,17 @@ definitions:
 
             NOTE: The amount field is an Int which implements the custom method
             signatures required by gogoproto.
+    description: >-
+      QueryStakingsResponse is the response type for the Query/Stakings RPC
+      method.
   cosmos.farming.v1beta1.QueryTotalStakingsResponse:
     type: object
     properties:
       amount:
         type: string
+    description: >-
+      QueryTotalStakingsResponse is the response type for the
+      Query/TotalStakings RPC method.
   google.protobuf.Any:
     type: object
     properties:

diff --git a/docs/Tutorials/demo/budget_with_farming.md b/docs/Tutorials/demo/budget_with_farming.md
@@ -215,7 +215,7 @@ We use the following values of the fields.
 {
   "title": "Public Farming Plan",
   "description": "Are you ready to farm?",
-  "add_request_proposals": [
+  "add_plan_requests": [
     {
       "name": "First Public Ratio Plan",
       "farming_pool_address": "cosmos1228ryjucdpdv3t87rxle0ew76a56ulvnfst0hq0sscd3nafgjpqqkcxcky",
@@ -399,7 +399,7 @@ Add second public ratio plan proposal
 {
   "title": "Update Public Farming Plan",
   "description": "Are you ready to farm?",
-  "update_request_proposals": [
+  "modify_plan_requests": [
     {
       "plan_id": 1,
       "name": "First Public Ratio Plan",
@@ -416,7 +416,7 @@ Add second public ratio plan proposal
       "epoch_ratio": "0.500000000000000000"
     }
   ],
-  "add_request_proposals": [
+  "add_plan_requests": [
     {
       "name": "Second Public Ratio Plan",
       "farming_pool_address": "cosmos1228ryjucdpdv3t87rxle0ew76a56ulvnfst0hq0sscd3nafgjpqqkcxcky",