Skip to content

Commit b9c6623

Browse files
Apply suggestions regarding transaction-controller CHANGELOG
Co-authored-by: Matthew Walsh <matthew.walsh@consensys.net>
1 parent 97cb464 commit b9c6623

File tree

1 file changed

+22
-31
lines changed

1 file changed

+22
-31
lines changed

packages/transaction-controller/CHANGELOG.md

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88

99
## [17.0.0]
1010
### Added
11-
- **BREAKING:** Add swaps logic into `TransactionController` ([#1877](https://github.com/MetaMask/core/pull/1877))
11+
- **BREAKING:** Add additional support swaps support ([#1877](https://github.com/MetaMask/core/pull/1877))
1212
- Swap transaction updates can be prevented by setting `disableSwaps` as `true`. If not set it will default to `false`.
13-
- This value MUST be set to true in mobile, since mobile doesn't use any swap logic.
1413
- If `disableSwaps` is `false` or not set, then the `createSwapsTransaction` callback MUST be defined.
15-
- Add hooks to support mmi logic ([#1787](https://github.com/MetaMask/core/pull/1787))
16-
- Add the option in the construction `hooks` giving the possibility to pass callback functions additional logic to execute.
17-
- Add the optional callback in hooks `getAdditionalSignArguments` returns additional arguments required to sign a transaction.
18-
- Add the optional callback in hooks `beforeApproveOnInit` additional logic to execute before starting an approval flow for a transaction during initialization. Return false to skip the transaction.
19-
- Add the optional callback in hooks `afterSign` additional logic to execute after signing a transaction. Return false to not change the status to signed.
20-
- Add the optional callback in hooks `beforePublish` additional logic to execute before publishing a transaction. Return false to prevent the broadcast of the transaction.
21-
- Add `onBootCleanup` functionality to constructor and `onNetworkChange` ([#1916](https://github.com/MetaMask/core/pull/1916))
22-
- Initialises approvals of `TransactionStatus.unapproved` transactions on active network
23-
- Refreshes the gas values for `TransactionStatus.unapproved` transactions on active network
24-
- Submits the `TransactionStatus.approved` transactions on active network
25-
- Support advanced gas fees in `TransactionController` ([#1966](https://github.com/MetaMask/core/pull/1966))
26-
- `getSavedGasFees` callback added as an optional parameter in constructor.
27-
- Setting `getSavedGasFees` callback will make saved gas fees (`advancedGasFees` in the `PreferencesController` state) be taken into account when updating gas fees.
28-
- Add updateCustodialTransaction to update the custodial transactions associated with a specific transaction ID. ([#2018](https://github.com/MetaMask/core/pull/2018))
14+
- Add optional hooks to support alternate flows ([#1787](https://github.com/MetaMask/core/pull/1787))
15+
- Add the `getAdditionalSignArguments` hook to provide additional arguments when signing.
16+
- Add the `beforeApproveOnInit` hook to execute additional logic before starting an approval flow for a transaction during initialization. Return `false` to skip the transaction.
17+
- Add the `afterSign` hook to execute additional logic after signing a transaction. Return `false` to not change the `status` to `signed`.
18+
- Add the `beforePublish` hook to execute additional logic before publishing a transaction. Return `false` to prevent the transaction being submitted.
19+
- Add additional persisted transaction support during initialization and on network change ([#1916](https://github.com/MetaMask/core/pull/1916))
20+
- Initialise approvals for unapproved transactions on the current network.
21+
- Add missing gas values for unapproved transactions on the current network.
22+
- Submit any approved transactions on the current network.
23+
- Support saved gas fees ([#1966](https://github.com/MetaMask/core/pull/1966))
24+
- Add optional `getSavedGasFees` callback to constructor.
25+
- Add `updateCustodialTransaction` method to update custodial transactions ([#2018](https://github.com/MetaMask/core/pull/2018))
2926
- Add `accessList` to txParam types ([#2016](https://github.com/MetaMask/core/pull/2016))
30-
- Adds `estimateGasBuffered` public method ([#2021](https://github.com/MetaMask/core/pull/2021))
31-
- Add method for adding params to transaction meta ([#1985](https://github.com/MetaMask/core/pull/1985))
32-
- Add gas values validation to transaction params ([#1978](https://github.com/MetaMask/core/pull/1978))
33-
- Add `approveTransactionsWithSameNonce` public method to core transaction controller ([#1961](https://github.com/MetaMask/core/pull/1961))
34-
- Add `clearUnapprovedTxs` public method to `TransactionController` ([#1979](https://github.com/MetaMask/core/pull/1979))
35-
- Add `updatePreviousGasParams` public method to `TransactionController` ([#1943](https://github.com/MetaMask/core/pull/1943))
36-
- Add `TransactionEvents` to be emitted from `TransactionController` ([#1894](https://github.com/MetaMask/core/pull/1894))
27+
- Add `estimateGasBuffered` method to estimate gas and apply a specific buffer multiplier ([#2021](https://github.com/MetaMask/core/pull/2021))
28+
- Add `updateSecurityAlertResponse` method ([#1985](https://github.com/MetaMask/core/pull/1985))
29+
- Add gas values validation ([#1978](https://github.com/MetaMask/core/pull/1978))
30+
- Add `approveTransactionsWithSameNonce` method ([#1961](https://github.com/MetaMask/core/pull/1961))
31+
- Add `clearUnapprovedTransactions` method ([#1979](https://github.com/MetaMask/core/pull/1979))
32+
- Add `updatePreviousGasParams` method ([#1943](https://github.com/MetaMask/core/pull/1943))
33+
- Emit additional events to support metrics in the clients ([#1894](https://github.com/MetaMask/core/pull/1894))
3734
- Populate the `firstRetryBlockNumber`, `retryCount`, and `warning` properties in the transaction metadata. ([#1896](https://github.com/MetaMask/core/pull/1896))
3835

3936
### Changed
4037
- **BREAKING:** Pending transactions are now automatically resubmitted. ([#1896](https://github.com/MetaMask/core/pull/1896))
4138
- This can be disabled by setting the new `pendingTransactions.isResubmitEnabled` constructor option to `false`.
4239
- **BREAKING:** Bump dependency and peer dependency on `@metamask/network-controller` to ^16.0.0
4340
- Persist specific error properties in core transaction metadata ([#1915](https://github.com/MetaMask/core/pull/1915))
44-
- create `TxError` type with specific properties to support both clients.
45-
- Updated `failTransaction` to use the new type.
41+
- Create `TransactionError` type with explicit properties.
4642
- Align core transaction error messages with extension ([#1980](https://github.com/MetaMask/core/pull/1980))
47-
- `processApproval` when the user rejects the request: MetaMask Tx Signature: User denied transaction signature.`
48-
- `validateParamRecipient` to use `@metamask/rpc-errors`: `Invalid "to" address.`
49-
- `validateParamFrom` to use `@metamask/rpc-errors`: `Invalid "from" address.`
50-
- `validateIfTransactionUnapproved`: ``TransactionsController: Can only call ${fnName} on an unapproved transaction.`
51-
- Change `initApprovals` method based on the extension ([#1867](https://github.com/MetaMask/core/pull/1867))
5243
- Catch of the `initApprovals` method to skip logging when the error is `userRejectedRequest`.
53-
- `stopTransaction` now creates a cancel transaction with same nonce instead of changing type to cancel ([#1998](https://github.com/MetaMask/core/pull/1998))
44+
- Create an additional transaction metadata entry when calling `stopTransaction` ([#1998](https://github.com/MetaMask/core/pull/1998))
5445
- Bump dependency `@metamask/eth-query` from ^3.0.1 to ^4.0.0 ([#2028](https://github.com/MetaMask/core/pull/2028))
5546
- Bump dependency and peer dependency on `@metamask/gas-fee-controller` to ^10.0.1
5647
- Bump @metamask/utils from 8.1.0 to 8.2.0 ([#1957](https://github.com/MetaMask/core/pull/1957))

0 commit comments

Comments
 (0)