@metamask/transaction-controller 8.0.1 → 9.0.0

package/dist/TransactionController.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Hardfork, Common } from '@ethereumjs/common';
+import { Hardfork } from '@ethereumjs/common';
 import type { TypedTransaction } from '@ethereumjs/tx';
 import type { AddApprovalRequest } from '@metamask/approval-controller';
 import type { BaseConfig, BaseState, RestrictedControllerMessenger } from '@metamask/base-controller';
@@ -69,6 +69,9 @@ export interface TransactionState extends BaseState {
     methodData: {
         [key: string]: MethodData;
     };
+    lastFetchedBlockNumbers: {
+        [key: string]: number;
+    };
 }
 /**
  * Multiplier used to determine a transaction's increased gas fee during cancellation
@@ -121,20 +124,33 @@ export declare class TransactionController extends BaseController<TransactionCon
      * Creates a TransactionController instance.
      *
      * @param options - The controller options.
+     * @param options.blockTracker - The block tracker used to poll for new blocks data.
      * @param options.getNetworkState - Gets the state of the network controller.
+     * @param options.getSelectedAddress - Gets the address of the currently selected account.
+     * @param options.incomingTransactions - Configuration options for incoming transaction support.
+     * @param options.incomingTransactions.apiKey - An optional API key to use when fetching remote transaction data.
+     * @param options.incomingTransactions.includeTokenTransfers - Whether or not to include ERC20 token transfers.
+     * @param options.incomingTransactions.isEnabled - Whether or not incoming transaction retrieval is enabled.
+     * @param options.incomingTransactions.updateTransactions - Whether or not to update local transactions using remote transaction data.
+     * @param options.messenger - The controller messenger.
      * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
      * @param options.provider - The provider used to create the underlying EthQuery instance.
-     * @param options.blockTracker - The block tracker used to poll for new blocks data.
-     * @param options.messenger - The controller messenger.
      * @param config - Initial options used to configure this controller.
      * @param state - Initial state to set on this controller.
      */
