Feat: re-adding the storage stats route (#344)

proto/canine_chain/storage/query.proto

@@ -136,6 +136,12 @@ service Query {
     option (google.api.http).get =
         "/jackal-dao/canine-chain/storage/price_check/{duration}/{bytes}";
   }
+
+  // Queries the storage space used and purchased
+  rpc StorageStats(QueryStorageStatsRequest) returns (QueryStorageStatsResponse) {
+    option (google.api.http).get =
+        "/jackal-dao/canine-chain/storage/storage_stats";
+  }
 }
 
 // QueryParamsRequest is request type for the Query/Params RPC method.
@@ -280,4 +286,15 @@ message QueryPriceCheckResponse {
   int64 price = 1;
 }
 
+message QueryStorageStatsRequest {}
+
+message QueryStorageStatsResponse {
+  uint64 purchased = 1;
+  uint64 used = 2;
+  bytes usedRatio = 3 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  uint64 activeUsers = 4;
+}
 // this line is used by starport scaffolding # 3

x/storage/client/cli/query.go

@@ -50,6 +50,7 @@ func GetQueryCmd(_ string) *cobra.Command {
 
 	cmd.AddCommand(CmdCheckPrice())
 	// this line is used by starport scaffolding # 1
+	cmd.AddCommand(CmdGetStorageStats())
 
 	return cmd
 }

x/storage/client/cli/query_storage_stats.go

@@ -0,0 +1,36 @@
+package cli
+
+import (
+	"context"
+
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/client/flags"
+	"github.com/jackalLabs/canine-chain/x/storage/types"
+	"github.com/spf13/cobra"
+)
+
+func CmdGetStorageStats() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "get-storage-stats",
+		Short: "lists stats about storage on the network",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+
+			queryClient := types.NewQueryClient(clientCtx)
+
+			params := &types.QueryStorageStatsRequest{}
+
+			res, err := queryClient.StorageStats(context.Background(), params)
+			if err != nil {
+				return err
+			}
+
+			return clientCtx.PrintProto(res)
+		},
+	}
+
+	flags.AddPaginationFlagsToCmd(cmd, cmd.Use)
+	flags.AddQueryFlagsToCmd(cmd)
+
+	return cmd
+}

x/storage/keeper/grpc_query_storage_stats.go

@@ -0,0 +1,45 @@
+package keeper
+
+import (
+	"context"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/jackalLabs/canine-chain/x/storage/types"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+)
+
+func (k Keeper) StorageStats(c context.Context, req *types.QueryStorageStatsRequest) (*types.QueryStorageStatsResponse, error) {
+	if req == nil {
+		return nil, status.Error(codes.InvalidArgument, "invalid request")
+	}
+
+	ctx := sdk.UnwrapSDKContext(c)
+
+	payment := k.GetAllStoragePaymentInfo(ctx)
+
+	var spacePurchased int64
+	var spaceUsed int64
+	var activeUsers uint64
+
+	for _, info := range payment {
+		if info.End.Before(ctx.BlockTime()) {
+			continue
+		}
+		spacePurchased += info.SpaceAvailable
+		spaceUsed += info.SpaceUsed
+		activeUsers++
+	}
+
+	decSpent := sdk.NewDec(spacePurchased)
+	decUsed := sdk.NewDec(spaceUsed)
+
+	ratio := decUsed.Quo(decSpent).MulInt64(100)
+
+	return &types.QueryStorageStatsResponse{
+		Purchased:   uint64(spacePurchased),
+		Used:        uint64(spaceUsed),
+		UsedRatio:   ratio,
+		ActiveUsers: activeUsers,
+	}, nil
+}