algod: Don't return a top level array from algod (#5404)

algorand · May 19, 2023 · a497df0 · a497df0
1 parent b684243
commit a497df0
Show file tree

Hide file tree

Showing 11 changed files with 956 additions and 914 deletions.
diff --git a/daemon/algod/api/algod.oas2.json b/daemon/algod/api/algod.oas2.json
@@ -1564,7 +1564,7 @@
         ],
         "responses": {
           "200": {
-            "$ref": "#/responses/TransactionGroupLedgerStateDeltaForRoundResponse"
+            "$ref": "#/responses/TransactionGroupLedgerStateDeltasForRoundResponse"
           },
           "401": {
             "description": "Invalid API Token",
@@ -4040,12 +4040,20 @@
         "$ref": "#/definitions/LedgerStateDelta"
       }
     },
-    "TransactionGroupLedgerStateDeltaForRoundResponse": {
+    "TransactionGroupLedgerStateDeltasForRoundResponse": {
       "description": "Response containing all ledger state deltas for transaction groups, with their associated Ids, in a single round.",
       "schema": {
-        "type": "array",
-        "items": {
-          "$ref": "#/definitions/LedgerStateDeltaForTransactionGroup"
+        "type": "object",
+        "required": [
+          "deltas"
+        ],
+        "properties": {
+          "deltas": {
+            "type": "array",
+            "items": {
+              "$ref": "#/definitions/LedgerStateDeltaForTransactionGroup"
+            }
+          }
         }
       }
     },

diff --git a/daemon/algod/api/algod.oas3.yml b/daemon/algod/api/algod.oas3.yml
@@ -857,14 +857,22 @@
         },
         "description": "Supply represents the current supply of MicroAlgos in the system."
       },
-      "TransactionGroupLedgerStateDeltaForRoundResponse": {
+      "TransactionGroupLedgerStateDeltasForRoundResponse": {
         "content": {
           "application/json": {
             "schema": {
-              "items": {
-                "$ref": "#/components/schemas/LedgerStateDeltaForTransactionGroup"
+              "properties": {
+                "deltas": {
+                  "items": {
+                    "$ref": "#/components/schemas/LedgerStateDeltaForTransactionGroup"
+                  },
+                  "type": "array"
+                }
               },
-              "type": "array"
+              "required": [
+                "deltas"
+              ],
+              "type": "object"
             }
           }
         },
@@ -4143,18 +4151,34 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "items": {
-                    "$ref": "#/components/schemas/LedgerStateDeltaForTransactionGroup"
+                  "properties": {
+                    "deltas": {
+                      "items": {
+                        "$ref": "#/components/schemas/LedgerStateDeltaForTransactionGroup"
+                      },
+                      "type": "array"
+                    }
                   },
-                  "type": "array"
+                  "required": [
+                    "deltas"
+                  ],
+                  "type": "object"
                 }
               },
               "application/msgpack": {
                 "schema": {
-                  "items": {
-                    "$ref": "#/components/schemas/LedgerStateDeltaForTransactionGroup"
+                  "properties": {
+                    "deltas": {
+                      "items": {
+                        "$ref": "#/components/schemas/LedgerStateDeltaForTransactionGroup"
+                      },
+                      "type": "array"
+                    }
                   },
-                  "type": "array"
+                  "required": [
+                    "deltas"
+                  ],
+                  "type": "object"
                 }
               }
             },

diff --git a/daemon/algod/api/server/v2/generated/data/routes.go b/daemon/algod/api/server/v2/generated/data/routes.go
diff --git a/daemon/algod/api/server/v2/generated/experimental/routes.go b/daemon/algod/api/server/v2/generated/experimental/routes.go
diff --git a/daemon/algod/api/server/v2/generated/model/types.go b/daemon/algod/api/server/v2/generated/model/types.go
diff --git a/daemon/algod/api/server/v2/generated/nonparticipating/private/routes.go b/daemon/algod/api/server/v2/generated/nonparticipating/private/routes.go
diff --git a/daemon/algod/api/server/v2/generated/nonparticipating/public/routes.go b/daemon/algod/api/server/v2/generated/nonparticipating/public/routes.go
diff --git a/daemon/algod/api/server/v2/generated/participating/private/routes.go b/daemon/algod/api/server/v2/generated/participating/private/routes.go
diff --git a/daemon/algod/api/server/v2/generated/participating/public/routes.go b/daemon/algod/api/server/v2/generated/participating/public/routes.go
diff --git a/daemon/algod/api/server/v2/handlers.go b/daemon/algod/api/server/v2/handlers.go
@@ -1745,7 +1745,12 @@ func (v2 *Handlers) GetTransactionGroupLedgerStateDeltasForRound(ctx echo.Contex
 	if err != nil {
 		return notFound(ctx, err, errFailedRetrievingStateDelta, v2.Log)
 	}
-	data, err := encode(handle, deltas)
+	response := struct {
+		Deltas []eval.TxnGroupDeltaWithIds
+	}{
+		Deltas: deltas,
+	}
+	data, err := encode(handle, response)
 	if err != nil {
 		return internalError(ctx, err, errFailedToEncodeResponse, v2.Log)
 	}

diff --git a/daemon/algod/api/server/v2/test/handlers_test.go b/daemon/algod/api/server/v2/test/handlers_test.go
@@ -2114,12 +2114,12 @@ func TestDeltasForTxnGroup(t *testing.T) {
 	)
 	require.NoError(t, err)
 
-	var roundResponse model.TransactionGroupLedgerStateDeltaForRoundResponse
+	var roundResponse model.TransactionGroupLedgerStateDeltasForRoundResponse
 	err = json.Unmarshal(rec.Body.Bytes(), &roundResponse)
 	require.NoError(t, err)
-	require.Equal(t, 1, len(roundResponse))
-	require.Equal(t, []string{txn1.ID().String()}, roundResponse[0].Ids)
-	hdr, ok := roundResponse[0].Delta["Hdr"].(map[string]interface{})
+	require.Equal(t, 1, len(roundResponse.Deltas))
+	require.Equal(t, []string{txn1.ID().String()}, roundResponse.Deltas[0].Ids)
+	hdr, ok := roundResponse.Deltas[0].Delta["Hdr"].(map[string]interface{})
 	require.True(t, ok)
 	require.Equal(t, delta1.Hdr.Round, basics.Round(hdr["rnd"].(float64)))