@metamask/smart-transactions-controller 12.0.1 → 13.1.0

package/CHANGELOG.md

@@ -6,10 +6,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [13.1.0]
+### Changed
+- Emit a new "smartTransactionConfirmationDone" event ([#424](https://github.com/MetaMask/smart-transactions-controller/pull/424))
+- Use a new API (Sentinel) for a health check ([#411](https://github.com/MetaMask/smart-transactions-controller/pull/411))
+
+## [13.0.0]
+### Changed
+- **BREAKING:** Updated `SmartTransactionsController` to inherit from `StaticIntervalPollingController` instead of `StaticIntervalPollingControllerV1` ([#397](https://github.com/MetaMask/smart-transactions-controller/pull/397)).
+  - The constructor for `SmartTransactionsController` now accepts a single options object instead of three separate arguments, with configuration options merged into this object.
+  - `SmartTransactionsController` now requires a `messenger` option (with the corresponding type `SmartTransactionsControllerMessenger` now available).
+  - The constructor no longer accepts `onNetworkStateChange`; instead, it subscribes to `NetworkController:stateChange`.
+  - The `getNetworkClientById` argument has been removed from the constructor and is now accessed through the messenger.
+  - The controller no longer subscribes to its own events; this is now managed via the messenger.
+  - Event emission is no longer handled by `EventEmitter`; the messenger is now used for emitting events.
+  - The `SmartTransactionsControllerConfig` type has been removed and replaced with `SmartTransactionsControllerOptions`.
+  - Added and exported the following types: `SmartTransactionsControllerMessenger`, `SmartTransactionsControllerState`, `SmartTransactionsControllerGetStateAction`, `SmartTransactionsControllerActions`, `SmartTransactionsControllerStateChangeEvent`, `SmartTransactionsControllerSmartTransactionEvent`, and `SmartTransactionsControllerEvents`.
+
 ## [12.0.1]
+### Changed
+- Remove logic for ensuring uniqueness of smart transactions ([#404](https://github.com/MetaMask/smart-transactions-controller/pull/404))
+  - This issue has been resolved in production.
+
 ### Fixed
 - Fix issue where this.ethQuery is sometimes unexpectedly undefined ([#405](https://github.com/MetaMask/smart-transactions-controller/pull/405))
-- Remove code that is no longer needed to ensure unique smart transactions ([#404](https://github.com/MetaMask/smart-transactions-controller/pull/404))
 
 ## [12.0.0]
 ### Changed
@@ -330,7 +350,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add initial SmartTransactionsController ([#1](https://github.com/MetaMask/smart-transactions-controller/pull/1))
 - Initial commit
 
-[Unreleased]: https://github.com/MetaMask/smart-transactions-controller/compare/v12.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/smart-transactions-controller/compare/v13.1.0...HEAD
+[13.1.0]: https://github.com/MetaMask/smart-transactions-controller/compare/v13.0.0...v13.1.0
+[13.0.0]: https://github.com/MetaMask/smart-transactions-controller/compare/v12.0.1...v13.0.0
 [12.0.1]: https://github.com/MetaMask/smart-transactions-controller/compare/v12.0.0...v12.0.1
 [12.0.0]: https://github.com/MetaMask/smart-transactions-controller/compare/v11.0.0...v12.0.0
 [11.0.0]: https://github.com/MetaMask/smart-transactions-controller/compare/v10.2.0...v11.0.0

package/dist/SmartTransactionsController.d.ts

@@ -1,65 +1,92 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import type { BaseConfig, BaseState } from '@metamask/base-controller';
-import type { NetworkClientId, NetworkController, NetworkState } from '@metamask/network-controller';
-import { StaticIntervalPollingControllerV1 } from '@metamask/polling-controller';
-import type { TransactionMeta } from '@metamask/transaction-controller';
-import EventEmitter from 'events';
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from '@metamask/base-controller';
+import type { NetworkClientId, NetworkControllerGetNetworkClientByIdAction, NetworkControllerStateChangeEvent } from '@metamask/network-controller';
+import { StaticIntervalPollingController } from '@metamask/polling-controller';
+import type { TransactionController, TransactionMeta, TransactionParams } from '@metamask/transaction-controller';
+import { MetaMetricsEventCategory, MetaMetricsEventName } from './constants';
 import type { Fees, Hex, IndividualTxFees, SignedCanceledTransaction, SignedTransaction, SmartTransaction, SmartTransactionsStatus, UnsignedTransaction, GetTransactionsOptions, MetaMetricsProps } from './types';
 import { SmartTransactionStatuses } from './types';
+import { getSmartTransactionMetricsProperties, getSmartTransactionMetricsSensitiveProperties } from './utils';
 export declare const DEFAULT_INTERVAL: number;
-export declare type SmartTransactionsControllerConfig = BaseConfig & {
-    interval: number;
-    clientId: string;
-    chainId: Hex;
-    supportedChainIds: Hex[];
-};
+/**
+ * The name of the {@link SmartTransactionsController}
+ */
+declare const controllerName = "SmartTransactionsController";
 declare type FeeEstimates = {
-    approvalTxFees: IndividualTxFees | undefined;
-    tradeTxFees: IndividualTxFees | undefined;
+    approvalTxFees: IndividualTxFees | null;
+    tradeTxFees: IndividualTxFees | null;
 };
-export declare type SmartTransactionsControllerState = BaseState & {
+export declare type SmartTransactionsControllerState = {
     smartTransactionsState: {
         smartTransactions: Record<Hex, SmartTransaction[]>;
-        userOptIn: boolean | undefined;
-        userOptInV2: boolean | undefined;
-        liveness: boolean | undefined;
+        userOptIn: boolean | null;
+        userOptInV2: boolean | null;
+        liveness: boolean | null;
         fees: FeeEstimates;
         feesByChainId: Record<Hex, FeeEstimates>;
         livenessByChainId: Record<Hex, boolean>;
     };
 };
-export default class SmartTransactionsController extends StaticIntervalPollingControllerV1<SmartTransactionsControllerConfig, SmartTransactionsControllerState> {
+/**
+ * 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;
+export declare type AllowedActions = NetworkControllerGetNetworkClientByIdAction;
+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;
+export declare type AllowedEvents = NetworkControllerStateChangeEvent;
+/**
+ * The messenger of the {@link SmartTransactionsController}.
+ */
+export declare type SmartTransactionsControllerMessenger = RestrictedControllerMessenger<typeof controllerName, SmartTransactionsControllerActions | AllowedActions, SmartTransactionsControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+declare type SmartTransactionsControllerOptions = {
+    interval?: number;
+    clientId?: string;
+    chainId?: Hex;
+    supportedChainIds?: Hex[];
+    getNonceLock: TransactionController['getNonceLock'];
+    confirmExternalTransaction: TransactionController['confirmExternalTransaction'];
+    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;
+    getTransactions: (options?: GetTransactionsOptions) => TransactionMeta[];
+    getMetaMetricsProps: () => Promise<MetaMetricsProps>;
+};
+export default class SmartTransactionsController extends StaticIntervalPollingController<typeof controllerName, SmartTransactionsControllerState, SmartTransactionsControllerMessenger> {
     #private;
-    /**
-     * Name of this controller used during composition
-     */
-    name: string;
     timeoutHandle?: NodeJS.Timeout;
-    private readonly getNonceLock;
-    private ethQuery;
-    confirmExternalTransaction: any;
-    getRegularTransactions: (options?: GetTransactionsOptions) => TransactionMeta[];
-    private readonly trackMetaMetricsEvent;
-    eventEmitter: EventEmitter;
-    private readonly getNetworkClientById;
-    private readonly getMetaMetricsProps;
-    private fetch;
-    constructor({ onNetworkStateChange, getNonceLock, confirmExternalTransaction, getTransactions, trackMetaMetricsEvent, getNetworkClientById, getMetaMetricsProps, }: {
-        onNetworkStateChange: (listener: (networkState: NetworkState) => void) => void;
-        getNonceLock: any;
-        confirmExternalTransaction: any;
-        getTransactions: (options?: GetTransactionsOptions) => TransactionMeta[];
-        trackMetaMetricsEvent: any;
-        getNetworkClientById: NetworkController['getNetworkClientById'];
-        getMetaMetricsProps: () => Promise<MetaMetricsProps>;
-    }, config?: Partial<SmartTransactionsControllerConfig>, state?: Partial<SmartTransactionsControllerState>);
+    constructor({ interval, clientId, chainId: InitialChainId, supportedChainIds, getNonceLock, confirmExternalTransaction, trackMetaMetricsEvent, state, messenger, getTransactions, getMetaMetricsProps, }: SmartTransactionsControllerOptions);
     _executePoll(networkClientId: string): Promise<void>;
-    checkPoll(state: any): void;
+    checkPoll({ smartTransactionsState: { smartTransactions }, }: SmartTransactionsControllerState): void;
     initializeSmartTransactionsForChainId(): void;
     poll(interval?: number): Promise<void>;
     stop(): Promise<void>;
-    setOptInState(state: boolean | undefined): void;
+    setOptInState(optInState: boolean | null): void;
     trackStxStatusChange(smartTransaction: SmartTransaction, prevSmartTransaction?: SmartTransaction): void;
     isNewSmartTransaction(smartTransactionUuid: string): boolean;
     updateSmartTransaction(smartTransaction: SmartTransaction, { networkClientId }?: {
@@ -79,8 +106,8 @@ export default class SmartTransactionsController extends StaticIntervalPollingCo
     submitSignedTransactions({ transactionMeta, txParams, signedTransactions, signedCanceledTransactions, networkClientId, }: {
         signedTransactions: SignedTransaction[];
         signedCanceledTransactions: SignedCanceledTransaction[];
-        transactionMeta?: any;
-        txParams?: any;
+        transactionMeta?: TransactionMeta;
+        txParams?: TransactionParams;
         networkClientId?: NetworkClientId;
     }): Promise<any>;
     cancelSmartTransaction(uuid: string, { networkClientId, }?: {