@keplr-wallet/background 0.12.313 → 0.13.1

package/build/tx-executor/messages.d.ts

@@ -0,0 +1,53 @@
+import { Message } from "@keplr-wallet/router";
+import { BackgroundTx, BackgroundTxStatus, TxExecutionType, TxExecution, ExecutionTypeToHistoryData, TxExecutionResult, IBCSwapMinimalTrackingData } from "./types";
+/**
+ * Record and execute multiple transactions
+ * execution id is returned if the transactions are recorded successfully
+ * and the execution will be started automatically after the transactions are recorded.
+ */
+export declare class RecordAndExecuteTxsMsg<T extends TxExecutionType = TxExecutionType> extends Message<TxExecutionResult> {
+    readonly vaultId: string;
+    readonly executionType: T;
+    readonly txs: (BackgroundTx & {
+        status: BackgroundTxStatus.PENDING | BackgroundTxStatus.CONFIRMED;
+    })[];
+    readonly executableChainIds: string[];
+    readonly historyData?: (T extends TxExecutionType.UNDEFINED ? undefined : ExecutionTypeToHistoryData[T]) | undefined;
+    readonly historyTxIndex?: number | undefined;
+    static type(): string;
+    constructor(vaultId: string, executionType: T, txs: (BackgroundTx & {
+        status: BackgroundTxStatus.PENDING | BackgroundTxStatus.CONFIRMED;
+    })[], executableChainIds: string[], historyData?: (T extends TxExecutionType.UNDEFINED ? undefined : ExecutionTypeToHistoryData[T]) | undefined, historyTxIndex?: number | undefined);
+    validateBasic(): void;
+    approveExternal(): boolean;
+    route(): string;
+    type(): string;
+}
+/**
+ * Resume existing direct transactions by execution id and transaction index
+ * This message is used to resume the execution of direct transactions that were paused by waiting for the asset to be bridged or other reasons.
+ */
+export declare class ResumeTxMsg extends Message<TxExecutionResult> {
+    readonly id: string;
+    readonly txIndex: number;
+    readonly signedTx: string;
+    readonly ibcSwapData?: IBCSwapMinimalTrackingData | undefined;
+    static type(): string;
+    constructor(id: string, txIndex: number, signedTx: string, ibcSwapData?: IBCSwapMinimalTrackingData | undefined);
+    validateBasic(): void;
+    approveExternal(): boolean;
+    route(): string;
+    type(): string;
+}
+/**
+ * Get execution data by execution id
+ */
+export declare class GetTxExecutionMsg extends Message<TxExecution | undefined> {
+    readonly id: string;
+    static type(): string;
+    constructor(id: string);
+    validateBasic(): void;
+    approveExternal(): boolean;
+    route(): string;
+    type(): string;
+}

package/build/tx-executor/messages.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetTxExecutionMsg = exports.ResumeTxMsg = exports.RecordAndExecuteTxsMsg = void 0;
+const router_1 = require("@keplr-wallet/router");
+const constants_1 = require("./constants");
+/**
+ * Record and execute multiple transactions
+ * execution id is returned if the transactions are recorded successfully
+ * and the execution will be started automatically after the transactions are recorded.
+ */
+class RecordAndExecuteTxsMsg extends router_1.Message {
+    static type() {
+        return "record-and-execute-txs";
+    }
+    constructor(vaultId, executionType, txs, executableChainIds, historyData, historyTxIndex) {
+        super();
+        this.vaultId = vaultId;
+        this.executionType = executionType;
+        this.txs = txs;
+        this.executableChainIds = executableChainIds;
+        this.historyData = historyData;
+        this.historyTxIndex = historyTxIndex;
+    }
+    validateBasic() {
+        if (!this.vaultId) {
+            throw new router_1.KeplrError("direct-tx-executor", 110, "vaultId is empty");
+        }
+        if (!this.executionType) {
+            throw new router_1.KeplrError("direct-tx-executor", 111, "executionType is empty");
+        }
+        if (!this.txs || this.txs.length === 0) {
+            throw new router_1.KeplrError("direct-tx-executor", 112, "txs is empty");
+        }
+        if (!this.executableChainIds || this.executableChainIds.length === 0) {
+            throw new router_1.KeplrError("direct-tx-executor", 113, "executableChainIds is empty");
+        }
+        if (this.historyTxIndex != null && this.historyTxIndex < 0) {
+            throw new router_1.KeplrError("direct-tx-executor", 114, "historyTxIndex is invalid");
+        }
+    }
+    approveExternal() {
+        return false;
+    }
+    route() {
+        return constants_1.ROUTE;
+    }
+    type() {
+        return RecordAndExecuteTxsMsg.type();
+    }
+}
+exports.RecordAndExecuteTxsMsg = RecordAndExecuteTxsMsg;
+/**
+ * Resume existing direct transactions by execution id and transaction index
+ * This message is used to resume the execution of direct transactions that were paused by waiting for the asset to be bridged or other reasons.
+ */
+class ResumeTxMsg extends router_1.Message {
+    static type() {
+        return "resume-tx";
+    }
+    constructor(id, txIndex, signedTx, ibcSwapData) {
+        super();
+        this.id = id;
+        this.txIndex = txIndex;
+        this.signedTx = signedTx;
+        this.ibcSwapData = ibcSwapData;
+    }
+    validateBasic() {
+        if (!this.id) {
+            throw new router_1.KeplrError("direct-tx-executor", 115, "id is empty");
+        }
+        if (this.txIndex != null && this.txIndex < 0) {
+            throw new router_1.KeplrError("direct-tx-executor", 116, "txIndex is invalid");
+        }
+        if (this.signedTx != null && this.signedTx.length === 0) {
+            throw new router_1.KeplrError("direct-tx-executor", 117, "signedTx is empty");
+        }
+    }
+    approveExternal() {
+        return false;
+    }
+    route() {
+        return constants_1.ROUTE;
+    }
+    type() {
+        return ResumeTxMsg.type();
+    }
+}
+exports.ResumeTxMsg = ResumeTxMsg;
+/**
+ * Get execution data by execution id
+ */
+class GetTxExecutionMsg extends router_1.Message {
+    static type() {
+        return "get-tx-execution";
+    }
+    constructor(id) {
+        super();
+        this.id = id;
+    }
+    validateBasic() {
+        if (!this.id) {
+            throw new router_1.KeplrError("direct-tx-executor", 115, "id is empty");
+        }
+    }
+    approveExternal() {
+        return false;
+    }
+    route() {
+        return constants_1.ROUTE;
+    }
+    type() {
+        return GetTxExecutionMsg.type();
+    }
+}
+exports.GetTxExecutionMsg = GetTxExecutionMsg;
+//# sourceMappingURL=messages.js.map

