feat(svm): web3 v2, codama clients, and events retrieval

.gitignore

@@ -33,3 +33,5 @@ target
 test-ledger
 idls
 src/svm/assets 
+src/svm/clients/*
+!src/svm/clients/index.ts

Anchor.toml

@@ -23,6 +23,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"
+queryEventsV2 = "NODE_NO_WARNINGS=1 yarn run ts-node ./scripts/svm/queryEventsV2.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"

package.json

@@ -26,7 +26,8 @@
     "lint-fix": "yarn prettier --write **/*.js **/*.ts ./programs/**/*.rs ./contracts**/*.sol && cargo +nightly fmt  --all && cargo clippy",
     "clean-fast": "for dir in node_modules cache cache-zk artifacts artifacts-zk dist typechain; do mv \"${dir}\" \"_${dir}\"; rm -rf \"_${dir}\" &; done",
     "clean": "rm -rf node_modules cache cache-zk artifacts artifacts-zk dist typechain",
-    "generate-svm-assets": "sh ./scripts/generate-svm-assets.sh",
+    "generate-svm-assets": "sh ./scripts/generate-svm-assets.sh && yarn generate-svm-clients",
+    "generate-svm-clients": "yarn ts-node ./scripts/svm/utils/generate-svm-clients.ts && yarn ts-node ./scripts/svm/utils/rename-clients-imports.ts",
     "build-evm": "hardhat compile",
     "build-svm": "echo 'Generating IDLs...' && anchor build > /dev/null 2>&1 || true && anchor run generateExternalTypes && anchor build",
     "build-ts": "tsc && rsync -a --include '*/' --include '*.d.ts' --exclude '*' ./typechain ./dist/",
@@ -54,6 +55,7 @@
     "@solana-developers/helpers": "^2.4.0",
     "@solana/spl-token": "^0.4.6",
     "@solana/web3.js": "^1.31.0",
+    "@solana/web3-v2.js": "npm:@solana/web3.js@2",
     "@types/yargs": "^17.0.33",
     "@uma/common": "^2.37.3",
     "@uma/contracts-node": "^0.4.17",
