@metamask/smart-transactions-controller 18.1.0 → 19.1.0

package/dist/SmartTransactionsController.d.mts

@@ -0,0 +1,149 @@
+/// <reference types="node" />
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
+import { type TraceCallback } from "@metamask/controller-utils";
+import type { NetworkClientId, NetworkControllerGetNetworkClientByIdAction, NetworkControllerGetStateAction, NetworkControllerStateChangeEvent } from "@metamask/network-controller";
+import type { TransactionControllerConfirmExternalTransactionAction, TransactionControllerGetNonceLockAction, TransactionControllerGetTransactionsAction, TransactionControllerUpdateTransactionAction, TransactionMeta, TransactionParams } from "@metamask/transaction-controller";
+import { MetaMetricsEventCategory, MetaMetricsEventName } from "./constants.mjs";
+import type { Fees, Hex, IndividualTxFees, SignedCanceledTransaction, SignedTransaction, SmartTransaction, SmartTransactionsStatus, UnsignedTransaction, MetaMetricsProps, FeatureFlags, ClientId } from "./types.mjs";
+import { SmartTransactionStatuses } from "./types.mjs";
+import { getSmartTransactionMetricsProperties, getSmartTransactionMetricsSensitiveProperties } from "./utils.mjs";
+export declare const DEFAULT_INTERVAL: number;
+/**
+ * The name of the {@link SmartTransactionsController}
+ */
+declare const controllerName = "SmartTransactionsController";
+declare type FeeEstimates = {
+    approvalTxFees: IndividualTxFees | null;
+    tradeTxFees: IndividualTxFees | null;
+};
+export declare type SmartTransactionsControllerState = {
+    smartTransactionsState: {
+        smartTransactions: Record<Hex, SmartTransaction[]>;
+        userOptIn: boolean | null;
+        userOptInV2: boolean | null;
+        liveness: boolean | null;
+        fees: FeeEstimates;
+        feesByChainId: Record<Hex, FeeEstimates>;
+        livenessByChainId: Record<Hex, boolean>;
+    };
+};
+/**
+ * Get the default {@link SmartTransactionsController} state.
+ *
+ * @returns The default {@link SmartTransactionsController} state.
+ */
+export declare function getDefaultSmartTransactionsControllerState(): SmartTransactionsControllerState;
+export declare type SmartTransactionsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SmartTransactionsControllerState>;
+/**
+ * The actions that can be performed using the {@link SmartTransactionsController}.
+ */
+export declare type SmartTransactionsControllerActions = SmartTransactionsControllerGetStateAction;
+declare type AllowedActions = NetworkControllerGetNetworkClientByIdAction | NetworkControllerGetStateAction | TransactionControllerGetNonceLockAction | TransactionControllerConfirmExternalTransactionAction | TransactionControllerGetTransactionsAction | TransactionControllerUpdateTransactionAction;
+export declare type SmartTransactionsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SmartTransactionsControllerState>;
+export declare type SmartTransactionsControllerSmartTransactionEvent = {
+    type: 'SmartTransactionsController:smartTransaction';
+    payload: [SmartTransaction];
+};
+export declare type SmartTransactionsControllerSmartTransactionConfirmationDoneEvent = {
+    type: 'SmartTransactionsController:smartTransactionConfirmationDone';
+    payload: [SmartTransaction];
+};
+/**
+ * The events that {@link SmartTransactionsController} can emit.
+ */
+export declare type SmartTransactionsControllerEvents = SmartTransactionsControllerStateChangeEvent | SmartTransactionsControllerSmartTransactionEvent | SmartTransactionsControllerSmartTransactionConfirmationDoneEvent;
+declare type AllowedEvents = NetworkControllerStateChangeEvent;
+/**
+ * The messenger of the {@link SmartTransactionsController}.
+ */
+export declare type SmartTransactionsControllerMessenger = RestrictedMessenger<typeof controllerName, SmartTransactionsControllerActions | AllowedActions, SmartTransactionsControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+declare type SmartTransactionsControllerOptions = {
+    interval?: number;
+    clientId: ClientId;
+    chainId?: Hex;
+    supportedChainIds?: Hex[];
+    trackMetaMetricsEvent: (event: {
+        event: MetaMetricsEventName;
+        category: MetaMetricsEventCategory;
+        properties?: ReturnType<typeof getSmartTransactionMetricsProperties>;
+        sensitiveProperties?: ReturnType<typeof getSmartTransactionMetricsSensitiveProperties>;
+    }, options?: {
+        metaMetricsId?: string;
+    } & Record<string, boolean>) => void;
+    state?: Partial<SmartTransactionsControllerState>;
+    messenger: SmartTransactionsControllerMessenger;
+    getMetaMetricsProps: () => Promise<MetaMetricsProps>;
+    getFeatureFlags: () => FeatureFlags;
+    trace?: TraceCallback;
+};
+export declare type SmartTransactionsControllerPollingInput = {
+    chainIds: Hex[];
+};
+declare const SmartTransactionsController_base: (abstract new (...args: any[]) => {
+    readonly "__#14@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#14@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPolling(input: SmartTransactionsControllerPollingInput): void;
+    _stopPollingByPollingTokenSetId(key: string): void;
+    readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
+    "__#3@#callbacks": Map<string, Set<(input: SmartTransactionsControllerPollingInput) => void>>;
+    _executePoll(input: SmartTransactionsControllerPollingInput): Promise<void>;
+    startPolling(input: SmartTransactionsControllerPollingInput): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingComplete(input: SmartTransactionsControllerPollingInput, callback: (input: SmartTransactionsControllerPollingInput) => void): void;
+}) & typeof import("@metamask/base-controller").BaseController;
+export declare class SmartTransactionsController extends SmartTransactionsController_base<typeof controllerName, SmartTransactionsControllerState, SmartTransactionsControllerMessenger> {
+    #private;
+    timeoutHandle?: NodeJS.Timeout;
+    constructor({ interval, clientId, chainId: InitialChainId, supportedChainIds, trackMetaMetricsEvent, state, messenger, getMetaMetricsProps, getFeatureFlags, trace, }: SmartTransactionsControllerOptions);
+    _executePoll({ chainIds, }: SmartTransactionsControllerPollingInput): Promise<void>;
+    checkPoll({ smartTransactionsState: { smartTransactions }, }: SmartTransactionsControllerState): void;
+    initializeSmartTransactionsForChainId(): void;
+    poll(interval?: number): Promise<void>;
+    stop(): Promise<void>;
+    setOptInState(optInState: boolean | null): void;
+    trackStxStatusChange(smartTransaction: SmartTransaction, prevSmartTransaction?: SmartTransaction): void;
+    isNewSmartTransaction(smartTransactionUuid: string, chainId?: Hex): boolean;
+    updateSmartTransaction(smartTransaction: SmartTransaction, { networkClientId }?: {
+        networkClientId?: NetworkClientId;
+    }): void;
+    updateSmartTransactions({ chainIds, }?: {
+        chainIds: Hex[];
+    }): Promise<void>;
+    fetchSmartTransactionsStatus(transactions: {
+        uuid: string;
+        networkClientId?: NetworkClientId;
+        chainId: Hex;
+    }[]): Promise<Record<string, SmartTransactionsStatus>>;
+    clearFees(): Fees;
+    getFees(tradeTx: UnsignedTransaction, approvalTx?: UnsignedTransaction, { networkClientId }?: {
+        networkClientId?: NetworkClientId;
+    }): Promise<Fees>;
+    submitSignedTransactions({ transactionMeta, txParams, signedTransactions, signedCanceledTransactions, networkClientId, }: {
+        signedTransactions: SignedTransaction[];
+        signedCanceledTransactions?: SignedCanceledTransaction[];
+        transactionMeta?: TransactionMeta;
+        txParams?: TransactionParams;
+        networkClientId?: NetworkClientId;
+    }): Promise<any>;
+    cancelSmartTransaction(uuid: string, { networkClientId, }?: {
+        networkClientId?: NetworkClientId;
+    }): Promise<void>;
+    fetchLiveness({ networkClientId, }?: {
+        networkClientId?: NetworkClientId;
+    }): Promise<boolean>;
+    setStatusRefreshInterval(interval: number): Promise<void>;
+    getTransactions({ addressFrom, status, }: {
+        addressFrom: string;
+        status: SmartTransactionStatuses;
+    }): SmartTransaction[];
+    getSmartTransactionByMinedTxHash(txHash: string | undefined): SmartTransaction | undefined;
+    wipeSmartTransactions({ address, ignoreNetwork, }: {
+        address: string;
+        ignoreNetwork?: boolean;
+    }): void;
+}
+export {};
+//# sourceMappingURL=SmartTransactionsController.d.mts.map

