extended error categories & code ranges implementation

Author: simsonraj

scripts/build.js

@@ -94,6 +94,10 @@ extensionsSpecsFiles.forEach(file => {
   extensionSpecs.push(parsed);
 });
 
+// Enhance the existing XErrorGroupsJSON extension with conditional validation for different error categories
+const enhancedErrorGroupSchema = JSON.parse(fs.readFileSync('src/extensions/schemas/x-error-category-ranges.json', 'utf8'));
+XErrorGroupsJSON.schema = enhancedErrorGroupSchema;
+
 extensionSpecs.push(XErrorGroupsJSON);
 
 let extensions = [];

src/extensions/components/execution-errors.yaml

@@ -1,24 +1,22 @@
 x-error-group:
   ExecutionErrors:
-    - code: -31800
+    - code: -31600
       message: "NONCE_TOO_LOW"
       data: "Transaction nonce is lower than the sender account's current nonce"
-    - code: -31801
+      x-error-category: "EXECUTION_ERRORS"
+    - code: -31601
       message: "NONCE_TOO_HIGH"
       data: "Transaction nonce is higher than the sender account's current nonce"
-    - code: -31802
+      x-error-category: "EXECUTION_ERRORS"
+    - code: -31602
       message: "EXECUTION_REVERTED"
       data: "Execution is reverted by REVERT Opcode"
-    - code: -31803
+      x-error-category: "EXECUTION_ERRORS"
+    - code: -31603
       message: "INVALID_OPCODE"
       data: "An invalid opcode was encountered during execution"
-    - code: -31804
+      x-error-category: "EXECUTION_ERRORS"
+    - code: -31604
       message: "OUT_OF_COUNTERS"
       data: "Not enough step counters to continue the execution"
-      x-metadata:
-        severity: "error"
-        must-implement: true
-        clients:
-          - "polygon-cdk":
-              - message: "Out of counters"
-              - version: ">=0.5.0"
+      x-error-category: "EXECUTION_ERRORS"

src/extensions/components/gas-error-groups.yaml

@@ -3,30 +3,40 @@ x-error-group:
     - code: -31800
       message: "GAS_TOO_LOW"
       data: "Transaction gas is too low / intrinsic gas too low"
+      x-error-category: "GAS_ERRORS"
     - code: -31801
       message: "OUT_OF_GAS"
       data: "The transaction ran out of gas"
+      x-error-category: "GAS_ERRORS"
     - code: -31802
       message: "GAS_PRICE_TOO_LOW"
       data: "Gas price too low / gas price below configured minimum gas price"
+      x-error-category: "GAS_ERRORS"
     - code: -31803
       message: "BLOCK_GAS_LIMIT_EXCEEDED"
       data: "Tx gas limit exceeds max block gas limit / intrinsic gas exceeds gas limit"
+      x-error-category: "GAS_ERRORS"
     - code: -31804
       message: "FEE_CAP_EXCEEDED"
       data: "Tx fee exceeds cap / max priority fee per gas higher than max fee per gas"
+      x-error-category: "GAS_ERRORS"
     - code: -31805
       message: "GAS_OVERFLOW"
       data: "Gas overflow error"
+      x-error-category: "GAS_ERRORS"
     - code: -31806
       message: "INSUFFICIENT_TRANSACTION_PRICE"
       data: "Transaction price must be greater than base fee / max fee per gas less than block base fee"
+      x-error-category: "GAS_ERRORS"
     - code: -31807
       message: "INVALID_MAX_PRIORITY_FEE_PER_GAS"
       data: "Max priority fee per gas higher than 2^256-1"
+      x-error-category: "GAS_ERRORS"
     - code: -31808
       message: "INVALID_MAX_FEE_PER_GAS"
       data: "Max fee per gas higher than 2^256-1"
+      x-error-category: "GAS_ERRORS"
     - code: -31809
       message: "INSUFFICIENT_FUNDS"
       data: "Insufficient funds for gas * price + value"
+      x-error-category: "GAS_ERRORS"

src/extensions/schemas/x-error-category-ranges.json

@@ -0,0 +1,57 @@
+{
+  "type": "array",
+  "items": {
+    "oneOf": [
+      {
+        "type": "array",
+        "items": {
+          "allOf": [
+            {
+              "type": "object",
+              "properties": {
+                "code": { "type": "integer", "description": "The code of the error." },
+                "message": { "type": "string", "description": "The message of the error." },
+                "data": {"description": "The data of the error." },
+                "x-error-category": { "type": "string"}
+              },
+              "required": ["code", "message"]
+            },
+            {
+              "if": {
+                "properties": {
+                  "x-error-category": { "const": "GAS_ERRORS" }
+                },
+                "required": ["x-error-category"]
+              },
+              "then": {
+                "properties": {
+                  "code": { "type": "integer", "minimum": -31999, "maximum": -31800 }
+                }
+              }
+            },
+            {
+              "if": {
+                "properties": {
+                  "x-error-category": { "const": "EXECUTION_ERRORS" }
+                },
+                "required": ["x-error-category"]
+              },
+              "then": {
+                "properties": {
+                  "code": { "type": "integer", "minimum": -31799, "maximum": -31600 }
+                }
+              }
+            }
+          ]
+        }
+      },
+      {
+        "type": "object",
+        "properties": {
+          "$ref": { "type": "string" }
+        },
+        "required": ["$ref"]
+      }
+    ]
+  }
+}