feat:add-tx-recovery

[npty]

Description

AXE-2924
AXE-4087

This PR has migrated the manualRelayToDestChain function from the old sdk to axelarjs. It's completely rewrote for readability and maintainability purpose, but it should work the same. The response format is compatible with the old version as well.

This PR also fixed our failed tests in that haven't been fixed for long time.

Usage

The function signature is changed (in a better way) due to our isomorphic pattern.

import { manualRelayToDestChain } from '@axelarjs/transaction-recovery';

// params structure
const params = {
  environment: "testnet" | "mainnet",
  txHash: "0x..",
  options?: {
       escapeAfterConfirm?: boolean | undefined;
       txLogIndex?: number | undefined;
       messageId?: string | undefined;
  }
}

// Basic Usage
const response = await manualRelayToDestChain({
  txHash,
  environment
});

The response's type is ManualRelayToDestChainResponse as below:

export type RecoveryTxType =
  | "axelar.confirm_gateway_tx"
  | "axelar.sign_commands"
  | "axelar.route_message"
  | "evm.gateway_approve";

export type RecoveryTx = {
  transactionHash: string;
};

export type ManualRelayToDestChainResponse = {
  success: boolean;
  type: RouteDir;
  logs: string[];
  error?: string | undefined;
  confirmTx?: RecoveryTx | undefined;
  signCommandTx?: RecoveryTx | undefined;
  routeMessageTx?: RecoveryTx | undefined;
  gatewayApproveTx?: RecoveryTx | undefined;
};

Migration Guide for Axelarscan

1. Install new package: npm install @axelarjs/transaction-recovery
2. Replace the old import with the following code:

import { manualRelayToDestChain, } from '@axelarjs/transaction-recovery';

3. Update the function call as follows:

const options = { 
  escapeAfterConfirm,
  messageId,
  txLogIndex: logIndex;
}
const response = await manualRelayToDestChain(ENVIRONMENT, transactionHash, options);

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
axelar-maestro	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 11, 2024 7:24am
axelar-registry	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 11, 2024 7:24am
axelar-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 11, 2024 7:24am

[changeset-bot]

🦋 Changeset detected

Latest commit: 4719824

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@axelarjs/transaction-recovery	Minor
@axelarjs/api	Minor
@axelarjs/cosmos	Patch
@axelarjs/core	Patch
@axelarjs/maestro	Patch
@axelarjs/deposit-address	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR