feat: add field private for subscription plan

Author: ironman0x7b2

proto/sentinel/plan/v3/events.proto

@@ -13,6 +13,7 @@ message EventCreate {
   string bytes = 3;
   string duration = 4;
   string prices = 5;
+  bool private = 6;
 }
 
 message EventLinkNode {
@@ -27,6 +28,12 @@ message EventUnlinkNode {
   string node_address = 3;
 }
 
+message EventUpdateDetails {
+  uint64 plan_id = 1 [(gogoproto.customname) = "PlanID"];
+  string prov_address = 2;
+  bool private = 3;
+}
+
 message EventUpdateStatus {
   uint64 plan_id = 1 [(gogoproto.customname) = "PlanID"];
   string prov_address = 2;

proto/sentinel/plan/v3/msg.proto

@@ -22,6 +22,7 @@ message MsgCreatePlanRequest {
     (gogoproto.stdduration) = true
   ];
   repeated sentinel.types.v1.Price prices = 4 [(gogoproto.nullable) = false];
+  bool private = 5;
 }
 
 message MsgLinkNodeRequest {
@@ -36,6 +37,12 @@ message MsgUnlinkNodeRequest {
   string node_address = 3;
 }
 
+message MsgUpdatePlanDetailsRequest {
+  string from = 1;
+  uint64 id = 2 [(gogoproto.customname) = "ID"];
+  bool private = 3;
+}
+
 message MsgUpdatePlanStatusRequest {
   string from = 1;
   uint64 id = 2 [(gogoproto.customname) = "ID"];
@@ -58,6 +65,8 @@ message MsgLinkNodeResponse {}
 
 message MsgUnlinkNodeResponse {}
 
+message MsgUpdatePlanDetailsResponse {}
+
 message MsgUpdatePlanStatusResponse {}
 
 message MsgStartSessionResponse {
@@ -68,6 +77,7 @@ service MsgService {
   rpc MsgCreatePlan(MsgCreatePlanRequest) returns (MsgCreatePlanResponse);
   rpc MsgLinkNode(MsgLinkNodeRequest) returns (MsgLinkNodeResponse);
   rpc MsgUnlinkNode(MsgUnlinkNodeRequest) returns (MsgUnlinkNodeResponse);
+  rpc MsgUpdatePlanDetails(MsgUpdatePlanDetailsRequest) returns (MsgUpdatePlanDetailsResponse);
   rpc MsgUpdatePlanStatus(MsgUpdatePlanStatusRequest) returns (MsgUpdatePlanStatusResponse);
   rpc MsgStartSession(MsgStartSessionRequest) returns (MsgStartSessionResponse);
 }

proto/sentinel/plan/v3/plan.proto

@@ -23,8 +23,9 @@ message Plan {
     (gogoproto.stdduration) = true
   ];
   repeated sentinel.types.v1.Price prices = 5 [(gogoproto.nullable) = false];
-  sentinel.types.v1.Status status = 6;
-  google.protobuf.Timestamp status_at = 7 [
+  bool private = 6;
+  sentinel.types.v1.Status status = 7;
+  google.protobuf.Timestamp status_at = 8 [
     (gogoproto.nullable) = false,
     (gogoproto.stdtime) = true
   ];

x/node/types/v3/msg.go

@@ -80,7 +80,7 @@ func (m *MsgRegisterNodeRequest) GetSigners() []sdk.AccAddress {
 	return []sdk.AccAddress{from.Bytes()}
 }
 
-// NewMsgUpdateNodeDetailsRequest creates a MsgUpdateNodeDetailsRequest for updating a node’s prices or remote URL.
+// NewMsgUpdateNodeDetailsRequest creates a MsgUpdateNodeDetailsRequest for updating a node's prices or remote URL.
 func NewMsgUpdateNodeDetailsRequest(from base.NodeAddress, gigabytePrices, hourlyPrices v1base.Prices, remoteAddrs []string) *MsgUpdateNodeDetailsRequest {
 	return &MsgUpdateNodeDetailsRequest{
 		From:           from.String(),

x/plan/client/cli/cli.go

@@ -21,6 +21,7 @@ func GetTxCommands() []*cobra.Command {
 		txCreatePlan(),
 		txLinkNode(),
 		txUnlinkNode(),
+		txUpdatePlanDetails(),
 		txUpdatePlanStatus(),
 	)
 

x/plan/client/cli/flags.go

@@ -7,7 +7,8 @@ import (
 )
 
 const (
-	flagPrices = "prices"
+	flagPrices  = "prices"
+	flagPrivate = "private"
 )
 
 func GetPrices(flags *pflag.FlagSet) (v1base.Prices, error) {
@@ -22,3 +23,7 @@ func GetPrices(flags *pflag.FlagSet) (v1base.Prices, error) {
 
 	return v1base.NewPricesFromString(s)
 }
+
+func GetPrivate(flags *pflag.FlagSet) (bool, error) {
+	return flags.GetBool(flagPrivate)
+}

x/plan/client/cli/tx.go

@@ -19,7 +19,7 @@ import (
 func txCreatePlan() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "create-plan [bytes] [duration]",
-		Short: "Create a new subscription plan with bytes, duration and pricing details",
+		Short: "Create a new subscription plan with bytes, duration, pricing details, and privacy setting",
 		Args:  cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx, err := client.GetClientTxContext(cmd)
@@ -42,11 +42,17 @@ func txCreatePlan() *cobra.Command {
 				return err
 			}
 
+			private, err := GetPrivate(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
 			msg := v3.NewMsgCreatePlanRequest(
 				ctx.FromAddress.Bytes(),
 				bytes,
 				duration,
 				prices,
+				private,
 			)
 			if err := msg.ValidateBasic(); err != nil {
 				return err
@@ -57,6 +63,7 @@ func txCreatePlan() *cobra.Command {
 	}
 
 	flags.AddTxFlagsToCmd(cmd)
+	cmd.Flags().Bool(flagPrivate, false, "set whether the plan should be private or not")
 	cmd.Flags().String(flagPrices, "", "specify the list of prices (e.g., 1000token)")
 
 	return cmd
@@ -140,6 +147,46 @@ func txUnlinkNode() *cobra.Command {
 	return cmd
 }
 
+func txUpdatePlanDetails() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "update-plan-details [id]",
+		Short: "Update the details of an existing subscription plan",
+		Args:  cobra.ExactArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx, err := client.GetClientTxContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			id, err := strconv.ParseUint(args[0], 10, 64)
+			if err != nil {
+				return err
+			}
+
+			private, err := GetPrivate(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			msg := v3.NewMsgUpdatePlanDetailsRequest(
+				ctx.FromAddress.Bytes(),
+				id,
+				private,
+			)
+			if err := msg.ValidateBasic(); err != nil {
+				return err
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(ctx, cmd.Flags(), msg)
+		},
+	}
+
+	flags.AddTxFlagsToCmd(cmd)
+	cmd.Flags().Bool(flagPrivate, false, "set whether the plan should be private or not")
+
+	return cmd
+}
+
 func txUpdatePlanStatus() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "update-plan-status [id] [status]",

x/plan/keeper/msg_handler.go

@@ -37,6 +37,7 @@ func (k *Keeper) HandleMsgCreatePlan(ctx sdk.Context, msg *v3.MsgCreatePlanReque
 		Bytes:       msg.Bytes,
 		Duration:    msg.Duration,
 		Prices:      msg.Prices,
+		Private:     msg.Private,
 		Status:      v1base.StatusInactive,
 		StatusAt:    ctx.BlockTime(),
 	}
@@ -164,8 +165,38 @@ func (k *Keeper) HandleMsgUnlinkNode(ctx sdk.Context, msg *v3.MsgUnlinkNodeReque
 	return &v3.MsgUnlinkNodeResponse{}, nil
 }
 
+// HandleMsgUpdatePlanDetails processes a request to update the details of a plan.
+// It updates the plan's privacy setting and ensures that the plan's details are persisted.
+func (k *Keeper) HandleMsgUpdatePlanDetails(ctx sdk.Context, msg *v3.MsgUpdatePlanDetailsRequest) (*v3.MsgUpdatePlanDetailsResponse, error) {
+	// Fetch and authorize the plan
+	plan, found := k.GetPlan(ctx, msg.ID)
+	if !found {
+		return nil, types.NewErrorPlanNotFound(msg.ID)
+	}
+
+	if msg.From != plan.ProvAddress {
+		return nil, types.NewErrorUnauthorized(msg.From)
+	}
+
+	// Apply the plan's privacy setting and persist the changes
+	plan.Private = msg.Private
+
+	k.SetPlan(ctx, plan)
+
+	// Emit event to indicate details update
+	ctx.EventManager().EmitTypedEvent(
+		&v3.EventUpdateDetails{
+			PlanID:      plan.ID,
+			ProvAddress: plan.ProvAddress,
+			Private:     plan.Private,
+		},
+	)
+
+	return &v3.MsgUpdatePlanDetailsResponse{}, nil
+}
+
 // HandleMsgUpdatePlanStatus handles a request to update the activation status of a plan.
-// It updates the plan’s status and cleans up the old status index.
+// It updates the plan's status and cleans up the old status index.
 func (k *Keeper) HandleMsgUpdatePlanStatus(ctx sdk.Context, msg *v3.MsgUpdatePlanStatusRequest) (*v3.MsgUpdatePlanStatusResponse, error) {
 	// Fetch and authorize the plan
 	plan, found := k.GetPlan(ctx, msg.ID)

x/plan/migrations/migrator.go

@@ -77,6 +77,7 @@ func (k *Migrator) migratePlans(ctx sdk.Context) {
 			Bytes:       base.Gigabyte.MulRaw(item.Gigabytes),
 			Duration:    item.Duration,
 			Prices:      prices,
+			Private:     false,
 			Status:      item.Status,
 			StatusAt:    item.StatusAt,
 		}

x/plan/services/v3/msg_server.go

@@ -39,6 +39,12 @@ func (m *msgServer) MsgUnlinkNode(c context.Context, req *v3.MsgUnlinkNodeReques
 	return m.HandleMsgUnlinkNode(ctx, req)
 }
 
+func (m *msgServer) MsgUpdatePlanDetails(c context.Context, req *v3.MsgUpdatePlanDetailsRequest) (*v3.MsgUpdatePlanDetailsResponse, error) {
+	ctx := sdk.UnwrapSDKContext(c)
+
+	return m.HandleMsgUpdatePlanDetails(ctx, req)
+}
+
 func (m *msgServer) MsgUpdatePlanStatus(c context.Context, req *v3.MsgUpdatePlanStatusRequest) (*v3.MsgUpdatePlanStatusResponse, error) {
 	ctx := sdk.UnwrapSDKContext(c)