changed state proof message to no longer be embedded (#4395)

algorand · Aug 12, 2022 · 3e048ee · 3e048ee
1 parent 5a852ba
commit 3e048ee
Show file tree

Hide file tree

Showing 7 changed files with 227 additions and 215 deletions.
diff --git a/daemon/algod/api/algod.oas2.json b/daemon/algod/api/algod.oas2.json
@@ -2683,42 +2683,7 @@
       ],
       "properties": {
         "Message": {
-          "description": "Represents the message that the state proofs are attesting to.",
-          "type": "object",
-          "required": [
-            "BlockHeadersCommitment",
-            "VotersCommitment",
-            "LnProvenWeight",
-            "FirstAttestedRound",
-            "LastAttestedRound"
-          ],
-          "properties": {
-            "BlockHeadersCommitment": {
-              "description": "The vector commitment root on all light block headers within a state proof interval.",
-              "type": "string",
-              "format": "byte"
-            },
-            "VotersCommitment": {
-              "description": "The vector commitment root of the top N accounts to sign the next StateProof.",
-              "type": "string",
-              "format": "byte"
-            },
-            "LnProvenWeight": {
-              "description": "An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof.",
-              "type": "integer",
-              "x-algorand-format": "uint64"
-            },
-            "FirstAttestedRound": {
-              "description": "The first round the message attests to.",
-              "type": "integer",
-              "x-algorand-format": "uint64"
-            },
-            "LastAttestedRound": {
-              "description": "The last round the message attests to.",
-              "type": "integer",
-              "x-algorand-format": "uint64"
-            }
-          }
+          "$ref": "#/definitions/StateProofMessage"
         },
         "StateProof": {
           "description": "The encoded StateProof for the message.",
@@ -2750,6 +2715,44 @@
           "format": "byte"
         }
       }
+    },
+    "StateProofMessage": {
+      "description": "Represents the message that the state proofs are attesting to.",
+      "type": "object",
+      "required": [
+        "BlockHeadersCommitment",
+        "VotersCommitment",
+        "LnProvenWeight",
+        "FirstAttestedRound",
+        "LastAttestedRound"
+      ],
+      "properties": {
+        "BlockHeadersCommitment": {
+          "description": "The vector commitment root on all light block headers within a state proof interval.",
+          "type": "string",
+          "format": "byte"
+        },
+        "VotersCommitment": {
+          "description": "The vector commitment root of the top N accounts to sign the next StateProof.",
+          "type": "string",
+          "format": "byte"
+        },
+        "LnProvenWeight": {
+          "description": "An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof.",
+          "type": "integer",
+          "x-algorand-format": "uint64"
+        },
+        "FirstAttestedRound": {
+          "description": "The first round the message attests to.",
+          "type": "integer",
+          "x-algorand-format": "uint64"
+        },
+        "LastAttestedRound": {
+          "description": "The last round the message attests to.",
+          "type": "integer",
+          "x-algorand-format": "uint64"
+        }
+      }
     }
   },
   "parameters": {

diff --git a/daemon/algod/api/algod.oas3.yml b/daemon/algod/api/algod.oas3.yml
@@ -1623,44 +1623,7 @@
         "description": "Represents a state proof and its corresponding message",
         "properties": {
           "Message": {
-            "description": "Represents the message that the state proofs are attesting to.",
-            "properties": {
-              "BlockHeadersCommitment": {
-                "description": "The vector commitment root on all light block headers within a state proof interval.",
-                "format": "byte",
-                "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
-                "type": "string"
-              },
-              "FirstAttestedRound": {
-                "description": "The first round the message attests to.",
-                "type": "integer",
-                "x-algorand-format": "uint64"
-              },
-              "LastAttestedRound": {
-                "description": "The last round the message attests to.",
-                "type": "integer",
-                "x-algorand-format": "uint64"
-              },
-              "LnProvenWeight": {
-                "description": "An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof.",
-                "type": "integer",
-                "x-algorand-format": "uint64"
-              },
-              "VotersCommitment": {
-                "description": "The vector commitment root of the top N accounts to sign the next StateProof.",
-                "format": "byte",
-                "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
-                "type": "string"
-              }
-            },
-            "required": [
-              "BlockHeadersCommitment",
-              "FirstAttestedRound",
-              "LastAttestedRound",
-              "LnProvenWeight",
-              "VotersCommitment"
-            ],
-            "type": "object"
+            "$ref": "#/components/schemas/StateProofMessage"
           },
           "StateProof": {
             "description": "The encoded StateProof for the message.",
@@ -1675,6 +1638,46 @@
         ],
         "type": "object"
       },
+      "StateProofMessage": {
+        "description": "Represents the message that the state proofs are attesting to.",
+        "properties": {
+          "BlockHeadersCommitment": {
+            "description": "The vector commitment root on all light block headers within a state proof interval.",
+            "format": "byte",
+            "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+            "type": "string"
+          },
+          "FirstAttestedRound": {
+            "description": "The first round the message attests to.",
+            "type": "integer",
+            "x-algorand-format": "uint64"
+          },
+          "LastAttestedRound": {
+            "description": "The last round the message attests to.",
+            "type": "integer",
+            "x-algorand-format": "uint64"
+          },
+          "LnProvenWeight": {
+            "description": "An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof.",
+            "type": "integer",
+            "x-algorand-format": "uint64"
+          },
+          "VotersCommitment": {
+            "description": "The vector commitment root of the top N accounts to sign the next StateProof.",
+            "format": "byte",
+            "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "BlockHeadersCommitment",
+          "FirstAttestedRound",
+          "LastAttestedRound",
+          "LnProvenWeight",
+          "VotersCommitment"
+        ],
+        "type": "object"
+      },
       "TealKeyValue": {
         "description": "Represents a key-value pair in an application store.",
         "properties": {

diff --git a/daemon/algod/api/algod2.oas2.json b/daemon/algod/api/algod2.oas2.json
diff --git a/daemon/algod/api/server/v2/generated/private/routes.go b/daemon/algod/api/server/v2/generated/private/routes.go
diff --git a/daemon/algod/api/server/v2/generated/private/types.go b/daemon/algod/api/server/v2/generated/private/types.go