refactor

Author: kev1n-peters

evm/ts/src/multiTokenNtt.ts

@@ -265,7 +265,6 @@ export class EvmMultiTokenNtt<N extends Network, C extends EvmChains>
               dstChain,
               gasLimit
             ).catch(() => 0n);
-            console.log("gas fee", gasFee);
             return {
               index: transceiver.index,
               payload: encoding.bignum.toBytes(gasFee, 32),
@@ -300,13 +299,14 @@ export class EvmMultiTokenNtt<N extends Network, C extends EvmChains>
     sender: AccountAddress<C>,
     token: TokenAddress<C>,
     amount: bigint,
-    destination: ChainAddress
+    destination: ChainAddress,
+    destinationGasLimit: bigint
   ): AsyncGenerator<EvmUnsignedTransaction<N, C>> {
     const senderAddress = new EvmAddress(sender).toString();
 
     const transceiverInstructions = await this.createTransceiverInstructions(
       destination.chain,
-      800_000n // TODO: make this configurable
+      destinationGasLimit
     );
 
     const totalPrice = await this.quoteDeliveryPrice(
@@ -625,4 +625,21 @@ export class EvmMultiTokenNtt<N extends Network, C extends EvmChains>
       parallelizable
     );
   }
+
+  async estimateGasLimit(
+    originalToken: MultiTokenNtt.OriginalTokenId
+  ): Promise<bigint> {
+    const GAS_LIMIT = 500_000n;
+
+    // More gas is needed to create the token on the destination chain
+    const GAS_LIMIT_CREATE_TOKEN = 1_000_000n;
+
+    // Check if the token already exists on the destination chain
+    const existingToken = await this.getLocalToken(originalToken);
+    const isUnattested = existingToken === null;
+
+    const gasLimit = isUnattested ? GAS_LIMIT_CREATE_TOKEN : GAS_LIMIT;
+
+    return gasLimit;
+  }
 }

evm/ts/src/multiTokenNttWithExecutor.ts

@@ -24,7 +24,6 @@ import {
   type MultiTokenNtt,
   type MultiTokenNttWithExecutor,
 } from "@wormhole-foundation/sdk-definitions-ntt";
-import { EvmMultiTokenNtt } from "./multiTokenNtt.js";
 
 const multiTokenNttWithExecutorAddresses: Partial<
   Record<Network, Partial<Record<EvmChains, string>>>
@@ -194,27 +193,6 @@ export class EvmMultiTokenNttWithExecutor<
     );
   }
 
-  async estimateMsgValueAndGasLimit(
-    originalToken: MultiTokenNtt.OriginalTokenId,
-    multiTokenNtt: EvmMultiTokenNtt<N, C>
-  ): Promise<{ msgValue: bigint; gasLimit: bigint }> {
-    const GAS_LIMIT = 500_000n;
-
-    // More gas is needed to create the token on the destination chain
-    const GAS_LIMIT_CREATE_TOKEN = 1_000_000n;
-
-    // Check if the token already exists on the destination chain
-    const existingToken = await multiTokenNtt.getLocalToken(originalToken);
-    const isUnattested = existingToken === null;
-
-    const gasLimit = isUnattested ? GAS_LIMIT_CREATE_TOKEN : GAS_LIMIT;
-
-    return {
-      msgValue: 0n,
-      gasLimit,
-    };
-  }
-
   createUnsignedTx(
     txReq: TransactionRequest,
     description: string,

sdk/definitions/src/multiTokenNtt.ts

@@ -108,7 +108,8 @@ export interface MultiTokenNtt<N extends Network, C extends Chain> {
     sender: AccountAddress<C>,
     token: TokenAddress<C>,
     amount: bigint,
-    destination: ChainAddress
+    destination: ChainAddress,
+    destinationGasLimit: bigint
   ): AsyncGenerator<UnsignedTransaction<N, C>>;
 
   redeem(
@@ -163,6 +164,10 @@ export interface MultiTokenNtt<N extends Network, C extends Chain> {
   ): Promise<TokenAddress<C>>;
 
   getWrappedNativeToken(): Promise<TokenId>;
+
+  estimateGasLimit(
+    originalToken: MultiTokenNtt.OriginalTokenId
+  ): Promise<bigint>;
 }
 
 declare module "@wormhole-foundation/sdk-definitions" {

sdk/definitions/src/multiTokenNttWithExecutor.ts

@@ -8,7 +8,6 @@ import type {
   UnsignedTransaction,
 } from "@wormhole-foundation/sdk-connect";
 import { NttWithExecutor } from "./nttWithExecutor.js";
-import type { MultiTokenNtt } from "./multiTokenNtt.js";
 import { Ntt } from "./ntt.js";
 
 export namespace MultiTokenNttWithExecutor {
@@ -26,11 +25,6 @@ export interface MultiTokenNttWithExecutor<N extends Network, C extends Chain> {
     amount: bigint,
     quote: MultiTokenNttWithExecutor.Quote
   ): AsyncGenerator<UnsignedTransaction<N, C>>;
-
-  estimateMsgValueAndGasLimit(
-    originalToken: MultiTokenNtt.OriginalTokenId,
-    multiTokenNtt: MultiTokenNtt<N, C>
-  ): Promise<{ msgValue: bigint; gasLimit: bigint }>;
 }
 
 declare module "@wormhole-foundation/sdk-definitions" {

sdk/route/src/executor/multiToken.ts

@@ -59,7 +59,7 @@ import { trackAxelar, trackExecutor } from "../tracking.js";
 
 export namespace MultiTokenNttExecutorRoute {
   export type Config = {
-    ntt: MultiTokenNttRoute.Config;
+    contracts: MultiTokenNtt.Contracts[];
     referrerFee?: ReferrerFeeConfig;
   };
 
@@ -72,8 +72,6 @@ export namespace MultiTokenNttExecutorRoute {
 
   export type NormalizedParams = MultiTokenNttRoute.NormalizedParams & {
     referrerFeeDbps: bigint;
-    gasLimit: bigint;
-    msgValue: bigint;
   };
 
   export interface ValidatedParams
@@ -122,16 +120,19 @@ export class MultiTokenNttExecutorRoute<N extends Network>
   readonly staticConfig: MultiTokenNttExecutorRoute.Config =
     // @ts-ignore
     this.constructor.config;
-  static config: MultiTokenNttExecutorRoute.Config = { ntt: { contracts: [] } };
+  static config: MultiTokenNttExecutorRoute.Config = { contracts: [] };
 
   static meta = { name: "MultiTokenNttExecutorRoute" };
 
   static supportedNetworks(): Network[] {
-    return MultiTokenNttRoute.resolveSupportedNetworks(this.config.ntt);
+    return MultiTokenNttRoute.resolveSupportedNetworks(this.config.contracts);
   }
 
   static supportedChains(network: Network): Chain[] {
-    return MultiTokenNttRoute.resolveSupportedChains(this.config.ntt, network);
+    return MultiTokenNttRoute.resolveSupportedChains(
+      this.config.contracts,
+      network
+    );
   }
 
   static async supportedDestinationTokens<N extends Network>(
@@ -143,7 +144,7 @@ export class MultiTokenNttExecutorRoute<N extends Network>
       sourceToken,
       fromChain,
       toChain,
-      this.config.ntt
+      this.config.contracts
     );
     return [destinationTokenId];
   }
@@ -164,6 +165,14 @@ export class MultiTokenNttExecutorRoute<N extends Network>
     request: routes.RouteTransferRequest<N>,
     params: Tp
   ): Promise<Vr> {
+    if (request.fromChain.chain === request.toChain.chain) {
+      return {
+        valid: false,
+        error: new Error("Source and destination chains must differ"),
+        params,
+      };
+    }
+
     const options = params.options ?? this.getDefaultOptions();
 
     if (
@@ -185,12 +194,12 @@ export class MultiTokenNttExecutorRoute<N extends Network>
     );
 
     const sourceContracts = MultiTokenNttRoute.resolveContracts(
-      this.staticConfig.ntt,
+      this.staticConfig.contracts,
       request.fromChain.chain
     );
 
     const destinationContracts = MultiTokenNttRoute.resolveContracts(
-      this.staticConfig.ntt,
+      this.staticConfig.contracts,
       request.toChain.chain
     );
 
@@ -208,30 +217,9 @@ export class MultiTokenNttExecutorRoute<N extends Network>
       request.toChain.chain
     );
 
-    const destinationNttWithExecutor = await request.toChain.getProtocol(
-      "MultiTokenNttWithExecutor",
-      {
-        multiTokenNtt: destinationContracts,
-      }
-    );
-
-    const destinationNtt = await request.toChain.getProtocol("MultiTokenNtt", {
-      multiTokenNtt: destinationContracts,
-    });
-
     const referrerFeeDbps = this.getReferrerFeeDbps(request);
 
-    let { msgValue, gasLimit } =
-      await destinationNttWithExecutor.estimateMsgValueAndGasLimit(
-        originalTokenId,
-        destinationNtt
-      );
-
-    ({ msgValue, gasLimit } = this.getGasOverrides(
-      request,
-      msgValue,
-      gasLimit
-    ));
+    const gasLimit = await this.estimateGasLimit(request, originalTokenId);
 
     const validatedParams: Vp = {
       amount: params.amount,
@@ -244,7 +232,6 @@ export class MultiTokenNttExecutorRoute<N extends Network>
         destinationTokenId: request.destination.id,
         originalTokenId,
         gasLimit,
-        msgValue,
         sendTransceivers,
       },
       options,
@@ -418,25 +405,33 @@ export class MultiTokenNttExecutorRoute<N extends Network>
       : 0n;
   }
 
-  getGasOverrides(
+  async estimateGasLimit(
     request: routes.RouteTransferRequest<N>,
-    msgValue: bigint,
-    gasLimit: bigint
-  ): { msgValue: bigint; gasLimit: bigint } {
+    originalTokenId: MultiTokenNtt.OriginalTokenId
+  ): Promise<bigint> {
     if (this.staticConfig.referrerFee?.perTokenOverrides) {
       const destinationTokenAddress = canonicalAddress(request.destination.id);
       const override =
         this.staticConfig.referrerFee.perTokenOverrides[
           request.destination.id.chain
         ]?.[destinationTokenAddress];
       if (override?.gasLimit !== undefined) {
-        gasLimit = override.gasLimit;
-      }
-      if (override?.msgValue !== undefined) {
-        msgValue = override.msgValue;
+        return override.gasLimit;
       }
     }
-    return { msgValue, gasLimit };
+
+    const destinationContracts = MultiTokenNttRoute.resolveContracts(
+      this.staticConfig.contracts,
+      request.toChain.chain
+    );
+
+    const destinationNtt = await request.toChain.getProtocol("MultiTokenNtt", {
+      multiTokenNtt: destinationContracts,
+    });
+
+    const gasLimit = await destinationNtt.estimateGasLimit(originalTokenId);
+
+    return gasLimit;
   }
 
   async fetchExecutorQuote(
@@ -474,7 +469,7 @@ export class MultiTokenNttExecutorRoute<N extends Network>
       request: {
         type: "GasInstruction" as const,
         gasLimit: params.normalizedParams.gasLimit,
-        msgValue: params.normalizedParams.msgValue,
+        msgValue: 0n,
       },
     });
 
@@ -647,7 +642,7 @@ export class MultiTokenNttExecutorRoute<N extends Network>
     }
 
     if (!receipt.attestation) {
-      throw new Error("No attestation found for the transfer");
+      throw new Error("No attestation found on the transfer receipt");
     }
 
     const toChain = this.wh.getChain(receipt.to);
@@ -674,15 +669,12 @@ export class MultiTokenNttExecutorRoute<N extends Network>
       // already attested by the wormhole transceiver
       return receipt;
     }
-    const completeTransfer = ntt.redeem(receipt.attestation.attestation);
 
-    const txids = await signSendWait(toChain, completeTransfer, signer);
-    return {
-      ...receipt,
-      state: TransferState.DestinationInitiated,
-      attestation: receipt.attestation,
-      destinationTxs: txids,
-    };
+    const completeXfer = ntt.redeem(receipt.attestation.attestation);
+
+    await signSendWait(toChain, completeXfer, signer);
+
+    return receipt;
   }
 
   async resume(tx: TransactionId): Promise<R> {
@@ -696,7 +688,7 @@ export class MultiTokenNttExecutorRoute<N extends Network>
     const { payload } = vaa.payload.nttManagerPayload;
 
     const sourceContracts = MultiTokenNttRoute.resolveContracts(
-      this.staticConfig.ntt,
+      this.staticConfig.contracts,
       fromChain.chain
     );
     if (
@@ -708,7 +700,7 @@ export class MultiTokenNttExecutorRoute<N extends Network>
     }
 
     const destinationContracts = MultiTokenNttRoute.resolveContracts(
-      this.staticConfig.ntt,
+      this.staticConfig.contracts,
       payload.toChain
     );
 
@@ -738,7 +730,7 @@ export class MultiTokenNttExecutorRoute<N extends Network>
       sourceTokenId,
       fromChain,
       this.wh.getChain(payload.toChain),
-      this.staticConfig.ntt,
+      this.staticConfig.contracts,
       originalTokenId
     );
 
@@ -773,7 +765,6 @@ export class MultiTokenNttExecutorRoute<N extends Network>
           sendTransceivers,
           referrerFeeDbps: 0n,
           gasLimit: 0n,
-          msgValue: 0n,
         },
         options: {
           nativeGas: undefined,