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

Author: agodnic

api/converter_utils.go

@@ -800,16 +800,37 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 
 	// Integer
 	filter.Limit = min(uintOrDefaultValue(params.Limit, si.opts.DefaultBlocksLimit), si.opts.MaxBlocksLimit)
+	// If min/max are mixed up
+	//
+	// This check is performed here instead of in validateBlockFilter because
+	// when converting params into a filter, the next token is merged with params.MinRound.
+	if params.MinRound != nil && params.MaxRound != nil && *params.MinRound > *params.MaxRound {
+		errorArr = append(errorArr, errInvalidRoundMinMax)
+	}
+	filter.MaxRound = params.MaxRound
+	filter.MinRound = params.MinRound
 
 	// String
 	if params.Next != nil {
 		n, err := idb.DecodeBlockRowNext(*params.Next)
 		if err != nil {
 			errorArr = append(errorArr, fmt.Sprintf("%s: %v", errUnableToParseNext, err))
 		}
-		filter.MinRound = max(filter.MinRound, n+1)
+		// Set the MinRound
+		if filter.MinRound == nil {
+			filter.MinRound = uint64Ptr(n + 1)
+		} else {
+			filter.MinRound = uint64Ptr(max(*filter.MinRound, n+1))
+		}
 	}
 
+	// If there were any errorArr while setting up the BlockFilter, return now.
+	if len(errorArr) > 0 {
+		err = errors.New("invalid input: " + strings.Join(errorArr, ", "))
+
+		// clear out the intermediates.
+		filter = idb.BlockFilter{}
+	}
 	return
 }
 

api/generated/v2/routes.go

@@ -48,6 +48,11 @@ type ServerImplementation struct {
 func validateBlockFilter(filter *idb.BlockFilter) error {
 	var errorArr = make([]string, 0)
 
+	if (filter.MaxRound != nil && *filter.MaxRound > math.MaxInt64) ||
+		(filter.MinRound != nil && *filter.MinRound > math.MaxInt64) {
+		errorArr = append(errorArr, errValueExceedingInt64)
+	}
+
 	if len(errorArr) > 0 {
 		return errors.New("invalid input: " + strings.Join(errorArr, ", "))
 	}

api/generated/v2/types.go

@@ -872,6 +872,12 @@
           },
           {
             "$ref": "#/parameters/next"
+          },
+          {
+            "$ref": "#/parameters/min-round"
+          },
+          {
+            "$ref": "#/parameters/max-round"
           }
         ],
         "responses": {

api/handlers.go

@@ -4823,6 +4823,22 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "description": "Include results at or after the specified min-round.",
+            "in": "query",
+            "name": "min-round",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "description": "Include results at or before the specified max-round.",
+            "in": "query",
+            "name": "max-round",
+            "schema": {
+              "type": "integer"
+            }
           }
         ],
         "responses": {

api/indexer.oas2.json

@@ -231,7 +231,8 @@ type GetBlockOptions struct {
 // BlockFilter is a parameter object with all the block filter options.
 type BlockFilter struct {
 	Limit    uint64
-	MinRound uint64
+	MaxRound *uint64
+	MinRound *uint64
 }
 
 // TransactionFilter is a parameter object with all the transaction filter options.

api/indexer.oas3.yml

@@ -725,14 +725,22 @@ func buildTransactionQuery(tf idb.TransactionFilter) (query string, whereArgs []
 
 func buildBlockQuery(bf idb.BlockFilter) (query string, whereArgs []interface{}, err error) {
 
+	// Compute the terms in the WHERE clause
 	whereParts := make([]string, 0)
 	whereArgs = make([]interface{}, 0)
-	partNumber := 1
+	{
+		partNumber := 1
 
-	if bf.MinRound != 0 {
-		whereParts = append(whereParts, fmt.Sprintf("round >= $%d", partNumber))
-		whereArgs = append(whereArgs, bf.MinRound)
-		partNumber++
+		if bf.MaxRound != nil {
+			whereParts = append(whereParts, fmt.Sprintf("round <= $%d", partNumber))
+			whereArgs = append(whereArgs, *bf.MaxRound)
+			partNumber++
+		}
+		if bf.MinRound != nil {
+			whereParts = append(whereParts, fmt.Sprintf("round >= $%d", partNumber))
+			whereArgs = append(whereArgs, *bf.MinRound)
+			partNumber++
+		}
 	}
 
 	// SELECT, FROM