@metamask/transaction-controller 62.22.0 → 63.1.0

package/CHANGELOG.md

@@ -7,6 +7,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [63.1.0]
+
+### Added
+
+- Add `perpsWithdraw` to `TransactionType` ([#8271](https://github.com/MetaMask/core/pull/8271))
+
+### Changed
+
+- Bump `@metamask/core-backend` from `^6.1.1` to `^6.2.0` ([#8232](https://github.com/MetaMask/core/pull/8232))
+- Remove legacy `actionId` deduplication logic from transaction lifecycle methods ([#8256](https://github.com/MetaMask/core/pull/8256))
+
+## [63.0.0]
+
+### Added
+
+- New public `getGasFeeTokens()` controller method ([#8183](https://github.com/MetaMask/core/pull/8183))
+- Expose missing public `TransactionController` methods through its messenger ([#8183](https://github.com/MetaMask/core/pull/8183))
+  - The following actions are now available:
+    - `TransactionController:handleMethodData`
+    - `TransactionController:isAtomicBatchSupported`
+    - `TransactionController:startIncomingTransactionPolling`
+    - `TransactionController:stopIncomingTransactionPolling`
+    - `TransactionController:updateIncomingTransactions`
+    - `TransactionController:stopTransaction`
+    - `TransactionController:speedUpTransaction`
+    - `TransactionController:estimateGasBuffered`
+    - `TransactionController:updateEditableParams`
+    - `TransactionController:setTransactionActive`
+    - `TransactionController:approveTransactionsWithSameNonce`
+    - `TransactionController:estimateGasFee`
+    - `TransactionController:getLayer1GasFee`
+    - `TransactionController:clearUnapprovedTransactions`
+    - `TransactionController:abortTransactionSigning`
+    - `TransactionController:updateAtomicBatchData`
+  - Corresponding action types (e.g. `TransactionControllerHandleMethodDataAction`) are available as well.
+
+### Changed
+
+- Bump `@metamask/approval-controller` from `^8.0.0` to `^9.0.0` ([#8225](https://github.com/MetaMask/core/pull/8225))
+- Bump `@metamask/gas-fee-controller` from `^26.0.3` to `^26.1.0` ([#8225](https://github.com/MetaMask/core/pull/8225))
+- **BREAKING:** Standardize names of `TransactionController` messenger action types ([#8183](https://github.com/MetaMask/core/pull/8183))
+  - All existing types for messenger actions have been renamed so they end in `Action` (e.g. `TransactionControllerEmulateNewTransaction` -> `TransactionControllerEmulateNewTransactionAction`). You will need to update imports appropriately.
+  - This change only affects the types. The action type strings themselves have not changed, so you do not need to update the list of actions you pass when initializing `TransactionController` messenger.
+
 ## [62.22.0]
 
 ### Added
@@ -2221,7 +2265,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@62.22.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@63.1.0...HEAD
+[63.1.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@63.0.0...@metamask/transaction-controller@63.1.0
+[63.0.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@62.22.0...@metamask/transaction-controller@63.0.0
 [62.22.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@62.21.0...@metamask/transaction-controller@62.22.0
 [62.21.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@62.20.0...@metamask/transaction-controller@62.21.0
 [62.20.0]: https://github.com/MetaMask/core/compare/@metamask/transaction-controller@62.19.0...@metamask/transaction-controller@62.20.0

package/dist/TransactionController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TransactionController-method-action-types.cjs.map

package/dist/TransactionController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionController-method-action-types.cjs","sourceRoot":"","sources":["../src/TransactionController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { TransactionController } from './TransactionController';\n\n/**\n * Handle new method data request.\n *\n * @param fourBytePrefix - The method prefix.\n * @param networkClientId - The ID of the network client used to fetch the method data.\n * @returns The method data object corresponding to the given signature prefix.\n */\nexport type TransactionControllerHandleMethodDataAction = {\n  type: `TransactionController:handleMethodData`;\n  handler: TransactionController['handleMethodData'];\n};\n\n/**\n * Add a batch of transactions to be submitted after approval.\n *\n * @param request - Request object containing the transactions to add.\n * @returns Result object containing the generated batch ID.\n */\nexport type TransactionControllerAddTransactionBatchAction = {\n  type: `TransactionController:addTransactionBatch`;\n  handler: TransactionController['addTransactionBatch'];\n};\n\n/**\n * Determine which chains support atomic batch transactions with the given account address.\n *\n * @param request - Request object containing the account address and other parameters.\n * @returns  Result object containing the supported chains and related information.\n */\nexport type TransactionControllerIsAtomicBatchSupportedAction = {\n  type: `TransactionController:isAtomicBatchSupported`;\n  handler: TransactionController['isAtomicBatchSupported'];\n};\n\n/**\n * Add a new unapproved transaction to state. Parameters will be validated, a\n * unique transaction ID will be generated, and `gas` and `gasPrice` will be calculated\n * if not provided. A `<tx.id>:unapproved` hub event will be emitted once added.\n *\n * @param txParams - Standard parameters for an Ethereum transaction.\n * @param options - Additional options to control how the transaction is added.\n * @returns Object containing a promise resolving to the transaction hash if approved.\n */\nexport type TransactionControllerAddTransactionAction = {\n  type: `TransactionController:addTransaction`;\n  handler: TransactionController['addTransaction'];\n};\n\n/**\n * Starts polling for incoming transactions from the remote transaction source.\n */\nexport type TransactionControllerStartIncomingTransactionPollingAction = {\n  type: `TransactionController:startIncomingTransactionPolling`;\n  handler: TransactionController['startIncomingTransactionPolling'];\n};\n\n/**\n * Stops polling for incoming transactions from the remote transaction source.\n */\nexport type TransactionControllerStopIncomingTransactionPollingAction = {\n  type: `TransactionController:stopIncomingTransactionPolling`;\n  handler: TransactionController['stopIncomingTransactionPolling'];\n};\n\n/**\n * Update the incoming transactions by polling the remote transaction source.\n *\n * @param request - Request object.\n * @param request.tags - Additional tags to identify the source of the request.\n */\nexport type TransactionControllerUpdateIncomingTransactionsAction = {\n  type: `TransactionController:updateIncomingTransactions`;\n  handler: TransactionController['updateIncomingTransactions'];\n};\n\n/**\n * Attempts to cancel a transaction based on its ID by setting its status to \"rejected\"\n * and emitting a `<tx.id>:finished` hub event.\n *\n * @param transactionId - The ID of the transaction to cancel.\n * @param gasValues - The gas values to use for the cancellation transaction.\n * @param options - The options for the cancellation transaction.\n * @param options.actionId - Unique ID persisted on transaction metadata.\n * @param options.estimatedBaseFee - The estimated base fee of the transaction.\n */\nexport type TransactionControllerStopTransactionAction = {\n  type: `TransactionController:stopTransaction`;\n  handler: TransactionController['stopTransaction'];\n};\n\n/**\n * Attempts to speed up a transaction increasing transaction gasPrice by ten percent.\n *\n * @param transactionId - The ID of the transaction to speed up.\n * @param gasValues - The gas values to use for the speed up transaction.\n * @param options - The options for the speed up transaction.\n * @param options.actionId - Unique ID persisted on transaction metadata.\n * @param options.estimatedBaseFee - The estimated base fee of the transaction.\n */\nexport type TransactionControllerSpeedUpTransactionAction = {\n  type: `TransactionController:speedUpTransaction`;\n  handler: TransactionController['speedUpTransaction'];\n};\n\n/**\n * Estimates required gas for a given transaction.\n *\n * @param transaction - The transaction to estimate gas for.\n * @param networkClientId - The network client id to use for the estimate.\n * @param options - Additional options for the estimate.\n * @param options.ignoreDelegationSignatures - Ignore signature errors if submitting delegations to the DelegationManager.\n * @returns The gas and gas price.\n */\nexport type TransactionControllerEstimateGasAction = {\n  type: `TransactionController:estimateGas`;\n  handler: TransactionController['estimateGas'];\n};\n\n/**\n * Estimates required gas for a batch of transactions.\n *\n * @param request - Request object.\n * @param request.chainId - Chain ID of the transactions.\n * @param request.from - Address of the sender.\n * @param request.transactions - Array of transactions within a batch request.\n * @returns Object containing the gas limit.\n */\nexport type TransactionControllerEstimateGasBatchAction = {\n  type: `TransactionController:estimateGasBatch`;\n  handler: TransactionController['estimateGasBatch'];\n};\n\n/**\n * Estimates required gas for a given transaction and add additional gas buffer with the given multiplier.\n *\n * @param transaction - The transaction params to estimate gas for.\n * @param multiplier - The multiplier to use for the gas buffer.\n * @param networkClientId - The network client id to use for the estimate.\n * @returns The buffered estimated gas and whether the estimation failed.\n */\nexport type TransactionControllerEstimateGasBufferedAction = {\n  type: `TransactionController:estimateGasBuffered`;\n  handler: TransactionController['estimateGasBuffered'];\n};\n\n/**\n * Updates an existing transaction in state.\n *\n * @param transactionMeta - The new transaction to store in state.\n * @param note - A note or update reason to be logged.\n */\nexport type TransactionControllerUpdateTransactionAction = {\n  type: `TransactionController:updateTransaction`;\n  handler: TransactionController['updateTransaction'];\n};\n\n/**\n * Adds external provided transaction to state as confirmed transaction.\n *\n * @param transactionMeta - TransactionMeta to add transactions.\n * @param transactionReceipt - TransactionReceipt of the external transaction.\n * @param baseFeePerGas - Base fee per gas of the external transaction.\n */\nexport type TransactionControllerConfirmExternalTransactionAction = {\n  type: `TransactionController:confirmExternalTransaction`;\n  handler: TransactionController['confirmExternalTransaction'];\n};\n\n/**\n * Acquires a nonce lock for the given address on the specified network,\n * ensuring that nonces are assigned sequentially without conflicts.\n *\n * @param address - The account address for which to acquire the nonce lock.\n * @param networkClientId - The ID of the network client to use.\n * @returns A promise that resolves to a nonce lock containing the next nonce and a release function.\n */\nexport type TransactionControllerGetNonceLockAction = {\n  type: `TransactionController:getNonceLock`;\n  handler: TransactionController['getNonceLock'];\n};\n\n/**\n * Updates the editable parameters of a transaction.\n *\n * @param txId - The ID of the transaction to update.\n * @param params - The editable parameters to update.\n * @param params.containerTypes - Container types applied to the parameters.\n * @param params.data - Data to pass with the transaction.\n * @param params.from - Address to send the transaction from.\n * @param params.gas - Maximum number of units of gas to use for the transaction.\n * @param params.gasPrice - Price per gas for legacy transactions.\n * @param params.maxFeePerGas - Maximum amount per gas to pay for the transaction, including the priority fee.\n * @param params.maxPriorityFeePerGas - Maximum amount per gas to give to validator as incentive.\n * @param params.updateType - Whether to update the transaction type. Defaults to `true`.\n * @param params.to - Address to send the transaction to.\n * @param params.value - Value associated with the transaction.\n * @returns The updated transaction metadata.\n */\nexport type TransactionControllerUpdateEditableParamsAction = {\n  type: `TransactionController:updateEditableParams`;\n  handler: TransactionController['updateEditableParams'];\n};\n\n/**\n * Update the isActive state of a transaction.\n *\n * @param transactionId - The ID of the transaction to update.\n * @param isActive - The active state.\n */\nexport type TransactionControllerSetTransactionActiveAction = {\n  type: `TransactionController:setTransactionActive`;\n  handler: TransactionController['setTransactionActive'];\n};\n\n/**\n * Signs and returns the raw transaction data for provided transaction params list.\n *\n * @param listOfTxParams - The list of transaction params to approve.\n * @param opts - Options bag.\n * @param opts.hasNonce - Whether the transactions already have a nonce.\n * @returns The raw transactions.\n */\nexport type TransactionControllerApproveTransactionsWithSameNonceAction = {\n  type: `TransactionController:approveTransactionsWithSameNonce`;\n  handler: TransactionController['approveTransactionsWithSameNonce'];\n};\n\n/**\n * Update a custodial transaction.\n *\n * @param request - The custodial transaction update request.\n *\n * @returns The updated transaction metadata.\n */\nexport type TransactionControllerUpdateCustodialTransactionAction = {\n  type: `TransactionController:updateCustodialTransaction`;\n  handler: TransactionController['updateCustodialTransaction'];\n};\n\n/**\n * Search transaction metadata for matching entries.\n *\n * @param opts - Options bag.\n * @param opts.initialList - The transactions to search. Defaults to the current state.\n * @param opts.limit - The maximum number of transactions to return. No limit by default.\n * @param opts.searchCriteria - An object containing values or functions for transaction properties to filter transactions with.\n * @returns An array of transactions matching the provided options.\n */\nexport type TransactionControllerGetTransactionsAction = {\n  type: `TransactionController:getTransactions`;\n  handler: TransactionController['getTransactions'];\n};\n\n/**\n * Estimates the gas fees for a transaction.\n *\n * @param args - The arguments for estimating gas fees.\n * @param args.transactionParams - The transaction parameters to estimate fees for.\n * @param args.chainId - The chain ID to use. If not provided, the network client ID is used to determine the chain.\n * @param args.networkClientId - The network client ID to use for the estimation.\n * @returns A promise that resolves to the estimated gas fee response.\n */\nexport type TransactionControllerEstimateGasFeeAction = {\n  type: `TransactionController:estimateGasFee`;\n  handler: TransactionController['estimateGasFee'];\n};\n\n/**\n * Determine the layer 1 gas fee for the given transaction parameters.\n *\n * @param request - The request object.\n * @param request.transactionParams - The transaction parameters to estimate the layer 1 gas fee for.\n * @param request.chainId - The ID of the chain where the transaction will be executed.\n * @param request.networkClientId - The ID of a specific network client to process the transaction.\n * @returns The layer 1 gas fee.\n */\nexport type TransactionControllerGetLayer1GasFeeAction = {\n  type: `TransactionController:getLayer1GasFee`;\n  handler: TransactionController['getLayer1GasFee'];\n};\n\n/**\n * Removes unapproved transactions from state.\n */\nexport type TransactionControllerClearUnapprovedTransactionsAction = {\n  type: `TransactionController:clearUnapprovedTransactions`;\n  handler: TransactionController['clearUnapprovedTransactions'];\n};\n\n/**\n * Stop the signing process for a specific transaction.\n * Throws an error causing the transaction status to be set to failed.\n *\n * @param transactionId - The ID of the transaction to stop signing.\n */\nexport type TransactionControllerAbortTransactionSigningAction = {\n  type: `TransactionController:abortTransactionSigning`;\n  handler: TransactionController['abortTransactionSigning'];\n};\n\n/**\n * Update the transaction data of a single nested transaction within an atomic batch transaction.\n *\n * @param options - The options bag.\n * @param options.transactionId - ID of the atomic batch transaction.\n * @param options.transactionIndex - Index of the nested transaction within the atomic batch transaction.\n * @param options.transactionData - New data to set for the nested transaction.\n * @returns The updated data for the atomic batch transaction.\n */\nexport type TransactionControllerUpdateAtomicBatchDataAction = {\n  type: `TransactionController:updateAtomicBatchData`;\n  handler: TransactionController['updateAtomicBatchData'];\n};\n\n/**\n * Emulate a new transaction.\n *\n * @param transactionId - The transaction ID.\n */\nexport type TransactionControllerEmulateNewTransactionAction = {\n  type: `TransactionController:emulateNewTransaction`;\n  handler: TransactionController['emulateNewTransaction'];\n};\n\n/**\n * Emulate a transaction update.\n *\n * @param transactionMeta - Transaction metadata.\n */\nexport type TransactionControllerEmulateTransactionUpdateAction = {\n  type: `TransactionController:emulateTransactionUpdate`;\n  handler: TransactionController['emulateTransactionUpdate'];\n};\n\n/**\n * Retrieve available gas fee tokens for a transaction.\n *\n * @param request - The request object containing transaction details.\n * @returns The list of available gas fee tokens.\n */\nexport type TransactionControllerGetGasFeeTokensAction = {\n  type: `TransactionController:getGasFeeTokens`;\n  handler: TransactionController['getGasFeeTokens'];\n};\n\n/**\n * Union of all TransactionController action types.\n */\nexport type TransactionControllerMethodActions =\n  | TransactionControllerHandleMethodDataAction\n  | TransactionControllerAddTransactionBatchAction\n  | TransactionControllerIsAtomicBatchSupportedAction\n  | TransactionControllerAddTransactionAction\n  | TransactionControllerStartIncomingTransactionPollingAction\n  | TransactionControllerStopIncomingTransactionPollingAction\n  | TransactionControllerUpdateIncomingTransactionsAction\n  | TransactionControllerStopTransactionAction\n  | TransactionControllerSpeedUpTransactionAction\n  | TransactionControllerEstimateGasAction\n  | TransactionControllerEstimateGasBatchAction\n  | TransactionControllerEstimateGasBufferedAction\n  | TransactionControllerUpdateTransactionAction\n  | TransactionControllerConfirmExternalTransactionAction\n  | TransactionControllerGetNonceLockAction\n  | TransactionControllerUpdateEditableParamsAction\n  | TransactionControllerSetTransactionActiveAction\n  | TransactionControllerApproveTransactionsWithSameNonceAction\n  | TransactionControllerUpdateCustodialTransactionAction\n  | TransactionControllerGetTransactionsAction\n  | TransactionControllerEstimateGasFeeAction\n  | TransactionControllerGetLayer1GasFeeAction\n  | TransactionControllerClearUnapprovedTransactionsAction\n  | TransactionControllerAbortTransactionSigningAction\n  | TransactionControllerUpdateAtomicBatchDataAction\n  | TransactionControllerEmulateNewTransactionAction\n  | TransactionControllerEmulateTransactionUpdateAction\n  | TransactionControllerGetGasFeeTokensAction;\n"]}

package/dist/TransactionController-method-action-types.d.cts

@@ -0,0 +1,327 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { TransactionController } from "./TransactionController.cjs";
+/**
+ * Handle new method data request.
+ *
+ * @param fourBytePrefix - The method prefix.
+ * @param networkClientId - The ID of the network client used to fetch the method data.
+ * @returns The method data object corresponding to the given signature prefix.
+ */
+export type TransactionControllerHandleMethodDataAction = {
+    type: `TransactionController:handleMethodData`;
+    handler: TransactionController['handleMethodData'];
+};
+/**
+ * Add a batch of transactions to be submitted after approval.
+ *
+ * @param request - Request object containing the transactions to add.
+ * @returns Result object containing the generated batch ID.
+ */
+export type TransactionControllerAddTransactionBatchAction = {
+    type: `TransactionController:addTransactionBatch`;
+    handler: TransactionController['addTransactionBatch'];
+};
+/**
+ * Determine which chains support atomic batch transactions with the given account address.
+ *
+ * @param request - Request object containing the account address and other parameters.
+ * @returns  Result object containing the supported chains and related information.
+ */
+export type TransactionControllerIsAtomicBatchSupportedAction = {
+    type: `TransactionController:isAtomicBatchSupported`;
+    handler: TransactionController['isAtomicBatchSupported'];
+};
+/**
+ * Add a new unapproved transaction to state. Parameters will be validated, a
+ * unique transaction ID will be generated, and `gas` and `gasPrice` will be calculated
+ * if not provided. A `<tx.id>:unapproved` hub event will be emitted once added.
+ *
+ * @param txParams - Standard parameters for an Ethereum transaction.
+ * @param options - Additional options to control how the transaction is added.
+ * @returns Object containing a promise resolving to the transaction hash if approved.
+ */
+export type TransactionControllerAddTransactionAction = {
+    type: `TransactionController:addTransaction`;
+    handler: TransactionController['addTransaction'];
+};
+/**
+ * Starts polling for incoming transactions from the remote transaction source.
+ */
+export type TransactionControllerStartIncomingTransactionPollingAction = {
+    type: `TransactionController:startIncomingTransactionPolling`;
+    handler: TransactionController['startIncomingTransactionPolling'];
+};
+/**
+ * Stops polling for incoming transactions from the remote transaction source.
+ */
+export type TransactionControllerStopIncomingTransactionPollingAction = {
+    type: `TransactionController:stopIncomingTransactionPolling`;
+    handler: TransactionController['stopIncomingTransactionPolling'];
+};
+/**
+ * Update the incoming transactions by polling the remote transaction source.
+ *
+ * @param request - Request object.
+ * @param request.tags - Additional tags to identify the source of the request.
+ */
+export type TransactionControllerUpdateIncomingTransactionsAction = {
+    type: `TransactionController:updateIncomingTransactions`;
+    handler: TransactionController['updateIncomingTransactions'];
+};
+/**
+ * Attempts to cancel a transaction based on its ID by setting its status to "rejected"
+ * and emitting a `<tx.id>:finished` hub event.
+ *
+ * @param transactionId - The ID of the transaction to cancel.
+ * @param gasValues - The gas values to use for the cancellation transaction.
+ * @param options - The options for the cancellation transaction.
+ * @param options.actionId - Unique ID persisted on transaction metadata.
+ * @param options.estimatedBaseFee - The estimated base fee of the transaction.
+ */
+export type TransactionControllerStopTransactionAction = {
+    type: `TransactionController:stopTransaction`;
+    handler: TransactionController['stopTransaction'];
+};
+/**
+ * Attempts to speed up a transaction increasing transaction gasPrice by ten percent.
+ *
+ * @param transactionId - The ID of the transaction to speed up.
+ * @param gasValues - The gas values to use for the speed up transaction.
+ * @param options - The options for the speed up transaction.
+ * @param options.actionId - Unique ID persisted on transaction metadata.
+ * @param options.estimatedBaseFee - The estimated base fee of the transaction.
+ */
+export type TransactionControllerSpeedUpTransactionAction = {
+    type: `TransactionController:speedUpTransaction`;
+    handler: TransactionController['speedUpTransaction'];
+};
+/**
+ * Estimates required gas for a given transaction.
+ *
+ * @param transaction - The transaction to estimate gas for.
+ * @param networkClientId - The network client id to use for the estimate.
+ * @param options - Additional options for the estimate.
+ * @param options.ignoreDelegationSignatures - Ignore signature errors if submitting delegations to the DelegationManager.
+ * @returns The gas and gas price.
+ */
+export type TransactionControllerEstimateGasAction = {
+    type: `TransactionController:estimateGas`;
+    handler: TransactionController['estimateGas'];
+};
+/**
+ * Estimates required gas for a batch of transactions.
+ *
+ * @param request - Request object.
+ * @param request.chainId - Chain ID of the transactions.
+ * @param request.from - Address of the sender.
+ * @param request.transactions - Array of transactions within a batch request.
+ * @returns Object containing the gas limit.
+ */
+export type TransactionControllerEstimateGasBatchAction = {
+    type: `TransactionController:estimateGasBatch`;
+    handler: TransactionController['estimateGasBatch'];
+};
+/**
+ * Estimates required gas for a given transaction and add additional gas buffer with the given multiplier.
+ *
+ * @param transaction - The transaction params to estimate gas for.
+ * @param multiplier - The multiplier to use for the gas buffer.
+ * @param networkClientId - The network client id to use for the estimate.
+ * @returns The buffered estimated gas and whether the estimation failed.
+ */
+export type TransactionControllerEstimateGasBufferedAction = {
+    type: `TransactionController:estimateGasBuffered`;
+    handler: TransactionController['estimateGasBuffered'];
+};
+/**
+ * Updates an existing transaction in state.
+ *
+ * @param transactionMeta - The new transaction to store in state.
+ * @param note - A note or update reason to be logged.
+ */
+export type TransactionControllerUpdateTransactionAction = {
+    type: `TransactionController:updateTransaction`;
+    handler: TransactionController['updateTransaction'];
+};
+/**
+ * Adds external provided transaction to state as confirmed transaction.
+ *
+ * @param transactionMeta - TransactionMeta to add transactions.
+ * @param transactionReceipt - TransactionReceipt of the external transaction.
+ * @param baseFeePerGas - Base fee per gas of the external transaction.
+ */
+export type TransactionControllerConfirmExternalTransactionAction = {
+    type: `TransactionController:confirmExternalTransaction`;
+    handler: TransactionController['confirmExternalTransaction'];
+};
+/**
+ * Acquires a nonce lock for the given address on the specified network,
+ * ensuring that nonces are assigned sequentially without conflicts.
+ *
+ * @param address - The account address for which to acquire the nonce lock.
+ * @param networkClientId - The ID of the network client to use.
+ * @returns A promise that resolves to a nonce lock containing the next nonce and a release function.
+ */
+export type TransactionControllerGetNonceLockAction = {
+    type: `TransactionController:getNonceLock`;
+    handler: TransactionController['getNonceLock'];
+};
+/**
+ * Updates the editable parameters of a transaction.
+ *
+ * @param txId - The ID of the transaction to update.
+ * @param params - The editable parameters to update.
+ * @param params.containerTypes - Container types applied to the parameters.
+ * @param params.data - Data to pass with the transaction.
+ * @param params.from - Address to send the transaction from.
+ * @param params.gas - Maximum number of units of gas to use for the transaction.
+ * @param params.gasPrice - Price per gas for legacy transactions.
+ * @param params.maxFeePerGas - Maximum amount per gas to pay for the transaction, including the priority fee.
+ * @param params.maxPriorityFeePerGas - Maximum amount per gas to give to validator as incentive.
+ * @param params.updateType - Whether to update the transaction type. Defaults to `true`.
+ * @param params.to - Address to send the transaction to.
+ * @param params.value - Value associated with the transaction.
+ * @returns The updated transaction metadata.
+ */
+export type TransactionControllerUpdateEditableParamsAction = {
+    type: `TransactionController:updateEditableParams`;
+    handler: TransactionController['updateEditableParams'];
+};
+/**
+ * Update the isActive state of a transaction.
+ *
+ * @param transactionId - The ID of the transaction to update.
+ * @param isActive - The active state.
+ */
+export type TransactionControllerSetTransactionActiveAction = {
+    type: `TransactionController:setTransactionActive`;
+    handler: TransactionController['setTransactionActive'];
+};
+/**
+ * Signs and returns the raw transaction data for provided transaction params list.
+ *
+ * @param listOfTxParams - The list of transaction params to approve.
+ * @param opts - Options bag.
+ * @param opts.hasNonce - Whether the transactions already have a nonce.
+ * @returns The raw transactions.
+ */
+export type TransactionControllerApproveTransactionsWithSameNonceAction = {
+    type: `TransactionController:approveTransactionsWithSameNonce`;
+    handler: TransactionController['approveTransactionsWithSameNonce'];
+};
+/**
+ * Update a custodial transaction.
+ *
+ * @param request - The custodial transaction update request.
+ *
+ * @returns The updated transaction metadata.
+ */
+export type TransactionControllerUpdateCustodialTransactionAction = {
+    type: `TransactionController:updateCustodialTransaction`;
+    handler: TransactionController['updateCustodialTransaction'];
+};
+/**
+ * Search transaction metadata for matching entries.
+ *
+ * @param opts - Options bag.
+ * @param opts.initialList - The transactions to search. Defaults to the current state.
+ * @param opts.limit - The maximum number of transactions to return. No limit by default.
+ * @param opts.searchCriteria - An object containing values or functions for transaction properties to filter transactions with.
+ * @returns An array of transactions matching the provided options.
+ */
+export type TransactionControllerGetTransactionsAction = {
+    type: `TransactionController:getTransactions`;
+    handler: TransactionController['getTransactions'];
+};
+/**
+ * Estimates the gas fees for a transaction.
+ *
+ * @param args - The arguments for estimating gas fees.
+ * @param args.transactionParams - The transaction parameters to estimate fees for.
+ * @param args.chainId - The chain ID to use. If not provided, the network client ID is used to determine the chain.
+ * @param args.networkClientId - The network client ID to use for the estimation.
+ * @returns A promise that resolves to the estimated gas fee response.
+ */
+export type TransactionControllerEstimateGasFeeAction = {
+    type: `TransactionController:estimateGasFee`;
+    handler: TransactionController['estimateGasFee'];
+};
+/**
+ * Determine the layer 1 gas fee for the given transaction parameters.
+ *
+ * @param request - The request object.
+ * @param request.transactionParams - The transaction parameters to estimate the layer 1 gas fee for.
+ * @param request.chainId - The ID of the chain where the transaction will be executed.
+ * @param request.networkClientId - The ID of a specific network client to process the transaction.
+ * @returns The layer 1 gas fee.
+ */
+export type TransactionControllerGetLayer1GasFeeAction = {
+    type: `TransactionController:getLayer1GasFee`;
+    handler: TransactionController['getLayer1GasFee'];
+};
+/**
+ * Removes unapproved transactions from state.
+ */
+export type TransactionControllerClearUnapprovedTransactionsAction = {
+    type: `TransactionController:clearUnapprovedTransactions`;
+    handler: TransactionController['clearUnapprovedTransactions'];
+};
+/**
+ * Stop the signing process for a specific transaction.
+ * Throws an error causing the transaction status to be set to failed.
+ *
+ * @param transactionId - The ID of the transaction to stop signing.
+ */
+export type TransactionControllerAbortTransactionSigningAction = {
+    type: `TransactionController:abortTransactionSigning`;
+    handler: TransactionController['abortTransactionSigning'];
+};
+/**
+ * Update the transaction data of a single nested transaction within an atomic batch transaction.
+ *
+ * @param options - The options bag.
+ * @param options.transactionId - ID of the atomic batch transaction.
+ * @param options.transactionIndex - Index of the nested transaction within the atomic batch transaction.
+ * @param options.transactionData - New data to set for the nested transaction.
+ * @returns The updated data for the atomic batch transaction.
+ */
+export type TransactionControllerUpdateAtomicBatchDataAction = {
+    type: `TransactionController:updateAtomicBatchData`;
+    handler: TransactionController['updateAtomicBatchData'];
+};
+/**
+ * Emulate a new transaction.
+ *
+ * @param transactionId - The transaction ID.
+ */
+export type TransactionControllerEmulateNewTransactionAction = {
+    type: `TransactionController:emulateNewTransaction`;
+    handler: TransactionController['emulateNewTransaction'];
+};
+/**
+ * Emulate a transaction update.
+ *
+ * @param transactionMeta - Transaction metadata.
+ */
+export type TransactionControllerEmulateTransactionUpdateAction = {
+    type: `TransactionController:emulateTransactionUpdate`;
+    handler: TransactionController['emulateTransactionUpdate'];
+};
+/**
+ * Retrieve available gas fee tokens for a transaction.
+ *
+ * @param request - The request object containing transaction details.
+ * @returns The list of available gas fee tokens.
+ */
+export type TransactionControllerGetGasFeeTokensAction = {
+    type: `TransactionController:getGasFeeTokens`;
+    handler: TransactionController['getGasFeeTokens'];
+};
+/**
+ * Union of all TransactionController action types.
+ */
+export type TransactionControllerMethodActions = TransactionControllerHandleMethodDataAction | TransactionControllerAddTransactionBatchAction | TransactionControllerIsAtomicBatchSupportedAction | TransactionControllerAddTransactionAction | TransactionControllerStartIncomingTransactionPollingAction | TransactionControllerStopIncomingTransactionPollingAction | TransactionControllerUpdateIncomingTransactionsAction | TransactionControllerStopTransactionAction | TransactionControllerSpeedUpTransactionAction | TransactionControllerEstimateGasAction | TransactionControllerEstimateGasBatchAction | TransactionControllerEstimateGasBufferedAction | TransactionControllerUpdateTransactionAction | TransactionControllerConfirmExternalTransactionAction | TransactionControllerGetNonceLockAction | TransactionControllerUpdateEditableParamsAction | TransactionControllerSetTransactionActiveAction | TransactionControllerApproveTransactionsWithSameNonceAction | TransactionControllerUpdateCustodialTransactionAction | TransactionControllerGetTransactionsAction | TransactionControllerEstimateGasFeeAction | TransactionControllerGetLayer1GasFeeAction | TransactionControllerClearUnapprovedTransactionsAction | TransactionControllerAbortTransactionSigningAction | TransactionControllerUpdateAtomicBatchDataAction | TransactionControllerEmulateNewTransactionAction | TransactionControllerEmulateTransactionUpdateAction | TransactionControllerGetGasFeeTokensAction;
+//# sourceMappingURL=TransactionController-method-action-types.d.cts.map

package/dist/TransactionController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionController-method-action-types.d.cts","sourceRoot":"","sources":["../src/TransactionController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,oCAAgC;AAErE;;;;;;GAMG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,qBAAqB,CAAC,iCAAiC,CAAC,CAAC;CACnE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,qBAAqB,CAAC,gCAAgC,CAAC,CAAC;CAClE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,qBAAqB,CAAC,4BAA4B,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,qBAAqB,CAAC,aAAa,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,qBAAqB,CAAC,4BAA4B,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,qBAAqB,CAAC,cAAc,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,2DAA2D,GAAG;IACxE,IAAI,EAAE,wDAAwD,CAAC;IAC/D,OAAO,EAAE,qBAAqB,CAAC,kCAAkC,CAAC,CAAC;CACpE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,qBAAqB,CAAC,4BAA4B,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,qBAAqB,CAAC,6BAA6B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC1C,2CAA2C,GAC3C,8CAA8C,GAC9C,iDAAiD,GACjD,yCAAyC,GACzC,0DAA0D,GAC1D,yDAAyD,GACzD,qDAAqD,GACrD,0CAA0C,GAC1C,6CAA6C,GAC7C,sCAAsC,GACtC,2CAA2C,GAC3C,8CAA8C,GAC9C,4CAA4C,GAC5C,qDAAqD,GACrD,uCAAuC,GACvC,+CAA+C,GAC/C,+CAA+C,GAC/C,2DAA2D,GAC3D,qDAAqD,GACrD,0CAA0C,GAC1C,yCAAyC,GACzC,0CAA0C,GAC1C,sDAAsD,GACtD,kDAAkD,GAClD,gDAAgD,GAChD,gDAAgD,GAChD,mDAAmD,GACnD,0CAA0C,CAAC"}