@@ -65,6 +67,9 @@
     "zksync-web3": "^0.14.3"
   },
   "devDependencies": {
+    "@codama/nodes-from-anchor": "^1.1.0",
+    "@codama/renderers-js": "^1.1.1",
+    "codama": "^1.2.0",
     "@consensys/linea-sdk": "^0.1.6",
     "@matterlabs/hardhat-zksync-deploy": "^0.6.3",
     "@matterlabs/hardhat-zksync-solc": "^1.1.4",

scripts/svm/queryEventsV2.ts

@@ -0,0 +1,52 @@
+// This script queries the events of the spoke pool and prints them in a human readable format.
+import { AnchorProvider } from "@coral-xyz/anchor";
+import { address, createSolanaRpc } from "@solana/web3-v2.js";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { readProgramEventsV2, stringifyCpiEvent, SvmSpokeIdl } from "../../src/svm";
+
+// Set up the provider
+const provider = AnchorProvider.env();
+
+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",
+    ],
+  })
+  .option("programId", {
+    type: "string",
+    demandOption: true,
+    describe: "SvmSpokeProgram ID to query events from",
+  }).argv;
+
+async function queryEvents(): Promise<void> {
+  const argv = await argvPromise;
+  const eventName = argv.eventName || "any";
+  const programId = argv.programId;
+  const rpc = createSolanaRpc(provider.connection.rpcEndpoint);
+  const events = await readProgramEventsV2(rpc, address(programId), SvmSpokeIdl, "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();

scripts/svm/utils/generate-svm-clients.ts

@@ -0,0 +1,24 @@
+import { createFromRoot } from "codama";
+import { rootNodeFromAnchor, AnchorIdl } from "@codama/nodes-from-anchor";
+import { renderVisitor as renderJavaScriptVisitor } from "@codama/renderers-js";
+import { SvmSpokeIdl, MulticallHandlerIdl } from "../../../src/svm/assets";
+import path from "path";
+export const clientsPath = path.join(__dirname, "..", "..", "..", "src", "svm", "clients");
+
+// Generate SvmSpoke clients
+let codama = createFromRoot(rootNodeFromAnchor(SvmSpokeIdl as AnchorIdl));
+codama.accept(renderJavaScriptVisitor(path.join(clientsPath, "SvmSpoke")));
+
+// Generate MulticallHandler clients
+codama = createFromRoot(rootNodeFromAnchor(MulticallHandlerIdl as AnchorIdl));
+codama.accept(renderJavaScriptVisitor(path.join(clientsPath, "MulticallHandler")));
+
+// codama = createFromRoot(rootNodeFromAnchor(MessageTransmitterIdl as AnchorIdl));
+// codama.accept(
+//     renderJavaScriptVisitor(path.join(clientsPath, "MessageTransmitter"))
+// );
+
+// codama = createFromRoot(rootNodeFromAnchor(TokenMessengerMinterIdl as AnchorIdl));
+// codama.accept(
+//     renderJavaScriptVisitor(path.join(clientsPath, "TokenMessengerMinter"))
+// );

scripts/svm/utils/rename-clients-imports.ts

@@ -0,0 +1,22 @@
+const fs = require("fs");
+const path = require("path");
+
+const clientsPath = path.join(__dirname, "..", "..", "..", "src", "svm", "clients");
+
+function replaceInFiles(dir: string): void {
+  const files = fs.readdirSync(dir);
+  files.forEach((file: string) => {
+    const filePath = path.join(dir, file);
+    const stat = fs.statSync(filePath);
+
+    if (stat.isDirectory()) {
+      replaceInFiles(filePath);
+    } else if (file.endsWith(".ts")) {
+      const fileContent = fs.readFileSync(filePath, "utf8");
+      const updatedContent = fileContent.replace("@solana/web3.js", "@solana/web3-v2.js");
+      fs.writeFileSync(filePath, updatedContent);
+    }
+  });
+}
+
+replaceInFiles(clientsPath);

src/svm/clients/index.ts

@@ -0,0 +1,4 @@
+import * as MulticallHandlerClient from "./MulticallHandler";
+import * as SvmSpokeClient from "./SvmSpoke";
+
+export { MulticallHandlerClient, SvmSpokeClient };

src/svm/index.ts

@@ -1,11 +1,4 @@
-export * from "./relayHashUtils";
-export * from "./instructionParamsUtils";
-export * from "./conversionUtils";
-export * from "./transactionUtils";
-export * from "./solanaProgramUtils";
-export * from "./coders";
-export * from "./programConnectors";
+export * from "./web3-v1";
+export * from "./web3-v2";
 export * from "./assets";
-export * from "./constants";
-export * from "./helpers";
-export * from "./cctpHelpers";
+export * from "./clients";

src/svm/cctpHelpers.ts → src/svm/web3-v1/cctpHelpers.ts

@@ -1,6 +1,6 @@
 import * as anchor from "@coral-xyz/anchor";
 import { array, object, optional, string, Struct } from "superstruct";
-import { readUInt256BE } from "../../src/svm";
+import { readUInt256BE } from "./relayHashUtils";
 
 // Index positions to decode Message Header from
 // https://developers.circle.com/stablecoins/docs/message-format#message-header

src/svm/coders.ts → src/svm/web3-v1/coders.ts

@@ -13,7 +13,7 @@ import {
 } from "@solana/web3.js";
 import bs58 from "bs58";
 import { Layout } from "buffer-layout";
-import { AcrossPlusMessage } from "../types/svm";
+import { AcrossPlusMessage } from "../../types/svm";
 
 /**
  * Extended Anchor accounts coder to handle large account data.

src/svm/web3-v1/index.ts

@@ -0,0 +1,10 @@
+export * from "./relayHashUtils";
+export * from "./instructionParamsUtils";
+export * from "./conversionUtils";
+export * from "./transactionUtils";
+export * from "./solanaProgramUtils";
+export * from "./coders";
+export * from "./programConnectors";
+export * from "./constants";
+export * from "./helpers";
+export * from "./cctpHelpers";

src/svm/instructionParamsUtils.ts → src/svm/web3-v1/instructionParamsUtils.ts

@@ -1,7 +1,7 @@
 import { Keypair, TransactionInstruction, Transaction, sendAndConfirmTransaction, PublicKey } from "@solana/web3.js";
 import { Program, BN } from "@coral-xyz/anchor";
-import { RelayData, SlowFillLeaf, RelayerRefundLeafSolana } from "../types/svm";
-import { SvmSpoke } from "../../target/types/svm_spoke";
+import { RelayData, SlowFillLeaf, RelayerRefundLeafSolana } from "../../types/svm";
+import { SvmSpoke } from "../../../target/types/svm_spoke";
 import { LargeAccountsCoder } from "./coders";
 
 /**

src/svm/programConnectors.ts → src/svm/web3-v1/programConnectors.ts

@@ -1,6 +1,6 @@
 import { AnchorProvider, Idl, Program } from "@coral-xyz/anchor";
-import { getDeployedAddress } from "../DeploymentUtils";
-import { SupportedNetworks } from "../types/svm";
+import { getDeployedAddress } from "../../DeploymentUtils";
+import { SupportedNetworks } from "../../types/svm";
 import {
   MessageTransmitterAnchor,
   MessageTransmitterIdl,
@@ -10,7 +10,7 @@ import {
   SvmSpokeIdl,
   TokenMessengerMinterAnchor,
   TokenMessengerMinterIdl,
-} from "./assets";
+} from "../assets";
 import { getSolanaChainId, isSolanaDevnet } from "./helpers";
 
 type ProgramOptions = { network?: SupportedNetworks; programId?: string };

src/svm/relayHashUtils.ts → src/svm/web3-v1/relayHashUtils.ts

@@ -1,6 +1,6 @@
 import { BN } from "@coral-xyz/anchor";
 import { ethers } from "ethers";
-import { RelayerRefundLeaf, RelayerRefundLeafSolana, SlowFillLeaf } from "../types/svm";
+import { RelayerRefundLeaf, RelayerRefundLeafSolana, SlowFillLeaf } from "../../types/svm";
 import { serialize } from "borsh";
 
 /**

src/svm/solanaProgramUtils.ts → src/svm/web3-v1/solanaProgramUtils.ts

@@ -8,7 +8,7 @@ import {
   SignaturesForAddressOptions,
 } from "@solana/web3.js";
 import { deserialize } from "borsh";
-import { EventType } from "../types/svm";
+import { EventType } from "../../types/svm";
 import { publicKeyToEvmAddress } from "./conversionUtils";
 
 /**
@@ -239,6 +239,8 @@ export function stringifyCpiEvent(obj: any): any {
     return obj.toString();
   } else if (BN.isBN(obj)) {
     return obj.toString();
+  } else if (typeof obj === "bigint" && obj !== 0n) {
+    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)) {

src/svm/web3-v2/index.ts

@@ -0,0 +1 @@
+export * from "./solanaProgramUtils";

src/svm/web3-v2/solanaProgramUtils.ts

@@ -0,0 +1,121 @@
+import { BorshEventCoder, Idl, utils } from "@coral-xyz/anchor";
+import web3, {
+  Address,
+  Commitment,
+  GetSignaturesForAddressApi,
+  GetTransactionApi,
+  RpcTransport,
+  Signature,
+} from "@solana/web3-v2.js";
+
+type GetTransactionReturnType = ReturnType<GetTransactionApi["getTransaction"]>;
+
+type GetSignaturesForAddressConfig = Parameters<GetSignaturesForAddressApi["getSignaturesForAddress"]>[1];
+
+type GetSignaturesForAddressTransaction = ReturnType<GetSignaturesForAddressApi["getSignaturesForAddress"]>[number];
+
+/**
+ * Reads all events for a specific program.
+ */
+export async function readProgramEventsV2(
+  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<RpcTransport>>,
+  program: Address,
+  anchorIdl: Idl,
+  finality: Commitment = "confirmed",
+  options: GetSignaturesForAddressConfig = { limit: 1000 }
+) {
+  const allSignatures: GetSignaturesForAddressTransaction[] = [];
+
+  // Fetch all signatures in sequential batches
+  while (true) {
+    const signatures = await rpc.getSignaturesForAddress(program, options).send();
+    allSignatures.push(...signatures);
+
+    // Update options for the next batch. Set before to the last fetched signature.
+    if (signatures.length > 0) {
+      options = { ...options, before: signatures[signatures.length - 1].signature };
+    }
+
+    if (options.limit && signatures.length < options.limit) break; // Exit early if the number of signatures < limit
+  }
+
+  // Fetch events for all signatures in parallel
+  const eventsWithSlots = await Promise.all(
+    allSignatures.map(async (signatureTransaction) => {
+      const events = await readEventsV2(rpc, signatureTransaction.signature, program, anchorIdl, finality);
+
+      return events.map((event) => ({
+        ...event,
+        confirmationStatus: signatureTransaction.confirmationStatus || "Unknown",
+        blockTime: signatureTransaction.blockTime || 0,
+        signature: signatureTransaction.signature,
+        slot: signatureTransaction.slot,
+        name: event.name || "Unknown",
+      }));
+    })
+  );
+  return eventsWithSlots.flat();
+}
+
+/**
+ * Reads events from a transaction.
+ */
+export async function readEventsV2(
+  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<RpcTransport>>,
+  txSignature: Signature,
+  programId: Address,
+  programIdl: Idl,
+  commitment: Commitment = "confirmed"
+) {
+  const txResult = await rpc.getTransaction(txSignature, { commitment, maxSupportedTransactionVersion: 0 }).send();
+
+  if (txResult === null) return [];
+
+  return processEventFromTx(txResult, programId, programIdl);
+}
+
+/**
+ * Processes events from a transaction.
+ */
+async function processEventFromTx(
+  txResult: GetTransactionReturnType,
+  programId: Address,
+  programIdl: Idl
+): Promise<{ program: Address; data: any; name: string | undefined }[]> {
+  if (!txResult) return [];
+  const eventAuthorities: Map<string, Address> = new Map();
+  const events: { program: Address; data: any; name: string | undefined }[] = [];
+  const [pda] = await web3.getProgramDerivedAddress({ programAddress: programId, seeds: ["__event_authority"] });
+  eventAuthorities.set(programId, pda);
+
+  const accountKeys = txResult.transaction.message.accountKeys;
+  const messageAccountKeys = [...accountKeys];
+  // Order matters here. writable accounts must be processed before readonly accounts.
+  // See https://docs.anza.xyz/proposals/versioned-transactions#new-transaction-format
+  messageAccountKeys.push(...(txResult?.meta?.loadedAddresses?.writable ?? []));
+  messageAccountKeys.push(...(txResult?.meta?.loadedAddresses?.readonly ?? []));
+
+  for (const ixBlock of txResult.meta?.innerInstructions ?? []) {
+    for (const ix of ixBlock.instructions) {
+      const ixProgramId = messageAccountKeys[ix.programIdIndex];
+      const singleIxAccount = ix.accounts.length === 1 ? messageAccountKeys[ix.accounts[0]] : undefined;
+      if (
+        ixProgramId !== undefined &&
+        singleIxAccount !== undefined &&
+        programId == ixProgramId &&
+        eventAuthorities.get(ixProgramId.toString()) == singleIxAccount
+      ) {
+        const ixData = utils.bytes.bs58.decode(ix.data);
+        const eventData = utils.bytes.base64.encode(Buffer.from(new Uint8Array(ixData).slice(8)));
+        let event = new BorshEventCoder(programIdl).decode(eventData);
+        events.push({
+          program: programId,
+          data: event?.data,
+          name: event?.name,
+        });
+      }
+    }
+  }
+
+  return events;
+}