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

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"

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();

src/svm/index.ts

@@ -1,3 +1,4 @@
 export * from "./web3-v1";
+export * from "./web3-v2";
 export * from "./assets";
 export * from "./clients";

src/svm/web3-v1/solanaProgramUtils.ts

@@ -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

@@ -2,37 +2,23 @@ import { BorshEventCoder, Idl, utils } from "@coral-xyz/anchor";
 import web3, {
   Address,
   Commitment,
+  GetSignaturesForAddressApi,
   GetTransactionApi,
+  RpcTransport,
   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;
-};
+type GetSignaturesForAddressConfig = Parameters<GetSignaturesForAddressApi["getSignaturesForAddress"]>[1];
+
+type GetSignaturesForAddressTransaction = ReturnType<GetSignaturesForAddressApi["getSignaturesForAddress"]>[number];
 
 /**
  * Reads all events for a specific program.
  */
-export async function readProgramEvents(
-  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<any>>,
+export async function readProgramEventsV2(
+  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<RpcTransport>>,
   program: Address,
   anchorIdl: Idl,
   finality: Commitment = "confirmed",
@@ -56,7 +42,7 @@ export async function readProgramEvents(
   // 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);
+      const events = await readEventsV2(rpc, signatureTransaction.signature, program, anchorIdl, finality);
 
       return events.map((event) => ({
         ...event,
@@ -74,8 +60,8 @@ export async function readProgramEvents(
 /**
  * Reads events from a transaction.
  */
-export async function readEvents(
-  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<any>>,
+export async function readEventsV2(
+  rpc: web3.Rpc<web3.SolanaRpcApiFromTransport<RpcTransport>>,
   txSignature: Signature,
   programId: Address,
   programIdl: Idl,
@@ -102,7 +88,12 @@ async function processEventFromTx(
   const [pda] = await web3.getProgramDerivedAddress({ programAddress: programId, seeds: ["__event_authority"] });
   eventAuthorities.set(programId, pda);
 
-  const messageAccountKeys = txResult.transaction.message.accountKeys;
+  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) {