Skip to content
This repository was archived by the owner on Jun 13, 2022. It is now read-only.

CHANGELOG.md

Latest commit

 

History

History
616 lines (504 loc) · 40.1 KB

CHANGELOG.md

File metadata and controls

616 lines (504 loc) · 40.1 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

28.0.0

Added

  • Add GrantPermissions action to PermissionsController (#780)
  • Add PermissionController.revokePermissionForAllSubjects action (#764)

Changed

  • BREAKING: Rename NotificationController to AnnouncementController (#697)
    • The NotificationController class is now AnnouncementController.
    • The controller notifications state has been renamed to announcements.
    • All other exported types including the word "notification" have been updated to use the word "announcement" instead.

27.1.1

Fixed

  • Move @keystonehq/metamask-airgapped-keyring to dependencies (#757)

27.1.0 [DEPRECATED]

Added

  • Now the KeyringController supports the QRKeyring from @keystonehq/metamask-airgapped-keyring. Developers can enable the import of accounts from a QR hardware wallet. A new optional parameter, setAccountLabel from the PreferencesController, should be passed to the KeyringController to enable this new functionality. (#685)
    • UPDATE: This is broken. Consumers are encouraged to upgrade to 27.1.1.

Changed

  • Bump eth-phishing-detect version from 1.1.14 to 1.1.16 (#742)
  • Bump @metamask/contract-metadata from 1.31.0 to 1.33.0 (#730)

Fixed

  • Improve error message when attempting to import an invalid private key (#739)

27.0.0

Changed

  • BREAKING: Further reduce load on Infura by removing non-critical data from the fallback implementation of the Gas API (#712)
    • In GasFeeEstimates – the type of the object returned by fetchGasEstimatesViaEthFeeHistory as well as type of gasFeeEstimates stored in GasFeeController — historicalBaseFeeRange, baseFeeTrend, latestPriorityFeeRange, historicalPriorityFeeRange, priorityFeeTrend, and networkCongestion can now be null. You should update your code to account for this.
    • The ExistingFeeHistoryBlock and NextFeeHistoryBlock types were inconvenient to use and are no longer public. You should use FeeHistoryBlock instead.
    • The BlockFeeHistoryDatasetFetcher class has been removed. There is no replacement.
    • The calculateBaseFeeRange, calculateBaseFeeTrend, calculateNetworkCongestion, calculatePriorityFeeRange, and calculatePriorityFeeTrend functions have been removed. There are no replacements.
  • Update AssetsContractController to make userAddress of getTokenStandardAndDetails optional (#717)

Fixed

  • Fix RateLimitController so that the rate limit is not reset aggressively (#716)

26.0.0

Added

  • Add PermissionController and SubjectMetadataController (#692)
  • Add RateLimitController (#698)
  • Add revokePermissions to PermissionController actions (#708)

Changed

  • BREAKING: Fetch and return token image as part of getDetails calls on ERC721Standard and ERC1155Standard (#702)
    • This change is breaking because it requires that the AssetsContractController (on which the ERC721Standard and ERC1155Standard are instantiated) be passed a listener for onPreferencesStateChange from the PreferencesController so that it can use the user's preferred IPFSGateway to fetch any images hosted on IPFS. Consumers will have to pass onPreferencesStateChange in an options object (first arg) to the AssetsContractController constructor when initializing.
  • Reduce load on Infura in gas estimate API fallback (#705)
  • Update fetchBlockFeeHistory to account for nonexistent baseFeePerGas (#703)
  • Update fetchBlockFeeHistory to account for test chains with a few number of blocks (#699)
  • Expose WebSocket via endowments for network access (#696)
  • Bump @metamask/metamask-eth-abis from ^2.1.0 to 3.0.0 (#681)

25.1.0

Changed

  • Make the userAddress argument to the getDetails method on the ERC20Standard class optional. (#674)

25.0.0

Added

  • Add optional third argument to method checkAndUpdateSingleCollectibleOwnershipStatus on CollectiblesController, which contains the userAddress and chainId to check asset ownership against. If not included, the method will still check against the currently configured selectedAddress and chainId configured in the CollectiblesController (#672)
  • Add getTokenStandardAndDetails method on AssetsContractController which determines whether the input contract conforms to particular known token standard (ERC20, ERC721 or ERC1155) and returns the detected standard along with some key values/details about that the contract and/or specified token within that contract (#667)

Changed

    • BREAKING - Standardize ERC721/1155/20 method names (#667)
    • Renames many methods on the AssetsContractController to include the contract type they are used by in the name in a standardized structure (i.e. getAssetName -> getERC721AssetName and balanceOfERC1155Collectible -> getERC1155BalanceOf).
    • Consumers will need to look at the AssetsContractController for any methods they consume and adapt names accordingly.

24.0.0

Added

  • Add checkAndUpdateSingleCollectibleOwnershipStatus method (#669)

Changed

    • BREAKING: Rename checkAndUpdateCollectibleOwnershipStatus to checkAndUpdateAllCollectibleOwnershipStatus (#669)
    • Previously incorrectly released as minor version bump 23.1.0.
    • Consumers who used checkAndUpdateCollectibleOwnershipStatus must update it's name to checkAndUpdateAllCollectibleOwnershipStatus.

23.1.0 [DEPRECATED]

Added

  • Add checkAndUpdateSingleCollectibleOwnershipStatus method (#669)

23.0.0

Added

  • Add method to check and update collectible ownership state (#664)
  • Add method to set a collectible as favorite (#623)
  • Update GasFeeController to use eth_feeHistory to compute gas fee recommendations when MetaSwap API is down (#614)
  • Update GasFeeController to expose additional data sourced from the MetaSwap API in support of design updates to "edit gas fee" functionality in extension (#632), (#646, #660)

Changed

  • Breaking Add caller-specified error for ApprovalController.clear (#656)
    • The new caller-specified error is mandatory. Consumers must add this error when calling the clear method for method to function properly.

Fixed

  • Fix polling initialization for collectibles (#662)

22.0.0

Added

  • BREAKING: Change IPFS URL generation to use subdomains and cidV1s over cidV0s, in order to enhance origin based security in our use of IPFS assets (#655)
  • Consumers using an IPFS gateway(s) which does not support IPFS subdomain formats will need to set the new config value 'useIPFSSubdomains' on CollectiblesController to false in order to have continued IPFS resolution support.

Removed

  • BREAKING: remove chainid normalization (#651)
    • This is breaking for anyone who adapted consumption of CollectiblesController to make use of v21.0.0. The chainId in the collectibles state shape is no longer normalized to decimal.

Fixed

  • Fix collectibles collection images (#650)

21.0.1

Fixed

  • Fix issue where chainId key in AllCollectibles & AllCollectibleContracts is formatted differently in manual collectible add and detection add flows. (#648)

21.0.0

Added

  • BREAKING: Add openSeaEnabled preference (#645)
  • Consumers of the collectibleDetectionController and collectibleController who wish to continue use of OpenSea's API and AutoDetection will either need to configure openSeaEnabled to true after instantiating the controller now or expose a toggle for users to change the openSeaEnabled state in the preferences controller.

Changed

  • Change expected shape of OpenSea contract API to use collections (#628)
  • Modify requirements for adding OpenSea detected contract (#644)

Removed

  • BREAKING: Add detection params (userAddress, chainId) and remove duplicate source of truth (#636)
  • Both collectibles and collectibleContracts are removed from CollectiblesController state.
  • Consumers who use these pieces of state will need to migrate to use the AllCollectibles and AllCollectiblesContracts state instead.

20.1.0

Added

  • Add new method addCollectibleVerifyOwnership to CollectiblesController (#635)
  • Add setting in PreferencesController to enable/disable collectible autoDetection and check against it in CollectibleDetectionController (#638)

Changed

  • Use user preferred ipfs gateway, as set in PreferencesController, to resolve ipfs based assets in CollectiblesController (#637)

20.0.0

Removed

  • BREAKING: Remove polling start call in detection controllers' constructors (#629)
    • Consumers of either of the TokenDetection and CollectibleDetection controllers who wish to immediately start polling upon instantiation will need to call the start method on the controller immediately after instantiation.
  • Remove ApprovalController.has signature overloads (#624)

19.0.0

Changed

  • BREAKING: Split AssetsDetectionController into CollectiblesDetectionController and TokenDetectionController (#619)
    • Consumers of the AssetsDetectionController will have to now import both TokenDetectionController and CollectibleDetectionController and split up the calling of any methods accordingly.
  • BREAKING: Set the CurrencyRateController property conversionDate to null if fetching the data fails. (#621)
    • Consumers of the CurrencyRateController will need to ensure their code anticipates that conversionDate will sometimes be set to null.

18.0.0

Added

  • BREAKING: ERC1155 support (#615)
    • CollectiblesController requires getOwnerOf, balanceOfERC1155Collectible and uriERC1155Collectible properties in the constructor which are methods from AssetsContractController.
  • Add support for custom networks by querying the blockchain as default and add support for IPFS metadata URIs (#616)

Changed

  • Bump @metamask/contract-metadata from 1.29.0 to 1.30.0 (#607)

17.0.0

Added

  • Add client id header to GasFeeController (#597)

Changed

  • Improve transaction state management for custom networks (#598)
  • Make TokenRatesController support fiat conversion for more networks (#585)

Removed

  • BREAKING: Simplify type of BaseControllerV2 state (#496)
    • Controllers based upon BaseControllerV2 might need to update their types.
    • Custom interfaces/classes will no longer be allowed in the controller state. Simple objects only.

16.0.0

Changed

  • Enable HTTP caching for the dynamic token list managed by the TokenListController (#594)

Removed

  • BREAKING: Remove syncTokens method from the TokenListController (#590)

Fixed

  • Fix bug that allowed getGasFeeEstimatesAndStartPolling to initiate multiple simultaneous fetch requests (#586)
  • Fix bug that cause an invalid tokenList to be in controller state when active network is not supported by our tokenList API (#588)

15.1.0

Changed

  • Improve transaction state management (#582)
    • TransactionController improvement to reconcile the data between local and remote sources (Etherscan) and avoid misleading display of gas and/or status information.
  • Bump immer from 8.0.1 to 9.0.6 (#581)

15.0.2

Fixed

  • Change AbortController to default import (#579)
    • Fix error thrown when polyfilled AbortController is instantiated as a named import.

15.0.1

Fixed

  • Add AbortController polyfill (#575)
    • 15.0.0 introduced the use of the global AbortController to this package. The global AbortController was first introduced in Node 15, so this unintentionally broke support for the minimum Node version this package should support, which is Node 12. By polyfilling the AbortController, we restore Node 12 support.

15.0.0

Changed

  • BREAKING: Update TokensController allTokens state structure to make network/chainID parent of account (#572)
    • The shape of allTokens state field on TokensController has been reorganized. Consumers of the TokensController will have to migrate existing token state to new shape.
  • BREAKING: ignoredTokens changed to allIgnoredTokens (#570)
    • a new state field on the TokensController - allIgnoredTokens - now manages ignoredTokens by network and accountAddress, ignoredTokens is now the array of token address strings (previously an array of full token objects) that have been hidden by the user for the currently active network and accountAddress pair. Consumers of the TokensController will have to migrate existing ignoredTokens array to allIgnoredTokens object.
  • BREAKING: Improve BaseControllerV2 messenger type (#556)
    • This is a breaking change, because anyone extending BaseControllerV2 will now be required to supply an additional generic parameter.
  • BREAKING: Remove redundant default export from util.ts (#574)
    • This is breaking for consumers who use the default import of the utils module, and will require using named imports instead.
  • BREAKING: Removing aggregator from TokenListToken (#564)
    • This is breaking because the the DynamicToken and TokenListToken types no longer contain an aggregators field. Consumers will have to remove aggregators for objects using this type.
  • BREAKING: Migrate ApprovalController to BaseControllerV2 (#555)
    • This is a breaking change because the BaseControllerV2 migration is breaking, and the 'resolve' method has been renamed to 'accept'.
  • Speed up token detection for most popular 1000 tokens (#568)
  • Cancel inflight request during chainId change and useStaticTokenList flag change (#571)
  • Update the token list API host (#563)
  • Bump @metamask/contract-metadata from 1.28.0 to 1.29.0 (#569)
  • Reduce frequency of token list updates (#561)
    • Previously it would update the token list upon any preference or network configuration change. Now it only restarts polling when the network switches or when the useStaticTokenList flag changes.

14.2.0

Added

  • Added the ability to limit the number of transactions stored (default is 40) (#550)
  • Added the ability to speedUp and stop based on provided gasValues from consumer (#535)
  • Consolidate token list controller data. (#527)
    • Adds 3 fields: address, aggregators, and occurrences to static tokens

14.1.0

Added

  • Controller messenger selector subscriptions (#551)

14.0.2 - 2021-07-28

Changed

  • Fix resetPolling functionality (#546)
    • This fix addresses a bug that was discovered in resetPolling in GasFeeController functionality being called too frequently.
  • Improve token list API error handling (#541)

14.0.1 - 2021-07-28 [DEPRECATED]

Changed

  • Ensure gas estimate fetching in gasFeeController correctly handles responses with invalid number of decimals (#544)
  • Bump @metamask/contract-metadata from 1.27.0 to 1.28.0 (#540)

14.0.0 - 2021-07-27 [DEPRECATED]

Added

  • BREAKING Add EIP1559 support including speedUpTransaction and stopTransaction (#521)
    • The breaking change here is that consumers of this repo now have to check if the transaction object includes a gas price and fetch and add it themselves (if need be).

Changed

  • Make equality comparisons for token and collectible addresses in TokensController and CollectiblesController case insensitive (#537)
  • Reset gas fee estimate polling onNetworkStateChange in the gasFeeController (#534)

Fixed

  • Update AssetDetectionController to handle new fetch limits for the OpenSea collectibles api (#536)

13.2.0

Added

  • Add options to GasFeeController fetchGasFeeEstimates (#526)

13.1.0

Added

  • Add ERC721 detection to TokensController (#524), (#530)

13.0.0 - 2021-07-12

Changed

  • BREAKING: Remove AssetsController and add CollectiblesController and TokensController in its place (#518)

12.1.0 - 2021-07-09

Added

  • Support for custom network and gas estimation (#505)
  • A fallback for the token list API service based on user preference (#517)

12.0.0 - 2021-07-07

Added

  • Add GasFeeController to provide gas fee estimates #494

Changed

  • BREAKING: Add chainId support to TokenRatesControllers #476
    • The breaking change here is that TokenRatesController constructor now requires a onNetworkStateChange listener
  • Add iconUrl to Token type in TokenListController #512

11.0.0 - 2021-07-02

Changed

  • We accidentally shipped a breaking change in v10.2.0. The changelog has been updated to explain the breaking change, and it has been republished as v11.0.0.

10.2.0 - 2021-06-30 [DEPRECATED]

Added

  • BREAKING: Add TokenListController to fetch the token list from token services API (#478)
    • The breaking change here is that AssetsDetectionController now requires getTokenListState as a constructor parameter.
  • Update @ethereumjs-tx to @ethereumjs/tx and add @ethereumjs/common to support EIP1559 compliant transactions (#489)

Changed

  • Bump @metamask/contract-metadata from 1.25.0 to 1.26.0 and 1.26.0 to 1.27.0 (#492,#501)

10.1.0 - 2021-06-07

Added

  • Export BaseControllerV2 Json type (#482)

Changed

  • Improve collectible detection by account (#487)
  • Upgrade ethereumjs util (#466)

Fixed

  • Skip token detection for tokens that are already tracked (#480)

10.0.0

Fixed

  • BREAKING: Fix stale conversionRate after switching network (#465)
    • The breaking change is the change in type of the conversionRate state of the CurrencyRateController - it's now nullable.

9.1.0 - 2021-05-20

Added

  • Add support for unicode domains to PhishingController (#471)

Changed

  • AssetsController collectibles metadata improvements (#454)

9.0.0

Added

  • Add getState action to BaseControllerV2 (#457)

Changed

  • BREAKING: Migrate CurrencyRateController to BaseControllerV2 (#372)
  • Add BaseControllerV2 support to ComposableController (#447)
  • Update eth-keyring-controller (#460)
  • Export BaseControllerV2 and ControllerMessenger (#462)
  • Improve restricted messenger types for controllers (#461)
  • Document all ControllerMessenger generic parameters (#456)
  • Bump @metamask/contract-metadata from 1.24.0 to 1.25.0 (#444)

8.0.0 - 2021-04-15

Added

  • Add restricted controller messenger (#378)

Changed

  • BREAKING: Update minimum Node.js version to v12 (#441)
  • BREAKING: Replace controller context (#387)
  • Bump @metamask/contract-metadata from 1.23.0 to 1.24.0 (#440)
  • Update lint rules (#442, #426)

Fixed

  • Don't remove collectibles during auto detection (#439)

7.0.0 - 2021-04-06

Added

  • Ability to indicate if a transaction was added from the users local device and account creation time (#436)

Changed

  • BREAKING: Organize assets by chainid (#435)
  • Support longer token symbols via wallet_watchAsset (#433)

6.2.1 - 2021-03-23

Fixed

  • Restore BN export (#428)

6.2.0 - 2021-03-23 [WITHDRAWN]

Added

  • Add the Notification Controller (to support "what's new" type announcements in-app) (#329)
  • Add support for specifying a custom nonce (#381)

Changed

  • Explicitly add ethereumjs-tx as a package.json dependency (#392)
  • Add types manifest field to package.json (#391)
  • Use "options bag" for parameters for BaseControllerV2 constructor (#388)
  • Ensure uuid dependency is type-checked (#403)
  • Update TypeScript to v4.2 (#369)
  • Asset metadata type conditionally requires error field, disallows for non-errors (#395)
  • Improve TransactionMeta type: status now an enum, error conditional on status, default error added for failed etherscan transaction (#406)
  • NetworkController no longer a required controller of TypedMessageManager (#416)
  • Update selectedAddress when identities are updated in PreferencesController.updateIdentities (#415)
  • Add contract address validation to AssetsContractController.getCollectibleTokenURI (#414)
  • Add descriptive error messages to empty toThrow call (#422)

Fixed

  • Fix signTransaction transaction parameter type (#400)
  • [BREAKING] Consistently use BN type for token balances (#398)

6.1.1 - 2021-03-12

Added

  • Add controller messaging system (#377)

Fixed

  • bugfix/dont modify current transactions (#386)
  • Fix format commands (#385)

6.1.0 - 2021-03-10

Added

  • Add Base Controller v2 (#358)
  • Add babel-runtime dependency required by ethjs-query (#341)
  • Add Dependabot config (#343)

Changed

  • Add chainId to every transaction (#349)
  • Add normalizeTokenTx for incoming transactions (#380)
  • Bump elliptic from 6.5.3 to 6.5.4 (#383)
  • Update prettier from v2.1.1 to v2.2.1 (#376)
  • Remove AlethioTransactionMeta (#374)
  • Improve JSON types (#373)
  • Add BaseControllerV2 state metadata (#371)
  • Update to TypeScript 4.1 (#370)
  • Constrain BaseController state to be valid JSON (#366)
  • Update ESLint config to v5 (#368)
  • Use unknown rather than any for BaseController state (#365)
  • BaseController send patches to state subscribers (#363)
  • TransactionController gas and approve transaction improvements (#350)
  • Extract CryptoCompare API to a separate module (#353)
  • Move tests alongside code under test (#354)
  • Bump @metamask/contract-metadata from 1.22.0 to 1.23.0 (#357)
  • Remove Alethio to get incoming token transactions, using etherscan instead (#351)
  • Prevent ApprovalController counting mismatch (#356)
  • Update sinon and @types/sinon to latest versions (#352)
  • Fix tsconfig.json indentation (#355)
  • Replace fetch-mock with nock (#340)
  • Update ethereumjs-wallet from v0.6.5 to v1.0.1 (#347)
  • Update @metamask/eslint-config from v3 to v4.1.0 (#344)
  • Update uuid from v3.3.3 to v8.3.2 (#346)
  • Update approval controller test import (#339)
  • Update typedoc (#342)
  • Remove unused test module (#338)
  • Replace await-semaphore with async-mutex (#334)
  • Update eth-json-rpc-filters in lockfile (#336)

Fixed

  • Fix AbstractMessageManager error (#367)
  • Enforce the usage of chainId instead of networkId in NetworkController (#324)

6.0.1 - 2021-02-05

Changed

  • Update typedoc from v0.15 to v20.20 (#333)
  • Update @metamask/contract-metadata from v1.19 to v1.22 (#332)
  • Bump node-notifier from 8.0.0 to 8.0.1 (#323)

Fixed

  • Add safelyExecuteWithTimeout for accountTracker.refresh (#331)
  • Add try/catch for assetsContract.getBalanceOf (#328)

6.0.0 - 2021-01-19

Changed

  • Remove default approval controller type (#321)

Fixed

  • Enforce the usage of chainId instead of networkId in NetworkController (#324)

5.1.0 - 2020-12-02

Changed

  • Updated automatically detected assets (#318)

Fixed

  • Robustified wallet_watchAssets params validation, and improved errors (#317)

5.0.0 - 2020-11-19

Added

  • ApprovalController (#309)
    • Add user-defined default type
    • Add Date.now() timestamps to request (approval.time)
    • Enable has lookups by type only

Changed

  • Breaking: ApprovalController: Require types for all requests (#309)
  • ApprovalController: Rename ApprovalInfo interface to Approval (#309)
  • PhishingController: Make no-cache fetch option explicit (#297)
  • Make package compatible with Node 12 (#287)

Fixed

  • ApprovalController: Fix faulty origin parameter type check (#309)
    • The type check was too loose, and would've permitted some invalid origins.

4.2.0 - 2020-11-13

Added

  • Expose ApprovalController count state (#306)
  • KeyringController onLock/onUnlock event handlers (#307)

Fixed

  • Properly initialize ApprovalController (#306)

4.1.0 - 2020-11-10

Added

  • ApprovalController approval count methods (#304)

4.0.2 - 2020-11-09

Changed

  • Unpin eth-sig-util dependency (#302)

4.0.1 - 2020-11-09

Fixed

  • Fix ApprovalController export (#300)

4.0.0 - 2020-11-09

Added

  • Add ApprovalController (#289)

Changed

  • Allow configuring CurrencyController to always fetch USD rate (#292)

Removed

  • BREAKING: Remove NetworkStatusController (#298)

3.2.0 - 2020-10-21

Added

  • Add addNewAccountWithoutUpdate method (#288)

3.1.0 - 2020-09-23

Changed

  • Update various dependencies
    • eth-rpc-errors@3.0.0 (#284)
    • web3-provider-engine@16.0.1 (#283)
    • isomorphic-fetch@3.0.0 (#282)
    • eth-json-rpc-infura@5.1.0 (#281)

3.0.1 - 2020-09-15

Changed

  • Remove If-None-Match header from phishing config requests (#277)

3.0.0 - 2020-09-11

Changed

  • Use Infura v3 API (#267)

2.0.5 - 2020-08-18

Changed

  • Add prepublishOnly build script (#260)

2.0.4 - 2020-08-18

Changed

  • Use jsDelivr instead of the GitHub API for content (#256)
  • Lower phishing config poll rate to 1 req/hr (#257)
  • Use renamed eth-rpc-error package (#252)

2.0.3 - 2020-07-27

Added

  • TransactionsController: Bugfix cancel / speedup transactions (#248)

2.0.2 - 2020-07-14

Added

  • TransactionsController: Fetch incoming token transactions (#247)

2.0.1 - 2020-06-18

Changed

  • Update PhishingController endpoint to use GitHub API (#244)

2.0.0 - 2020-05-07

Changed

  • Rebrand as @metamask/controllers (#226)
  • Use yarn & drop npm-shrinkwrap.json (#193)

Removed

  • Remove shapeshift controller (#209)