-    constructor({ getNetworkState, onNetworkStateChange, provider, blockTracker, messenger, }: {
+    constructor({ blockTracker, getNetworkState, getSelectedAddress, incomingTransactions, messenger, onNetworkStateChange, provider, }: {
+        blockTracker: BlockTracker;
         getNetworkState: () => NetworkState;
+        getSelectedAddress: () => string;
+        incomingTransactions: {
+            apiKey?: string;
+            includeTokenTransfers?: boolean;
+            isEnabled?: () => boolean;
+            updateTransactions?: boolean;
+        };
+        messenger: TransactionControllerMessenger;
         onNetworkStateChange: (listener: (state: NetworkState) => void) => void;
         provider: Provider;
-        blockTracker: BlockTracker;
-        messenger: TransactionControllerMessenger;
     }, config?: Partial<TransactionConfig>, state?: Partial<TransactionState>);
     /**
      * Starts a new polling interval.
@@ -155,22 +171,24 @@ export declare class TransactionController extends BaseController<TransactionCon
      * if not provided. If A `<tx.id>:unapproved` hub event will be emitted once added.
      *
      * @param transaction - The transaction object to add.
-     * @param origin - The domain origin to append to the generated TransactionMeta.
-     * @param deviceConfirmedOn - An enum to indicate what device the transaction was confirmed to append to the generated TransactionMeta.
+     * @param opts - Additional options to control how the transaction is added.
+     * @param opts.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
+     * @param opts.origin - The origin of the transaction request, such as a dApp hostname.
+     * @param opts.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @returns Object containing a promise resolving to the transaction hash if approved.
      */
-    addTransaction(transaction: Transaction, origin?: string, deviceConfirmedOn?: WalletDevice): Promise<Result>;
-    prepareUnsignedEthTx(txParams: Record<string, unknown>): TypedTransaction;
+    addTransaction(transaction: Transaction, { deviceConfirmedOn, origin, requireApproval, }?: {
+        deviceConfirmedOn?: WalletDevice;
+        origin?: string;
+        requireApproval?: boolean | undefined;
+    }): Promise<Result>;
+    startIncomingTransactionPolling(): void;
+    stopIncomingTransactionPolling(): void;
+    updateIncomingTransactions(): Promise<void>;
     /**
-     * `@ethereumjs/tx` uses `@ethereumjs/common` as a configuration tool for
-     * specifying which chain, network, hardfork and EIPs to support for
-     * a transaction. By referencing this configuration, and analyzing the fields
-     * specified in txParams, @ethereumjs/tx is able to determine which EIP-2718
-     * transaction type to use.
-     *
-     * @returns {Common} common configuration object
+     * Creates approvals for all unapproved transactions persisted.
      */
-    getCommonConfiguration(): Common;
+    initApprovals(): void;
     /**
      * Attempts to cancel a transaction based on its ID by setting its status to "rejected"
      * and emitting a `<tx.id>:finished` hub event.
@@ -217,18 +235,12 @@ export declare class TransactionController extends BaseController<TransactionCon
      *
      * @param ignoreNetwork - Determines whether to wipe all transactions, or just those on the
      * current network. If `true`, all transactions are wiped.
+     * @param address - If specified, only transactions originating from this address will be
+     * wiped on current network.
      */
-    wipeTransactions(ignoreNetwork?: boolean): void;
-    /**
-     * Get transactions from Etherscan for the given address. By default all transactions are
-     * returned, but the `fromBlock` option can be given to filter just for transactions from a
-     * specific block onward.
-     *
-     * @param address - The address to fetch the transactions for.
-     * @param opt - Object containing optional data, fromBlock and Etherscan API key.
-     * @returns The block number of the latest incoming transaction.
-     */
-    fetchAll(address: string, opt?: FetchAllOptions): Promise<string | void>;
+    wipeTransactions(ignoreNetwork?: boolean, address?: string): void;
+    startIncomingTransactionProcessing(): void;
+    stopIncomingTransactionProcessing(): void;
     private processApproval;
     /**
      * Approves a transaction and updates it's status in state. If this is not a
@@ -296,6 +308,21 @@ export declare class TransactionController extends BaseController<TransactionCon
     private getTransaction;
     private getApprovalId;
     private isTransactionCompleted;
+    private getChainAndNetworkId;
+    private prepareUnsignedEthTx;
+    /**
+     * `@ethereumjs/tx` uses `@ethereumjs/common` as a configuration tool for
+     * specifying which chain, network, hardfork and EIPs to support for
+     * a transaction. By referencing this configuration, and analyzing the fields
+     * specified in txParams, @ethereumjs/tx is able to determine which EIP-2718
+     * transaction type to use.
+     *
+     * @returns common configuration object
+     */
+    private getCommonConfiguration;
+    private onIncomingTransactions;
+    private onUpdatedLastFetchedBlockNumbers;
+    private generateDappSuggestedGasFees;
 }
 export default TransactionController;
 //# sourceMappingURL=TransactionController.d.ts.map

package/dist/TransactionController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TransactionController.d.ts","sourceRoot":"","sources":["../src/TransactionController.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAoB,MAAM,oBAAoB,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEvD,OAAO,KAAK,EAEV,kBAAkB,EAEnB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAc3D,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAKtC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAMtC,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAe1E,eAAO,MAAM,QAAQ,kBAAkB,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAChE,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAC;CAC3C;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,MAAM,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,aAAa,MAAM,CAAC;AAEjC;;GAEG;AACH,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAE/C;;GAEG;AACH,aAAK,cAAc,GAAG,kBAAkB,CAAC;AAEzC;;GAEG;AACH,oBAAY,8BAA8B,GAAG,6BAA6B,CACxE,OAAO,cAAc,EACrB,cAAc,EACd,KAAK,EACL,cAAc,CAAC,MAAM,CAAC,EACtB,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,iBAAiB,EACjB,gBAAgB,CACjB;IACC,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAE5C,OAAO,CAAC,QAAQ,CAAM;IAEtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IAEpC,OAAO,CAAC,MAAM,CAAC,CAAgC;IAE/C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;IAErC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqB;IAErD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IAEjE,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAA4B;IAEtE,OAAO,CAAC,eAAe;YAUT,cAAc;IAM5B;;OAEG;IACH,GAAG,eAAsB;IAEzB;;OAEG;IACM,IAAI,SAA2B;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,CACL,WAAW,EAAE,gBAAgB,EAC7B,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE/B;;;;;;;;;;;OAWG;gBAED,EACE,eAAe,EACf,oBAAoB,EACpB,QAAQ,EACR,YAAY,EACZ,SAAS,GACV,EAAE;QACD,eAAe,EAAE,MAAM,YAAY,CAAC;QACpC,oBAAoB,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,KAAK,IAAI,CAAC;QACxE,QAAQ,EAAE,QAAQ,CAAC;QACnB,YAAY,EAAE,YAAY,CAAC;QAC3B,SAAS,EAAE,8BAA8B,CAAC;KAC3C,EACD,MAAM,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,EACnC,KAAK,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAgDnC;;;;OAIG;IACG,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5C;;;;;OAKG;IACG,gBAAgB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAoBnE;;;;;;;;;OASG;IACG,cAAc,CAClB,WAAW,EAAE,WAAW,EACxB,MAAM,CAAC,EAAE,MAAM,EACf,iBAAiB,CAAC,EAAE,YAAY,GAC/B,OAAO,CAAC,MAAM,CAAC;IAqClB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,gBAAgB;IAOzE;;;;;;;;OAQG;IAEH,sBAAsB,IAAI,MAAM;IAwBhC;;;;;;OAMG;IACG,eAAe,CACnB,aAAa,EAAE,MAAM,EACrB,SAAS,CAAC,EAAE,aAAa,GAAG,sBAAsB;IA4FpD;;;;;OAKG;IACG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,SAAS,CAAC,EAAE,aAAa,GAAG,sBAAsB;IAoHpD;;;;;OAKG;IACG,WAAW,CAAC,WAAW,EAAE,WAAW;;;;;;;;;IA6E1C;;;OAGG;IACG,wBAAwB;IAmC9B;;;;OAIG;IACH,iBAAiB,CAAC,eAAe,EAAE,eAAe;IAWlD;;;;;OAKG;IACH,gBAAgB,CAAC,aAAa,CAAC,EAAE,OAAO;IAwBxC;;;;;;;;OAQG;IACG,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,eAAe,GACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YAoBX,eAAe;IA8D7B;;;;;;;OAOG;YACW,kBAAkB;IAwFhC;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAezB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,wBAAwB;IA0BhC;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IASpB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAUzB;;;;;OAKG;YACW,oCAAoC;IA4DlD;;;;;;;;OAQG;YACW,4BAA4B;YAa5B,eAAe;IAmB7B,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,sBAAsB;CAc/B;AAED,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"TransactionController.d.ts","sourceRoot":"","sources":["../src/TransactionController.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAA4B,MAAM,oBAAoB,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEvD,OAAO,KAAK,EAEV,kBAAkB,EAEnB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAc3D,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAMtC,OAAO,KAAK,EACV,WAAW,EACX,eAAe,EACf,YAAY,EAEb,MAAM,SAAS,CAAC;AAgBjB,eAAO,MAAM,QAAQ,kBAAkB,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAChE,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAC;IAC1C,uBAAuB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACpD;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,MAAM,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,aAAa,MAAM,CAAC;AAEjC;;GAEG;AACH,QAAA,MAAM,cAAc,0BAA0B,CAAC;AAE/C;;GAEG;AACH,aAAK,cAAc,GAAG,kBAAkB,CAAC;AAEzC;;GAEG;AACH,oBAAY,8BAA8B,GAAG,6BAA6B,CACxE,OAAO,cAAc,EACrB,cAAc,EACd,KAAK,EACL,cAAc,CAAC,MAAM,CAAC,EACtB,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,iBAAiB,EACjB,gBAAgB,CACjB;IACC,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAE5C,OAAO,CAAC,QAAQ,CAAM;IAEtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IAEpC,OAAO,CAAC,MAAM,CAAC,CAAgC;IAE/C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;IAErC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqB;IAErD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IAEjE,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAA4B;IAEtE,OAAO,CAAC,eAAe;YAUT,cAAc;IAM5B;;OAEG;IACH,GAAG,eAAsB;IAEzB;;OAEG;IACM,IAAI,SAA2B;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,CACL,WAAW,EAAE,gBAAgB,EAC7B,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE/B;;;;;;;;;;;;;;;;;OAiBG;gBAED,EACE,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,oBAAyB,EACzB,SAAS,EACT,oBAAoB,EACpB,QAAQ,GACT,EAAE;QACD,YAAY,EAAE,YAAY,CAAC;QAC3B,eAAe,EAAE,MAAM,YAAY,CAAC;QACpC,kBAAkB,EAAE,MAAM,MAAM,CAAC;QACjC,oBAAoB,EAAE;YACpB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAChC,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC;YAC1B,kBAAkB,CAAC,EAAE,OAAO,CAAC;SAC9B,CAAC;QACF,SAAS,EAAE,8BAA8B,CAAC;QAC1C,oBAAoB,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,KAAK,IAAI,CAAC;QACxE,QAAQ,EAAE,QAAQ,CAAC;KACpB,EACD,MAAM,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,EACnC,KAAK,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAuEnC;;;;OAIG;IACG,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5C;;;;;OAKG;IACG,gBAAgB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAoBnE;;;;;;;;;;;OAWG;IACG,cAAc,CAClB,WAAW,EAAE,WAAW,EACxB,EACE,iBAAiB,EACjB,MAAM,EACN,eAAe,GAChB,GAAE;QACD,iBAAiB,CAAC,EAAE,YAAY,CAAC;QACjC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAClC,GACL,OAAO,CAAC,MAAM,CAAC;IA6ClB,+BAA+B;IAI/B,8BAA8B;IAIxB,0BAA0B;IAIhC;;OAEG;IACH,aAAa;IAkBb;;;;;;OAMG;IACG,eAAe,CACnB,aAAa,EAAE,MAAM,EACrB,SAAS,CAAC,EAAE,aAAa,GAAG,sBAAsB;IA4FpD;;;;;OAKG;IACG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,SAAS,CAAC,EAAE,aAAa,GAAG,sBAAsB;IAoHpD;;;;;OAKG;IACG,WAAW,CAAC,WAAW,EAAE,WAAW;;;;;;;;;IA6E1C;;;OAGG;IACG,wBAAwB;IAkC9B;;;;OAIG;IACH,iBAAiB,CAAC,eAAe,EAAE,eAAe;IAWlD;;;;;;;OAOG;IACH,gBAAgB,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM;IAgC1D,kCAAkC;IAIlC,iCAAiC;YAInB,eAAe;IAyE7B;;;;;;;OAOG;YACW,kBAAkB;IAuFhC;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAezB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,wBAAwB;IA0BhC;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IASpB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAUzB;;;;;OAKG;YACW,oCAAoC;IAkElD;;;;;;;;OAQG;YACW,4BAA4B;YAa5B,eAAe;IAsB7B,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,sBAAsB;IAe9B,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,oBAAoB;IAS5B;;;;;;;;OAQG;IACH,OAAO,CAAC,sBAAsB;IAwB9B,OAAO,CAAC,sBAAsB;IA0B9B,OAAO,CAAC,gCAAgC;IAaxC,OAAO,CAAC,4BAA4B;CAqCrC;AAED,eAAe,qBAAqB,CAAC"}

package/dist/TransactionController.js

@@ -50,15 +50,21 @@ class TransactionController extends base_controller_1.BaseController {
      * Creates a TransactionController instance.
      *
      * @param options - The controller options.
+     * @param options.blockTracker - The block tracker used to poll for new blocks data.
      * @param options.getNetworkState - Gets the state of the network controller.
+     * @param options.getSelectedAddress - Gets the address of the currently selected account.
+     * @param options.incomingTransactions - Configuration options for incoming transaction support.
+     * @param options.incomingTransactions.apiKey - An optional API key to use when fetching remote transaction data.
+     * @param options.incomingTransactions.includeTokenTransfers - Whether or not to include ERC20 token transfers.
+     * @param options.incomingTransactions.isEnabled - Whether or not incoming transaction retrieval is enabled.
+     * @param options.incomingTransactions.updateTransactions - Whether or not to update local transactions using remote transaction data.
+     * @param options.messenger - The controller messenger.
      * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
      * @param options.provider - The provider used to create the underlying EthQuery instance.
-     * @param options.blockTracker - The block tracker used to poll for new blocks data.
-     * @param options.messenger - The controller messenger.
      * @param config - Initial options used to configure this controller.
      * @param state - Initial state to set on this controller.
      */
-    constructor({ getNetworkState, onNetworkStateChange, provider, blockTracker, messenger, }, config, state) {
+    constructor({ blockTracker, getNetworkState, getSelectedAddress, incomingTransactions = {}, messenger, onNetworkStateChange, provider, }, config, state) {
         super(config, state);
         this.mutex = new async_mutex_1.Mutex();
         /**
@@ -76,6 +82,7 @@ class TransactionController extends base_controller_1.BaseController {
         this.defaultState = {
             methodData: {},
             transactions: [],
+            lastFetchedBlockNumbers: {},
         };
         this.initialize();
         this.provider = provider;
@@ -90,11 +97,19 @@ class TransactionController extends base_controller_1.BaseController {
             getConfirmedTransactions: (address) => (0, utils_1.getAndFormatTransactionsForNonceTracker)(address, types_1.TransactionStatus.confirmed, this.state.transactions),
         });
         this.incomingTransactionHelper = new IncomingTransactionHelper_1.IncomingTransactionHelper({
+            blockTracker,
+            getCurrentAccount: getSelectedAddress,
             getNetworkState,
-            getEthQuery: () => this.ethQuery,
+            isEnabled: incomingTransactions.isEnabled,
+            remoteTransactionSource: new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource({
+                apiKey: incomingTransactions.apiKey,
+                includeTokenTransfers: incomingTransactions.includeTokenTransfers,
+            }),
             transactionLimit: this.config.txHistoryLimit,
-            remoteTransactionSource: new EtherscanRemoteTransactionSource_1.EtherscanRemoteTransactionSource(),
+            updateTransactions: incomingTransactions.updateTransactions,
         });
+        this.incomingTransactionHelper.hub.on('transactions', this.onIncomingTransactions.bind(this));
+        this.incomingTransactionHelper.hub.on('updatedLastFetchedBlockNumbers', this.onUpdatedLastFetchedBlockNumbers.bind(this));
         onNetworkStateChange(() => {
             this.ethQuery = new eth_query_1.default(this.provider);
             this.registry = new eth_method_registry_1.default({ provider: this.provider });
@@ -160,26 +175,30 @@ class TransactionController extends base_controller_1.BaseController {
      * if not provided. If A `<tx.id>:unapproved` hub event will be emitted once added.
      *
      * @param transaction - The transaction object to add.
-     * @param origin - The domain origin to append to the generated TransactionMeta.
-     * @param deviceConfirmedOn - An enum to indicate what device the transaction was confirmed to append to the generated TransactionMeta.
+     * @param opts - Additional options to control how the transaction is added.
+     * @param opts.deviceConfirmedOn - An enum to indicate what device confirmed the transaction.
+     * @param opts.origin - The origin of the transaction request, such as a dApp hostname.
+     * @param opts.requireApproval - Whether the transaction requires approval by the user, defaults to true unless explicitly disabled.
      * @returns Object containing a promise resolving to the transaction hash if approved.
      */
-    addTransaction(transaction, origin, deviceConfirmedOn) {
+    addTransaction(transaction, { deviceConfirmedOn, origin, requireApproval, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { providerConfig, networkId } = this.getNetworkState();
+            const { chainId, networkId } = this.getChainAndNetworkId();
             const { transactions } = this.state;
             transaction = (0, utils_1.normalizeTransaction)(transaction);
             (0, utils_1.validateTransaction)(transaction);
+            const dappSuggestedGasFees = this.generateDappSuggestedGasFees(transaction, origin);
             const transactionMeta = {
                 id: (0, uuid_1.v1)(),
                 networkID: networkId !== null && networkId !== void 0 ? networkId : undefined,
-                chainId: providerConfig.chainId,
+                chainId,
                 origin,
                 status: types_1.TransactionStatus.unapproved,
                 time: Date.now(),
                 transaction,
                 deviceConfirmedOn,
                 verifiedOnBlockchain: false,
+                dappSuggestedGasFees,
             };
             try {
                 const { gas, estimateGasError } = yield this.estimateGas(transaction);
@@ -194,40 +213,39 @@ class TransactionController extends base_controller_1.BaseController {
             this.update({ transactions: this.trimTransactionsForState(transactions) });
             this.hub.emit(`unapprovedTransaction`, transactionMeta);
             return {
-                result: this.processApproval(transactionMeta),
+                result: this.processApproval(transactionMeta, {
+                    requireApproval,
+                }),
                 transactionMeta,
             };
         });
     }
-    prepareUnsignedEthTx(txParams) {
-        return tx_1.TransactionFactory.fromTxData(txParams, {
-            common: this.getCommonConfiguration(),
-            freeze: false,
+    startIncomingTransactionPolling() {
+        this.incomingTransactionHelper.start();
+    }
+    stopIncomingTransactionPolling() {
+        this.incomingTransactionHelper.stop();
+    }
+    updateIncomingTransactions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.incomingTransactionHelper.update();
         });
     }
     /**
-     * `@ethereumjs/tx` uses `@ethereumjs/common` as a configuration tool for
-     * specifying which chain, network, hardfork and EIPs to support for
-     * a transaction. By referencing this configuration, and analyzing the fields
-     * specified in txParams, @ethereumjs/tx is able to determine which EIP-2718
-     * transaction type to use.
-     *
-     * @returns {Common} common configuration object
+     * Creates approvals for all unapproved transactions persisted.
      */
-    getCommonConfiguration() {
-        const { networkId, providerConfig: { type: chain, chainId, nickname: name }, } = this.getNetworkState();
-        if (chain !== controller_utils_1.RPC &&
-            chain !== controller_utils_1.NetworkType['linea-goerli'] &&
-            chain !== controller_utils_1.NetworkType['linea-mainnet']) {
-            return new common_1.Common({ chain, hardfork: exports.HARDFORK });
+    initApprovals() {
+        const { networkId, chainId } = this.getChainAndNetworkId();
+        const unapprovedTxs = this.state.transactions.filter((transaction) => transaction.status === types_1.TransactionStatus.unapproved &&
+            (0, utils_1.transactionMatchesNetwork)(transaction, chainId, networkId));
+        for (const txMeta of unapprovedTxs) {
+            this.processApproval(txMeta, {
+                shouldShowRequest: false,
+            }).catch((error) => {
+                /* istanbul ignore next */
+                console.error('Error during persisted transaction approval', error);
+            });
         }
-        const customChainParams = {
-            name,
-            chainId: parseInt(chainId, 16),
-            networkId: networkId === null ? NaN : parseInt(networkId, undefined),
-            defaultHardfork: exports.HARDFORK,
-        };
-        return common_1.Common.custom(customChainParams);
     }
     /**
      * Attempts to cancel a transaction based on its ID by setting its status to "rejected"
@@ -432,8 +450,7 @@ class TransactionController extends base_controller_1.BaseController {
     queryTransactionStatuses() {
         return __awaiter(this, void 0, void 0, function* () {
             const { transactions } = this.state;
-            const { providerConfig, networkId: currentNetworkID } = this.getNetworkState();
-            const { chainId: currentChainId } = providerConfig;
+            const { chainId: currentChainId, networkId: currentNetworkID } = this.getChainAndNetworkId();
             let gotUpdates = false;
             yield (0, controller_utils_1.safelyExecute)(() => Promise.all(transactions.map((meta, index) => __awaiter(this, void 0, void 0, function* () {
                 // Using fallback to networkID only when there is no chainId present.
@@ -474,58 +491,49 @@ class TransactionController extends base_controller_1.BaseController {
      *
      * @param ignoreNetwork - Determines whether to wipe all transactions, or just those on the
      * current network. If `true`, all transactions are wiped.
+     * @param address - If specified, only transactions originating from this address will be
+     * wiped on current network.
      */
-    wipeTransactions(ignoreNetwork) {
+    wipeTransactions(ignoreNetwork, address) {
         /* istanbul ignore next */
-        if (ignoreNetwork) {
+        if (ignoreNetwork && !address) {
             this.update({ transactions: [] });
             return;
         }
-        const { providerConfig, networkId: currentNetworkID } = this.getNetworkState();
-        const { chainId: currentChainId } = providerConfig;
-        const newTransactions = this.state.transactions.filter(({ networkID, chainId }) => {
+        const { chainId: currentChainId, networkId: currentNetworkID } = this.getChainAndNetworkId();
+        const newTransactions = this.state.transactions.filter(({ networkID, chainId, transaction }) => {
+            var _a;
             // Using fallback to networkID only when there is no chainId present. Should be removed when networkID is completely removed.
-            const isCurrentNetwork = chainId === currentChainId ||
+            const isMatchingNetwork = ignoreNetwork ||
+                chainId === currentChainId ||
                 (!chainId && networkID === currentNetworkID);
-            return !isCurrentNetwork;
+            if (!isMatchingNetwork) {
+                return true;
+            }
+            const isMatchingAddress = !address || ((_a = transaction.from) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === address.toLowerCase();
+            return !isMatchingAddress;
         });
         this.update({
             transactions: this.trimTransactionsForState(newTransactions),
         });
     }
-    /**
-     * Get transactions from Etherscan for the given address. By default all transactions are
-     * returned, but the `fromBlock` option can be given to filter just for transactions from a
-     * specific block onward.
-     *
-     * @param address - The address to fetch the transactions for.
-     * @param opt - Object containing optional data, fromBlock and Etherscan API key.
-     * @returns The block number of the latest incoming transaction.
-     */
-    fetchAll(address, opt) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { transactions: localTransactions } = this.state;
-            const { updateRequired, transactions, latestBlockNumber } = yield this.incomingTransactionHelper.reconcile({
-                address,
-                localTransactions,
-                fromBlock: opt === null || opt === void 0 ? void 0 : opt.fromBlock,
-                apiKey: opt === null || opt === void 0 ? void 0 : opt.etherscanApiKey,
-            });
-            if (updateRequired) {
-                this.update({
-                    transactions: this.trimTransactionsForState(transactions),
-                });
-            }
-            return latestBlockNumber;
-        });
+    startIncomingTransactionProcessing() {
+        this.incomingTransactionHelper.start();
+    }
+    stopIncomingTransactionProcessing() {
+        this.incomingTransactionHelper.stop();
     }
-    processApproval(transactionMeta) {
+    processApproval(transactionMeta, { requireApproval, shouldShowRequest = true, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const transactionId = transactionMeta.id;
             let resultCallbacks;
             try {
-                const acceptResult = yield this.requestApproval(transactionMeta);
-                resultCallbacks = acceptResult.resultCallbacks;
+                if (requireApproval !== false) {
+                    const acceptResult = yield this.requestApproval(transactionMeta, {
+                        shouldShowRequest,
+                    });
+                    resultCallbacks = acceptResult.resultCallbacks;
+                }
                 const { meta, isCompleted } = this.isTransactionCompleted(transactionId);
                 if (meta && !isCompleted) {
                     yield this.approveTransaction(transactionId);
@@ -574,8 +582,7 @@ class TransactionController extends base_controller_1.BaseController {
         return __awaiter(this, void 0, void 0, function* () {
             const { transactions } = this.state;
             const releaseLock = yield this.mutex.acquire();
-            const { providerConfig } = this.getNetworkState();
-            const { chainId } = providerConfig;
+            const { chainId } = this.getChainAndNetworkId();
             const index = transactions.findIndex(({ id }) => transactionID === id);
             const transactionMeta = transactions[index];
             const { transaction: { nonce, from }, } = transactionMeta;
@@ -733,8 +740,13 @@ class TransactionController extends base_controller_1.BaseController {
                     if (!txReceipt) {
                         return [meta, false];
                     }
+                    const txBlock = yield (0, controller_utils_1.query)(this.ethQuery, 'getBlockByHash', [
+                        txReceipt.blockHash,
+                    ]);
                     meta.verifiedOnBlockchain = true;
                     meta.transaction.gasUsed = txReceipt.gasUsed;
+                    meta.txReceipt = txReceipt;
+                    meta.baseFeePerGas = txBlock === null || txBlock === void 0 ? void 0 : txBlock.baseFeePerGas;
                     // According to the Web3 docs:
                     // TRUE if the transaction was successful, FALSE if the EVM reverted the transaction.
                     if (Number(txReceipt.status) === 0) {
@@ -789,7 +801,7 @@ class TransactionController extends base_controller_1.BaseController {
             return Number(txReceipt.status) === 0;
         });
     }
-    requestApproval(txMeta) {
+    requestApproval(txMeta, { shouldShowRequest }) {
         return __awaiter(this, void 0, void 0, function* () {
             const id = this.getApprovalId(txMeta);
             const { origin } = txMeta;
@@ -801,7 +813,7 @@ class TransactionController extends base_controller_1.BaseController {
                 type,
                 requestData,
                 expectsResult: true,
-            }, true));
+            }, shouldShowRequest));
         });
     }
     getTransaction(transactionID) {
@@ -819,6 +831,83 @@ class TransactionController extends base_controller_1.BaseController {
         const isCompleted = this.isLocalFinalState(transaction.status);
         return { meta: transaction, isCompleted };
     }
+    getChainAndNetworkId() {
+        const { networkId, providerConfig } = this.getNetworkState();
+        const chainId = providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.chainId;
+        return { networkId, chainId };
+    }
+    prepareUnsignedEthTx(txParams) {
+        return tx_1.TransactionFactory.fromTxData(txParams, {
+            common: this.getCommonConfiguration(),
+            freeze: false,
+        });
+    }
+    /**
+     * `@ethereumjs/tx` uses `@ethereumjs/common` as a configuration tool for
+     * specifying which chain, network, hardfork and EIPs to support for
+     * a transaction. By referencing this configuration, and analyzing the fields
+     * specified in txParams, @ethereumjs/tx is able to determine which EIP-2718
+     * transaction type to use.
+     *
+     * @returns common configuration object
+     */
+    getCommonConfiguration() {
+        const { networkId, providerConfig: { type: chain, chainId, nickname: name }, } = this.getNetworkState();
+        if (chain !== controller_utils_1.RPC &&
+            chain !== controller_utils_1.NetworkType['linea-goerli'] &&
+            chain !== controller_utils_1.NetworkType['linea-mainnet']) {
+            return new common_1.Common({ chain, hardfork: exports.HARDFORK });
+        }
+        const customChainParams = {
+            name,
+            chainId: parseInt(chainId, 16),
+            networkId: networkId === null ? NaN : parseInt(networkId, undefined),
+            defaultHardfork: exports.HARDFORK,
+        };
+        return common_1.Common.custom(customChainParams);
+    }
+    onIncomingTransactions({ added, updated, }) {
+        const { transactions: currentTransactions } = this.state;
+        const updatedTransactions = [
+            ...added,
+            ...currentTransactions.map((originalTransaction) => {
+                const updatedTransaction = updated.find(({ transactionHash }) => transactionHash === originalTransaction.transactionHash);
+                return updatedTransaction !== null && updatedTransaction !== void 0 ? updatedTransaction : originalTransaction;
+            }),
+        ];
+        this.update({
+            transactions: this.trimTransactionsForState(updatedTransactions),
+        });
+    }
+    onUpdatedLastFetchedBlockNumbers({ lastFetchedBlockNumbers, blockNumber, }) {
+        this.update({ lastFetchedBlockNumbers });
+        this.hub.emit('incomingTransactionBlock', blockNumber);
+    }
+    generateDappSuggestedGasFees(transaction, origin) {
+        if (!origin || origin === controller_utils_1.ORIGIN_METAMASK) {
+            return undefined;
+        }
+        const { gasPrice, maxFeePerGas, maxPriorityFeePerGas, gas } = transaction;
+        if (gasPrice === undefined &&
+            maxFeePerGas === undefined &&
+            maxPriorityFeePerGas === undefined &&
+            gas === undefined) {
+            return undefined;
+        }
+        const dappSuggestedGasFees = {};
+        if (gasPrice !== undefined) {
+            dappSuggestedGasFees.gasPrice = gasPrice;
+        }
+        else if (maxFeePerGas !== undefined ||
+            maxPriorityFeePerGas !== undefined) {
+            dappSuggestedGasFees.maxFeePerGas = maxFeePerGas;
+            dappSuggestedGasFees.maxPriorityFeePerGas = maxPriorityFeePerGas;
+        }
+        if (gas !== undefined) {
+            dappSuggestedGasFees.gas = gas;
+        }
+        return dappSuggestedGasFees;
+    }
 }
 exports.TransactionController = TransactionController;
 exports.default = TransactionController;