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

.gitignore

@@ -32,3 +32,5 @@ target
 **/*.rs.bk
 test-ledger
 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

@@ -1,6 +1,6 @@
 {
   "name": "@across-protocol/contracts",
-  "version": "3.0.25",
+  "version": "3.0.26",
   "author": "UMA Team",
   "license": "AGPL-3.0-only",
   "repository": {
@@ -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/addressToPublicKey.ts

@@ -1,4 +1,4 @@
-import { evmAddressToPublicKey } from "../../src/svm";
+import { evmAddressToPublicKey } from "../../src/svm/web3-v1";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 const argv = yargs(hideBin(process.argv)).option("address", {

scripts/svm/bridgeLiabilityToHubPool.ts

@@ -38,12 +38,16 @@ import {
   SOLANA_SPOKE_STATE_SEED,
   SOLANA_USDC_DEVNET,
   SOLANA_USDC_MAINNET,
-} from "../../src/svm";
+} from "../../src/svm/web3-v1";
 
 import { TOKEN_SYMBOLS_MAP } from "@across-protocol/constants";
 import { getNodeUrl } from "@uma/common";
 import { BigNumber, ethers } from "ethers";
-import { getMessageTransmitterProgram, getSpokePoolProgram, getTokenMessengerMinterProgram } from "../../src/svm";
+import {
+  getMessageTransmitterProgram,
+  getSpokePoolProgram,
+  getTokenMessengerMinterProgram,
+} from "../../src/svm/web3-v1";
 import { BondToken__factory } from "../../typechain";
 import { formatUsdc, requireEnv } from "./utils/helpers";
 

scripts/svm/closeRelayerPdas.ts

@@ -5,7 +5,7 @@ import { AnchorProvider, BN } from "@coral-xyz/anchor";
 import { PublicKey, SystemProgram } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { calculateRelayEventHashUint8Array, getSpokePoolProgram, readProgramEvents } from "../../src/svm";
+import { calculateRelayEventHashUint8Array, getSpokePoolProgram, readProgramEvents } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/enableRoute.ts

@@ -6,7 +6,7 @@ import { ASSOCIATED_TOKEN_PROGRAM_ID, TOKEN_PROGRAM_ID, getAssociatedTokenAddres
 import { PublicKey, SystemProgram } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSpokePoolProgram } from "../../src/svm";
+import { getSpokePoolProgram } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/executeRebalanceToHubPool.ts

@@ -67,9 +67,9 @@ import {
   SOLANA_SPOKE_STATE_SEED,
   SOLANA_USDC_DEVNET,
   SOLANA_USDC_MAINNET,
-  SvmSpokeAnchor,
-} from "../../src/svm";
+} from "../../src/svm/web3-v1";
 import { RelayerRefundLeafSolana, RelayerRefundLeafType } from "../../src/types/svm";
+import { SvmSpokeAnchor } from "../../src/svm";
 
 // Set up Solana provider.
 const provider = AnchorProvider.env();

scripts/svm/executeRebalanceToSpokePool.ts

@@ -26,7 +26,7 @@ import {
   isSolanaDevnet,
   SOLANA_USDC_DEVNET,
   SOLANA_USDC_MAINNET,
-} from "../../src/svm";
+} from "../../src/svm/web3-v1";
 import { HubPool__factory } from "../../typechain";
 import { requireEnv } from "./utils/helpers";
 import { constructSimpleRebalanceTree } from "./utils/poolRebalanceTree";

scripts/svm/fakeFillWithRandomDistribution.ts

@@ -21,7 +21,7 @@ import {
   getSpokePoolProgram,
   loadFillV3RelayParams,
   sendTransactionWithLookupTable,
-} from "../../src/svm";
+} from "../../src/svm/web3-v1";
 import { FillDataParams, FillDataValues } from "../../src/types/svm";
 
 // Set up the provider and signer.

scripts/svm/initialize.ts

@@ -5,7 +5,7 @@ import { AnchorProvider, BN } from "@coral-xyz/anchor";
 import { PublicKey, SystemProgram } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { evmAddressToPublicKey, getSpokePoolProgram } from "../../src/svm";
+import { evmAddressToPublicKey, getSpokePoolProgram } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/proposeRebalanceToHubPool.ts

@@ -30,7 +30,7 @@ import { getNodeUrl } from "@uma/common";
 import { BigNumber, ethers } from "ethers";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSolanaChainId, SOLANA_USDC_DEVNET, SOLANA_USDC_MAINNET } from "../../src/svm";
+import { getSolanaChainId, SOLANA_USDC_DEVNET, SOLANA_USDC_MAINNET } from "../../src/svm/web3-v1";
 import { BondToken__factory, HubPool__factory } from "../../typechain";
 import { CHAIN_IDs } from "../../utils/constants";
 import {

scripts/svm/proposeRebalanceToSpokePool.ts

@@ -13,7 +13,7 @@ import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import { CHAIN_IDs, TOKEN_SYMBOLS_MAP } from "../../utils/constants";
 // eslint-disable-next-line camelcase
-import { getSolanaChainId } from "../../src/svm";
+import { getSolanaChainId } from "../../src/svm/web3-v1";
 import { BondToken__factory, HubPool__factory } from "../../typechain";
 import { requireEnv } from "./utils/helpers";
 import { constructSimpleRebalanceTree } from "./utils/poolRebalanceTree";

scripts/svm/publicKeyToAddress.ts

@@ -1,6 +1,6 @@
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { publicKeyToEvmAddress } from "../../src/svm";
+import { publicKeyToEvmAddress } from "../../src/svm/web3-v1";
 
 const argv = yargs(hideBin(process.argv)).option("publicKey", {
   type: "string",

scripts/svm/queryDeposits.ts

@@ -5,7 +5,7 @@ import { AnchorProvider, BN } from "@coral-xyz/anchor";
 import { PublicKey } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSpokePoolProgram, readProgramEvents } from "../../src/svm";
+import { getSpokePoolProgram, readProgramEvents } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/queryEvents.ts

@@ -3,7 +3,7 @@ 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 { readProgramEvents, stringifyCpiEvent } from "../../src/svm/web3-v1";
 import { SvmSpoke } from "../../target/types/svm_spoke";
 
 // Set up the provider

scripts/svm/queryEventsV2.ts

@@ -0,0 +1,54 @@
+// 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 { stringifyCpiEvent } from "../../src/svm/web3-v1";
+import { SvmSpokeIdl } from "../../src/svm";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { readProgramEvents } 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 readProgramEvents(rpc, address(programId), SvmSpokeIdl, "confirmed");
+  const filteredEvents = events.filter((event: any) => (eventName == "any" ? true : event.name == eventName));
+  const formattedEvents = filteredEvents.map((event: any) => stringifyCpiEvent(event));
+
+  console.log(JSON.stringify(formattedEvents, null, 2));
+}
+
+// Run the queryEvents function
+queryEvents();

scripts/svm/queryFills.ts

@@ -5,7 +5,7 @@ import { AnchorProvider, BN } from "@coral-xyz/anchor";
 import { PublicKey } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSpokePoolProgram, readProgramEvents, strPublicKey, u8Array32ToInt } from "../../src/svm";
+import { getSpokePoolProgram, readProgramEvents, strPublicKey, u8Array32ToInt } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/queryRoute.ts

@@ -11,7 +11,7 @@ import {
 import { PublicKey } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSpokePoolProgram } from "../../src/svm";
+import { getSpokePoolProgram } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/queryState.ts

@@ -5,7 +5,7 @@ import { AnchorProvider, BN } from "@coral-xyz/anchor";
 import { PublicKey } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSpokePoolProgram } from "../../src/svm";
+import { getSpokePoolProgram } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/remoteHubPoolPauseDeposits.ts

@@ -19,7 +19,7 @@ import {
   getMessageTransmitterProgram,
   getSpokePoolProgram,
   isSolanaDevnet,
-} from "../../src/svm";
+} from "../../src/svm/web3-v1";
 import { HubPool__factory } from "../../typechain";
 import { requireEnv } from "./utils/helpers";
 

scripts/svm/remoteHubPoolSetDepositRoute.ts

@@ -24,7 +24,7 @@ import {
   isSolanaDevnet,
   SOLANA_USDC_DEVNET,
   SOLANA_USDC_MAINNET,
-} from "../../src/svm";
+} from "../../src/svm/web3-v1";
 import { HubPool__factory } from "../../typechain";
 import { CHAIN_IDs } from "../../utils/constants";
 import { requireEnv } from "./utils/helpers";

scripts/svm/remotePauseDeposits.ts

@@ -20,7 +20,7 @@ import {
   isSolanaDevnet,
   MAINNET_CCTP_MESSAGE_TRANSMITTER_ADDRESS,
   SEPOLIA_CCTP_MESSAGE_TRANSMITTER_ADDRESS,
-} from "../../src/svm";
+} from "../../src/svm/web3-v1";
 import { CHAIN_IDs } from "../../utils/constants";
 import { requireEnv } from "./utils/helpers";
 

scripts/svm/simpleDeposit.ts

@@ -12,7 +12,7 @@ import {
 import { PublicKey, Transaction, sendAndConfirmTransaction } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSpokePoolProgram } from "../../src/svm";
+import { getSpokePoolProgram } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

scripts/svm/simpleFakeRelayerRepayment.ts

@@ -24,7 +24,7 @@ import {
 import { MerkleTree } from "@uma/common/dist/MerkleTree";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { getSpokePoolProgram, loadExecuteRelayerRefundLeafParams, relayerRefundHashFn } from "../../src/svm";
+import { getSpokePoolProgram, loadExecuteRelayerRefundLeafParams, relayerRefundHashFn } from "../../src/svm/web3-v1";
 import { RelayerRefundLeafSolana, RelayerRefundLeafType } from "../../src/types/svm";
 
 // Set up the provider

scripts/svm/simpleFill.ts

@@ -14,7 +14,7 @@ import {
 import { PublicKey, SystemProgram, Transaction, sendAndConfirmTransaction } from "@solana/web3.js";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { calculateRelayHashUint8Array, getSpokePoolProgram, intToU8Array32 } from "../../src/svm";
+import { calculateRelayHashUint8Array, getSpokePoolProgram, intToU8Array32 } from "../../src/svm/web3-v1";
 
 // Set up the provider
 const provider = AnchorProvider.env();

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/helpers.ts

@@ -2,7 +2,7 @@ import { BN } from "@coral-xyz/anchor";
 import { PublicKey } from "@solana/web3.js";
 import { MerkleTree } from "@uma/common";
 import { BigNumber, ethers } from "ethers";
-import { relayerRefundHashFn } from "../../../src/svm";
+import { relayerRefundHashFn } from "../../../src/svm/web3-v1";
 import { RelayerRefundLeafSolana, RelayerRefundLeafType } from "../../../src/types/svm";
 
 export const requireEnv = (name: string): string => {

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