feat(svm): query events script (#804)

* feat(svm): add query events script

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

* refactor: organize

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

* feat: unused import

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

* feat(svm): parse ids

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

* Update src/svm/solanaProgramUtils.ts

Co-authored-by: Reinis Martinsons <77973553+Reinis-FRP@users.noreply.github.com>

* fix: starts with

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

* refactor: comment

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

* refactor: fix comment

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>

---------

Signed-off-by: Pablo Maldonado <pablomaldonadoturci@gmail.com>
Co-authored-by: Reinis Martinsons <77973553+Reinis-FRP@users.noreply.github.com>

Author: md0x

Anchor.toml

@@ -22,6 +22,7 @@ wallet = "test/svm/keys/localnet-wallet.json"
 
 [scripts]
 test = "anchor run generateExternalTypes && yarn run ts-mocha -p ./tsconfig.json -t 1000000 test/svm/**/*.ts"
+queryEvents = "NODE_NO_WARNINGS=1 yarn run ts-node ./scripts/svm/queryEvents.ts"
 initialize = "NODE_NO_WARNINGS=1 yarn run ts-node  ./scripts/svm/initialize.ts"
 queryState = "NODE_NO_WARNINGS=1 yarn run ts-node ./scripts/svm/queryState.ts"
 enableRoute = "NODE_NO_WARNINGS=1 yarn run ts-node ./scripts/svm/enableRoute.ts"

scripts/svm/queryEvents.ts

@@ -0,0 +1,49 @@
+// This script queries the events of the spoke pool and prints them in a human readable format.
+import * as anchor from "@coral-xyz/anchor";
+import { AnchorProvider, Program } from "@coral-xyz/anchor";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { readProgramEvents, stringifyCpiEvent } from "../../src/svm";
+import { SvmSpoke } from "../../target/types/svm_spoke";
+
+// Set up the provider
+const provider = AnchorProvider.env();
+anchor.setProvider(provider);
+const idl = require("../../target/idl/svm_spoke.json");
+const program = new Program<SvmSpoke>(idl, provider);
+const programId = program.programId;
+console.log("SVM-Spoke Program ID:", programId.toString());
+
+const argvPromise = yargs(hideBin(process.argv)).option("eventName", {
+  type: "string",
+  demandOption: false,
+  describe: "Name of the event to query",
+  choices: [
+    "any",
+    "filledV3Relay",
+    "v3FundsDeposited",
+    "enabledDepositRoute",
+    "relayedRootBundle",
+    "executedRelayerRefundRoot",
+    "bridgedToHubPool",
+    "pausedDeposits",
+    "pausedFills",
+    "setXDomainAdmin",
+    "emergencyDeletedRootBundle",
+    "requestedV3SlowFill",
+    "claimedRelayerRefund",
+    "tokensBridged",
+  ],
+}).argv;
+
+async function queryEvents(): Promise<void> {
+  const argv = await argvPromise;
+  const eventName = argv.eventName || "any";
+  const events = await readProgramEvents(provider.connection, program, "confirmed");
+  const filteredEvents = events.filter((event) => (eventName == "any" ? true : event.name == eventName));
+  const formattedEvents = filteredEvents.map((event) => stringifyCpiEvent(event));
+  console.log(JSON.stringify(formattedEvents, null, 2));
+}
+
+// Run the queryEvents function
+queryEvents();

src/svm/solanaProgramUtils.ts

@@ -1,4 +1,4 @@
-import { Idl, Program, utils, web3 } from "@coral-xyz/anchor";
+import { BN, Idl, Program, utils, web3 } from "@coral-xyz/anchor";
 import {
   ConfirmedSignatureInfo,
   Connection,
@@ -8,6 +8,8 @@ import {
   SignaturesForAddressOptions,
 } from "@solana/web3.js";
 import { EventType } from "../types/svm";
+import { publicKeyToEvmAddress } from "./conversionUtils";
+import { deserialize } from "borsh";
 
 /**
  * Finds a program address with a given label and optional extra seeds.
@@ -189,3 +191,69 @@ export async function subscribeToCpiEventsForProgram(
 
   return subscriptionId;
 }
+
+/**
+ * Class for DepositId.
+ */
+class DepositId {
+  value: Uint8Array; // Fixed-length array as Uint8Array
+
+  constructor(properties: { value: Uint8Array }) {
+    this.value = properties.value;
+  }
+}
+
+/**
+ * Borsh schema for deserializing DepositId.
+ */
+const depositIdSchema = new Map(
+  [[DepositId, { kind: "struct", fields: [["value", [32]]] }]] // Fixed array [u8; 32]
+);
+
+/**
+ * Parses depositId: checks if only the first 4 bytes are non-zero and returns a u32 or deserializes the full array.
+ */
+function parseDepositId(value: Uint8Array): string {
+  const restAreZero = value.slice(4).every((byte) => byte === 0);
+
+  if (restAreZero) {
+    // Parse the first 4 bytes as a little-endian u32
+    const u32Value = new DataView(value.buffer).getUint32(0, true); // true for little-endian
+    return u32Value.toString();
+  }
+
+  // Deserialize the full depositId using the Borsh schema
+  const depositId = deserialize(depositIdSchema, DepositId, Buffer.from(value));
+  return new BN(depositId.value).toString();
+}
+
+/**
+ * Stringifies a CPI event.
+ */
+export function stringifyCpiEvent(obj: any): any {
+  if (obj?.constructor?.toString()?.includes("PublicKey")) {
+    if (obj.toString().startsWith("111111111111")) {
+      // First 12 bytes are 0 for EVM addresses.
+      return publicKeyToEvmAddress(obj);
+    }
+    return obj.toString();
+  } else if (BN.isBN(obj)) {
+    return obj.toString();
+  } else if (Array.isArray(obj) && obj.length == 32) {
+    return Buffer.from(obj).toString("hex"); // Hex representation for fixed-length arrays
+  } else if (Array.isArray(obj)) {
+    return obj.map(stringifyCpiEvent);
+  } else if (obj !== null && typeof obj === "object") {
+    return Object.fromEntries(
+      Object.entries(obj).map(([key, value]) => {
+        if (key === "depositId" && Array.isArray(value) && value.length === 32) {
+          // Parse depositId using the helper function
+          const parsedValue = parseDepositId(new Uint8Array(value));
+          return [key, parsedValue];
+        }
+        return [key, stringifyCpiEvent(value)];
+      })
+    );
+  }
+  return obj;
+}