Add public and private plan creation

app/app.go

@@ -88,6 +88,7 @@ import (
 
 	farmingparams "github.com/tendermint/farming/app/params"
 	"github.com/tendermint/farming/x/farming"
+	farmingclient "github.com/tendermint/farming/x/farming/client"
 	farmingkeeper "github.com/tendermint/farming/x/farming/keeper"
 	farmingtypes "github.com/tendermint/farming/x/farming/types"
 
@@ -114,6 +115,7 @@ var (
 		distr.AppModuleBasic{},
 		gov.NewAppModuleBasic(
 			paramsclient.ProposalHandler, distrclient.ProposalHandler, upgradeclient.ProposalHandler, upgradeclient.CancelProposalHandler,
+			farmingclient.ProposalHandler,
 			// todo: farming proposal handler
 		),
 		params.AppModuleBasic{},

contrib/devtools/Dockerfile

@@ -6,7 +6,6 @@ ENV GOLANG_PROTOBUF_VERSION=1.3.5 \
   GOGO_PROTOBUF_VERSION=1.3.2 \
   GRPC_GATEWAY_VERSION=1.14.7 
 
-
 RUN GO111MODULE=on go get \
   github.com/golang/protobuf/protoc-gen-go@v${GOLANG_PROTOBUF_VERSION} \
   github.com/gogo/protobuf/protoc-gen-gogo@v${GOGO_PROTOBUF_VERSION} \

docs/Explanation/ADR/README.md

@@ -0,0 +1,11 @@
+# Architecture Decision Records (ADR)
+
+Use this location to record all high-level architecture decisions in the farming module
+
+## Definitions
+
+## Rationale
+
+## Creating new ADR
+
+## ADR Table of Contents

docs/How-To/farming_plans.md

@@ -0,0 +1,243 @@
+# Farming Plans
+
+There are two different types of farming plans in the farming module. Where as a public farming plan can only be created through governance proposal, a private farming plan can be created with any account. The plan creator's account is used as distributing account FarmingPoolAddress that will be distributed to farmers automatically. 
+
+In this documentation, there are sample data provided in JSON structure that are needed to test the functionality by using farming command line interfaces. 
+
+## Table of Contetns
+
+- [Bootstrap Local Network](#Boostrap)
+- [Public Farming Plan](#Public-Farming-Plan)
+  * [AddPublicFarmingFixedAmountPlan](#AddPublicFarmingFixedAmountPlan)
+  * [AddPublicFarmingRatioPlan](#AddPublicFarmingRatioPlan)
+  * [AddMultiplePublicPlans](#AddMultiplePublicPlans)
+  * [UpdatePublicFarmingFixedAmountPlan](#UpdatePublicFarmingFixedAmountPlan)
+  * [DeletePublicFarmingFixedAmountPlan](#DeletePublicFarmingFixedAmountPlan)
+- [Private Farming Plan](#Private-Farming-Plan)
+  * [PrivateFarmingFixedAmountPlan](#PrivateFarmingFixedAmountPlan)
+  * [PrivateFarmingRatioPlan](#PrivateFarmingRatioPlan)
+
+# Bootstrap
+
+```bash
+# Clone the project 
+git clone https://github.com/tendermint/farming.git
+cd cosmos-sdk
+make install
+
+# Configure variables
+export BINARY=farmingd
+export HOME_1=$HOME/.farmingapp
+export CHAIN_ID=localnet
+export VALIDATOR_1="struggle panic room apology luggage game screen wing want lazy famous eight robot picture wrap act uphold grab away proud music danger naive opinion"
+export USER_1="guard cream sadness conduct invite crumble clock pudding hole grit liar hotel maid produce squeeze return argue turtle know drive eight casino maze host"
+export GENESIS_COINS=10000000000stake,10000000000uatom,10000000000uusd
+
+# Boostrap
+$BINARY init $CHAIN_ID --chain-id $CHAIN_ID
+echo $VALIDATOR_1 | $BINARY keys add val1 --keyring-backend test --recover
+echo $USER_1 | $BINARY keys add user1 --keyring-backend test --recover
+$BINARY add-genesis-account $($BINARY keys show val1 --keyring-backend test -a) $GENESIS_COINS
+$BINARY add-genesis-account $($BINARY keys show user1 --keyring-backend test -a) $GENESIS_COINS
+$BINARY gentx val1 100000000stake --chain-id $CHAIN_ID --keyring-backend test
+$BINARY collect-gentxs
+
+# Modify app.toml
+sed -i '' 's/enable = false/enable = true/g' $HOME_1/config/app.toml
+sed -i '' 's/swagger = false/swagger = true/g' $HOME_1/config/app.toml
+
+# Modify governance proposal for testing purpose
+sed -i '' 's%"amount": "10000000"%"amount": "1"%g' $HOME_1/config/genesis.json
+sed -i '' 's%"quorum": "0.334000000000000000",%"quorum": "0.000000000000000001",%g' $HOME_1/config/genesis.json
+sed -i '' 's%"threshold": "0.500000000000000000",%"threshold": "0.000000000000000001",%g' $HOME_1/config/genesis.json
+sed -i '' 's%"voting_period": "172800s"%"voting_period": "60s"%g' $HOME_1/config/genesis.json
+
+# Start
+$BINARY start
+```
+
+# Public Farming Plan
+
+## AddPublicFarmingFixedAmountPlan
+
+```json
+{
+  "title": "Public Farming Plan",
+  "description": "Are you ready to farm?",
+  "add_request_proposals": [
+    {
+      "name": "First Public Farming Plan",
+      "farming_pool_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "termination_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "staking_coin_weights": [
+        {
+          "denom": "PoolCoinDenom",
+          "amount": "1.000000000000000000"
+        }
+      ],
+      "start_time": "2021-07-15T08:41:21.662422Z",
+      "end_time": "2022-07-16T08:41:21.662422Z",
+      "epoch_amount": [
+        {
+          "denom": "uatom",
+          "amount": "1"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## AddPublicFarmingRatioPlan
+
+```json
+{
+  "title": "Public Farming Plan",
+  "description": "Are you ready to farm?",
+  "add_request_proposals": [
+    {
+      "name": "First Public Farming Plan",
+      "farming_pool_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "termination_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "staking_coin_weights": [
+        {
+          "denom": "PoolCoinDenom",
+          "amount": "1.000000000000000000"
+        }
+      ],
+      "start_time": "2021-07-15T08:41:21.662422Z",
+      "end_time": "2022-07-16T08:41:21.662422Z",
+      "epoch_ratio": "1.000000000000000000"
+    }
+  ]
+}
+```
+
+## AddMultiplePublicPlans
+
+```json
+{
+  "title": "Public Farming Plan",
+  "description": "Are you ready to farm?",
+  "add_request_proposals": [
+    {
+      "name": "First Public Farming Plan",
+      "farming_pool_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "termination_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "staking_coin_weights": [
+        {
+          "denom": "PoolCoinDenom",
+          "amount": "1.000000000000000000"
+        }
+      ],
+      "start_time": "2021-07-15T08:41:21.662422Z",
+      "end_time": "2022-07-16T08:41:21.662422Z",
+      "epoch_amount": [
+        {
+          "denom": "uatom",
+          "amount": "1"
+        }
+      ]
+    },
+    {
+      "name": "First Public Farming Plan",
+      "farming_pool_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "termination_address": "cosmos1zaavvzxez0elundtn32qnk9lkm8kmcszzsv80v",
+      "staking_coin_weights": [
+        {
+          "denom": "PoolCoinDenom",
+          "amount": "1.000000000000000000"
+        }
+      ],
+      "start_time": "2021-07-15T08:41:21.662422Z",
+      "end_time": "2022-07-16T08:41:21.662422Z",
+      "epoch_ratio": "1.000000000000000000"
+    }
+  ]
+}
+```
+
+## UpdatePublicFarmingFixedAmountPlan
+
+```json
+{
+  "title": "Let's Update the Farming Plan 1",
+  "description": "FarmingPoolAddress needs to be changed",
+  "update_request_proposals": [
+    {
+      "plan_id": 1,
+      "farming_pool_address": "cosmos13w4ueuk80d3kmwk7ntlhp84fk0arlm3mqf0w08",
+      "termination_address": "cosmos13w4ueuk80d3kmwk7ntlhp84fk0arlm3mqf0w08",
+      "staking_coin_weights": [
+        {
+          "denom": "uatom",
+          "amount": "1.000000000000000000"
+        }
+      ],
+      "start_time": "2021-07-15T08:41:21.662422Z",
+      "end_time": "2022-07-16T08:41:21.662422Z",
+      "epoch_amount": [
+        {
+          "denom": "uatom",
+          "amount": "1"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## DeletePublicFarmingFixedAmountPlan
+
+```json
+{
+  "title": "Delete Public Farming Plan 1",
+  "description": "This plan is no longer needed",
+  "delete_request_proposals": [
+    {
+      "plan_id": 1
+    }
+  ]
+}
+```
+
+# Private Farming Plan
+
+## PrivateFarmingFixedAmountPlan
+
+```json
+{
+	"name": "This Farming Plan intends to incentivize ATOM HODLERS!",
+  "staking_coin_weights": [
+	  {
+	      "denom": "uatom",
+	      "amount": "1.000000000000000000"
+	  }
+  ],
+  "start_time": "2021-07-15T08:41:21.662422Z",
+  "end_time": "2022-07-16T08:41:21.662422Z",
+  "epoch_amount": [
+    {
+      "denom": "uatom",
+      "amount": "1"
+    }
+  ]
+}
+```
+
+## PrivateFarmingRatioPlan
+
+```json
+{
+	"name": "This Farming Plan intends to incentivize ATOM HODLERS!",
+  "staking_coin_weights": [
+	  {
+	      "denom": "uatom",
+	      "amount": "1.000000000000000000"
+	  }
+  ],
+  "start_time": "2021-07-15T08:41:21.662422Z",
+  "end_time": "2022-07-16T08:41:21.662422Z",
+  "epoch_ratio":"1.000000000000000000"
+}
+```

docs/README.md

@@ -0,0 +1,9 @@
+# Farming Module Documentation 
+
+## Get Started
+
+## References
+
+## Other Resources
+
+## Contribute

docs/Tutorials/README.md

@@ -0,0 +1 @@
+## Tutorials

proto/tendermint/farming/v1beta1/farming.proto

@@ -51,36 +51,39 @@ message BasePlan {
   // id specifies index of the farming plan
   uint64 id = 1;
 
+  // name specifies the name for the base plan
+  string name = 2;
+
   // type specifies the plan type; type 0 is public and 1 is private
   // public plan must be created through governance proposal and private plan is
   // created by account
-  PlanType type = 2;
+  PlanType type = 3;
 
   // farming_pool_address defines the bech32-encoded address of the farming pool
-  string farming_pool_address = 3 [(gogoproto.moretags) = "yaml:\"farming_pool_address\""];
+  string farming_pool_address = 4 [(gogoproto.moretags) = "yaml:\"farming_pool_address\""];
 
   // reward_pool_address defines the bech32-encoded address that distributes
   // reward amount of coins to farmers
-  string reward_pool_address = 4 [(gogoproto.moretags) = "yaml:\"reward_pool_address\""];
+  string reward_pool_address = 5 [(gogoproto.moretags) = "yaml:\"reward_pool_address\""];
 
   // termination_address defines the bech32-encoded address that terminates plan
   // when the plan ends after the end time, the balance of farming pool address
   // is transferred to the termination address
-  string termination_address = 5 [(gogoproto.moretags) = "yaml:\"termination_address\""];
+  string termination_address = 6 [(gogoproto.moretags) = "yaml:\"termination_address\""];
 
   // staking_coin_weights specifies coin weights for the plan
-  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 6 [
+  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 7 [
     (gogoproto.moretags)     = "yaml:\"staking_coin_weights\"",
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins",
     (gogoproto.nullable)     = false
   ];
 
   // start_time specifies the start time of the plan
-  google.protobuf.Timestamp start_time = 7
+  google.protobuf.Timestamp start_time = 8
       [(gogoproto.stdtime) = true, (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"start_time\""];
 
   // end_time specifies the end time of the plan
-  google.protobuf.Timestamp end_time = 8
+  google.protobuf.Timestamp end_time = 9
       [(gogoproto.stdtime) = true, (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"end_time\""];
 }