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} \

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\""];
 }
 

proto/tendermint/farming/v1beta1/proposal.proto

@@ -4,20 +4,128 @@ package tendermint.farming.v1beta1;
 
 import "gogoproto/gogo.proto";
 import "cosmos_proto/cosmos.proto";
+import "cosmos/base/v1beta1/coin.proto";
 import "tendermint/farming/v1beta1/farming.proto";
-import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
 
 option go_package = "github.com/tendermint/farming/x/farming/types";
 
-// PublicPlanProposal details a proposal for creating a public plan.
+// PublicPlanProposal defines a public farming plan governance proposal that receives one of the following requests:
+// A request that creates a public farming plan, a request that updates the plan, and a request that deletes the plan.
+// For public plan creation, depending on which field is passed, either epoch amount or epoch ratio, it creates a fixed amount plan or ratio plan.  
 message PublicPlanProposal {
   option (gogoproto.goproto_getters)  = false;
   option (gogoproto.goproto_stringer) = false;
 
-  string title       = 1;
+  // title specifies the title of the plan
+  string title = 1;
+
+  // description specifies the description of the plan
   string description = 2;
 
-  // plans specifies the plan interface(s); it can be FixedAmountPlan or
-  // RatioPlan
-  repeated google.protobuf.Any plans = 3;
+  // add_request_proposals specifies AddRequestProposal object
+  repeated AddRequestProposal add_request_proposals = 3 [(gogoproto.moretags) = "yaml:\"add_request_proposals\""];
+
+  // update_request_proposals specifies UpdateRequestProposal object
+  repeated UpdateRequestProposal update_request_proposals = 4
+      [(gogoproto.moretags) = "yaml:\"update_request_proposals\""];
+
+  // delete_request_proposals specifies DeleteRequestProposal object
+  repeated DeleteRequestProposal delete_request_proposals = 5
+      [(gogoproto.moretags) = "yaml:\"delete_request_proposals\""];
+}
+
+// AddRequestProposal details a proposal for creating a public plan.
+message AddRequestProposal {
+  // name specifies the plan name that describes what plan is for
+  string name = 1;
+
+  // farming_pool_address defines the bech32-encoded address of the farming pool
+  string farming_pool_address = 2 [(gogoproto.moretags) = "yaml:\"farming_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 = 3 [(gogoproto.moretags) = "yaml:\"termination_address\""];
+
+  // staking_coin_weights specifies coin weights for the plan
+  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 4 [
+    (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 = 5
+      [(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 = 6
+      [(gogoproto.stdtime) = true, (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"end_time\""];
+
+  // epoch_amount specifies the distributing amount for each epoch
+  repeated cosmos.base.v1beta1.Coin epoch_amount = 7 [
+    (gogoproto.moretags)     = "yaml:\"epoch_amount\"",
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (gogoproto.nullable)     = false
+  ];
+
+  // epoch_ratio specifies the distributing amount by ratio
+  string epoch_ratio = 8 [
+    (gogoproto.moretags)   = "yaml:\"epoch_ratio\"",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// UpdateRequestProposal details a proposal for updating an existing public plan.
+message UpdateRequestProposal {
+  // plan_id specifies index of the farming plan
+  uint64 plan_id = 1;
+
+  // name specifies the plan name that describes what plan is for
+  string name = 2;
+
+  // farming_pool_address defines the bech32-encoded address of the farming pool
+  string farming_pool_address = 3 [(gogoproto.moretags) = "yaml:\"farming_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 = 4 [(gogoproto.moretags) = "yaml:\"termination_address\""];
+
+  // staking_coin_weights specifies coin weights for the plan
+  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 5 [
+    (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 = 6
+      [(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 = 7
+      [(gogoproto.stdtime) = true, (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"end_time\""];
+
+  // epoch_amount specifies the distributing amount for each epoch
+  repeated cosmos.base.v1beta1.Coin epoch_amount = 8 [
+    (gogoproto.moretags)     = "yaml:\"epoch_amount\"",
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (gogoproto.nullable)     = false
+  ];
+
+  // epoch_ratio specifies the distributing amount by ratio
+  string epoch_ratio = 9 [
+    (gogoproto.moretags)   = "yaml:\"epoch_ratio\"",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// DeleteRequestProposal details a proposal for deleting an existing public plan.
+message DeleteRequestProposal {
+  // plan_id specifies index of the farming plan
+  uint64 plan_id = 1;
 }

proto/tendermint/farming/v1beta1/tx.proto

@@ -33,26 +33,29 @@ service Msg {
 message MsgCreateFixedAmountPlan {
   option (gogoproto.goproto_getters) = false;
 
+  // name specifies the name for the plan
+  string name = 1;
+
   // farming_pool_address defines the bech32-encoded address of the farming pool
-  string farming_pool_address = 1 [(gogoproto.moretags) = "yaml:\"farming_pool_address\""];
+  string farming_pool_address = 2 [(gogoproto.moretags) = "yaml:\"farming_pool_address\""];
 
   // staking_coin_weights specifies coins weight for the plan
-  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 2 [
+  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 3 [
     (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 = 3
+  google.protobuf.Timestamp start_time = 4
       [(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 = 4
+  google.protobuf.Timestamp end_time = 5
       [(gogoproto.stdtime) = true, (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"end_time\""];
 
   // epoch_amount specifies the distributing amount for each epoch
-  repeated cosmos.base.v1beta1.Coin epoch_amount = 5 [
+  repeated cosmos.base.v1beta1.Coin epoch_amount = 6 [
     (gogoproto.moretags)     = "yaml:\"epoch_amount\"",
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
     (gogoproto.nullable)     = false
@@ -68,26 +71,29 @@ message MsgCreateFixedAmountPlanResponse {}
 message MsgCreateRatioPlan {
   option (gogoproto.goproto_getters) = false;
 
+  // name specifies the name for the plan
+  string name = 1;
+
   // farming_pool_address defines the bech32-encoded address of the farming pool
-  string farming_pool_address = 1 [(gogoproto.moretags) = "yaml:\"farming_pool_address\""];
+  string farming_pool_address = 2 [(gogoproto.moretags) = "yaml:\"farming_pool_address\""];
 
   // staking_coin_weights specifies coins weight for the plan
-  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 2 [
+  repeated cosmos.base.v1beta1.DecCoin staking_coin_weights = 3 [
     (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 = 3
+  google.protobuf.Timestamp start_time = 4
       [(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 = 4
+  google.protobuf.Timestamp end_time = 5
       [(gogoproto.stdtime) = true, (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"end_time\""];
 
   // epoch_ratio specifies the distributing amount by ratio
-  string epoch_ratio = 5 [
+  string epoch_ratio = 6 [
     (gogoproto.moretags)   = "yaml:\"epoch_ratio\"",
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable)   = false