Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Rename enableTxParamsGasFeeUpdates to isAutomaticGasFeeUpdateEnabled and also callback #5602

Merged
merged 6 commits into from
Apr 8, 2025

Conversation

OGPoyraz
Copy link
Member

@OGPoyraz OGPoyraz commented Apr 7, 2025

Explanation

This PR aims to rename enableTxParamsGasFeeUpdates to isAutomaticGasFeeUpdateEnabled and make it a callback function instead of a boolean.
This callback is invoked before performing txParams gas fee updates. The update will proceed only if the callback returns a truthy value.

References

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/4595
Mobile update PR: MetaMask/metamask-mobile#14470 (Not updated package yet since major update PR in review MetaMask/metamask-mobile#14326 )
Extension update PR:

Changelog

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@OGPoyraz OGPoyraz requested review from a team as code owners April 7, 2025 10:54
@OGPoyraz
Copy link
Member Author

OGPoyraz commented Apr 7, 2025

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented Apr 7, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "27.0.0-preview-160372c",
  "@metamask-previews/address-book-controller": "6.0.3-preview-160372c",
  "@metamask-previews/announcement-controller": "7.0.3-preview-160372c",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-160372c",
  "@metamask-previews/approval-controller": "7.1.3-preview-160372c",
  "@metamask-previews/assets-controllers": "56.0.0-preview-160372c",
  "@metamask-previews/base-controller": "8.0.0-preview-160372c",
  "@metamask-previews/bridge-controller": "12.0.0-preview-160372c",
  "@metamask-previews/bridge-status-controller": "11.0.0-preview-160372c",
  "@metamask-previews/build-utils": "3.0.3-preview-160372c",
  "@metamask-previews/chain-agnostic-permission": "0.3.0-preview-160372c",
  "@metamask-previews/composable-controller": "11.0.0-preview-160372c",
  "@metamask-previews/controller-utils": "11.7.0-preview-160372c",
  "@metamask-previews/earn-controller": "0.10.0-preview-160372c",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-160372c",
  "@metamask-previews/ens-controller": "16.0.0-preview-160372c",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-160372c",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-160372c",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-160372c",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-160372c",
  "@metamask-previews/keyring-controller": "21.0.1-preview-160372c",
  "@metamask-previews/logging-controller": "6.0.4-preview-160372c",
  "@metamask-previews/message-manager": "12.0.1-preview-160372c",
  "@metamask-previews/multichain": "4.0.0-preview-160372c",
  "@metamask-previews/multichain-api-middleware": "0.1.1-preview-160372c",
  "@metamask-previews/multichain-network-controller": "0.3.0-preview-160372c",
  "@metamask-previews/multichain-transactions-controller": "0.8.0-preview-160372c",
  "@metamask-previews/name-controller": "8.0.3-preview-160372c",
  "@metamask-previews/network-controller": "23.2.0-preview-160372c",
  "@metamask-previews/notification-services-controller": "5.0.1-preview-160372c",
  "@metamask-previews/permission-controller": "11.0.6-preview-160372c",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-160372c",
  "@metamask-previews/phishing-controller": "12.4.1-preview-160372c",
  "@metamask-previews/polling-controller": "13.0.0-preview-160372c",
  "@metamask-previews/preferences-controller": "17.0.0-preview-160372c",
  "@metamask-previews/profile-sync-controller": "11.0.0-preview-160372c",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-160372c",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-160372c",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-160372c",
  "@metamask-previews/sample-controllers": "0.1.0-preview-160372c",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-160372c",
  "@metamask-previews/signature-controller": "27.1.0-preview-160372c",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-160372c",
  "@metamask-previews/transaction-controller": "53.0.0-preview-160372c",
  "@metamask-previews/user-operation-controller": "32.0.0-preview-160372c"
}

@OGPoyraz
Copy link
Member Author

OGPoyraz commented Apr 7, 2025

@metamaskbot publish-preview

Copy link
Contributor

