[work-in-progress] improve manual relay

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   - Fixed `estimateGasFee` function in how it handles the `minGasPrice` parameter, which should compare the min to the destination chain gas price, whereas it was comparing to the source chain price originally.
 - AxelarRecoveryAPI
   - introduced wss subscription service (subscribeToTx) to invoke subscribe to specific transactions for updates
+- AxelarGMPRecoveryAPI
+  - fixes to manualRelayToDestinationChain to first check is transaction is already confirmed but not broadcast, and broadcast the transaction (as identified by command ID) if so
 
 ## [0.12.4] - 2023-FEBRUARY-1
 

src/constants/index.ts

@@ -5,6 +5,7 @@ export interface EnvironmentConfigs {
   axelarRpcUrl: string;
   axelarLcdUrl: string;
   axelarGMPApiUrl: string;
+  axelarscanBaseApiUrl: string;
   depositServiceUrl: string;
   recoveryApiUrl: string;
   axelarCrosschainApiUrl: string;
@@ -17,6 +18,7 @@ const localConfigs: EnvironmentConfigs = {
   axelarRpcUrl: "https://axelar-testnet-rpc.axelar-dev.workers.dev",
   axelarLcdUrl: "https://axelar-testnet-lcd.axelar-dev.workers.dev",
   axelarGMPApiUrl: "https://testnet.api.gmp.axelarscan.io",
+  axelarscanBaseApiUrl: "",
   depositServiceUrl: "https://deposit-service-devnet-release.devnet.axelar.dev",
   recoveryApiUrl: "https://axelar-signing-relayer-testnet.axelar.dev",
   axelarCrosschainApiUrl: "https://testnet.api.axelarscan.io/cross-chain",
@@ -28,6 +30,7 @@ const devnetConfigs: EnvironmentConfigs = {
   axelarRpcUrl: "",
   axelarLcdUrl: "",
   axelarGMPApiUrl: "https://devnet.api.gmp.axelarscan.io",
+  axelarscanBaseApiUrl: "",
   depositServiceUrl: "https://deposit-service-devnet-release.devnet.axelar.dev",
   recoveryApiUrl: "",
   axelarCrosschainApiUrl: "",
@@ -40,6 +43,7 @@ const testnetConfigs: EnvironmentConfigs = {
   axelarLcdUrl: "https://rpc-axelar-testnet.imperator.co",
   depositServiceUrl: "https://deposit-service.testnet.axelar.dev",
   axelarGMPApiUrl: "https://testnet.api.gmp.axelarscan.io",
+  axelarscanBaseApiUrl: "https://testnet.api.axelarscan.io",
   recoveryApiUrl: "https://axelar-signing-relayer-testnet.axelar.dev",
   axelarCrosschainApiUrl: "https://testnet.api.axelarscan.io/cross-chain",
   axelarscanUrl: "https://testnet.axelarscan.io",
@@ -50,6 +54,7 @@ const mainnetConfigs: EnvironmentConfigs = {
   axelarRpcUrl: "https://mainnet.rpc.axelar.dev/chain/axelar",
   axelarLcdUrl: "https://lcd-axelar.imperator.co",
   axelarGMPApiUrl: "https://api.gmp.axelarscan.io",
+  axelarscanBaseApiUrl: "https://api.axelarscan.io",
   depositServiceUrl: "https://deposit-service.mainnet.axelar.dev",
   recoveryApiUrl: "https://axelar-signing-relayer-mainnet.axelar.dev",
   axelarCrosschainApiUrl: "https://api.axelarscan.io/cross-chain",

src/libs/TransactionRecoveryApi/AxelarGMPRecoveryAPI.ts

@@ -13,6 +13,7 @@ import {
 } from "../types";
 import {
   AxelarRecoveryApi,
+  BatchedCommandsAxelarscanResponse,
   ExecuteParams,
   GMPStatus,
   GMPStatusResponse,
@@ -25,6 +26,7 @@ import { AxelarQueryAPI } from "../AxelarQueryAPI";
 import rpcInfo from "./constants/chain";
 import {
   getDestinationChainFromTxReceipt,
+  getEventIndexFromTxReceipt,
   getGasAmountFromTxReceipt,
   getLogIndexFromTxReceipt,
   getNativeGasAmountFromTxReceipt,
@@ -46,10 +48,11 @@ import {
   NotGMPTransactionError,
   UnsupportedGasTokenError,
 } from "./constants/error";
-import { callExecute, CALL_EXECUTE_ERROR } from "./helpers";
+import { callExecute, CALL_EXECUTE_ERROR, getCommandId } from "./helpers";
 import { asyncRetry, sleep, throwIfInvalidChainIds } from "../../utils";
 import { BatchedCommandsResponse } from "@axelar-network/axelarjs-types/axelar/evm/v1beta1/query";
-import { Interface } from "ethers/lib/utils";
+import { arrayify, Interface, keccak256 } from "ethers/lib/utils";
+import { fromHex } from "@cosmjs/encoding";
 
 export class AxelarGMPRecoveryAPI extends AxelarRecoveryApi {
   axelarQueryApi: AxelarQueryAPI;
@@ -77,6 +80,10 @@ export class AxelarGMPRecoveryAPI extends AxelarRecoveryApi {
     });
   }
 
+  public getCommandIdFromSrcTxHash(srcChainId: number, txHash: string, eventIndex: number) {
+    return getCommandId(srcChainId, txHash, eventIndex);
+  }
+
   public async manualRelayToDestChain(
     txHash: string,
     evmWalletDetails?: EvmWalletDetails
@@ -97,6 +104,9 @@ export class AxelarGMPRecoveryAPI extends AxelarRecoveryApi {
       signCommandTx,
     });
 
+    /**
+     * 1. check if transaction is already executed or approved
+     */
     if (status === GMPStatus.CANNOT_FETCH_STATUS)
       return errorResponse(ApproveGatewayError.FETCHING_STATUS_FAILED);
     if (status === GMPStatus.DEST_EXECUTED)
@@ -105,23 +115,59 @@ export class AxelarGMPRecoveryAPI extends AxelarRecoveryApi {
       return errorResponse(ApproveGatewayError.ALREADY_APPROVED);
 
     const srcChain = callTx.chain;
+    const destChainName = callTx.returnValues.destinationChain.toLowerCase();
     const destChain = callTx.returnValues.destinationChain;
 
+    /**
+     * 3. check if command ID exists. if it does, no need to reconfirm. if it doesn't, then move on to confirm
+     * if command ID exists but command has not been executed, then execute it
+     */
     try {
-      confirmTx = await this.confirmGatewayTx(txHash, srcChain);
-      await sleep(2);
+      const destChainId = rpcInfo[this.environment].networkInfo[destChainName]?.chainId;
+      const eventIndex = await this.getEventIndex(srcChain, txHash, evmWalletDetails);
+      if (!eventIndex || eventIndex < 0) throw `could not find event index for ${txHash}`;
+
+      const commandId = this.getCommandIdFromSrcTxHash(destChainId, txHash, eventIndex);
+      if (commandId) {
+        const batchData = await this.fetchBatchData(commandId);
+        if (batchData) {
+          const command = batchData.commands.find((command) => command.id === commandId);
+          if (command && !command?.executed) {
+            const approveTx = await this.sendApproveTx(
+              destChain,
+              batchData.execute_data,
+              _evmWalletDetails
+            );
+            return {
+              success: true,
+              approveTx,
+            };
+          }
+          return { success: false, error: "Transaction is already confirmed" };
+        }
+        return {
+          success: false,
+          error: "Already confirmed but unable to send to destination chain",
+        };
+      }
+    } catch (e) {
+      console.error(e);
+    }
 
-      createPendingTransferTx = await this.createPendingTransfers(destChain);
-      await sleep(2);
+    /**
+     * 4. transaction was not confirmed by the network at all, so confirm it and bring through the rest of the pipeline
+     */
+
+    try {
+      confirmTx = await this.confirmGatewayTx(txHash, srcChain);
+      await sleep(3);
 
       signCommandTx = await this.signCommands(destChain);
       const signEvent = signCommandTx.rawLog[0]?.events?.find(
         (event: any) => event.type === "sign"
       );
+      await sleep(3);
 
-      if (!signEvent) return errorResponse(ApproveGatewayError.SIGN_COMMAND_FAILED);
-
-      await sleep(2);
       const batchedCommandId = signEvent.attributes.find(
         (attr: any) => attr.key === "batchedCommandId"
       )?.value;
@@ -132,7 +178,7 @@ export class AxelarGMPRecoveryAPI extends AxelarRecoveryApi {
       );
       if (!batchedCommand) return errorResponse(ApproveGatewayError.ERROR_BATCHED_COMMAND);
 
-      await sleep(2);
+      await sleep(3);
 
       const approveTx = await this.sendApproveTx(
         destChain,
@@ -217,6 +263,13 @@ export class AxelarGMPRecoveryAPI extends AxelarRecoveryApi {
     return this.subtractGasFee(sourceChain, destinationChain, gasTokenSymbol, paidGasFee, options);
   }
 
+  public async getEventIndex(chain: EvmChain, txHash: string, evmWalletDetails?: EvmWalletDetails) {
+    const signer = this.getSigner(chain, evmWalletDetails || { useWindowEthereum: true });
+    const receipt = await signer.provider.getTransactionReceipt(txHash);
+    if (!receipt) return -1;
+    return getEventIndexFromTxReceipt(receipt);
+  }
+
   /**
    * Pay native token as gas fee for the given transaction hash.
    * If the transaction details is not valid, it will return an error with reason.

src/libs/TransactionRecoveryApi/AxelarRecoveryApi.ts

@@ -70,6 +70,33 @@ export interface ExecuteParamsResponse {
   data?: ExecuteParams;
 }
 
+export interface CommandObj {
+  id: string;
+  type: string;
+  key_id: string;
+  max_gas_cost: number;
+  executed: boolean;
+  transactionHash: string;
+  transactionIndex: string;
+  logIndex: number;
+  block_timestamp: number;
+}
+export interface BatchedCommandsAxelarscanResponse {
+  data: string;
+  status: string;
+  key_id: string;
+  execute_data: string;
+  prev_batched_commands_id: string;
+  command_ids: string[];
+  proof: Record<string, string[]>;
+  weights: string[];
+  threshold: string;
+  signatures: string[];
+  batch_id: string;
+  chain: string;
+  commands: CommandObj[];
+  id: string;
+}
 export type SubscriptionStrategy =
   | {
       kind: "websocket";
@@ -88,6 +115,7 @@ export class AxelarRecoveryApi {
   readonly environment: Environment;
   readonly recoveryApiUrl: string;
   readonly axelarGMPApiUrl: string;
+  readonly axelarscanBaseApiUrl: string;
   readonly axelarRpcUrl: string;
   readonly axelarLcdUrl: string;
   readonly wssStatusUrl: string;
@@ -99,6 +127,7 @@ export class AxelarRecoveryApi {
     const { environment } = config;
     const links: EnvironmentConfigs = getConfigs(environment);
     this.axelarGMPApiUrl = links.axelarGMPApiUrl;
+    this.axelarscanBaseApiUrl = links.axelarscanBaseApiUrl;
     this.recoveryApiUrl = links.recoveryApiUrl;
     this.wssStatusUrl = links.wssStatus;
     this.axelarRpcUrl = config.axelarRpcUrl || links.axelarRpcUrl;
@@ -117,6 +146,14 @@ export class AxelarRecoveryApi {
       .catch(() => undefined);
   }
 
+  public async fetchBatchData(commandId: string): Promise<BatchedCommandsAxelarscanResponse> {
+    return this.execPost(this.axelarscanBaseApiUrl, "/batches", {
+      commandId,
+    })
+      .then((res) => res[0])
+      .catch(() => undefined);
+  }
+
   private parseGMPStatus(response: any): GMPStatus | string {
     const { error, status } = response;
 

src/libs/TransactionRecoveryApi/client/EVMClient/index.ts

@@ -13,7 +13,7 @@ export default class EVMClient {
       this.provider = provider;
     } else {
       this.provider =
-        useWindowEthereum && window?.ethereum
+        useWindowEthereum && typeof window !== "undefined" && window?.ethereum
           ? new ethers.providers.Web3Provider(window.ethereum, networkOptions)
           : new ethers.providers.JsonRpcProvider(rpcUrl, networkOptions);
     }

src/libs/TransactionRecoveryApi/helpers/contractEventHelper.ts

@@ -30,6 +30,14 @@ export function getLogIndexFromTxReceipt(
   );
 }
 
+export function getEventIndexFromTxReceipt(
+  receipt: ethers.providers.TransactionReceipt
+): Nullable<number> {
+  return (
+    getContractCallEvent(receipt)?.eventIndex || getContractCallWithTokenEvent(receipt)?.eventIndex
+  );
+}
+
 export function isContractCallWithToken(receipt: ethers.providers.TransactionReceipt): boolean {
   return !!getContractCallWithTokenEvent(receipt);
 }
@@ -173,14 +181,15 @@ export function findContractEvent(
   eventSignatures: string[],
   abiInterface: Interface
 ): Nullable<EventLog> {
-  for (const log of receipt.logs) {
+  for (const [index, log] of receipt.logs.entries()) {
     const eventIndex = eventSignatures.indexOf(log.topics[0]);
     if (eventIndex > -1) {
       const eventLog = abiInterface.parseLog(log);
       return {
         signature: eventSignatures[eventIndex],
         eventLog,
         logIndex: log.logIndex,
+        eventIndex: index,
       };
     }
   }

src/libs/TransactionRecoveryApi/helpers/getCommandId.ts

@@ -0,0 +1,15 @@
+import { arrayify, keccak256 } from "ethers/lib/utils";
+
+export function getCommandId(chainID: number, txHash: string, sourceEventIndex: number) {
+  const seiArr = arrayify(sourceEventIndex).reverse();
+  const txHashWithEventIndex = new Uint8Array([
+    ...arrayify(txHash),
+    ...new Uint8Array(8).map((a, i) => seiArr[i] || a),
+  ]);
+  console.log("chain id", chainID);
+  const chainIdByteArray = arrayify(chainID);
+  const dataToHash = new Uint8Array(txHashWithEventIndex.length + chainIdByteArray.length);
+  dataToHash.set(txHashWithEventIndex, 0);
+  dataToHash.set(chainIdByteArray, txHashWithEventIndex.length);
+  return keccak256(dataToHash).slice(2); // remove 0x prefix
+}

src/libs/TransactionRecoveryApi/helpers/index.ts

@@ -2,3 +2,4 @@ export * from "./axelarHelper";
 export * from "./contractEventHelper";
 export * from "./providerHelper";
 export * from "./contractCallHelper";
+export * from "./getCommandId";

src/libs/test/TransactionRecoveryAPI/EncodingTests.spec.ts

@@ -0,0 +1,27 @@
+import { AxelarGMPRecoveryAPI } from "../../TransactionRecoveryApi/AxelarGMPRecoveryAPI";
+import { AddGasOptions, Environment, EvmChain, EvmWalletDetails } from "../../types";
+import { utils } from "@axelar-network/axelar-local-dev";
+
+describe("AxelarDepositRecoveryAPI", () => {
+  const { setLogger } = utils;
+  setLogger(() => null);
+
+  let evmWalletDetails: EvmWalletDetails;
+  beforeEach(() => {
+    vitest.clearAllMocks();
+    evmWalletDetails = {
+      privateKey: "",
+      useWindowEthereum: false,
+    };
+  });
+
+  describe("creating command ID", () => {
+    const api = new AxelarGMPRecoveryAPI({ environment: Environment.TESTNET });
+    test("It should create a command ID from a tx hash and event index", async () => {
+      const txHash = "0xa290f800f2089535a0abb013cea9cb26e1cdb3f2a2f2a8dcef2f149eb7a4d3be";
+      const eventIndex = await api.getEventIndex(EvmChain.MOONBEAM, txHash, evmWalletDetails);
+      const res = await api.getCommandIdFromSrcTxHash(97, txHash, eventIndex as number);
+      expect(res).toEqual("131f5b18753a46a21b9a154818242c9dc0647c9d85faf13461bd3fefbab6c3de");
+    }, 60000);
+  });
+});

src/libs/types/index.ts

@@ -148,6 +148,7 @@ export interface EventLog {
   signature: string;
   eventLog: LogDescription;
   logIndex: number;
+  eventIndex: number;
 }
 
 export interface ExecuteArgs {