@keplr-wallet/background 0.12.312 → 0.13.0

package/src/recent-send-history/types.ts

@@ -1,7 +1,15 @@
-import { AppCurrency } from "@keplr-wallet/types";
+import { AppCurrency, SwapProvider } from "@keplr-wallet/types";
 
+export { SwapProvider };
+
+// ============================================================================
+// RecentSend History Types
+// ============================================================================
+
+/**
+ * Stored recent send history record.
+ */
 export interface RecentSendHistory {
-  timestamp: number;
   sender: string;
   recipient: string;
   amount: {
@@ -9,7 +17,6 @@ export interface RecentSendHistory {
     denom: string;
   }[];
   memo: string;
-
   ibcChannels:
     | {
         portId: string;
@@ -17,8 +24,123 @@ export interface RecentSendHistory {
         counterpartyChainId: string;
       }[]
     | undefined;
+  timestamp: number;
 }
 
+// ============================================================================
+// IBC History Types (Transfer & Swap)
+// ============================================================================
+
+/**
+ * Data required to record an IBC transfer history.
+ * Used by tx-executor when creating history entries.
+ */
+export interface IBCTransferHistoryData {
+  readonly historyType: string;
+  readonly sourceChainId: string;
+  readonly destinationChainId: string;
+  readonly channels: {
+    portId: string;
+    channelId: string;
+    counterpartyChainId: string;
+  }[];
+  readonly sender: string;
+  readonly recipient: string;
+  readonly amount: {
+    readonly amount: string;
+    readonly denom: string;
+  }[];
+  readonly memo: string;
+  readonly notificationInfo: {
+    readonly currencies: AppCurrency[];
+  };
+}
+
+/**
+ * Data required to record an IBC swap history.
+ * Used by tx-executor when creating history entries.
+ */
+export interface IBCSwapHistoryData {
+  readonly swapType: "amount-in" | "amount-out";
+  readonly chainId: string;
+  readonly destinationChainId: string;
+  readonly sender: string;
+  readonly amount: {
+    amount: string;
+    denom: string;
+  }[];
+  readonly memo: string;
+  readonly ibcChannels: {
+    portId: string;
+    channelId: string;
+    counterpartyChainId: string;
+  }[];
+  readonly destinationAsset: {
+    chainId: string;
+    denom: string;
+  };
+  readonly swapChannelIndex: number;
+  readonly swapReceiver: string[];
+  readonly notificationInfo: {
+    currencies: AppCurrency[];
+  };
+}
+
+// IBC swap 추가 트래킹에 필요한 최소 입력 데이터
+export type IBCSwapMinimalTrackingData = Pick<
+  IBCSwapHistoryData,
+  "chainId" | "swapReceiver" | "ibcChannels" | "swapChannelIndex"
+>;
+
+/**
+ * Stored IBC transfer history record (subset of IBCHistory).
+ */
+export interface IBCTransferHistory {
+  recipient: string;
+}
+
+/**
+ * Stored IBC swap history record (subset of IBCHistory).
+ */
+export interface IBCSwapHistory {
+  swapType: "amount-in" | "amount-out";
+  swapChannelIndex: number;
+  swapReceiver: string[];
+
+  destinationAsset: {
+    chainId: string;
+    denom: string;
+  };
+
+  resAmount: {
+    amount: string;
+    denom: string;
+  }[][];
+
+  swapRefundInfo?: {
+    chainId: string;
+    amount: {
+      amount: string;
+      denom: string;
+    }[];
+  };
+}
+
+export type IbcHop = {
+  portId: string;
+  channelId: string;
+  counterpartyChainId: string;
+  sequence?: string;
+  dstChannelId?: string;
+  completed: boolean;
+  error?: string;
+  rewound?: boolean;
+  rewoundButNextRewindingBlocked?: boolean;
+};
+
+/**
+ * Stored IBC history record (union of IBCTransferHistory and IBCSwapHistory).
+ */
 export type IBCHistory = {
   id: string;
   chainId: string;
@@ -38,25 +160,7 @@ export type IBCHistory = {
   txError?: string;
   packetTimeout?: boolean;
 
-  ibcHistory:
-    | {
-        portId: string;
-        channelId: string;
-        counterpartyChainId: string;
-
-        sequence?: string;
-        // 위의 channel id는 src channel id이고
-        // 얘는 dst channel id이다
-        // 각 tracking이 완료될때마다 events에서 찾아서 추가된다.
-        dstChannelId?: string;
-
-        completed: boolean;
-        error?: string;
-        rewound?: boolean;
-        // swap 이후에는 rewind가 불가능하기 때문에
-        // swap 등에서는 이 값이 true일 수 있음
-        rewoundButNextRewindingBlocked?: boolean;
-      }[];
+  ibcHistory: IbcHop[];
 
   // Already notified to user
   notified?: boolean;
@@ -65,34 +169,155 @@ export type IBCHistory = {
   };
 } & (IBCTransferHistory | IBCSwapHistory);
 
-export interface IBCTransferHistory {
-  recipient: string;
+// ============================================================================
+// SwapV2 History Types
+// ============================================================================
+
+export enum SwapV2RouteStepStatus {
+  IN_PROGRESS = "in_progress",
+  SUCCESS = "success",
+  FAILED = "failed",
+  UNKNOWN = "unknown",
 }
 
-export interface IBCSwapHistory {
-  swapType: "amount-in" | "amount-out";
-  swapChannelIndex: number;
-  swapReceiver: string[];
+export enum SwapV2TxStatus {
+  IN_PROGRESS = "in_progress",
+  SUCCESS = "success",
+  PARTIAL_SUCCESS = "partial_success",
+  FAILED = "failed",
+  UNKNOWN = "unknown",
+}
+
+export interface SwapV2TxStatusStep {
+  chain_id: string;
+  status: SwapV2RouteStepStatus;
+  tx_hash?: string;
+  explorer_url?: string;
+}
+
+export interface SwapV2AssetLocation {
+  chain_id: string;
+  denom: string;
+  amount: string;
+}
+
+export interface SwapV2TxStatusRequest {
+  provider: SwapProvider;
+  from_chain: string;
+  to_chain?: string; // optional, used by Squid
+  tx_hash: string;
+}
+
+export interface SwapV2TxStatusResponse {
+  provider: SwapProvider;
+  status: SwapV2TxStatus;
+  steps: SwapV2TxStatusStep[];
+  asset_location?: SwapV2AssetLocation | null;
+}
 
+/**
+ * Base interface for SwapV2History data.
+ * Contains common fields between SwapV2HistoryData and SwapV2History.
+ */
+export interface SwapV2HistoryBase {
+  fromChainId: string;
+  toChainId: string;
+  provider: SwapProvider;
+  sender: string;
+  recipient: string;
+  amount: {
+    amount: string;
+    denom: string;
+  }[];
+  simpleRoute: {
+    isOnlyEvm: boolean;
+    chainId: string;
+    receiver: string;
+  }[];
   destinationAsset: {
     chainId: string;
     denom: string;
+    expectedAmount: string;
+  };
+  routeDurationSeconds: number;
+  notificationInfo: {
+    currencies: AppCurrency[];
   };
+  isOnlyUseBridge?: boolean;
+}
+
+/**
+ * Data required to record a SwapV2 history.
+ * Used by tx-executor when creating history entries.
+ */
+export type SwapV2HistoryData = SwapV2HistoryBase;
+
+/**
+ * Stored SwapV2 history record.
+ */
+export interface SwapV2History extends SwapV2HistoryBase {
+  id: string;
+  timestamp: number;
+  txHash: string;
+
+  status: SwapV2TxStatus;
+  routeIndex: number; // 현재까지 진행된 라우팅 인덱스
 
   resAmount: {
     amount: string;
     denom: string;
   }[][];
 
-  swapRefundInfo?: {
+  assetLocationInfo?: {
     chainId: string;
     amount: {
       amount: string;
       denom: string;
     }[];
+    /**
+     * "refund": 실패/오류로 인해 자산이 중간에서 릴리즈된 경우
+     * "intermediate": TX는 성공했지만 자산이 최종 목적지가 아닌 중간 단계에 도달한 경우
+     *                 (예: base USDC -> osmosis OSMO 스왑 시, noble USDC가 먼저 도착)
+     *                 이 경우 추가 TX를 실행하여 최종 목적지로 자산을 보내거나,
+     *                 현재 받은 자산을 그대로 둘 수 있음
+     */
+    type: "refund" | "intermediate";
   };
+
+  backgroundExecutionId?: string;
+
+  // Multi TX swap 재개 시 추가 트래킹 데이터
+  additionalTrackingData?:
+    | { type: "evm"; chainId: string; txHash: string } // EVM: debug_traceTransaction으로 추적
+    | {
+        type: "cosmos-ibc";
+        chainId: string;
+        swapReceiver: string[];
+        swapChannelIndex: number;
+        txHash: string; // 시작 트랜잭션 해시
+        txFulfilled?: boolean; // 시작 트랜잭션 완료 여부
+        packetTimeout?: boolean;
+        dynamicHopDetected?: boolean; // 동적 홉이 감지되었는지 여부
+        // 각 IBC hop의 tracking 상태 (필요 최소 데이터만 저장)
+        ibcHistory: IbcHop[];
+      };
+  additionalTrackDone?: boolean; // additional tracking 완료 여부
+  additionalTrackError?: string; // additional tracking 에러
+
+  trackDone?: boolean; // status tracking이 완료되었는지 여부
+  trackError?: string; // status tracking 중 에러가 발생했는지 여부
+  finalizationRetryCount?: number; // success/partial_success/failed 상태에서 currentStep이 진행 중일 때 추가 polling 횟수
+  unknownStatusFirstSeenAt?: number; // UNKNOWN 상태가 처음 발견된 timestamp (ms)
+
+  notified?: boolean;
+
+  hidden?: boolean;
 }
 
+// ============================================================================
+// Skip History Types (Legacy)
+// ============================================================================
+
 export type SkipHistory = {
   id: string;
   chainId: string;
@@ -147,10 +372,22 @@ export type SkipHistory = {
   isOnlyUseBridge?: boolean; // send bridge 페이지에서 swap코드를 사용 하고 있기 때문에 브릿지만 사용했는지 여부 필요함
 };
 
+// ============================================================================
+// History Data Union Type
+// ============================================================================
+
 /**
- * This file is a temporary file to store types that are required for tracking the status of a transaction related to the skip-go.
- * Reference: https://github.com/skip-mev/skip-go/blob/staging/packages/client/src/types/lifecycle.ts
+ * Union type of all history data types.
  */
+export type HistoryData =
+  | IBCTransferHistoryData
+  | IBCSwapHistoryData
+  | SwapV2HistoryData;
+
+// ============================================================================
+// Skip/Bridge Tracking Types
+// Reference: https://github.com/skip-mev/skip-go/blob/staging/packages/client/src/types/lifecycle.ts
+// ============================================================================
 
 export type StatusState =
   | "STATE_UNKNOWN"

package/src/tx/service.ts

@@ -35,6 +35,7 @@ export class BackgroundTxService {
     mode: "async" | "sync" | "block",
     options: {
       silent?: boolean;
+      skipTracingTxResult?: boolean;
       onFulfill?: (tx: any) => void;
     }
   ): Promise<Uint8Array> {
@@ -92,6 +93,10 @@ export class BackgroundTxService {
 
       const txHash = Buffer.from(txResponse.txhash, "hex");
 
+      if (options.skipTracingTxResult) {
+        return txHash;
+      }
+
       // 이 기능은 tx commit일때 notification을 띄울 뿐이다.
       // 실제 로직 처리와는 관계가 없어야하기 때문에 여기서 await을 하면 안된다!!
       retry(
@@ -152,6 +157,42 @@ export class BackgroundTxService {
     }
   }
 
+  async traceTx(chainId: string, txHash: string): Promise<any> {
+    const chainInfo = this.chainsService.getChainInfoOrThrow(chainId);
+    const txHashBuffer = Buffer.from(txHash, "hex");
+
+    return await retry(
+      () => {
+        return new Promise<any>((resolve, reject) => {
+          const txTracer = new TendermintTxTracer(chainInfo.rpc, "/websocket");
+          txTracer.addEventListener("close", () => {
+            // reject if ws closed before fulfilled
+            // 하지만 로직상 fulfill 되기 전에 ws가 닫히는게 되기 때문에
+            // delay를 좀 준다.
+            // trace 이후 로직은 동기적인 로직밖에 없기 때문에 문제될 게 없다.
+            // 문제될게 없다.
+            setTimeout(() => {
+              reject();
+            }, 500);
+          });
+          txTracer.addEventListener("error", () => {
+            reject();
+          });
+          txTracer.traceTx(txHashBuffer).then((tx) => {
+            txTracer.close();
+
+            resolve(tx);
+          });
+        });
+      },
+      {
+        maxRetries: 10,
+        waitMsAfterError: 10 * 1000, // 10sec
+        maxWaitMsAfterError: 5 * 60 * 1000, // 5min
+      }
+    );
+  }
+
   private static processTxResultNotification(
     notification: Notification,
     result: any

package/src/tx-ethereum/service.ts

@@ -20,6 +20,7 @@ export class BackgroundTxEthereumService {
     tx: Uint8Array,
     options: {
       silent?: boolean;
+      skipTracingTxResult?: boolean;
       onFulfill?: (txReceipt: EthTxReceipt) => void;
     }
   ): Promise<string> {
@@ -64,6 +65,10 @@ export class BackgroundTxEthereumService {
         );
       }
 
+      if (options.skipTracingTxResult) {
+        return txHash;
+      }
+
       retry(
         () => {
           return new Promise<void>(async (resolve, reject) => {
@@ -121,6 +126,58 @@ export class BackgroundTxEthereumService {
     }
   }
 
+  async getEthereumTxReceipt(
+    origin: string,
+    chainId: string,
+    txHash: string
+  ): Promise<EthTxReceipt | null> {
+    const chainInfo = this.chainsService.getChainInfoOrThrow(chainId);
+    const evmInfo = ChainsService.getEVMInfo(chainInfo);
+    if (!evmInfo) {
+      return null;
+    }
+
+    return await retry(
+      () => {
+        return new Promise<EthTxReceipt | null>(async (resolve, reject) => {
+          const txReceiptResponse = await simpleFetch<{
+            result: EthTxReceipt | null;
+            error?: Error;
+          }>(evmInfo.rpc, {
+            method: "POST",
+            headers: {
+              "content-type": "application/json",
+              "request-source": origin,
+            },
+            body: JSON.stringify({
+              jsonrpc: "2.0",
+              method: "eth_getTransactionReceipt",
+              params: [txHash],
+              id: 1,
+            }),
+          });
+
+          if (txReceiptResponse.data.error) {
+            console.error(txReceiptResponse.data.error);
+            resolve(null);
+          }
+
+          const txReceipt = txReceiptResponse.data.result;
+          if (txReceipt) {
+            resolve(txReceipt);
+          }
+
+          reject(new Error("No tx receipt responded"));
+        });
+      },
+      {
+        maxRetries: 50,
+        waitMsAfterError: 500,
+        maxWaitMsAfterError: 15000,
+      }
+    );
+  }
+
   private static processTxResultNotification(notification: Notification): void {
     try {
       notification.create({

package/src/tx-executor/constants.ts

@@ -0,0 +1 @@
+export const ROUTE = "background-tx-executor";

package/src/tx-executor/handler.ts

@@ -0,0 +1,71 @@
+import {
+  Env,
+  Handler,
+  InternalHandler,
+  KeplrError,
+  Message,
+} from "@keplr-wallet/router";
+import { BackgroundTxExecutorService } from "./service";
+import {
+  RecordAndExecuteTxsMsg,
+  ResumeTxMsg,
+  GetTxExecutionMsg,
+} from "./messages";
+
+export const getHandler: (service: BackgroundTxExecutorService) => Handler = (
+  service: BackgroundTxExecutorService
+) => {
+  return (env: Env, msg: Message<unknown>) => {
+    switch (msg.constructor) {
+      case RecordAndExecuteTxsMsg:
+        return handleRecordAndExecuteTxsMsg(service)(
+          env,
+          msg as RecordAndExecuteTxsMsg
+        );
+      case GetTxExecutionMsg:
+        return handleGetTxExecutionMsg(service)(env, msg as GetTxExecutionMsg);
+      case ResumeTxMsg:
+        return handleResumeTxMsg(service)(env, msg as ResumeTxMsg);
+      default:
+        throw new KeplrError("direct-tx-executor", 100, "Unknown msg type");
+    }
+  };
+};
+
+const handleRecordAndExecuteTxsMsg: (
+  service: BackgroundTxExecutorService
+) => InternalHandler<RecordAndExecuteTxsMsg> = (service) => {
+  return (env, msg) => {
+    return service.recordAndExecuteTxs(
+      env,
+      msg.vaultId,
+      msg.executionType,
+      msg.txs,
+      msg.executableChainIds,
+      msg.historyData,
+      msg.historyTxIndex
+    );
+  };
+};
+
+const handleResumeTxMsg: (
+  service: BackgroundTxExecutorService
+) => InternalHandler<ResumeTxMsg> = (service) => {
+  return async (env, msg) => {
+    return await service.resumeTx(
+      env,
+      msg.id,
+      msg.txIndex,
+      msg.signedTx,
+      msg.ibcSwapData
+    );
+  };
+};
+
+const handleGetTxExecutionMsg: (
+  service: BackgroundTxExecutorService
+) => InternalHandler<GetTxExecutionMsg> = (service) => {
+  return (_env, msg) => {
+    return service.getTxExecution(msg.id);
+  };
+};

package/src/tx-executor/index.ts

@@ -0,0 +1,3 @@
+export * from "./service";
+export * from "./messages";
+export * from "./types";

package/src/tx-executor/init.ts

@@ -0,0 +1,20 @@
+import { Router } from "@keplr-wallet/router";
+import { ROUTE } from "./constants";
+import { getHandler } from "./handler";
+import { BackgroundTxExecutorService } from "./service";
+import {
+  RecordAndExecuteTxsMsg,
+  ResumeTxMsg,
+  GetTxExecutionMsg,
+} from "./messages";
+
+export function init(
+  router: Router,
+  service: BackgroundTxExecutorService
+): void {
+  router.registerMessage(RecordAndExecuteTxsMsg);
+  router.registerMessage(ResumeTxMsg);
+  router.registerMessage(GetTxExecutionMsg);
+
+  router.addHandler(ROUTE, getHandler(service));
+}

package/src/tx-executor/internal.ts

@@ -0,0 +1,9 @@
+export * from "./service";
+export * from "./init";
+export type { TxExecutionEvent } from "./types";
+export {
+  createSingleChannelEventBus,
+  EventBusPublisher,
+  EventBusSubscriber,
+  EventBusCore,
+} from "@keplr-wallet/common";