feat: index cairovm errors (#1526)

* feat: index cairovm errors

* fmt

* cleanup

indexer/src/main.ts

@@ -3,7 +3,7 @@ import { padString, toHexString } from "./utils/hex.ts";
 import {
   ethValidationFailed,
   isKakarotTransaction,
-  isRevertedWithOutOfResources,
+  isReverted,
 } from "./utils/filter.ts";
 
 // Constants
@@ -256,7 +256,7 @@ function processTransactions(
   return (transactions ?? [])
     .filter(
       (tx) =>
-        isRevertedWithOutOfResources(tx.receipt) &&
+        isReverted(tx.receipt) &&
         isKakarotTransaction(tx.transaction),
     )
     .map((tx) => createProcessedTransaction(tx, blockInfo, cumulativeGasUsages))

indexer/src/types/interfaces.ts

@@ -41,8 +41,8 @@ export interface TransactionContext {
 export interface ExtendedJsonRpcTx extends JsonRpcTx {
   /** The y parity of the signature. */
   yParity?: string;
-  /** Indicates if the transaction is reverted due to running out of resources. */
-  isRunOutOfResources?: boolean;
+  /** Indicates the reverted message if the transaction was reverted. */
+  reverted?: string;
 }
 
 /**

indexer/src/types/transaction.ts

@@ -1,6 +1,6 @@
 // Utils
 import { padBigint, padBytes } from "../utils/hex.ts";
-import { isRevertedWithOutOfResources } from "../utils/filter.ts";
+import { isReverted } from "../utils/filter.ts";
 
 // Starknet
 import { Transaction, TransactionReceipt, uint256 } from "../deps.ts";
@@ -121,20 +121,19 @@ export function setYParityFlag(
 }
 
 /**
- * Adds the isRunOutOfResources flag to the transaction result if the transaction
- * was reverted due to running out of resources.
+ * Adds the reverted field to the transaction result if the transaction was reverted.
  *
  * @param receipt - The transaction receipt object.
  * @param result - The transaction result object in Ethereum format.
  */
-export function setFlagRunOutOfResources(
+export function setRevertedFlag(
   receipt: TransactionReceipt,
   result: ExtendedJsonRpcTx,
 ): void {
   // Check if the transaction was reverted due to running out of resources
-  if (isRevertedWithOutOfResources(receipt)) {
-    // Set the isRunOutOfResources flag to true in the result
-    result.isRunOutOfResources = true;
+  if (isReverted(receipt)) {
+    // Set the reverted field to the result
+    result.reverted = receipt.revertReason;
   }
 }
 
@@ -236,7 +235,7 @@ export function typedTransactionToEthTx({
 
   setYParityFlag(typedTransaction, jsonTx, result);
 
-  setFlagRunOutOfResources(receipt, result);
+  setRevertedFlag(receipt, result);
 
   return result;
 }

indexer/src/utils/filter.ts

@@ -69,16 +69,15 @@ export function ethValidationFailed(event: Event): boolean {
 }
 
 /**
- * Checks if a transaction receipt indicates that it was reverted due to running out of resources.
+ * Checks if a transaction receipt indicates that it was reverted.
  *
  * @param {TransactionReceipt} receipt - The transaction receipt to check.
- * @returns {boolean} - Returns true if the transaction was reverted due to out of resources, otherwise false.
+ * @returns {boolean} - Returns true if the transaction was reverted, otherwise false.
  */
-export function isRevertedWithOutOfResources(
+export function isReverted(
   receipt: TransactionReceipt,
 ): boolean {
   return (
-    receipt.executionStatus.includes("REVERTED") &&
-    (receipt.revertReason ?? "").includes("RunResources has no remaining steps")
+    receipt.executionStatus.includes("REVERTED")
   );
 }

indexer/tests/filter.test.ts

@@ -5,7 +5,7 @@ import {
 import {
   ethValidationFailed,
   isKakarotTransaction,
-  isRevertedWithOutOfResources,
+  isReverted,
 } from "../src/utils/filter.ts";
 import { Event, Transaction, TransactionReceipt } from "../src/deps.ts";
 
@@ -247,7 +247,7 @@ Deno.test(
 );
 
 Deno.test(
-  "isRevertedWithOutOfResources: true on status reverted and revert reason",
+  "isReverted: true on status reverted and revert reason",
   () => {
     const receipt: TransactionReceipt = {
       executionStatus: "EXECUTION_STATUS_REVERTED",
@@ -260,12 +260,12 @@ Deno.test(
       revertReason:
         "Could not reach the end of the program. RunResources has no remaining steps",
     };
-    assert(isRevertedWithOutOfResources(receipt));
+    assert(isReverted(receipt));
   },
 );
 
 Deno.test(
-  "isRevertedWithOutOfResources: false on status reverted and no revert reason",
+  "isReverted: true on status reverted and no revert reason",
   () => {
     const receipt: TransactionReceipt = {
       executionStatus: "EXECUTION_STATUS_REVERTED",
@@ -276,11 +276,11 @@ Deno.test(
       l2ToL1Messages: [],
       events: [],
     };
-    assertFalse(isRevertedWithOutOfResources(receipt));
+    assert(isReverted(receipt));
   },
 );
 
-Deno.test("isRevertedWithOutOfResources: false on status succeeded", () => {
+Deno.test("isReverted: false on status succeeded", () => {
   const receipt: TransactionReceipt = {
     executionStatus: "EXECUTION_STATUS_SUCCEEDED",
     transactionHash: "0x01",
@@ -292,11 +292,11 @@ Deno.test("isRevertedWithOutOfResources: false on status succeeded", () => {
     revertReason:
       "Could not reach the end of the program. RunResources has no remaining steps",
   };
-  assertFalse(isRevertedWithOutOfResources(receipt));
+  assertFalse(isReverted(receipt));
 });
 
 Deno.test(
-  "isRevertedWithOutOfResources: false on incorrect revert reason",
+  "isReverted: true no matter the revert reason if status is reverted",
   () => {
     const receipt: TransactionReceipt = {
       executionStatus: "EXECUTION_STATUS_REVERTED",
@@ -308,6 +308,6 @@ Deno.test(
       events: [],
       revertReason: "eth validation failed",
     };
-    assertFalse(isRevertedWithOutOfResources(receipt));
+    assert(isReverted(receipt));
   },
 );