Add min/max time parameters to GET /v2/blocks

AlgoNode · Oct 16, 2024 · ecf2f87 · ecf2f87
1 parent 8e5e975
commit ecf2f87
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 11 deletions.
diff --git a/api/converter_utils.go b/api/converter_utils.go
@@ -824,6 +824,14 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 		}
 	}
 
+	// Time
+	if params.AfterTime != nil {
+		filter.AfterTime = *params.AfterTime
+	}
+	if params.BeforeTime != nil {
+		filter.BeforeTime = *params.BeforeTime
+	}
+
 	// If there were any errorArr while setting up the BlockFilter, return now.
 	if len(errorArr) > 0 {
 		err = errors.New("invalid input: " + strings.Join(errorArr, ", "))

diff --git a/api/error_messages.go b/api/error_messages.go
@@ -11,6 +11,7 @@ import (
 const (
 	errInvalidRoundAndMinMax           = "cannot specify round and min-round/max-round"
 	errInvalidRoundMinMax              = "min-round must be less than max-round"
+	errInvalidTimeMinMax               = "after-time must be less than before-time"
 	errUnableToParseAddress            = "unable to parse address"
 	errInvalidCreatorAddress           = "found an invalid creator address"
 	errUnableToParseBase64             = "unable to parse base64 data"

diff --git a/api/generated/v2/routes.go b/api/generated/v2/routes.go
diff --git a/api/generated/v2/types.go b/api/generated/v2/types.go
diff --git a/api/handlers.go b/api/handlers.go
@@ -48,11 +48,17 @@ type ServerImplementation struct {
 func validateBlockFilter(filter *idb.BlockFilter) error {
 	var errorArr = make([]string, 0)
 
+	// Int64 overflows
 	if (filter.MaxRound != nil && *filter.MaxRound > math.MaxInt64) ||
 		(filter.MinRound != nil && *filter.MinRound > math.MaxInt64) {
 		errorArr = append(errorArr, errValueExceedingInt64)
 	}
 
+	// Time
+	if !filter.AfterTime.IsZero() && !filter.BeforeTime.IsZero() && filter.AfterTime.After(filter.BeforeTime) {
+		errorArr = append(errorArr, errInvalidTimeMinMax)
+	}
+
 	if len(errorArr) > 0 {
 		return errors.New("invalid input: " + strings.Join(errorArr, ", "))
 	}

diff --git a/api/indexer.oas2.json b/api/indexer.oas2.json
@@ -878,6 +878,12 @@
           },
           {
             "$ref": "#/parameters/max-round"
+          },
+          {
+            "$ref": "#/parameters/before-time"
+          },
+          {
+            "$ref": "#/parameters/after-time"
           }
         ],
         "responses": {

diff --git a/api/indexer.oas3.yml b/api/indexer.oas3.yml
@@ -4839,6 +4839,28 @@
             "schema": {
               "type": "integer"
             }
+          },
+          {
+            "description": "Include results before the given time. Must be an RFC 3339 formatted string.",
+            "in": "query",
+            "name": "before-time",
+            "schema": {
+              "format": "date-time",
+              "type": "string",
+              "x-algorand-format": "RFC3339 String"
+            },
+            "x-algorand-format": "RFC3339 String"
+          },
+          {
+            "description": "Include results after the given time. Must be an RFC 3339 formatted string.",
+            "in": "query",
+            "name": "after-time",
+            "schema": {
+              "format": "date-time",
+              "type": "string",
+              "x-algorand-format": "RFC3339 String"
+            },
+            "x-algorand-format": "RFC3339 String"
           }
         ],
         "responses": {

diff --git a/idb/idb.go b/idb/idb.go
@@ -230,9 +230,11 @@ type GetBlockOptions struct {
 
 // BlockFilter is a parameter object with all the block filter options.
 type BlockFilter struct {
-	Limit    uint64
-	MaxRound *uint64
-	MinRound *uint64
+	Limit      uint64
+	MaxRound   *uint64
+	MinRound   *uint64
+	AfterTime  time.Time
+	BeforeTime time.Time
 }
 
 // TransactionFilter is a parameter object with all the transaction filter options.

diff --git a/idb/postgres/postgres.go b/idb/postgres/postgres.go
@@ -741,6 +741,22 @@ func buildBlockQuery(bf idb.BlockFilter) (query string, whereArgs []interface{},
 			whereParts = append(whereParts, fmt.Sprintf("round >= $%d", partNumber))
 			whereArgs = append(whereArgs, *bf.MinRound)
 		}
+		if !bf.AfterTime.IsZero() {
+			partNumber++
+			whereParts = append(
+				whereParts,
+				fmt.Sprintf("round >= (SELECT tmp.round FROM block_header tmp WHERE tmp.realtime > $%d ORDER BY tmp.realtime ASC, tmp.round ASC LIMIT 1)", partNumber),
+			)
+			whereArgs = append(whereArgs, bf.AfterTime)
+		}
+		if !bf.BeforeTime.IsZero() {
+			partNumber++
+			whereParts = append(
+				whereParts,
+				fmt.Sprintf("round <= (SELECT tmp.round FROM block_header tmp WHERE tmp.realtime < $%d ORDER BY tmp.realtime DESC, tmp.round DESC LIMIT 1)", partNumber),
+			)
+			whereArgs = append(whereArgs, bf.BeforeTime)
+		}
 	}
 
 	// SELECT, FROM