feat(iro): add tradable only filter to IRO plans (#1358)

proto/dymensionxyz/dymension/iro/query.proto

@@ -67,7 +67,10 @@ message QueryParamsResponse {
 }
 
 // QueryPlanRequest is the request type for the Query/QueryPlan RPC method.
-message QueryPlansRequest {}
+message QueryPlansRequest {
+  // tradable_only is an optional flag to filter out plans that have not started yet, and that are not settled.
+  bool tradable_only = 1;
+}
 
 // QueryPlanResponse is the response type for the Query/QueryPlan RPC method.
 message QueryPlansResponse {

x/iro/cli/flags.go

@@ -25,6 +25,7 @@ const (
 	FlagBondingCurve                           = "curve"
 	FlagIncentivesStartDurationAfterSettlement = "incentives-start"
 	FlagIncentivesEpochs                       = "incentives-epochs"
+	FlagTradableOnly                           = "tradable-only"
 )
 
 var (

x/iro/cli/query.go

@@ -46,7 +46,14 @@ func CmdQueryPlans() *cobra.Command {
 			}
 			queryClient := types.NewQueryClient(clientCtx)
 
-			res, err := queryClient.QueryPlans(cmd.Context(), &types.QueryPlansRequest{})
+			tradableOnly, err := cmd.Flags().GetBool(FlagTradableOnly)
+			if err != nil {
+				return err
+			}
+
+			res, err := queryClient.QueryPlans(cmd.Context(), &types.QueryPlansRequest{
+				TradableOnly: tradableOnly,
+			})
 			if err != nil {
 				return err
 			}
@@ -56,6 +63,7 @@ func CmdQueryPlans() *cobra.Command {
 	}
 
 	flags.AddQueryFlagsToCmd(cmd)
+	cmd.Flags().BoolP(FlagTradableOnly, "t", false, "Query only tradable plans")
 	return cmd
 }
 

x/iro/genesis.go

@@ -33,7 +33,7 @@ func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState)
 func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState {
 	genesis := types.GenesisState{}
 	genesis.Params = k.GetParams(ctx)
-	genesis.Plans = append(genesis.Plans, k.GetAllPlans(ctx)...)
+	genesis.Plans = append(genesis.Plans, k.GetAllPlans(ctx, false)...)
 
 	return &genesis
 }

x/iro/genesis_test.go

@@ -33,7 +33,7 @@ func TestGenesis(t *testing.T) {
 	iro.InitGenesis(ctx, *k, genesisState)
 
 	// assertions
-	require.Len(t, k.GetAllPlans(ctx), 2)
+	require.Len(t, k.GetAllPlans(ctx, false), 2)
 	_, found := k.GetPlanByRollapp(ctx, "rollapp1")
 	require.True(t, found)
 	lastPlanId := k.GetLastPlanId(ctx)

x/iro/keeper/create_plan_test.go

@@ -89,7 +89,7 @@ func (s *KeeperTestSuite) TestCreatePlan() {
 	s.Require().Equal(planId2, fmt.Sprintf("%d", plan.Id))
 
 	// test get all plans
-	plans := k.GetAllPlans(s.Ctx)
+	plans := k.GetAllPlans(s.Ctx, false)
 	s.Require().Len(plans, 2)
 
 	ok := s.App.AccountKeeper.HasAccount(s.Ctx, plan.GetAddress())

x/iro/keeper/iro.go

@@ -65,7 +65,7 @@ func (k Keeper) MustGetPlanByRollapp(ctx sdk.Context, rollappId string) types.Pl
 }
 
 // GetAllPlans returns all plans
-func (k Keeper) GetAllPlans(ctx sdk.Context) (list []types.Plan) {
+func (k Keeper) GetAllPlans(ctx sdk.Context, tradableOnly bool) (list []types.Plan) {
 	store := prefix.NewStore(ctx.KVStore(k.storeKey), types.PlanKeyPrefix)
 	iterator := sdk.KVStorePrefixIterator(store, []byte{})
 
@@ -74,6 +74,9 @@ func (k Keeper) GetAllPlans(ctx sdk.Context) (list []types.Plan) {
 	for ; iterator.Valid(); iterator.Next() {
 		var val types.Plan
 		k.cdc.MustUnmarshal(iterator.Value(), &val)
+		if tradableOnly && !val.IsSettled() && !val.StartTime.After(ctx.BlockTime()) {
+			continue
+		}
 		list = append(list, val)
 	}
 

x/iro/keeper/query.go

@@ -122,7 +122,7 @@ func (k Keeper) QueryPlans(goCtx context.Context, req *types.QueryPlansRequest)
 		return nil, status.Error(codes.InvalidArgument, "invalid request")
 	}
 	ctx := sdk.UnwrapSDKContext(goCtx)
-	return &types.QueryPlansResponse{Plans: k.GetAllPlans(ctx)}, nil
+	return &types.QueryPlansResponse{Plans: k.GetAllPlans(ctx, req.TradableOnly)}, nil
 }
 
 // QuerySpotPrice implements types.QueryServer.