sdk: Add svmShims to Ntt.Contracts to configure Wormhole Shims (#718)

nvsriram · web-flow · commit 8bd672c5164c · 2025-10-23T09:28:34.000-04:00
This PR adds: * Update `Ntt.Contracts` to add a `svmShims` field that works like how [the current Solana shimOverrides argument in the constructor works](#663 (comment)) — the main difference being that it is now backwards compatible * Update `SolanaNtt` and `SolanaNttWormholeTransceiver` classes to use the `svmShims` field * Add default shim addresses as a `SolanaChains`-keyed constant that can be reference by `SolanaNttWormholeTransceiver` * Update tests
diff --git a/sdk/__tests__/utils.ts b/sdk/__tests__/utils.ts
@@ -48,8 +48,8 @@ export const NETWORK: "Devnet" = "Devnet";
 type NativeSdkSigner<P extends Platform> = P extends "Evm"
   ? ethers.Wallet
   : P extends "Solana"
-  ? web3.Keypair
-  : never;
+    ? web3.Keypair
+    : never;
 
 interface Signers<P extends Platform = Platform> {
   address: ChainAddress;
@@ -212,7 +212,7 @@ export async function link(chainInfos: Ctx[], accountantPrivateKey: string) {
     );
     vaas.push(serialize(vaa));
   }
-  
+
   // Submit all registrations at once
   await submitAccountantVAAs(vaas, accountantPrivateKey);
 }
@@ -267,8 +267,6 @@ export async function transferWithChecks(sourceCtx: Ctx, destinationCtx: Ctx) {
   const [managerBalanceAfterRecv, userBalanceAfterRecv] =
     await getManagerAndUserBalance(destinationCtx);
 
-
-
   checkBalances(
     sourceCtx.mode,
     [managerBalanceBeforeSend, managerBalanceAfterSend],
@@ -300,9 +298,8 @@ async function waitForRelay(
   let success = false;
   while (!success) {
     try {
-      const successBlock = await wormholeRelayer.deliverySuccessBlock(
-        deliveryHash
-      );
+      const successBlock =
+        await wormholeRelayer.deliverySuccessBlock(deliveryHash);
       if (successBlock > 0) success = true;
       console.log("Relayer delivery: ", success);
     } catch (e) {
@@ -468,10 +465,12 @@ async function deployEvm(ctx: Ctx): Promise<Ctx> {
   console.log("Initialize the manager");
   await tryAndWaitThrice(() => manager.initialize());
   console.log("Initialize the transceiver");
-  const coreFee = await (await ctx.context.getWormholeCore()).getMessageFee()
-  await tryAndWaitThrice(() => transceiver.initialize({
-    value: coreFee
-  }));
+  const coreFee = await (await ctx.context.getWormholeCore()).getMessageFee();
+  await tryAndWaitThrice(() =>
+    transceiver.initialize({
+      value: coreFee,
+    })
+  );
 
   // Setup the initial calls, like transceivers for the manager
   console.log("Set transceiver for manager");
@@ -538,6 +537,7 @@ async function deploySolana(ctx: Ctx): Promise<Ctx> {
     transceiver: {
       wormhole: transceiverProgramId,
     },
+    svmShims: {},
   };
 
   const manager = (await getNtt(ctx)) as SolanaNtt<typeof NETWORK, "Solana">;
@@ -600,6 +600,7 @@ async function deploySolana(ctx: Ctx): Promise<Ctx> {
       },
       manager: manager.program.programId.toString(),
       token: mint.toString(),
+      svmShims: {},
     },
   };
 }
@@ -751,22 +752,22 @@ async function tryAndWaitThrice(
 }
 
 export async function setMessageFee(chains: Chain[], fee: bigint) {
-  console.log(`Setting message fee for ${chains} to ${fee}`)
+  console.log(`Setting message fee for ${chains} to ${fee}`);
   for (const chain of chains) {
-    const chainCtx = wh.getChain(chain)
-    const core = await chainCtx.getWormholeCore()
-    const coreAddress = chainCtx.config.contracts.coreBridge
-    const existingFee = await core.getMessageFee()
-    console.log(`Existing core bridge fee for ${chain}: ${existingFee}`)
-    const rpc = await chainCtx.getRpc()
+    const chainCtx = wh.getChain(chain);
+    const core = await chainCtx.getWormholeCore();
+    const coreAddress = chainCtx.config.contracts.coreBridge;
+    const existingFee = await core.getMessageFee();
+    console.log(`Existing core bridge fee for ${chain}: ${existingFee}`);
+    const rpc = await chainCtx.getRpc();
     await rpc.send("anvil_setStorageAt", [
       coreAddress,
       7, // messageFee storage slot
-      ethers.zeroPadValue(ethers.toBeHex(fee), 32)
+      ethers.zeroPadValue(ethers.toBeHex(fee), 32),
     ]);
-  
-    const newFee = await core.getMessageFee()
-    console.log(`New core bridge fee for ${chain}: ${newFee}`)
+
+    const newFee = await core.getMessageFee();
+    console.log(`New core bridge fee for ${chain}: ${newFee}`);
   }
 }
 
diff --git a/sdk/definitions/src/ntt.ts b/sdk/definitions/src/ntt.ts
@@ -4,6 +4,7 @@ import {
   toChainId,
   type Chain,
   type Network,
+  type PlatformToChains,
 } from "@wormhole-foundation/sdk-base";
 
 import {
@@ -17,6 +18,7 @@ import {
   keccak256,
 } from "@wormhole-foundation/sdk-definitions";
 
+import { PublicKey } from "@solana/web3.js";
 import {
   NttManagerMessage,
   nativeTokenTransferLayout,
@@ -25,7 +27,6 @@ import {
   transceiverInstructionLayout,
   transceiverRegistration,
 } from "./layouts/index.js";
-import { PublicKey } from "@solana/web3.js";
 
 /**
  * @namespace Ntt
@@ -42,6 +43,31 @@ export namespace Ntt {
       [type: string]: string;
     };
     quoter?: string;
+    svmShims?: {
+      postMessageShimOverride?: string;
+      verifyVaaShimOverride?: string;
+    };
+  };
+
+  export const DEFAULT_SVM_SHIM_ADDRESSES: {
+    [chain in PlatformToChains<"Solana">]: {
+      postMessageShim: string;
+      verifyVaaShim: string;
+    };
+  } = {
+    Solana: {
+      postMessageShim: "EtZMZM22ViKMo4r5y4Anovs3wKQ2owUmDpjygnMMcdEX",
+      verifyVaaShim: "EFaNWErqAtVWufdNb7yofSHHfWFos843DFpu4JBw24at",
+    },
+    // TODO: update once shim is configured
+    Pythnet: {
+      postMessageShim: "",
+      verifyVaaShim: "",
+    },
+    Fogo: {
+      postMessageShim: "",
+      verifyVaaShim: "",
+    },
   };
 
   export type Message = NttManagerMessage<typeof nativeTokenTransferLayout>;
@@ -365,7 +391,7 @@ export interface Ntt<N extends Network, C extends Chain> {
 export interface NttTransceiver<
   N extends Network,
   C extends Chain,
-  A extends Ntt.Attestation
+  A extends Ntt.Attestation,
 > {
   getTransceiverType(payer?: AccountAddress<C>): Promise<string>;
 
@@ -427,15 +453,15 @@ export interface WormholeNttTransceiver<N extends Network, C extends Chain>
 export interface SolanaNttTransceiver<
   N extends Network,
   C extends Chain,
-  A extends Ntt.Attestation
+  A extends Ntt.Attestation,
 > extends NttTransceiver<N, C, A> {
   programId: PublicKey;
 }
 
 export interface EvmNttTransceiver<
   N extends Network,
   C extends Chain,
-  A extends Ntt.Attestation
+  A extends Ntt.Attestation,
 > extends NttTransceiver<N, C, A> {}
 
 declare module "@wormhole-foundation/sdk-definitions" {
diff --git a/solana/tests/anchor.test.ts b/solana/tests/anchor.test.ts
@@ -14,6 +14,7 @@ import {
   serialize,
   serializePayload,
 } from "@wormhole-foundation/sdk";
+import { Ntt } from "@wormhole-foundation/sdk-definitions-ntt";
 import * as testing from "@wormhole-foundation/sdk-definitions/testing";
 import {
   SolanaAddress,
@@ -24,9 +25,8 @@ import {
   SolanaWormholeCore,
   utils,
 } from "@wormhole-foundation/sdk-solana-core";
-
 import { IdlVersion, NTT, getTransceiverProgram } from "../ts/index.js";
-import { SolanaNtt, WormholeShimOverrides } from "../ts/sdk/index.js";
+import { SolanaNtt } from "../ts/sdk/index.js";
 import {
   TestDummyTransferHook,
   TestHelper,
@@ -49,7 +49,7 @@ const NTT_ADDRESS: anchor.web3.PublicKey =
   anchor.workspace.ExampleNativeTokenTransfers.programId;
 const WH_TRANSCEIVER_ADDRESS: anchor.web3.PublicKey =
   anchor.workspace.NttTransceiver.programId;
-const USE_WORMHOLE_SHIMS: WormholeShimOverrides = {};
+const SOLANA_WORMHOLE_SHIMS: Ntt.Contracts["svmShims"] = {};
 
 /**
  * Test Helpers
@@ -158,10 +158,10 @@ describe("example-native-token-transfers", () => {
           transceiver: {
             wormhole: nttTransceivers["wormhole"].programId.toBase58(),
           },
+          svmShims: SOLANA_WORMHOLE_SHIMS,
         },
       },
-      VERSION,
-      USE_WORMHOLE_SHIMS
+      VERSION
     );
   });
 
@@ -559,6 +559,7 @@ describe("example-native-token-transfers", () => {
         transceiver: {
           wormhole: nttTransceivers["wormhole"].programId.toBase58(),
         },
+        svmShims: SOLANA_WORMHOLE_SHIMS,
       },
     };
 
@@ -615,9 +616,8 @@ describe("example-native-token-transfers", () => {
         });
         const whTransceiver = await ntt.getWormholeTransceiver();
         expect(whTransceiver).toBeTruthy();
-        const transceiverType = await whTransceiver!.getTransceiverType(
-          payerAddress
-        );
+        const transceiverType =
+          await whTransceiver!.getTransceiverType(payerAddress);
         expect(transceiverType).toBe("wormhole");
       });
     });
diff --git a/solana/ts/sdk/ntt.ts b/solana/ts/sdk/ntt.ts
@@ -55,15 +55,11 @@ import { IDL as WormholePostMessageShimIdl } from "../idl/wormhole_shim/ts/wormh
 import { type WormholeVerifyVaaShim } from "../idl/wormhole_shim/ts/wormhole_verify_vaa_shim.js";
 import { IDL as WormholeVerifyVaaShimIdl } from "../idl/wormhole_shim/ts/wormhole_verify_vaa_shim.js";
 
-export type WormholeShimOverrides = {
-  postMessageShimOverride?: PublicKey;
-  verifyVaaShimOverride?: PublicKey;
-};
-
 export class SolanaNttWormholeTransceiver<
-  N extends Network,
-  C extends SolanaChains
-> implements
+    N extends Network,
+    C extends SolanaChains,
+  >
+  implements
     WormholeNttTransceiver<N, C>,
     SolanaNttTransceiver<N, C, WormholeNttTransceiver.VAA>
 {
@@ -76,21 +72,37 @@ export class SolanaNttWormholeTransceiver<
     readonly manager: SolanaNtt<N, C>,
     readonly program: Program<NttBindings.Transceiver<IdlVersion>>,
     readonly version: string = "3.0.0",
-    readonly shimOverrides: WormholeShimOverrides | null = {}
+    readonly svmShims: Ntt.Contracts["svmShims"] = undefined
   ) {
     this.programId = program.programId;
     this.pdas = NTT.transceiverPdas(program.programId);
-    if (shimOverrides) {
+
+    if (svmShims) {
+      const postMessageShimAddress =
+        svmShims.postMessageShimOverride ??
+        Ntt.DEFAULT_SVM_SHIM_ADDRESSES[this.manager.chain]["postMessageShim"];
+      if (!postMessageShimAddress) {
+        throw new Error(
+          "No default or override Wormhole Post Message Shim address provided"
+        );
+      }
       this.postMessageShim = new Program<WormholePostMessageShim>(
         WormholePostMessageShimIdl,
-        shimOverrides.postMessageShimOverride ??
-          new PublicKey("EtZMZM22ViKMo4r5y4Anovs3wKQ2owUmDpjygnMMcdEX"),
+        postMessageShimAddress,
         { connection: this.program.provider.connection }
       );
+
+      const verifyVaaShimAddress =
+        svmShims.verifyVaaShimOverride ??
+        Ntt.DEFAULT_SVM_SHIM_ADDRESSES[this.manager.chain]["verifyVaaShim"];
+      if (!verifyVaaShimAddress) {
+        throw new Error(
+          "No default or override Wormhole Verify VAA Shim address provided"
+        );
+      }
       this.verifyVaaShim = new Program<WormholeVerifyVaaShim>(
         WormholeVerifyVaaShimIdl,
-        shimOverrides.verifyVaaShimOverride ??
-          new PublicKey("EFaNWErqAtVWufdNb7yofSHHfWFos843DFpu4JBw24at"),
+        verifyVaaShimAddress,
         { connection: this.program.provider.connection }
       );
     }
@@ -562,8 +574,7 @@ export class SolanaNtt<N extends Network, C extends SolanaChains>
     readonly chain: C,
     readonly connection: Connection,
     readonly contracts: Contracts & { ntt?: Ntt.Contracts },
-    readonly version: string = "3.0.0",
-    readonly shimOverrides: WormholeShimOverrides | null = {}
+    readonly version: string = "3.0.0"
   ) {
     if (!contracts.ntt) throw new Error("Ntt contracts not found");
 
@@ -609,7 +620,7 @@ export class SolanaNtt<N extends Network, C extends SolanaChains>
               version as IdlVersion
             ),
             version,
-            shimOverrides
+            contracts.ntt!.svmShims
           );
           this.transceivers.push(whTransceiver.program);
         } else {
@@ -658,7 +669,7 @@ export class SolanaNtt<N extends Network, C extends SolanaChains>
         this,
         transceiverProgram,
         this.version,
-        this.shimOverrides
+        this.contracts.ntt!.svmShims
       );
     return null;
   }
