additional proto fields and query refactor

Author: toteki

proto/umee/incentive/v1/genesis.proto

@@ -10,17 +10,20 @@ import "umee/incentive/v1/incentive.proto";
 // GenesisState defines the x/incentive module's genesis state.
 message GenesisState {
   Params                    params               = 1 [(gogoproto.nullable) = false];
-  repeated IncentiveProgram programs             = 2 [(gogoproto.nullable) = false];
-  uint32                    next_program_id      = 3;
-  repeated cosmos.base.v1beta1.Coin total_bonded = 4 [
+  repeated IncentiveProgram completed_programs   = 2 [(gogoproto.nullable) = false];
+  repeated IncentiveProgram ongoing_programs     = 3 [(gogoproto.nullable) = false];
+  repeated IncentiveProgram upcoming_programs    = 4 [(gogoproto.nullable) = false];
+  uint32                    next_program_id      = 5;
+  uint64                    last_rewards_time    = 6;
+  repeated cosmos.base.v1beta1.Coin total_bonded = 7 [
     (gogoproto.nullable)     = false,
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   ];
-  repeated BondAmount        bond_amounts        = 5 [(gogoproto.nullable) = false];
-  repeated PendingReward     pending_rewards     = 6 [(gogoproto.nullable) = false];
-  repeated RewardBasis       reward_bases        = 7 [(gogoproto.nullable) = false];
-  repeated RewardAccumulator reward_accumulators = 8 [(gogoproto.nullable) = false];
-  repeated Unbonding         unbondings          = 9 [(gogoproto.nullable) = false];
+  repeated BondAmount        bond_amounts        = 8 [(gogoproto.nullable) = false];
+  repeated PendingReward     pending_rewards     = 9 [(gogoproto.nullable) = false];
+  repeated RewardBasis       reward_bases        = 10 [(gogoproto.nullable) = false];
+  repeated RewardAccumulator reward_accumulators = 11 [(gogoproto.nullable) = false];
+  repeated Unbonding         unbondings          = 12 [(gogoproto.nullable) = false];
 }
 
 // BondAmount tracks the amount of coins of one uToken denomination bonded to a

proto/umee/incentive/v1/incentive.proto

@@ -13,13 +13,13 @@ message Params {
   // max_unbondings defines the maximum amount of concurrent unbondings an address can have.
   uint32 max_unbondings = 1;
 
-  // unbonding_duration_long defines the unbonding duration (in blocks) of the long tier.
+  // unbonding_duration_long defines the unbonding duration (in seconds) of the long tier.
   uint64 unbonding_duration_long = 2;
 
-  // unbonding_duration_middle defines the unbonding duration (in blocks) of the middle tier.
+  // unbonding_duration_middle defines the unbonding duration (in seconds) of the middle tier.
   uint64 unbonding_duration_middle = 3;
 
-  // unbonding_duration_short defines the unbonding duration (in blocks) of the short tier.
+  // unbonding_duration_short defines the unbonding duration (in seconds) of the short tier.
   uint64 unbonding_duration_short = 4;
 
   // The tier_weight_short defines how the proportion of rewards assets locked
@@ -48,10 +48,10 @@ message IncentiveProgram {
   // It is zero when the program is being proposed by governance.
   uint32 id = 1;
 
-  // start_height is the block height at which the incentives begin.
-  uint64 start_height = 2;
+  // start_time is the block time at which the incentives begin.
+  uint64 start_time = 2;
 
-  // duration is the length of the incentive program in blocks.
+  // duration is the length of the incentive program in seconds.
   uint64 duration = 3;
 
   // denom defines the denomination of the incentivized collateral uToken.

proto/umee/incentive/v1/query.proto

@@ -11,52 +11,88 @@ option go_package = "github.com/umee-network/umee/v3/x/incentive";
 // Query defines the gRPC querier service.
 service Query {
   // Params queries the parameters of the x/incentive module.
-  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
+  rpc Params(QueryParams) returns (QueryParamsResponse) {
     option (google.api.http).get = "/umee/incentive/v1/params";
   }
 
-  // IncentivePrograms queries for all incentives programs that have been passed
-  // by governance, including upcoming and completed ones.
-  rpc IncentivePrograms(QueryIncentiveProgramsRequest)
-      returns (QueryIncentiveProgramsResponse) {
-    option (google.api.http).get = "/umee/incentive/v1/incentive_programs";
+  // CompletedIncentivePrograms queries for all incentives programs that have been passed
+  // by governance, and either run to completion or expired immediately due to not being funded.
+  rpc CompletedIncentivePrograms(QueryCompletedIncentivePrograms)
+      returns (QueryCompletedIncentiveProgramsResponse) {
+    option (google.api.http).get = "/umee/incentive/v1/incentive_programs/completed";
+  }
+
+  // OngoingIncentivePrograms queries for all incentives programs that have been passed
+  // by governance, funded, and started but not yet completed.
+  rpc OngoingIncentivePrograms(QueryOngoingIncentivePrograms)
+      returns (QueryOngoingIncentiveProgramsResponse) {
+    option (google.api.http).get = "/umee/incentive/v1/incentive_programs/ongoing";
+  }
+
+  // UpcomingIncentivePrograms queries for all incentives programs that have been passed
+  // by governance, but not yet started. They may or may not have been funded.
+  rpc UpcomingIncentivePrograms(QueryUpcomingIncentivePrograms)
+      returns (QueryUpcomingIncentiveProgramsResponse) {
+    option (google.api.http).get = "/umee/incentive/v1/incentive_programs/upcoming";
   }
 
   // IncentiveProgram queries a single incentive program by ID.
-  rpc IncentiveProgram(QueryIncentiveProgramRequest)
+  rpc IncentiveProgram(QueryIncentiveProgram)
       returns (QueryIncentiveProgramResponse) {
     option (google.api.http).get = "/umee/incentive/v1/incentive_program/{id}";
   }
 }
 
-// QueryParamsRequest defines the request structure for the Params gRPC service
+// QueryParams defines the request structure for the Params gRPC service
 // handler.
-message QueryParamsRequest {}
+message QueryParams {}
 
 // QueryParamsResponse defines the response structure for the Params gRPC
 // service handler.
 message QueryParamsResponse {
   Params params = 1 [(gogoproto.nullable) = false];
 }
 
-// QueryIncentiveProgramsRequest defines the request structure for the IncentivePrograms
-// gRPC service handler.
-message QueryIncentiveProgramsRequest {
+// QueryUpcomingIncentivePrograms defines the request structure for the
+// OngoingIncentivePrograms and UpcomingIncentivePrograms gRPC service handlers.
+message QueryUpcomingIncentivePrograms {
+}
+
+// QueryUpcomingIncentiveProgramsResponse defines the response structure for the
+// OngoingIncentivePrograms and UpcomingIncentivePrograms gRPC service handlers.
+message QueryUpcomingIncentiveProgramsResponse {
+  repeated IncentiveProgram programs = 1 [(gogoproto.nullable) = false];
+}
+
+// QueryOngoingIncentivePrograms defines the request structure for the
+// OngoingIncentivePrograms and UpcomingIncentivePrograms gRPC service handlers.
+message QueryOngoingIncentivePrograms {
+}
+
+// QueryOngoingIncentiveProgramsResponse defines the response structure for the
+// OngoingIncentivePrograms and UpcomingIncentivePrograms gRPC service handlers.
+message QueryOngoingIncentiveProgramsResponse {
+  repeated IncentiveProgram programs = 1 [(gogoproto.nullable) = false];
+}
+
+// QueryCompletedIncentivePrograms defines the request structure for the
+// CompletedIncentivePrograms gRPC service handler.
+message QueryCompletedIncentivePrograms {
   // pagination defines an optional pagination for the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 1;
 }
 
-// QueryIncentiveProgramsResponse defines the response structure for the
-// IncentivePrograms gRPC service handler.
-message QueryIncentiveProgramsResponse {
+// QueryCompletedIncentiveProgramsResponse defines the response structure for the
+// CompletedIncentivePrograms gRPC service handler.
+message QueryCompletedIncentiveProgramsResponse {
   repeated IncentiveProgram programs = 1 [(gogoproto.nullable) = false];
   // pagination defines an optional pagination for the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 2;
 }
 
-// QueryIncentiveProgramRequest defines the request structure for the IncentiveProgram
+// QueryIncentiveProgram defines the request structure for the IncentiveProgram
 // gRPC service handler.
-message QueryIncentiveProgramRequest {
+message QueryIncentiveProgram {
   // ID specifies which program to query for
   uint32 id = 1;
 }

x/incentive/genesis.go

@@ -10,8 +10,11 @@ import (
 // NewGenesisState creates a new GenesisState object
 func NewGenesisState(
 	params Params,
-	programs []IncentiveProgram,
+	upcomingPrograms []IncentiveProgram,
+	ongoingPrograms []IncentiveProgram,
+	completedPrograms []IncentiveProgram,
 	nextID uint32,
+	lastRewardsTime uint64,
 	totalBonded sdk.Coins,
 	bondAmounts []BondAmount,
 	pendingRewards []PendingReward,
@@ -21,7 +24,10 @@ func NewGenesisState(
 ) *GenesisState {
 	return &GenesisState{
 		Params:             params,
-		Programs:           programs,
+		UpcomingPrograms:   upcomingPrograms,
+		OngoingPrograms:    ongoingPrograms,
+		CompletedPrograms:  completedPrograms,
+		LastRewardsTime:    lastRewardsTime,
 		NextProgramId:      nextID,
 		TotalBonded:        totalBonded,
 		BondAmounts:        bondAmounts,
@@ -35,8 +41,9 @@ func NewGenesisState(
 // DefaultGenesis returns the default genesis state of the x/incentive module.
 func DefaultGenesis() *GenesisState {
 	return &GenesisState{
-		Params:        DefaultParams(),
-		NextProgramId: 1,
+		Params:          DefaultParams(),
+		NextProgramId:   1,
+		LastRewardsTime: 0,
 	}
 }
 
@@ -50,7 +57,17 @@ func (gs GenesisState) Validate() error {
 	// TODO: Finish validation logic - includes in-progress programs
 	// all ID < NextID (and NextID = len(programs) + 1)
 
-	for _, p := range gs.Programs {
+	for _, p := range gs.UpcomingPrograms {
+		if err := p.Validate(); err != nil {
+			return err
+		}
+	}
+	for _, p := range gs.OngoingPrograms {
+		if err := p.Validate(); err != nil {
+			return err
+		}
+	}
+	for _, p := range gs.CompletedPrograms {
 		if err := p.Validate(); err != nil {
 			return err
 		}