@metamask/smart-transactions-controller 6.2.2 → 8.0.0

package/CHANGELOG.md

@@ -6,6 +6,71 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [8.0.0]
+### Changed
+- **BREAKING:** The constructor now requires a `getTransactions` option, which can be used to get a list of existing transactions ([#301](https://github.com/MetaMask/smart-transactions-controller/pull/301))
+- Ensure that a transaction does not get re-confirmed if it is already confirmed or submitted. MetaMask Swaps are confirmed from this controller, other transaction types are most of the time confirmed from the TransactionController. ([#301](https://github.com/MetaMask/smart-transactions-controller/pull/301))
+
+## [7.0.0]
+### Added
+- **BREAKING:** Track fees and liveness for multiple chains by adding `feesByChainId` and `livenessByChainId` properties to SmartTransactionsControllerState ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+  - In particular, clients should prefer accessing `feesByChainId` and `livenessByChainId` instead of `fees` and `liveness`, which will be removed in a future major version.
+- `SmartTransactionsController` now inherits from `StaticIntervalPollingControllerV1` ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237), [#265](https://github.com/MetaMask/smart-transactions-controller/pull/265))
+  - This change introduces a set of public methods to the controller which is designed to manage polling on a particular network instead of the globally selected network. Internally, `updateSmartTransactions` will still be called as the legacy polling does. The methods added are:
+    - `setIntervalLength`
+    - `getIntervalLength`
+    - `startPollingByNetworkClientId`
+    - `stopAllPolling`
+    - `stopPollingByPollingToken`
+    - `onPollingCompleteByNetworkClientId`
+- Validation can be now be circumvented by passing the `skipConfirm` option ([#271](https://github.com/MetaMask/smart-transactions-controller/pull/271))
+- Several methods now take a `networkClientId` option within an options object which can be used to operate on smart transactions that live on a particular chain instead of the globally selected one ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+  - `updateSmartTransaction`
+  - `fetchSmartTransactionsStatus`
+  - `getFees`
+  - `submitSignedTransactions`
+  - `cancelSmartTransaction`
+  - `fetchLiveness`
+- Expose `eventEmitter` as a public property ([#298](https://github.com/MetaMask/smart-transactions-controller/pull/298))
+- `submitSignedTransactions` now takes a `transactionMeta` option which is used to set the `type` of the submitted smart transaction ([#298](https://github.com/MetaMask/smart-transactions-controller/pull/298))
+- `submitSignedTransactions` now sets `uuid` and `txHash` on the submitted smart transaction ([#298](https://github.com/MetaMask/smart-transactions-controller/pull/298))
+- `submitSignedTransactions` now returns metadata about the submitted transaction ([#298](https://github.com/MetaMask/smart-transactions-controller/pull/298))
+- Add `getTxHash` utility function which can be used to get the transaction hash from a signed transaction ([#298](https://github.com/MetaMask/smart-transactions-controller/pull/298))
+- `<transaction-uuid>:smartTransaction` is now emitted whenever a smart transaction is updated ([#298](https://github.com/MetaMask/smart-transactions-controller/pull/298))
+  - This occurs after transactions are submitted, after they are confirmed, after statuses are updated, and also explicitly via `updateSmartTransaction`.
+
+### Changed
+- **BREAKING**: Bump `@metamask/network-controller` from `^15.0.0` to `^17.0.0` ([#238](https://github.com/MetaMask/smart-transactions-controller/pull/238) [#241](https://github.com/MetaMask/smart-transactions-controller/pull/241))
+  - This is breaking because the type of the `messenger` has backward-incompatible changes. See the changelog for `@metamask/base-controller@4.0.0` for more.
+- **BREAKING**: The set of supported chains (configurable via `supportedChainIds`) now defaults to including Goerli instead of Rinkeby ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+- **BREAKING**: Minimum Node.js version is now 18.18 ([#270](https://github.com/MetaMask/smart-transactions-controller/pull/270))
+- **BREAKING:** Constrain the type of the constructor `provider` option to `Provider` from `@metamask/network-controller` ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+- **BREAKING:** The constructor now takes a required argument `getNetworkClientById`, which should be bound from NetworkController's `getNetworkClientById` method ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+- **BREAKING:** `fetchSmartTransactionsStatus` now emits `<transaction-uuid>:smartTransaction` instead of `<transaction-uuid>:transaction-hash` ([#279](https://github.com/MetaMask/smart-transactions-controller/pull/279))
+  - This event contains more information than just the transaction hash.
+  - This event is also always emitted even if there is no transaction hash.
+- **BREAKING:** Use a category of "Transactions" for MetaMetrics events rather than "swaps" ([#282](https://github.com/MetaMask/smart-transactions-controller/pull/282))
+- Bump `@metamask/base-controller` from `^3.2.1` to `^4.0.0` ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+- Bump `@metamask/controller-utils` from `^5.0.0` to `^8.0.3` ([#242](https://github.com/MetaMask/smart-transactions-controller/pull/242) [#244](https://github.com/MetaMask/smart-transactions-controller/pull/244))([#242](https://github.com/MetaMask/smart-transactions-controller/pull/242)) ([#244](https://github.com/MetaMask/smart-transactions-controller/pull/244)) ([#267](https://github.com/MetaMask/smart-transactions-controller/pull/267)) ([#272](https://github.com/MetaMask/smart-transactions-controller/pull/272))
+- Bump `@metamask/network-controller` from `^15.2.0` to `^17.2.0` ([#238](https://github.com/MetaMask/smart-transactions-controller/pull/238)) ([#241](https://github.com/MetaMask/smart-transactions-controller/pull/241)) ([#255](https://github.com/MetaMask/smart-transactions-controller/pull/255)) ([#264](https://github.com/MetaMask/smart-transactions-controller/pull/264)) ([#265](https://github.com/MetaMask/smart-transactions-controller/pull/265))
+- Bump `@metamask/polling-controller` from `^2.0.0` to `^5.0.0` ([#265](https://github.com/MetaMask/smart-transactions-controller/pull/265))
+- Remove `@ethersprovider/bignumber` and `@ethersproject/providers` from dependencies; replace with `@metamask/eth-query@^4.0.0` ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+- Add `events@^3.3.0` as a dependency ([#271](https://github.com/MetaMask/smart-transactions-controller/pull/271))
+- Deprecate `time` property on `SmartTransaction` type in favor of `creationTime` ([#298](https://github.com/MetaMask/smart-transactions-controller/pull/298))
+
+### Removed
+- **BREAKING:** Remove property `ethersProvider` from `SmartTransactionsController` ([#237](https://github.com/MetaMask/smart-transactions-controller/pull/237))
+
+### Fixed
+- Fix `getFees` so that it does not blow away an existing `nonce` on the trade transaction ([#271](https://github.com/MetaMask/smart-transactions-controller/pull/271))
+- Fix `submitSignedTransactions` so that it sets a `nonce` on the resulting transaction if it doesn't have one ([#271](https://github.com/MetaMask/smart-transactions-controller/pull/271))
+- Fix updating a smart transaction to no longer throw when no smart transactions have been previously saved under the current chain ([#271](https://github.com/MetaMask/smart-transactions-controller/pull/271))
+- Properly override controller name to `SmartTransactionController` ([#273](https://github.com/MetaMask/smart-transactions-controller/pull/273))
+- Properly mark `getFees` as having an optional second argument, since it was being handled that way anyway ([#271](https://github.com/MetaMask/smart-transactions-controller/pull/271))
+- The controller now waits until the first NetworkController update before making use of the `provider` constructor argument to hit the currently selected network ([#274](https://github.com/MetaMask/smart-transactions-controller/pull/274))
+  - This change was made because in the future, the `provider` may no longer be defined initially.
+  - This change may cause errors to be thrown immediately following a network switch until a future NetworkController state update or polling iteration.
+
 ## [6.2.2]
 ### Fixed
 - Revert "Parameterize SmartTransactionsController state by ChainId for MultiChain + Integrate PollingController Mixin ([#235](https://github.com/MetaMask/smart-transactions-controller/pull/235))
@@ -183,7 +248,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/v6.2.2...HEAD
+[Unreleased]: https://github.com/MetaMask/smart-transactions-controller/compare/v8.0.0...HEAD
+[8.0.0]: https://github.com/MetaMask/smart-transactions-controller/compare/v7.0.0...v8.0.0
+[7.0.0]: https://github.com/MetaMask/smart-transactions-controller/compare/v6.2.2...v7.0.0
 [6.2.2]: https://github.com/MetaMask/smart-transactions-controller/compare/v6.2.1...v6.2.2
 [6.2.1]: https://github.com/MetaMask/smart-transactions-controller/compare/v6.2.0...v6.2.1
 [6.2.0]: https://github.com/MetaMask/smart-transactions-controller/compare/v6.1.0...v6.2.0

package/README.md

@@ -14,8 +14,8 @@ or
 
 ### Setup
 
-- Install [Node.js](https://nodejs.org) version 16
-  - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
+- Install the current LTS version of [Node.js](https://nodejs.org)
+  - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm install` will install the latest suitable version and running `nvm use` will automatically choose the right node version for you.
 - Install [Yarn v3](https://yarnpkg.com/getting-started/install)
 - Run `yarn install` to install dependencies and run any required post-install scripts
 

package/dist/SmartTransactionsController.d.ts

@@ -1,40 +1,60 @@
 /// <reference types="node" />
-import { BaseConfig, BaseController, BaseState } from '@metamask/base-controller';
-import { NetworkState } from '@metamask/network-controller';
-import { SmartTransaction, SignedTransaction, SignedCanceledTransaction, UnsignedTransaction, SmartTransactionStatuses, Fees, IndividualTxFees } from './types';
+/// <reference types="node" />
+import type { BaseConfig, BaseState } from '@metamask/base-controller';
+import type { Provider } from '@metamask/eth-query';
+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 { Fees, Hex, IndividualTxFees, SignedCanceledTransaction, SignedTransaction, SmartTransaction, SmartTransactionsStatus, UnsignedTransaction, GetTransactionsOptions } from './types';
+import { SmartTransactionStatuses } from './types';
 export declare const DEFAULT_INTERVAL: number;
 export declare type SmartTransactionsControllerConfig = BaseConfig & {
     interval: number;
     clientId: string;
-    chainId: string;
+    chainId: Hex;
     supportedChainIds: string[];
 };
+declare type FeeEstimates = {
+    approvalTxFees: IndividualTxFees | undefined;
+    tradeTxFees: IndividualTxFees | undefined;
+};
 export declare type SmartTransactionsControllerState = BaseState & {
     smartTransactionsState: {
-        smartTransactions: Record<string, SmartTransaction[]>;
+        smartTransactions: Record<Hex, SmartTransaction[]>;
         userOptIn: boolean | undefined;
         userOptInV2: boolean | undefined;
         liveness: boolean | undefined;
-        fees: {
-            approvalTxFees: IndividualTxFees | undefined;
-            tradeTxFees: IndividualTxFees | undefined;
-        };
+        fees: FeeEstimates;
+        feesByChainId: Record<Hex, FeeEstimates>;
+        livenessByChainId: Record<Hex, boolean>;
     };
 };
-export default class SmartTransactionsController extends BaseController<SmartTransactionsControllerConfig, SmartTransactionsControllerState> {
+export default class SmartTransactionsController extends StaticIntervalPollingControllerV1<SmartTransactionsControllerConfig, SmartTransactionsControllerState> {
+    #private;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
     timeoutHandle?: NodeJS.Timeout;
-    private getNonceLock;
-    ethersProvider: any;
+    private readonly getNonceLock;
+    private ethQuery;
     confirmExternalTransaction: any;
-    private trackMetaMetricsEvent;
+    getRegularTransactions: (options?: GetTransactionsOptions) => TransactionMeta[];
+    private readonly trackMetaMetricsEvent;
+    eventEmitter: EventEmitter;
+    private readonly getNetworkClientById;
     private fetch;
-    constructor({ onNetworkStateChange, getNonceLock, provider, confirmExternalTransaction, trackMetaMetricsEvent, }: {
+    constructor({ onNetworkStateChange, getNonceLock, provider, confirmExternalTransaction, getTransactions, trackMetaMetricsEvent, getNetworkClientById, }: {
         onNetworkStateChange: (listener: (networkState: NetworkState) => void) => void;
         getNonceLock: any;
-        provider: any;
+        provider: Provider;
         confirmExternalTransaction: any;
+        getTransactions: (options?: GetTransactionsOptions) => TransactionMeta[];
         trackMetaMetricsEvent: any;
+        getNetworkClientById: NetworkController['getNetworkClientById'];
     }, config?: Partial<SmartTransactionsControllerConfig>, state?: Partial<SmartTransactionsControllerState>);
+    _executePoll(networkClientId: string): Promise<void>;
     checkPoll(state: any): void;
     initializeSmartTransactionsForChainId(): void;
     poll(interval?: number): Promise<void>;
@@ -42,23 +62,37 @@ export default class SmartTransactionsController extends BaseController<SmartTra
     setOptInState(state: boolean | undefined): void;
     trackStxStatusChange(smartTransaction: SmartTransaction, prevSmartTransaction?: SmartTransaction): void;
     isNewSmartTransaction(smartTransactionUuid: string): boolean;
-    updateSmartTransaction(smartTransaction: SmartTransaction): void;
-    updateSmartTransactions(): Promise<void>;
-    confirmSmartTransaction(smartTransaction: SmartTransaction): Promise<void>;
-    fetchSmartTransactionsStatus(uuids: string[]): Promise<SmartTransaction[]>;
+    updateSmartTransaction(smartTransaction: SmartTransaction, { networkClientId }?: {
+        networkClientId?: NetworkClientId;
+    }): void;
+    updateSmartTransactions({ networkClientId, }?: {
+        networkClientId?: NetworkClientId;
+    }): Promise<void>;
+    fetchSmartTransactionsStatus(uuids: string[], { networkClientId }?: {
+        networkClientId?: NetworkClientId;
+    }): Promise<Record<string, SmartTransactionsStatus>>;
     addNonceToTransaction(transaction: UnsignedTransaction): Promise<UnsignedTransaction>;
     clearFees(): Fees;
-    getFees(tradeTx: UnsignedTransaction, approvalTx: UnsignedTransaction): Promise<Fees>;
-    submitSignedTransactions({ txParams, signedTransactions, signedCanceledTransactions, }: {
+    getFees(tradeTx: UnsignedTransaction, approvalTx?: UnsignedTransaction, { networkClientId }?: {
+        networkClientId?: NetworkClientId;
+    }): Promise<Fees>;
+    submitSignedTransactions({ transactionMeta, txParams, signedTransactions, signedCanceledTransactions, networkClientId, }: {
         signedTransactions: SignedTransaction[];
         signedCanceledTransactions: SignedCanceledTransaction[];
+        transactionMeta?: any;
         txParams?: any;
+        networkClientId?: NetworkClientId;
     }): Promise<any>;
-    cancelSmartTransaction(uuid: string): Promise<void>;
-    fetchLiveness(): Promise<boolean>;
+    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[];
 }
+export {};