package/build/tx-executor/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/tx-executor/messages.ts"],"names":[],"mappings":";;;AAAA,iDAA2D;AAC3D,2CAAoC;AAWpC;;;;GAIG;AACH,MAAa,sBAEX,SAAQ,gBAA0B;IAC3B,MAAM,CAAC,IAAI;QAChB,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED,YACkB,OAAe,EACf,aAAgB,EAChB,GAEZ,EACY,kBAA4B,EAC5B,WAEiB,EACjB,cAAuB;QAEvC,KAAK,EAAE,CAAC;QAXQ,YAAO,GAAP,OAAO,CAAQ;QACf,kBAAa,GAAb,aAAa,CAAG;QAChB,QAAG,GAAH,GAAG,CAEf;QACY,uBAAkB,GAAlB,kBAAkB,CAAU;QAC5B,gBAAW,GAAX,WAAW,CAEM;QACjB,mBAAc,GAAd,cAAc,CAAS;IAGzC,CAAC;IAED,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,mBAAU,CAAC,oBAAoB,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC;SACrE;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,MAAM,IAAI,mBAAU,CAAC,oBAAoB,EAAE,GAAG,EAAE,wBAAwB,CAAC,CAAC;SAC3E;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,mBAAU,CAAC,oBAAoB,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;SACjE;QAED,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE;YACpE,MAAM,IAAI,mBAAU,CAClB,oBAAoB,EACpB,GAAG,EACH,6BAA6B,CAC9B,CAAC;SACH;QAED,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,EAAE;YAC1D,MAAM,IAAI,mBAAU,CAClB,oBAAoB,EACpB,GAAG,EACH,2BAA2B,CAC5B,CAAC;SACH;IACH,CAAC;IAEQ,eAAe;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK;QACH,OAAO,iBAAK,CAAC;IACf,CAAC;IAED,IAAI;QACF,OAAO,sBAAsB,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;CACF;AA/DD,wDA+DC;AAED;;;GAGG;AACH,MAAa,WAAY,SAAQ,gBAA0B;IAClD,MAAM,CAAC,IAAI;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,YACkB,EAAU,EACV,OAAe,EACf,QAAgB,EAChB,WAAwC;QAExD,KAAK,EAAE,CAAC;QALQ,OAAE,GAAF,EAAE,CAAQ;QACV,YAAO,GAAP,OAAO,CAAQ;QACf,aAAQ,GAAR,QAAQ,CAAQ;QAChB,gBAAW,GAAX,WAAW,CAA6B;IAG1D,CAAC;IAED,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,mBAAU,CAAC,oBAAoB,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;SAChE;QAED,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE;YAC5C,MAAM,IAAI,mBAAU,CAAC,oBAAoB,EAAE,GAAG,EAAE,oBAAoB,CAAC,CAAC;SACvE;QAED,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACvD,MAAM,IAAI,mBAAU,CAAC,oBAAoB,EAAE,GAAG,EAAE,mBAAmB,CAAC,CAAC;SACtE;IACH,CAAC;IAEQ,eAAe;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK;QACH,OAAO,iBAAK,CAAC;IACf,CAAC;IAED,IAAI;QACF,OAAO,WAAW,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CACF;AAvCD,kCAuCC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,gBAAgC;IAC9D,MAAM,CAAC,IAAI;QAChB,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,YAA4B,EAAU;QACpC,KAAK,EAAE,CAAC;QADkB,OAAE,GAAF,EAAE,CAAQ;IAEtC,CAAC;IAED,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,mBAAU,CAAC,oBAAoB,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;SAChE;IACH,CAAC;IAEQ,eAAe;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK;QACH,OAAO,iBAAK,CAAC;IACf,CAAC;IAED,IAAI;QACF,OAAO,iBAAiB,CAAC,IAAI,EAAE,CAAC;IAClC,CAAC;CACF;AA1BD,8CA0BC"}

