Add parameters to endpoint GET /v2/blocks

Add `updates` and `participation` parameters to the endpoint `GET /v2/blocks`.
AlgoNode · Oct 22, 2024 · 30fec05 · 30fec05
1 parent d8c260c
commit 30fec05
Show file tree

Hide file tree

Showing 7 changed files with 571 additions and 411 deletions.
diff --git a/api/converter_utils.go b/api/converter_utils.go
@@ -843,6 +843,26 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 
 	// Address list
 	{
+		numParticipationFilters := 0
+		if params.Proposer != nil {
+			numParticipationFilters++
+		}
+		if params.Expired != nil {
+			numParticipationFilters++
+		}
+		if params.Absent != nil {
+			numParticipationFilters++
+		}
+		if params.Updates != nil {
+			numParticipationFilters++
+		}
+		if params.Participation != nil {
+			numParticipationFilters++
+		}
+		if numParticipationFilters > 1 {
+			errorArr = append(errorArr, "only one of `proposer`, `expired`, `absent`, `updates`, or `participation` can be specified")
+		}
+
 		filter.Proposers = make(map[sdk.Address]struct{}, 0)
 		if params.Proposer != nil {
 			for _, s := range *params.Proposer {
@@ -869,6 +889,27 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 				filter.AbsentParticipationAccounts[addr] = struct{}{}
 			}
 		}
+
+		// Updates = absent || expired
+		if params.Updates != nil {
+			for _, s := range *params.Updates {
+				var addr sdk.Address
+				addr, errorArr = decodeSdkAddress(s, "updates", errorArr)
+				filter.AbsentParticipationAccounts[addr] = struct{}{}
+				filter.ExpiredParticipationAccounts[addr] = struct{}{}
+			}
+		}
+
+		// Participation = proposer || absent || expired
+		if params.Participation != nil {
+			for _, s := range *params.Participation {
+				var addr sdk.Address
+				addr, errorArr = decodeSdkAddress(s, "participation", errorArr)
+				filter.Proposers[addr] = struct{}{}
+				filter.AbsentParticipationAccounts[addr] = struct{}{}
+				filter.ExpiredParticipationAccounts[addr] = struct{}{}
+			}
+		}
 	}
 
 	// If there were any errorArr while setting up the BlockFilter, return now.

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
@@ -893,6 +893,12 @@
           },
           {
             "$ref": "#/parameters/absent"
+          },
+          {
+            "$ref": "#/parameters/updates"
+          },
+          {
+            "$ref": "#/parameters/participation"
           }
         ],
         "responses": {
@@ -2735,6 +2741,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
+    },
     "absent": {
       "type": "array",
       "items": {
@@ -2757,14 +2774,25 @@
       "in": "query",
       "required": false
     },
-    "proposer": {
+    "updates": {
       "type": "array",
       "items": {
         "type": "string",
         "x-algorand-format": "Address"
       },
-      "description": "Block proposer. Comma separated list of addresses.",
-      "name": "proposer",
+      "description": "Expired or absent participation accounts. Comma separated list of addresses.",
+      "name": "updates",
+      "in": "query",
+      "required": false
+    },
+    "participation": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "x-algorand-format": "Address"
+      },
+      "description": "Proposer, expired or absent participation accounts. Comma separated list of addresses.",
+      "name": "participation",
       "in": "query",
       "required": false
     },

diff --git a/api/indexer.oas3.yml b/api/indexer.oas3.yml
@@ -231,6 +231,20 @@
         },
         "x-algorand-format": "base64"
       },
+      "participation": {
+        "description": "Proposer, expired or absent participation accounts. Comma separated list of addresses.",
+        "explode": false,
+        "in": "query",
+        "name": "participation",
+        "schema": {
+          "items": {
+            "type": "string",
+            "x-algorand-format": "Address"
+          },
+          "type": "array"
+        },
+        "style": "form"
+      },
       "proposer": {
         "description": "Block proposer. Comma separated list of addresses.",
         "explode": false,
@@ -316,6 +330,20 @@
         "schema": {
           "type": "string"
         }
+      },
+      "updates": {
+        "description": "Expired or absent participation accounts. Comma separated list of addresses.",
+        "explode": false,
+        "in": "query",
+        "name": "updates",
+        "schema": {
+          "items": {
+            "type": "string",
+            "x-algorand-format": "Address"
+          },
+          "type": "array"
+        },
+        "style": "form"
       }
     },
     "responses": {
@@ -4945,6 +4973,34 @@
               "type": "array"
             },
             "style": "form"
+          },
+          {
+            "description": "Expired or absent participation accounts. Comma separated list of addresses.",
+            "explode": false,
+            "in": "query",
+            "name": "updates",
+            "schema": {
+              "items": {
+                "type": "string",
+                "x-algorand-format": "Address"
+              },
+              "type": "array"
+            },
+            "style": "form"
+          },
+          {
+            "description": "Proposer, expired or absent participation accounts. Comma separated list of addresses.",
+            "explode": false,
+            "in": "query",
+            "name": "participation",
+            "schema": {
+              "items": {
+                "type": "string",
+                "x-algorand-format": "Address"
+              },
+              "type": "array"
+            },
+            "style": "form"
           }
         ],
         "responses": {