refactor: adapt add-gas module to support IOC pattern

packages/transaction-recovery/scripts/clean.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-npx rimraf build cosmosSigner services *.js *.d.ts
+npx rimraf build add-gas *.js *.d.ts

packages/transaction-recovery/src/addGas/addGas.spec.ts → packages/transaction-recovery/src/add-gas/addGas.spec.ts

@@ -1,10 +1,13 @@
+import { createAxelarQueryNodeClient } from "@axelarjs/api/axelar-query/node";
+import { createAxelarConfigNodeClient } from "@axelarjs/api/config/node";
+import { createGMPNodeClient } from "@axelarjs/api/gmp/node";
 import { ENVIRONMENTS } from "@axelarjs/core";
 
 import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
 import { vi } from "vitest";
 
 import { type AutocalculateGasOptions, type SendOptions } from "../types";
-import { addGas } from "./addGas";
+import { addGas, AddGasDependencies } from "./addGas";
 
 const MOCK_ADD_GAS_RESPONSE = {
   code: 0,
@@ -19,19 +22,22 @@ const MOCK_ADD_GAS_RESPONSE = {
   gasWanted: 250000,
 };
 
-vi.mock("../cosmosSigner/signer", () => {
-  const mockAddGasSignAndBroadcast = () => MOCK_ADD_GAS_RESPONSE;
-
-  const getCosmosSigner = vi.fn(() => ({
-    signAndBroadcast: vi.fn().mockImplementation(mockAddGasSignAndBroadcast),
-  }));
-
-  return {
-    getCosmosSigner,
+describe("addGas", () => {
+  const mockSignAndBroadcast = () => MOCK_ADD_GAS_RESPONSE;
+
+  const mockGetSigningStargateClient = vi.fn(() =>
+    Promise.resolve({
+      signAndBroadcast: vi.fn().mockImplementation(mockSignAndBroadcast),
+    })
+  );
+
+  const DEFAULT_ADD_GAS_DEPENDENCIES: AddGasDependencies = {
+    axelarQueryClient: createAxelarQueryNodeClient(ENVIRONMENTS.testnet),
+    configClient: createAxelarConfigNodeClient(ENVIRONMENTS.testnet),
+    gmpClient: createGMPNodeClient(ENVIRONMENTS.testnet),
+    getSigningStargateClient: mockGetSigningStargateClient as any,
   };
-});
 
-describe("addGas", () => {
   test("broadcast an IBC transfer", async () => {
     const txHash =
       "6118C285B0C7A139C5636184BECBF8C201FF36B61F44060B82EFE4C535084D9C";
@@ -56,12 +62,15 @@ describe("addGas", () => {
       offlineSigner,
     };
 
-    const res = await addGas({
-      txHash,
-      token,
-      sendOptions,
-      chain: "osmosis-6",
-    });
+    const res = await addGas(
+      {
+        txHash,
+        token,
+        sendOptions,
+        chain: "osmosis-6",
+      },
+      DEFAULT_ADD_GAS_DEPENDENCIES
+    );
 
     expect(res).toEqual({
       broadcastResult: MOCK_ADD_GAS_RESPONSE,
@@ -93,13 +102,16 @@ describe("addGas", () => {
       offlineSigner,
     };
 
-    const res = await addGas({
-      txHash,
-      token: "autocalculate",
-      sendOptions,
-      autocalculateGasOptions,
-      chain: "osmosis-6",
-    });
+    const res = await addGas(
+      {
+        txHash,
+        token: "autocalculate",
+        sendOptions,
+        autocalculateGasOptions,
+        chain: "osmosis-6",
+      },
+      DEFAULT_ADD_GAS_DEPENDENCIES
+    );
 
     expect(res).toEqual({
       broadcastResult: MOCK_ADD_GAS_RESPONSE,

packages/transaction-recovery/src/addGas/addGas.ts → packages/transaction-recovery/src/add-gas/addGas.ts

@@ -1,35 +1,50 @@
-import { S3CosmosChainConfig } from "@axelarjs/api/s3/types";
-import { COSMOS_GAS_RECEIVER_OPTIONS, Environment } from "@axelarjs/core";
+import { AxelarQueryAPIClient, ConfigClient, GMPClient } from "@axelarjs/api";
+import { AxelarCosmosChainConfig } from "@axelarjs/api/config/types";
+import { COSMOS_GAS_RECEIVER_OPTIONS } from "@axelarjs/core";
 
-import { assertIsDeliverTxSuccess, Coin } from "@cosmjs/stargate";
+import { OfflineSigner } from "@cosmjs/proto-signing";
+import {
+  assertIsDeliverTxSuccess,
+  Coin,
+  SigningStargateClient,
+} from "@cosmjs/stargate";
 
-import { getCosmosSigner } from "../cosmosSigner";
-import { getGmpClient, getS3Client } from "../services";
 import { AddGasParams, AddGasResponse, GetFullFeeOptions } from "../types";
 
+export type AddGasDependencies = {
+  axelarQueryClient: AxelarQueryAPIClient;
+  configClient: ConfigClient;
+  gmpClient: GMPClient;
+  getSigningStargateClient: (
+    rpcUrl: string,
+    offlineSigner: OfflineSigner
+  ) => Promise<SigningStargateClient>;
+};
+
 /**
  * Adds gas to a transaction that might be stuck due to insufficient gas
  *
  * @param params {AddGasParams} - Parameters to add gas to a transaction
  * @returns {Promise<AddGasResponse>} - Response from adding gas to a transaction
  */
-export async function addGas({
-  autocalculateGasOptions,
-  sendOptions,
-  ...params
-}: AddGasParams): Promise<AddGasResponse> {
-  const chainConfig = await fetchChainConfig(
-    sendOptions.environment,
-    params.chain
-  );
+export async function addGas(
+  { autocalculateGasOptions, sendOptions, ...params }: AddGasParams,
+  dependencies: AddGasDependencies
+): Promise<AddGasResponse> {
+  const chainConfig = await dependencies.configClient
+    .getChainConfigs(sendOptions.environment)
+    .then((res) => res.chains[params.chain] as AxelarCosmosChainConfig)
+    .catch(() => undefined);
 
   if (!chainConfig) {
     throw new Error(`chain ID ${params.chain} not found`);
   }
 
   const { rpc, channelIdToAxelar } = chainConfig.cosmosConfigs;
 
-  const tx = await fetchGMPTransaction(sendOptions.environment, params.txHash);
+  const [tx] = await dependencies.gmpClient
+    .searchGMP({ txHash: params.txHash })
+    .catch(() => []);
 
   if (!tx) {
     return {
@@ -56,9 +71,9 @@ export async function addGas({
       ? params.token
       : await getFullFee({
           tx,
-          environment: sendOptions.environment,
           autocalculateGasOptions,
           chainConfig,
+          axelarQueryClient: dependencies.axelarQueryClient,
         });
 
   const sender = await sendOptions.offlineSigner
@@ -81,9 +96,12 @@ export async function addGas({
     };
   }
 
-  const signer = await getCosmosSigner(rpcUrl, sendOptions.offlineSigner);
+  const signingStargateClient = await dependencies.getSigningStargateClient(
+    rpcUrl,
+    sendOptions.offlineSigner
+  );
 
-  const broadcastResult = await signer.signAndBroadcast(
+  const broadcastResult = await signingStargateClient.signAndBroadcast(
     sender,
     [
       {
@@ -111,47 +129,20 @@ export async function addGas({
     broadcastResult,
   };
 }
-
-async function fetchChainConfig(environment: Environment, chain: string) {
-  const s3Client = await getS3Client(environment);
-  return s3Client
-    .getChainConfigs(environment)
-    .then((res) => res.chains[chain] as S3CosmosChainConfig)
-    .catch(() => undefined);
-}
-
-async function fetchGMPTransaction(environment: Environment, txHash: string) {
-  const gmpClient = await getGmpClient(environment);
-  const [tx] = await gmpClient.searchGMP({ txHash }).catch(() => []);
-
-  return tx;
-}
-
 async function getFullFee({
-  environment,
   autocalculateGasOptions,
   tx,
   chainConfig,
+  axelarQueryClient,
 }: GetFullFeeOptions): Promise<Coin> {
-  const apiClient =
-    typeof window === "undefined"
-      ? (
-          await import("@axelarjs/api/axelar-query/node")
-        ).createAxelarQueryNodeClient(environment, {})
-      : (
-          await import("@axelarjs/api/axelar-query/browser")
-        ).createAxelarQueryBrowserClient(environment, {});
-
-  const amount = await apiClient.estimateGasFee({
+  const amount = await axelarQueryClient.estimateGasFee({
     sourceChain: tx.call.chain,
     destinationChain: tx.call.returnValues.destinationChain,
     gasLimit: autocalculateGasOptions?.gasLimit ?? BigInt(1_000_000),
     gasMultiplier: autocalculateGasOptions?.gasMultipler ?? 1,
     sourceTokenSymbol: tx.gas_paid.returnValues.denom,
   });
 
-  console.log({ amount });
-
   const denom = getIBCDenomOnSrcChain(
     tx.gas_paid.returnValues.denom,
     chainConfig
@@ -172,7 +163,7 @@ function matchesOriginalTokenPayment(
 
 function getIBCDenomOnSrcChain(
   denomOnAxelar: string,
-  chain: S3CosmosChainConfig
+  chain: AxelarCosmosChainConfig
 ) {
   const { ibcDenom } =
     chain.assets?.find(({ id }) => id === denomOnAxelar) ?? {};

packages/transaction-recovery/src/add-gas/browser.ts

@@ -0,0 +1,21 @@
+import {
+  createAxelarQueryBrowserClient,
+  createConfigBrowserClient,
+  createGMPBrowserClient,
+} from "@axelarjs/api";
+
+import { SigningStargateClient } from "@cosmjs/stargate";
+
+import { AddGasParams } from "~/types";
+import { addGas } from "./addGas";
+
+export default function addGasBrowser(params: AddGasParams) {
+  const { environment } = params.sendOptions;
+
+  return addGas(params, {
+    axelarQueryClient: createAxelarQueryBrowserClient(environment, {}),
+    configClient: createConfigBrowserClient(environment),
+    gmpClient: createGMPBrowserClient(environment),
+    getSigningStargateClient: SigningStargateClient.connectWithSigner,
+  });
+}

packages/transaction-recovery/src/add-gas/node.ts

@@ -0,0 +1,21 @@
+import {
+  createAxelarQueryNodeClient,
+  createConfigNodeClient,
+  createGMPNodeClient,
+} from "@axelarjs/api";
+
+import { SigningStargateClient } from "@cosmjs/stargate";
+
+import { AddGasParams } from "~/types";
+import { addGas } from "./addGas";
+
+export default function addGasNode(params: AddGasParams) {
+  const { environment } = params.sendOptions;
+
+  return addGas(params, {
+    axelarQueryClient: createAxelarQueryNodeClient(environment, {}),
+    configClient: createConfigNodeClient(environment),
+    gmpClient: createGMPNodeClient(environment),
+    getSigningStargateClient: SigningStargateClient.connectWithSigner,
+  });
+}

packages/transaction-recovery/src/index.ts

@@ -1 +1 @@
-export * from "./addGas";
+export * from "./add-gas";

packages/transaction-recovery/src/types.ts

@@ -1,8 +1,12 @@
-import { S3CosmosChainConfig, SearchGMPResponseData } from "@axelarjs/api";
-import { Environment } from "@axelarjs/core";
+import type {
+  AxelarCosmosChainConfig,
+  AxelarQueryAPIClient,
+  SearchGMPResponseData,
+} from "@axelarjs/api";
+import type { Environment } from "@axelarjs/core";
 
-import { OfflineSigner } from "@cosmjs/proto-signing";
-import { Coin, DeliverTxResponse, StdFee } from "@cosmjs/stargate";
+import type { OfflineSigner } from "@cosmjs/proto-signing";
+import type { Coin, DeliverTxResponse, StdFee } from "@cosmjs/stargate";
 
 export type SendOptions = {
   txFee: StdFee;
@@ -31,8 +35,8 @@ export type AddGasResponse = {
 };
 
 export type GetFullFeeOptions = {
-  environment: Environment;
   autocalculateGasOptions?: AutocalculateGasOptions | undefined;
   tx: SearchGMPResponseData;
-  chainConfig: S3CosmosChainConfig;
+  chainConfig: AxelarCosmosChainConfig;
+  axelarQueryClient: AxelarQueryAPIClient;
 };