feat: add get all tracked objects endpoint

Author: mgpai22

config.example.yaml

@@ -21,7 +21,9 @@ debug:
 server:
   listenAddress: "0.0.0.0"
   listenPort: 8080
-  enableDebug: true
+  enableDebug: false
+  defaultPageLimit: 50
+  maxPageLimit: 1000
 
 submit:
   url: "https://cardano-preview.blockfrost.io/api/v0/tx/submit"

internal/api/api.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"net/http"
 	"net/http/pprof"
+	"strconv"
 	"time"
 
 	"zenGate-Global/merkle-oracle-node/internal/config"
@@ -89,7 +90,8 @@ func Start(
 	// Health check endpoint
 	router.GET("/healthcheck", handleHealthcheck)
 
-	// Object endpoint
+	// Object endpoints
+	router.GET("/objects", handleGetAllObjectIDs)
 	router.GET("/objects/:id", handleGetObjectByID)
 
 	// Setup metrics endpoint
@@ -201,7 +203,13 @@ func handleGetObjectByID(c *gin.Context) {
 	if timestampParam != "" {
 		parsed, err := time.Parse(time.RFC3339, timestampParam)
 		if err != nil {
-			BadRequest(c, fmt.Errorf("invalid timestamp format, expected RFC3339 (e.g. 2024-01-15T10:30:00Z): %w", err))
+			BadRequest(
+				c,
+				fmt.Errorf(
+					"invalid timestamp format, expected RFC3339 (e.g. 2024-01-15T10:30:00Z): %w",
+					err,
+				),
+			)
 			return
 		}
 		targetTimestamp = &parsed
@@ -222,7 +230,11 @@ func handleGetObjectByID(c *gin.Context) {
 	var responseTimestamp time.Time
 
 	if targetTimestamp != nil {
-		objectValues, err = db.GetObjectValuesAtTimestamp(c.Request.Context(), id, *targetTimestamp)
+		objectValues, err = db.GetObjectValuesAtTimestamp(
+			c.Request.Context(),
+			id,
+			*targetTimestamp,
+		)
 		responseTimestamp = *targetTimestamp
 	} else {
 		objectValues, err = db.GetObjectCurrentValues(c.Request.Context(), id)
@@ -249,6 +261,85 @@ func handleGetObjectByID(c *gin.Context) {
 	c.JSON(http.StatusOK, response)
 }
 
+// handleGetAllObjectIDs godoc
+// @Summary      Get All Object IDs
+// @Description  Retrieves a paginated list of all tracked object IDs from the database.
+// @Tags         objects
+// @Accept       json
+// @Produce      json
+// @Param        limit   query     int     false  "Number of items per page (default: 20, max: 1000)"
+// @Param        offset  query     int     false  "Number of items to skip (default: 0)"
+// @Success      200  {object}  database.GetAllObjectIDsResult "Paginated list of object IDs"
+// @Failure      400  {object}  map[string]string "Invalid query parameters"
+// @Failure      500  {object}  map[string]string "Internal server error"
+// @Router       /objects [get]
+func handleGetAllObjectIDs(c *gin.Context) {
+	db := c.MustGet("db").(*database.Database)
+	cfg := c.MustGet("cfg").(*config.Config)
+
+	limitStr := c.Query("limit")
+	limit := cfg.Server.DefaultPageLimit
+	if limitStr != "" {
+		parsedLimit, err := strconv.Atoi(limitStr)
+		if err != nil {
+			BadRequest(
+				c,
+				fmt.Errorf("invalid limit parameter: must be a number"),
+			)
+			return
+		}
+		if parsedLimit <= 0 {
+			BadRequest(
+				c,
+				fmt.Errorf("invalid limit parameter: must be greater than 0"),
+			)
+			return
+		}
+		if parsedLimit > cfg.Server.MaxPageLimit {
+			BadRequest(
+				c,
+				fmt.Errorf(
+					"invalid limit parameter: maximum allowed is %d",
+					cfg.Server.MaxPageLimit,
+				),
+			)
+			return
+		}
+		limit = parsedLimit
+	}
+
+	offsetStr := c.Query("offset")
+	offset := 0
+	if offsetStr != "" {
+		parsedOffset, err := strconv.Atoi(offsetStr)
+		if err != nil {
+			BadRequest(
+				c,
+				fmt.Errorf("invalid offset parameter: must be a number"),
+			)
+			return
+		}
+		if parsedOffset < 0 {
+			BadRequest(
+				c,
+				fmt.Errorf(
+					"invalid offset parameter: must be greater than or equal to 0",
+				),
+			)
+			return
+		}
+		offset = parsedOffset
+	}
+
+	result, err := db.GetAllObjectIDs(c.Request.Context(), limit, offset)
+	if err != nil {
+		ServerError(c, fmt.Errorf("failed to get object IDs: %w", err))
+		return
+	}
+
+	c.JSON(http.StatusOK, result)
+}
+
 func ServerError(c *gin.Context, err error) {
 	logging.GetLogger().
 		Error("server error", "error", err, "path", c.Request.URL.Path)

internal/config/config.go

@@ -29,9 +29,11 @@ type Config struct {
 }
 
 type ServerConfig struct {
-	ListenAddress string `yaml:"listenAddress"`
-	ListenPort    int    `yaml:"listenPort"`
-	EnableDebug   bool   `yaml:"enableDebug"`
+	ListenAddress    string `yaml:"listenAddress"`
+	ListenPort       int    `yaml:"listenPort"`
+	EnableDebug      bool   `yaml:"enableDebug"`
+	DefaultPageLimit int    `yaml:"defaultPageLimit" envconfig:"SERVER_DEFAULT_PAGE_LIMIT"`
+	MaxPageLimit     int    `yaml:"maxPageLimit"     envconfig:"SERVER_MAX_PAGE_LIMIT"`
 }
 
 type IndexerConfig struct {
@@ -174,6 +176,13 @@ func (c *Config) setDefaults() {
 		c.Server.ListenPort = 8080
 	}
 
+	if c.Server.DefaultPageLimit == 0 {
+		c.Server.DefaultPageLimit = 50
+	}
+	if c.Server.MaxPageLimit == 0 {
+		c.Server.MaxPageLimit = 1000
+	}
+
 	// Network defaults
 	if c.Network == "" {
 		c.Network = network

internal/database/operation.go

@@ -460,6 +460,48 @@ func (d *Database) GetObjectByID(
 	return &obj, nil
 }
 
+type GetAllObjectIDsResult struct {
+	ObjectIDs []string `json:"objectIds"`
+	Total     int64    `json:"total"`
+	Limit     int      `json:"limit"`
+	Offset    int      `json:"offset"`
+	HasMore   bool     `json:"hasMore"`
+}
+
+// GetAllObjectIDs returns a paginated list of all tracked object IDs
+func (d *Database) GetAllObjectIDs(
+	ctx context.Context,
+	limit, offset int,
+) (*GetAllObjectIDsResult, error) {
+	var objectIDs []string
+	var total int64
+
+	// Get total count
+	if err := d.db.WithContext(ctx).
+		Model(&Object{}).
+		Count(&total).Error; err != nil {
+		return nil, fmt.Errorf("failed to count objects: %w", err)
+	}
+
+	// Get paginated object IDs
+	if err := d.db.WithContext(ctx).
+		Model(&Object{}).
+		Select("id").
+		Order("id ASC").
+		Limit(limit).
+		Offset(offset).
+		Pluck("id", &objectIDs).Error; err != nil {
+		return nil, fmt.Errorf("failed to get object IDs: %w", err)
+	}
+
+	return &GetAllObjectIDsResult{
+		ObjectIDs: objectIDs,
+		Total:     total,
+		Limit:     limit,
+		Offset:    offset,
+	}, nil
+}
+
 // GetObjectCurrentValues returns the current key-value pairs for an object as a flat map
 func (d *Database) GetObjectCurrentValues(
 	ctx context.Context,
@@ -477,7 +519,11 @@ func (d *Database) GetObjectCurrentValues(
 		Joins(`JOIN value ON value.value_hash = key.current_value_hash`).
 		Where(`key.object_id = ? AND key.deleted_at IS NULL AND NOT key.is_deleted`, id).
 		Scan(&rows).Error; err != nil {
-		return nil, fmt.Errorf("failed to get current values for object %s: %w", id, err)
+		return nil, fmt.Errorf(
+			"failed to get current values for object %s: %w",
+			id,
+			err,
+		)
 	}
 
 	out := make(map[string]any, len(rows))
@@ -486,7 +532,11 @@ func (d *Database) GetObjectCurrentValues(
 		dec := json.NewDecoder(bytes.NewReader(r.Raw))
 		dec.UseNumber()
 		if err := dec.Decode(&v); err != nil {
-			return nil, fmt.Errorf("failed to unmarshal value for key %s: %w", r.RawKey, err)
+			return nil, fmt.Errorf(
+				"failed to unmarshal value for key %s: %w",
+				r.RawKey,
+				err,
+			)
 		}
 		out[r.RawKey] = v
 	}
@@ -548,7 +598,11 @@ func (d *Database) GetObjectValuesAtTimestamp(
 		dec := json.NewDecoder(bytes.NewReader(r.Raw))
 		dec.UseNumber()
 		if err := dec.Decode(&v); err != nil {
-			return nil, fmt.Errorf("failed to unmarshal value for key %s: %w", r.RawKey, err)
+			return nil, fmt.Errorf(
+				"failed to unmarshal value for key %s: %w",
+				r.RawKey,
+				err,
+			)
 		}
 		out[r.RawKey] = v
 	}