github-actions bot commented Apr 7, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "27.0.0-preview-714dae1",
  "@metamask-previews/address-book-controller": "6.0.3-preview-714dae1",
  "@metamask-previews/announcement-controller": "7.0.3-preview-714dae1",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-714dae1",
  "@metamask-previews/approval-controller": "7.1.3-preview-714dae1",
  "@metamask-previews/assets-controllers": "56.0.0-preview-714dae1",
  "@metamask-previews/base-controller": "8.0.0-preview-714dae1",
  "@metamask-previews/bridge-controller": "12.0.0-preview-714dae1",
  "@metamask-previews/bridge-status-controller": "11.0.0-preview-714dae1",
  "@metamask-previews/build-utils": "3.0.3-preview-714dae1",
  "@metamask-previews/chain-agnostic-permission": "0.3.0-preview-714dae1",
  "@metamask-previews/composable-controller": "11.0.0-preview-714dae1",
  "@metamask-previews/controller-utils": "11.7.0-preview-714dae1",
  "@metamask-previews/earn-controller": "0.10.0-preview-714dae1",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-714dae1",
  "@metamask-previews/ens-controller": "16.0.0-preview-714dae1",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-714dae1",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-714dae1",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-714dae1",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-714dae1",
  "@metamask-previews/keyring-controller": "21.0.1-preview-714dae1",
  "@metamask-previews/logging-controller": "6.0.4-preview-714dae1",
  "@metamask-previews/message-manager": "12.0.1-preview-714dae1",
  "@metamask-previews/multichain": "4.0.0-preview-714dae1",
  "@metamask-previews/multichain-api-middleware": "0.1.1-preview-714dae1",
  "@metamask-previews/multichain-network-controller": "0.3.0-preview-714dae1",
  "@metamask-previews/multichain-transactions-controller": "0.8.0-preview-714dae1",
  "@metamask-previews/name-controller": "8.0.3-preview-714dae1",
  "@metamask-previews/network-controller": "23.2.0-preview-714dae1",
  "@metamask-previews/notification-services-controller": "5.0.1-preview-714dae1",
  "@metamask-previews/permission-controller": "11.0.6-preview-714dae1",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-714dae1",
  "@metamask-previews/phishing-controller": "12.4.1-preview-714dae1",
  "@metamask-previews/polling-controller": "13.0.0-preview-714dae1",
  "@metamask-previews/preferences-controller": "17.0.0-preview-714dae1",
  "@metamask-previews/profile-sync-controller": "11.0.0-preview-714dae1",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-714dae1",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-714dae1",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-714dae1",
  "@metamask-previews/sample-controllers": "0.1.0-preview-714dae1",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-714dae1",
  "@metamask-previews/signature-controller": "27.1.0-preview-714dae1",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-714dae1",
  "@metamask-previews/transaction-controller": "53.0.0-preview-714dae1",
  "@metamask-previews/user-operation-controller": "32.0.0-preview-714dae1"
}

vinistevam
vinistevam previously approved these changes Apr 7, 2025
matthewwalsh0
matthewwalsh0 previously approved these changes Apr 7, 2025
* Callback to determine whether gas fee updates should be enabled for a given transaction.
* Returns true to enable updates, false to disable them.
*/
enableTxParamsGasFeeUpdates?: (transactionMeta: TransactionMeta) => boolean;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor, should we take this chance to rename this to something more standard like isAutomaticGasFeeUpdateEnabled?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@OGPoyraz OGPoyraz dismissed stale reviews from matthewwalsh0 and vinistevam via b2f00f3 April 7, 2025 14:57
@OGPoyraz OGPoyraz changed the title fix: Change enableTxParamsGasFeeUpdates to callback fix: Rename enableTxParamsGasFeeUpdates to isAutomaticGasFeeUpdateEnabled and also callback Apr 7, 2025
@OGPoyraz OGPoyraz merged commit 46a6215 into main Apr 8, 2025
197 checks passed
@OGPoyraz OGPoyraz deleted the ogp/4595 branch April 8, 2025 09:31
matallui added a commit that referenced this pull request Apr 9, 2025
* main:
  Fix unmocked block tracker warning in NetworkController tests (#5289)
  ci: GH action to remind developers to add release notes in CHANGELOG.md (#5620)
  Release 355.0.0 (#5619)
  Release 354.0.0 (#5615)
  fix: Update origin in Snap requests (#5616)
  Release/353.0.0 (#5612)
  refactor(accounts-controller): use type-cast instead of `@ts-expect-error` (#5568)
  feat: support external sign transactions (#5604)
  feat: extend isAtomicBatchSupported result (#5600)
  fix: Rename `enableTxParamsGasFeeUpdates` to `isAutomaticGasFeeUpdateEnabled` and also callback (#5602)
  Release/352.0.0 (#5608)
  feat: STAKE-1005: refresh staking data when staking txs are confirmed (#5607)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants