sdk: multi-token-ntt protocol support

Adds support for the MultiTokenNtt protocol along
with two new routes: MultiTokenNtt{Manual,Executor}Route.

Author: kev1n-peters

evm/ts/__tests__/calculateLocalTokenAddress.test.ts

@@ -0,0 +1,48 @@
+import { MultiTokenNtt } from "@wormhole-foundation/sdk-definitions-ntt";
+import { EvmMultiTokenNtt } from "../src/multiTokenNtt.js";
+import { toUniversal } from "@wormhole-foundation/sdk-definitions";
+
+describe("calculateLocalTokenAddress", () => {
+  it("should calculate the correct local token address", async () => {
+    const tokenImplementation = "0xbd7312fA1d9433ab2616FBE7aC615A58D81D2c8E";
+    const creationCode =
+      "0x604060808152610416908138038061001681610218565b93843982019181818403126102135780516001600160a01b038116808203610213576020838101516001600160401b0394919391858211610213570186601f820112156102135780519061007161006c83610253565b610218565b918083528583019886828401011161021357888661008f930161026e565b813b156101b9577f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc80546001600160a01b031916841790556000927fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b8480a28051158015906101b2575b61010b575b855160d190816103458239f35b855194606086019081118682101761019e578697849283926101889952602788527f416464726573733a206c6f772d6c6576656c2064656c65676174652063616c6c87890152660819985a5b195960ca1b8a8901525190845af4913d15610194573d9061017a61006c83610253565b91825281943d92013e610291565b508038808080806100fe565b5060609250610291565b634e487b7160e01b84526041600452602484fd5b50826100f9565b855162461bcd60e51b815260048101859052602d60248201527f455243313936373a206e657720696d706c656d656e746174696f6e206973206e60448201526c1bdd08184818dbdb9d1c9858dd609a1b6064820152608490fd5b600080fd5b6040519190601f01601f191682016001600160401b0381118382101761023d57604052565b634e487b7160e01b600052604160045260246000fd5b6001600160401b03811161023d57601f01601f191660200190565b60005b8381106102815750506000910152565b8181015183820152602001610271565b919290156102f357508151156102a5575090565b3b156102ae5790565b60405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606490fd5b8251909150156103065750805190602001fd5b6044604051809262461bcd60e51b825260206004830152610336815180928160248601526020868601910161026e565b601f01601f19168101030190fdfe608060405236156054577f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc54600090819081906001600160a01b0316368280378136915af43d82803e156050573d90f35b3d90fd5b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc54600090819081906001600160a01b0316368280378136915af43d82803e156050573d90f3fea26469706673582212206554f4df1904914343564cd467a416ab7dfbd4626b3eb40104613d037cd433f264736f6c63430008130033";
+    const expectedAddress = "0xCaf00B2fB2fa0EAE51ecAfef7e45f13fF1BB448a";
+
+    const originalToken: MultiTokenNtt.OriginalTokenId = {
+      chain: "Sepolia",
+      // @ts-ignore
+      address: toUniversal(
+        "Sepolia",
+        "0x738141EFf659625F2eAD4feECDfCD94155C67f18"
+      ),
+    };
+
+    const tokenMeta = {
+      name: "W Token",
+      symbol: "Ws",
+      decimals: 18,
+    };
+
+    const mockMultiTokenNtt = {
+      tokenImplementation: jest.fn().mockResolvedValue(tokenImplementation),
+      tokenProxyCreationCode: jest.fn().mockResolvedValue(creationCode),
+    };
+
+    // Minimal implementation of MultiTokenNtt for testing
+    const multiTokenNtt = {
+      multiTokenNtt: mockMultiTokenNtt,
+      managerAddress: "0x600D3C45Cd002E7359D12597Bb8058a0C32A20Df",
+      chain: "Monad",
+      calculateLocalTokenAddress:
+        EvmMultiTokenNtt.prototype.calculateLocalTokenAddress,
+    };
+
+    const result = await multiTokenNtt.calculateLocalTokenAddress(
+      originalToken,
+      tokenMeta
+    );
+
+    expect(result.toString()).toBe(expectedAddress);
+  });
+});

evm/ts/src/axelar.ts

@@ -0,0 +1,186 @@
+import { Chain, Network } from "@wormhole-foundation/sdk-base";
+
+// The point if this module is to use direct API calls instead of importing the entire @axelar-network/axelarjs-sdk to stay lightweight.
+
+// Axelar chains: https://github.com/axelarnetwork/axelarjs-sdk/blob/53a957deb1209325b1e3d109e0985a64db6d9901/src/constants/EvmChain.ts#L1
+export const axelarChains: Partial<Record<Chain, string>> = {
+  Ethereum: "ethereum",
+  Monad: "monad",
+  Sepolia: "ethereum-sepolia",
+  // add more as needed
+};
+
+// https://github.com/axelarnetwork/axelarjs-sdk/blob/53a957deb1209325b1e3d109e0985a64db6d9901/src/libs/TransactionRecoveryApi/AxelarRecoveryApi.ts#L16
+export enum GMPStatus {
+  SRC_GATEWAY_CALLED = "source_gateway_called",
+  DEST_GATEWAY_APPROVED = "destination_gateway_approved",
+  DEST_EXECUTED = "destination_executed",
+  EXPRESS_EXECUTED = "express_executed",
+  DEST_EXECUTE_ERROR = "error",
+  DEST_EXECUTING = "executing",
+  APPROVING = "approving",
+  FORECALLED = "forecalled",
+  FORECALLED_WITHOUT_GAS_PAID = "forecalled_without_gas_paid",
+  NOT_EXECUTED = "not_executed",
+  NOT_EXECUTED_WITHOUT_GAS_PAID = "not_executed_without_gas_paid",
+  INSUFFICIENT_FEE = "insufficient_fee",
+  UNKNOWN_ERROR = "unknown_error",
+  CANNOT_FETCH_STATUS = "cannot_fetch_status",
+  SRC_GATEWAY_CONFIRMED = "confirmed",
+}
+
+export interface GMPError {
+  txHash: string;
+  chain: string;
+  message: string;
+}
+
+export function getAxelarApiUrl(network: Network): string {
+  return network === "Mainnet"
+    ? "https://api.axelarscan.io"
+    : "https://testnet.api.axelarscan.io";
+}
+
+export function getAxelarChain(chain: Chain): string {
+  const axelarChain = axelarChains[chain];
+  if (!axelarChain) {
+    throw new Error(`Unsupported axelar chain: ${chain}`);
+  }
+  return axelarChain;
+}
+
+export async function getAxelarGasFee(
+  network: Network,
+  sourceChain: Chain,
+  destinationChain: Chain,
+  gasLimit: bigint,
+  timeoutMs = 10000
+): Promise<bigint> {
+  const url = `${getAxelarApiUrl(network)}/gmp/estimateGasFee`;
+  const axelarSourceChain = getAxelarChain(sourceChain);
+  const axelarDestinationChain = getAxelarChain(destinationChain);
+
+  const controller = new AbortController();
+  const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
+
+  // Set a minimum fee of 1 to avoid 0-fee issue with relays not proceeding
+  // past the gas paid step
+  let fee = 1n;
+
+  try {
+    const response = await fetch(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify({
+        sourceChain: axelarSourceChain,
+        destinationChain: axelarDestinationChain,
+        gasMultiplier: "auto",
+        gasLimit: gasLimit.toString(),
+      }),
+      signal: controller.signal,
+    });
+
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Failed to estimate gas fee: ${response.status} ${errorText}`
+      );
+    }
+
+    const result = await response.json();
+
+    const parsedFee = BigInt(result);
+    if (parsedFee > 0n) {
+      fee = parsedFee;
+    }
+  } finally {
+    clearTimeout(timeoutId);
+  }
+
+  return fee;
+}
+
+export async function getAxelarTransactionStatus(
+  network: Network,
+  sourceChain: Chain,
+  txHash: string,
+  timeoutMs = 10000
+): Promise<{ status: GMPStatus | string; error?: GMPError }> {
+  const url = `${getAxelarApiUrl(network)}/gmp/searchGMP`;
+
+  const axelarSourceChain = getAxelarChain(sourceChain);
+
+  const controller = new AbortController();
+  const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
+
+  try {
+    const response = await fetch(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify({
+        sourceChain: axelarSourceChain,
+        txHash: txHash,
+      }),
+      signal: controller.signal,
+    });
+
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Failed to get transaction status: ${response.status} ${errorText}`
+      );
+    }
+
+    const result = await response.json();
+    if (!result.data || result.data.length === 0) {
+      throw new Error("No transaction details found");
+    }
+
+    const txDetails = result.data[0];
+    return {
+      status: parseGMPStatus(txDetails),
+      error: parseGMPError(txDetails),
+    };
+  } finally {
+    clearTimeout(timeoutId);
+  }
+}
+
+export function parseGMPStatus(response: any): GMPStatus | string {
+  const { error, status } = response;
+
+  if (status === "error" && error) return GMPStatus.DEST_EXECUTE_ERROR;
+  else if (status === "executed") return GMPStatus.DEST_EXECUTED;
+  else if (status === "approved") return GMPStatus.DEST_GATEWAY_APPROVED;
+  else if (status === "called") return GMPStatus.SRC_GATEWAY_CALLED;
+  else if (status === "executing") return GMPStatus.DEST_EXECUTING;
+  else {
+    return status;
+  }
+}
+
+export function parseGMPError(response: any): GMPError | undefined {
+  if (response.error) {
+    return {
+      message: response.error.error.message,
+      txHash: response.error.sourceTransactionHash,
+      chain: response.error.chain,
+    };
+  } else if (response.is_insufficient_fee) {
+    return {
+      message: "Insufficient gas",
+      txHash: response.call.transaction.hash,
+      chain: response.call.chain,
+    };
+  }
+}
+
+export function getAxelarExplorerUrl(network: Network, txHash: string): string {
+  return network === "Mainnet"
+    ? `https://axelarscan.io/gmp/${txHash}`
+    : `https://testnet.axelarscan.io/gmp/${txHash}`;
+}