package/dist/SmartTransactionsController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SmartTransactionsController.d.mts","sourceRoot":"","sources":["../src/SmartTransactionsController.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EAEpB,kCAAkC;AACnC,OAAO,EAKL,KAAK,aAAa,EACnB,mCAAmC;AAEpC,OAAO,KAAK,EACV,eAAe,EACf,2CAA2C,EAC3C,+BAA+B,EAC/B,iCAAiC,EAClC,qCAAqC;AAEtC,OAAO,KAAK,EACV,qDAAqD,EACrD,uCAAuC,EACvC,0CAA0C,EAC1C,4CAA4C,EAC5C,eAAe,EACf,iBAAiB,EAClB,yCAAyC;AAK1C,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EAErB,wBAAoB;AACrB,OAAO,KAAK,EACV,IAAI,EACJ,GAAG,EACH,gBAAgB,EAChB,yBAAyB,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,uBAAuB,EACvB,mBAAmB,EACnB,gBAAgB,EAChB,YAAY,EACZ,QAAQ,EACT,oBAAgB;AACjB,OAAO,EAAW,wBAAwB,EAAE,oBAAgB;AAC5D,OAAO,EAWL,oCAAoC,EACpC,6CAA6C,EAG9C,oBAAgB;AAGjB,eAAO,MAAM,gBAAgB,QAAa,CAAC;AAI3C;;GAEG;AACH,QAAA,MAAM,cAAc,gCAAgC,CAAC;AAWrD,aAAK,YAAY,GAAG;IAClB,cAAc,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACxC,WAAW,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACtC,CAAC;AAEF,oBAAY,gCAAgC,GAAG;IAC7C,sBAAsB,EAAE;QACtB,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,gBAAgB,EAAE,CAAC,CAAC;QACnD,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;QAC1B,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;QAC5B,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;QACzB,IAAI,EAAE,YAAY,CAAC;QACnB,aAAa,EAAE,MAAM,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QACzC,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;KACzC,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,0CAA0C,IAAI,gCAAgC,CA2B7F;AAED,oBAAY,yCAAyC,GACnD,wBAAwB,CACtB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ;;GAEG;AACH,oBAAY,kCAAkC,GAC5C,yCAAyC,CAAC;AAE5C,aAAK,cAAc,GACf,2CAA2C,GAC3C,+BAA+B,GAC/B,uCAAuC,GACvC,qDAAqD,GACrD,0CAA0C,GAC1C,4CAA4C,CAAC;AAEjD,oBAAY,2CAA2C,GACrD,0BAA0B,CACxB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ,oBAAY,gDAAgD,GAAG;IAC7D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC7B,CAAC;AAEF,oBAAY,gEAAgE,GAAG;IAC7E,IAAI,EAAE,8DAA8D,CAAC;IACrE,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,iCAAiC,GACzC,2CAA2C,GAC3C,gDAAgD,GAChD,gEAAgE,CAAC;AAErE,aAAK,aAAa,GAAG,iCAAiC,CAAC;AAEvD;;GAEG;AACH,oBAAY,oCAAoC,GAAG,mBAAmB,CACpE,OAAO,cAAc,EACrB,kCAAkC,GAAG,cAAc,EACnD,iCAAiC,GAAG,aAAa,EACjD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF,aAAK,kCAAkC,GAAG;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,iBAAiB,CAAC,EAAE,GAAG,EAAE,CAAC;IAC1B,qBAAqB,EAAE,CACrB,KAAK,EAAE;QACL,KAAK,EAAE,oBAAoB,CAAC;QAC5B,QAAQ,EAAE,wBAAwB,CAAC;QACnC,UAAU,CAAC,EAAE,UAAU,CAAC,OAAO,oCAAoC,CAAC,CAAC;QACrE,mBAAmB,CAAC,EAAE,UAAU,CAC9B,OAAO,6CAA6C,CACrD,CAAC;KACH,EACD,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC3D,IAAI,CAAC;IACV,KAAK,CAAC,EAAE,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAClD,SAAS,EAAE,oCAAoC,CAAC;IAChD,mBAAmB,EAAE,MAAM,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrD,eAAe,EAAE,MAAM,YAAY,CAAC;IACpC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,oBAAY,uCAAuC,GAAG;IACpD,QAAQ,EAAE,GAAG,EAAE,CAAC;CACjB,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,2BAA4B,SAAQ,iCAC/C,OAAO,cAAc,EACrB,gCAAgC,EAChC,oCAAoC,CACrC;;IASC,aAAa,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;gBAyBnB,EACV,QAA2B,EAC3B,QAAQ,EACR,OAAO,EAAE,cAAgC,EACzC,iBAAsD,EACtD,qBAAqB,EACrB,KAAU,EACV,SAAS,EACT,mBAAmB,EACnB,eAAe,EACf,KAAK,GACN,EAAE,kCAAkC;IA8C/B,YAAY,CAAC,EACjB,QAAQ,GACT,EAAE,uCAAuC,GAAG,OAAO,CAAC,IAAI,CAAC;IAe1D,SAAS,CAAC,EACR,sBAAsB,EAAE,EAAE,iBAAiB,EAAE,GAC9C,EAAE,gCAAgC;IAcnC,qCAAqC;IAS/B,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtC,IAAI;IAKV,aAAa,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI;IAM/C,oBAAoB,CAClB,gBAAgB,EAAE,gBAAgB,EAClC,oBAAoB,CAAC,EAAE,gBAAgB;IAsBzC,qBAAqB,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO;IAY3E,sBAAsB,CACpB,gBAAgB,EAAE,gBAAgB,EAClC,EAAE,eAAe,EAAE,GAAE;QAAE,eAAe,CAAC,EAAE,eAAe,CAAA;KAAO;IAqL3D,uBAAuB,CAC3B,EACE,QAAQ,GACT,GAAE;QACD,QAAQ,EAAE,GAAG,EAAE,CAAC;KAGjB,GACA,OAAO,CAAC,IAAI,CAAC;IA6JV,4BAA4B,CAChC,YAAY,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,CAAC,EAAE,eAAe,CAAC;QAClC,OAAO,EAAE,GAAG,CAAC;KACd,EAAE,GACF,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;IAiEnD,SAAS,IAAI,IAAI;IAYX,OAAO,CACX,OAAO,EAAE,mBAAmB,EAC5B,UAAU,CAAC,EAAE,mBAAmB,EAChC,EAAE,eAAe,EAAE,GAAE;QAAE,eAAe,CAAC,EAAE,eAAe,CAAA;KAAO,GAC9D,OAAO,CAAC,IAAI,CAAC;IAqEV,wBAAwB,CAAC,EAC7B,eAAe,EACf,QAAQ,EACR,kBAAkB,EAClB,0BAA+B,EAC/B,eAAe,GAChB,EAAE;QACD,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;QACxC,0BAA0B,CAAC,EAAE,yBAAyB,EAAE,CAAC;QACzD,eAAe,CAAC,EAAE,eAAe,CAAC;QAClC,QAAQ,CAAC,EAAE,iBAAiB,CAAC;QAC7B,eAAe,CAAC,EAAE,eAAe,CAAC;KACnC;IAyJK,sBAAsB,CAC1B,IAAI,EAAE,MAAM,EACZ,EACE,eAAe,GAChB,GAAE;QACD,eAAe,CAAC,EAAE,eAAe,CAAC;KAC9B,GACL,OAAO,CAAC,IAAI,CAAC;IAYV,aAAa,CAAC,EAClB,eAAe,GAChB,GAAE;QACD,eAAe,CAAC,EAAE,eAAe,CAAC;KAC9B,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBnB,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB/D,eAAe,CAAC,EACd,WAAW,EACX,MAAM,GACP,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,wBAAwB,CAAC;KAClC,GAAG,gBAAgB,EAAE;IAOtB,gCAAgC,CAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,gBAAgB,GAAG,SAAS;IAa/B,qBAAqB,CAAC,EACpB,OAAO,EACP,aAAa,GACd,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,GAAG,IAAI;CAmDT"}