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

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/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,3 @@
-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 "./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/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/web3-v2/solanaProgramUtils.ts

@@ -0,0 +1,130 @@
+import { BorshEventCoder, Idl, utils } from "@coral-xyz/anchor";
+import web3, {
+  Address,
+  Commitment,
+  GetTransactionApi,
+  Signature,
+  Slot,
+  TransactionError,
+  UnixTimestamp,
+} from "@solana/web3-v2.js";
+
+type GetTransactionReturnType = ReturnType<GetTransactionApi["getTransaction"]>;
+
+type GetSignaturesForAddressConfig = Readonly<{
+  before?: Signature;
+  commitment?: Exclude<Commitment, "processed">;
+  limit?: number;
+  minContextSlot?: Slot;
+  until?: Signature;
+}>;
+
+type GetSignaturesForAddressTransaction = {
+  blockTime: UnixTimestamp | null;
+  confirmationStatus: Commitment | null;
+  err: TransactionError | null;
+  memo: string | null;
+  signature: Signature;
+  slot: Slot;
+};
+
+/**
+ * Reads all events for a specific program.
+ */
+export async function readProgramEvents(
+  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<any>>,
+  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 readEvents(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 readEvents(
+  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<any>>,
+  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 messageAccountKeys = txResult.transaction.message.accountKeys;
+
+  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;
+}