package/build/tx-executor/service.d.ts

@@ -0,0 +1,67 @@
+import { KVStore } from "@keplr-wallet/common";
+import { ChainsService } from "../chains";
+import { KeyRingCosmosService } from "../keyring-cosmos";
+import { KeyRingEthereumService } from "../keyring-ethereum";
+import { AnalyticsService } from "../analytics";
+import { RecentSendHistoryService } from "../recent-send-history";
+import { BackgroundTxService } from "../tx";
+import { BackgroundTxEthereumService } from "../tx-ethereum";
+import { Env } from "@keplr-wallet/router";
+import { TxExecution, TxExecutionType, BackgroundTx, BackgroundTxStatus, ExecutionTypeToHistoryData, TxExecutionResult, PendingTxExecutionResult, IBCSwapMinimalTrackingData } from "./types";
+import { EventBusSubscriber } from "@keplr-wallet/common";
+import { TxExecutionEvent } from "./types";
+export declare class BackgroundTxExecutorService {
+    protected readonly kvStore: KVStore;
+    protected readonly chainsService: ChainsService;
+    protected readonly keyRingCosmosService: KeyRingCosmosService;
+    protected readonly keyRingEthereumService: KeyRingEthereumService;
+    protected readonly backgroundTxService: BackgroundTxService;
+    protected readonly backgroundTxEthereumService: BackgroundTxEthereumService;
+    protected readonly analyticsService: AnalyticsService;
+    protected readonly recentSendHistoryService: RecentSendHistoryService;
+    protected readonly subscriber: EventBusSubscriber<TxExecutionEvent>;
+    protected recentTxExecutionSeq: number;
+    protected readonly recentTxExecutionMap: Map<string, TxExecution>;
+    constructor(kvStore: KVStore, chainsService: ChainsService, keyRingCosmosService: KeyRingCosmosService, keyRingEthereumService: KeyRingEthereumService, backgroundTxService: BackgroundTxService, backgroundTxEthereumService: BackgroundTxEthereumService, analyticsService: AnalyticsService, recentSendHistoryService: RecentSendHistoryService, subscriber: EventBusSubscriber<TxExecutionEvent>);
+    init(): Promise<void>;
+    protected handleTxExecutionEvent(event: TxExecutionEvent): void;
+    recordAndExecuteTxs<T extends TxExecutionType>(env: Env, vaultId: string, type: T, txs: (BackgroundTx & {
+        status: BackgroundTxStatus.PENDING | BackgroundTxStatus.CONFIRMED;
+    })[], executableChainIds: string[], historyData?: T extends TxExecutionType.UNDEFINED ? undefined : ExecutionTypeToHistoryData[T], historyTxIndex?: number): Promise<TxExecutionResult>;
+    /**
+     * Execute blocked transactions by execution id and transaction index
+     */
+    resumeTx(env: Env, id: string, txIndex: number, signedTx: string, ibcSwapData?: IBCSwapMinimalTrackingData): Promise<TxExecutionResult>;
+    protected executeTxs(id: string, options?: {
+        txIndex?: number;
+        signedTx?: string;
+        ibcSwapData?: IBCSwapMinimalTrackingData;
+    }): Promise<TxExecutionResult>;
+    /**
+     * Execute a pending transaction without modifying observable state.
+     * Returns the result which should be applied by the caller using runInAction.
+     * This reduces autorun trigger count by batching state updates.
+     */
+    protected executePendingTx(vaultId: string, tx: BackgroundTx, executableChainIds: string[], preventAutoSign: boolean, providedSignedTx?: string): Promise<PendingTxExecutionResult>;
+    protected signTx(vaultId: string, tx: BackgroundTx): Promise<string>;
+    private signEvmTx;
+    private signCosmosTx;
+    protected broadcastTx(tx: BackgroundTx): Promise<string>;
+    private broadcastEvmTx;
+    private broadcastCosmosTx;
+    protected traceTx(tx: BackgroundTx): Promise<boolean>;
+    private traceEvmTx;
+    private traceCosmosTx;
+    /**
+     * Find the index of the most recent confirmed transaction with executable chain ids.
+     * Returns -1 if not found.
+     */
+    private findHistoryTxIndex;
+    protected recordHistoryIfNeeded(execution: TxExecution): void;
+    getRecentTxExecutions(): TxExecution[];
+    getTxExecution(id: string): TxExecution | undefined;
+    protected removeTxExecution(id: string): void;
+    protected cleanupOldExecutions(): void;
+    private recordSwapV2HistoryErrorIfNeeded;
+    private clearSwapV2HistoryBackgroundExecutionIdIfNeeded;
+}