Add proposer parameter to GET /v2/blocks

AlgoNode · Oct 17, 2024 · 3a92111 · 3a92111
1 parent ecf2f87
commit 3a92111
Show file tree

Hide file tree

Showing 11 changed files with 491 additions and 397 deletions.
diff --git a/api/converter_utils.go b/api/converter_utils.go
@@ -34,6 +34,15 @@ func decodeDigest(str *string, field string, errorArr []string) (string, []strin
 	return "", errorArr
 }
 
+// decodeSdkAddress returns the sdk.Address representation of the input string, or appends an error to errorArr
+func decodeSdkAddress(str string, field string, errorArr []string) (sdk.Address, []string) {
+	addr, err := sdk.DecodeAddress(str)
+	if err != nil {
+		return sdk.ZeroAddress, append(errorArr, fmt.Sprintf("%s '%s': %v", errUnableToParseAddress, field, err))
+	}
+	return addr, errorArr
+}
+
 // decodeAddress returns the byte representation of the input string, or appends an error to errorArr
 func decodeAddress(str *string, field string, errorArr []string) ([]byte, []string) {
 	if str != nil {
@@ -832,6 +841,18 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 		filter.BeforeTime = *params.BeforeTime
 	}
 
+	// Address list
+	{
+		filter.Proposers = make(map[sdk.Address]struct{}, 0)
+		if params.Proposer != nil {
+			for _, s := range *params.Proposer {
+				var addr sdk.Address
+				addr, errorArr = decodeSdkAddress(s, "proposer", errorArr)
+				filter.Proposers[addr] = struct{}{}
+			}
+		}
+	}
+
 	// 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/generated/common/routes.go b/api/generated/common/routes.go
diff --git a/api/generated/common/types.go b/api/generated/common/types.go
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/indexer.oas2.json b/api/indexer.oas2.json
@@ -884,6 +884,9 @@
           },
           {
             "$ref": "#/parameters/after-time"
+          },
+          {
+            "$ref": "#/parameters/proposer"
           }
         ],
         "responses": {
@@ -2726,6 +2729,17 @@
     }
   },
   "parameters": {
+    "proposer": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "x-algorand-format": "Address"
+      },
+      "description": "Block proposer. Comma separated list of addresses.",
+      "name": "proposer",
+      "in": "query",
+      "required": false
+    },
     "account-id": {
       "type": "string",
       "description": "account string",

diff --git a/api/indexer.oas3.yml b/api/indexer.oas3.yml
@@ -203,6 +203,20 @@
         },
         "x-algorand-format": "base64"
       },
+      "proposer": {
+        "description": "Block proposer. Comma separated list of addresses.",
+        "explode": false,
+        "in": "query",
+        "name": "proposer",
+        "schema": {
+          "items": {
+            "type": "string",
+            "x-algorand-format": "Address"
+          },
+          "type": "array"
+        },
+        "style": "form"
+      },
       "rekey-to": {
         "description": "Include results which include the rekey-to field.",
         "in": "query",
@@ -4861,6 +4875,20 @@
               "x-algorand-format": "RFC3339 String"
             },
             "x-algorand-format": "RFC3339 String"
+          },
+          {
+            "description": "Block proposer. Comma separated list of addresses.",
+            "explode": false,
+            "in": "query",
+            "name": "proposer",
+            "schema": {
+              "items": {
+                "type": "string",
+                "x-algorand-format": "Address"
+              },
+              "type": "array"
+            },
+            "style": "form"
           }
         ],
         "responses": {

diff --git a/idb/idb.go b/idb/idb.go
@@ -235,6 +235,7 @@ type BlockFilter struct {
 	MinRound   *uint64
 	AfterTime  time.Time
 	BeforeTime time.Time
+	Proposers  map[sdk.Address]struct{}
 }
 
 // TransactionFilter is a parameter object with all the transaction filter options.

diff --git a/idb/postgres/internal/schema/setup_postgres.sql b/idb/postgres/internal/schema/setup_postgres.sql
@@ -5,7 +5,8 @@ CREATE TABLE public.block_header (
     rewardslevel INT8 NOT NULL,
     header JSONB NOT NULL,
     CONSTRAINT block_header_pkey PRIMARY KEY (round ASC),
-    INDEX block_header_time (realtime ASC)
+    INDEX block_header_time (realtime ASC),
+    INDEX block_header_idx_proposer (((header->'prp')::TEXT), round) WHERE (header->'prp') IS NOT NULL
 );
 
 CREATE TABLE public.txn (

diff --git a/idb/postgres/internal/schema/setup_postgres_sql.go b/idb/postgres/internal/schema/setup_postgres_sql.go
diff --git a/idb/postgres/postgres.go b/idb/postgres/postgres.go
@@ -757,6 +757,16 @@ func buildBlockQuery(bf idb.BlockFilter) (query string, whereArgs []interface{},
 			)
 			whereArgs = append(whereArgs, bf.BeforeTime)
 		}
+		if len(bf.Proposers) > 0 {
+			var proposersStr []string
+			for addr := range bf.Proposers {
+				proposersStr = append(proposersStr, `'"`+addr.String()+`"'`)
+			}
+			whereParts = append(
+				whereParts,
+				fmt.Sprintf("( (header->'prp') IS NOT NULL AND ((header->'prp')::TEXT IN (%s)) )", strings.Join(proposersStr, ",")),
+			)
+		}
 	}
 
 	// SELECT, FROM