CHANGELOG.md

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

22.1.1

Changed

• Update StreamProvider.initialize to call metamask_getProviderState with isInitializingStreamProvider: true (#422)
  • In implementing metamask_getProviderState, the extension makes a request for the network version; this parameter allows us to opt-out of that extra request on UI initialization.

22.1.0

Changed

• Adds a new shouldAnnounceCaip294 flag to initializeProvider options (defaulted to true), so instead of the providerInfo.rdns value determining whether or not to announce the caip-294 target, the caller of initializeProvider can directly control this (#419)

22.0.1

Fixed

• Catch error when ethereum provider is set before we attempt to set it (#416)

22.0.0

Changed

• BREAKING: initializeProvider announces the extensionId, when available, via a caip-348 target on in the new targets property of the CAIP-294 wallet announcement event instead of the previous extensionId property (#413)

21.0.0

Changed

• BREAKING: initializeProvider() no longer accepts the jsonRpcStreamName option param. (#410)
  • This helper no longers instantiates a jsonRpcStreamName named substream from the connectionStream Duplex stream option param.
  • Callers of initializeProvider() should now instantiate their own metamask-provider named substream and pass it in as the value for connectionStream.

20.0.0

Changed

• BREAKING: An isConnected boolean property is now expected in the result of metamask_getProviderState and metamask_chainChanged events (#404)
• BREAKING: A networkVersion value of loading received by the chainChanged event handler is now interpreted to be null. In this case, the networkChanged event emits a null value as well. (#404)
• BREAKING: The disconnect event is now tied to the new isConnected property instead of the networkVersion property. (#404)
• A change in the isUnlocked boolean property of the metamask_getProviderState and metamask_accountsChanged events (from what is in state) no longer causes the accountsChanged event to be emitted (#405)
• MetaMaskInpageProvider.isUnlocked() will always return true until the inpage to contentscript stream ends and the provider enters a permanently disconnected state (#405)

19.0.0

Changed

• BREAKING: StreamProvider no longer accepts a jsonRpcStreamName parameter (#400)
  • Previously, this parameter was used internally to create an ObjectMultiplex stream and substream for JSON-RPC communication
  • Now, the consumer is responsible for creating and managing the stream multiplexing if needed
  • The provider will use the provided stream connection directly without any multiplexing
• BREAKING: MetaMaskInpageProvider no longer accepts a jsonRpcStreamName parameter (#400)
  • This change is inherited from StreamProvider, as MetaMaskInpageProvider extends StreamProvider
  • Stream multiplexing should be handled before provider instantiation
• initializeInpageProvider now handles stream multiplexing internally (#400)
  • Creates an ObjectMultiplex instance and substream using the provided jsonRpcStreamName
  • This maintains backwards compatibility for consumers using initializeInpageProvider
• createExternalExtensionProvider now handles stream multiplexing internally (#400)
  • Creates an ObjectMultiplex instance and substream for JSON-RPC communication
  • This maintains backwards compatibility for consumers using createExternalExtensionProvider

18.3.1

Changed

• Bump @metamask/json-rpc-engine from ^10.0.1 to ^10.0.2 (#397)
• Bump @metamask/json-rpc-middleware-stream from ^8.0.5 to ^8.0.6 (#397)
• Bump @metamask/rpc-errors from ^7.0.1 to ^7.0.2 (#397)
• Bump @metamask/utils from ^10.0.0 to ^11.0.1 (#397)

18.3.0

Added

• Implement Wallet Discovery via CAIP-294 for Wallet Multichain API (#395)

18.2.0

Added

• Add new export for initializeInpageProvider with legacy build system support (#391)
  • Previously this module could be imported from /dist/initializeInpageProvider, but this only worked with build systems that support the exports field (e.g. browserify).
  • This new initializeInpageProvider export has a JavaScript redirect for older build systems, so it should work correctly in all cases.

18.1.2

Fixed

• Allow optional jsonRpcStreamName for initializeInpageProvider (#390)
  • This parameter was accidentally made required in v18.1.0

18.1.1

Changed

• Bump MetaMask dependencies (#385, #384, #383)

18.1.0

Added

• Add intializeInpageProvider as package export (#380)

Fixed

• Remove spurious typescript reference (#381)

18.0.0

Changed

• BREAKING: Bump @metamask/json-rpc-engine from ^9.0.1 to ^10.0.0 (#378)
• BREAKING: Bump @metamask/rpc-errors from ^6.4.0 to ^7.0.0 (#373)
• Bump @metamask/object-multiplex from ^2.0.0 to ^2.1.0 (#375)
• Bump @metamask/utils from ^9.2.1 to ^9.3.0 (#370)

17.2.1

Fixed

• Add support for edge-chromium to createExternalExtensionProvider (#318, #368)
• Fix ESM-related build issues (#362, #363)

17.2.0

Changed

• Bump @metamask/utils from 9.1.0 to 9.2.1 (#357)
• Bump micromatch from 4.0.5 to 4.0.8 in the npm_and_yarn group (#359)

Removed

• Remove deprecation console warnings when accessing window.ethereum.chainId, window.ethereum.networkVersion, and window.ethereum.selectedAddress (#360)

17.1.2

Added

• Add @metamask/providers/stream-provider export (#351)
  • This replaces the @metamask/providers/dist/StreamProvider export. It still exists for backwards compatibility, but will be removed in a future major release.

Changed

• Bump @metamask/utils from 9.0.0 to 9.1.0 (#348)

17.1.1

Changed

• Bump @metamask/json-rpc-engine to ^9.0.1 (#345)
• Bump @metamask/json-rpc-middleware-stream to ^8.0.1 (#345)
• Bump @metamask/rpc-errors to ^6.3.1 (#345)
• Bump @metamask/superstruct to ^3.1.0 (#338)
• Bump @metamask/utils to ^9.0.0 (#345)

Fixed

• Bump devDependency @ts-bridge/cli to ^0.2.0 (#343)
  • Fixes incorrect handling of json file imports, where an extension was appended to the file name after compilation (e.g. *.json.cjs or *.json.mjs).

17.1.0

Changed

• Bump @metamask/json-rpc-middleware-stream from ^7.0.1 to ^8.0.0 (#327)
• Bump @metamask/json-rpc-engine from ^8.0.2 to ^9.0.0 (#328)
• Bump extension-port-stream from ^3.0.0 to ^4.1.0 (#331)
• Bump @metamask/utils from ^8.4.0 to ^8.5.0 (#329)
• Bump @metamask/rpc-errors from ^6.2.1 to ^6.3.0 (#326)

Fixed

• Produce and export ESM-compatible TypeScript type declaration files in addition to CommonJS-compatible declaration files (#336)
  • This fixes the issue of this package being unusable by any TypeScript project that uses Node16 or NodeNext as its moduleResolution option.
  • Previously, this package shipped with only one variant of type declaration files, and these files were only CommonJS-compatible, and the exports field in package.json linked to these files. This is an anti-pattern and was rightfully flagged by the "Are the Types Wrong?" tool as "masquerading as CJS".
• Remove chunk files (#336).
  • Previously, the build tool we used to generate JavaScript files extracted common code to "chunk" files. While this was intended to make this package more tree-shakeable, it also made debugging more difficult for our development teams. These chunk files are no longer present.
• Use named extension-port-stream import to ensure compatibility with bundlers such as Vite (#331)

17.0.0

Changed

• Change provider RPC error log severity from error to warn (#323)

Fixed

• BREAKING: Change webextension-polyfill from dependency to peerDependency (#319)
  • Users are now expected to have the polyfill in their environment

16.1.0

Added

• Restore deprecated properties, networkChanged event, and offline send() net_version support (#312)
• Bump MetaMask dependencies (#310)
• Bump @metamask/safe-event-emitter from 3.0.0 to 3.1.1 (#309)
• Bump @metamask/utils from 8.3.0 to 8.4.0 (#311)
• Bump tar from 6.1.13 to 6.2.1 (#314)

16.0.0

Removed

• BREAKING: Remove deprecated properties, networkChanged event, and offline send() net_version support (#306)
  • window.ethereum.chainId has been removed. Use the 'eth_chainId' RPC method instead.
  • window.ethereum.networkVersion has been removed. Use the 'net_version' RPC method instead.
  • window.ethereum.selectedAddress has been removed. Use the 'eth_accounts' RPC method instead.
  • networkChanged event has been removed. The closest equivalent is the chainChanged event.
  • window.ethereum.send() no longer resolves net_version offline (from cache).

Changed

• Bump @metamask/json-rpc-engine from 7.3.2 to 7.3.3 (#305)

15.0.0

Added

• BREAKING: Add ESM build (#296)
  • It's no longer possible to import files from the dist folder directly, with the exception of ./dist/StreamProvider

Changed

• Bump several MetaMask dependencies (#304)
• Export RequestArguments and ConsoleLike types (#302)

14.0.2

Fixed

• Don't send null params to underlying provider (#292)

14.0.1

Fixed

• Don't send undefined params to underlying provider (#290)

14.0.0

Changed

• BREAKING: Update to streams3 API (#288)
  • Update extension-port-stream from ^2.1.1 to ^3.0.0
    • Force subdependency readable-stream to ^3.6.2 in resolutions
  • Update json-rpc-middleware-stream from ^4.2.3 to ^5.0.1
  • Update @metamask/object-multiplex from ^1.3.0 to ^2.0.0
  • Add direct dependency on readable-stream@^3.6.2
  • Replace internal usage of stream with readable-stream

13.1.0

Added

• Add support for EIP-6963 (#263)
  • initializeProvider() params object now accepts an optional providerInfo property with a value of EIP6963ProviderInfo object
  • Add eip6963AnnounceProvider() which supports a wallet by announcing a provider through the eip6963:announceProvider event and re-announcing the provider whenever an eip6963:requestProvider event is received
  • Add eip6963RequestProvider() which supports a dapp by dispatching an eip6963:requestProvider event and invoking a callback for each eip6963:announceProvider event received
  • Add EIP6963AnnounceProviderEvent type
  • Add EIP6963ProviderDetail type
  • Add EIP6963ProviderInfo type
  • Add EIP6963RequestProviderEvent type

13.0.0

Changed

• BREAKING: Update chainId, networkVersion, and selectedAddress to be read-only (#280)
• Log deprecation warning when accessing chainId, networkVersion, and selectedAddress (#280)
• Remove pump (#281)

12.0.0

Changed

• BREAKING: Replace eth-rpc-errors@^4.0.2 with @metamask/rpc-errors@6.0.0 (#277)
• BREAKING: Replace json-rpc-engine@^6.1.0 with @metamask/json-rpc-engine@7.1.1 (#277)
• Upgrade @metamask/utils from ^6.2.0 to ^8.1.0 (#277)

11.1.2

Changed

• Update extension-port-stream to ^2.1.1 (#273)

11.1.1

Changed

• Update fast-deep-equal (#258)

11.1.0

Added

• Add warning for callers of wallet_watchAsset with ERC721 and ERC1155 token types, that support is currently considered experimental (#264)

11.0.0

Changed

• BREAKING: Minimum Node.js version 16 (#254)
• Support Flask and Beta in the external extension provider (#252)
• Bump @metamask/safe-event-emitter from 2.0.0 to 3.0.0 (#255)

Fixed

• Fix console warning about deprecated webextension-polyfill-ts (#249)
• Prevent accountsChanged + eth_accounts callback loop (#248)
  • If you listen to the provider accountsChanged event, modify the returned accounts, then call eth_accounts, it was possible to enter an infinite loop. This was caused by the provider mistakenly thinking the accounts had changed because of the mutation performed in the event listener, triggering redundant accountsChanged events. This was fixed; there should be no more redundant accountsChanged events and no infinite loop.

10.2.1

Changed

• Update json-rpc-middleware-stream (#234)

10.2.0

Changed

• Update json-rpc-middleware-stream (#230)

10.1.0

Changed

• Update json-rpc-middleware-stream (#228)

10.0.0

Changed

• Retry sending messages to extension when METAMASK_EXTENSION_STREAM_CONNECT is received (#223)
• BREAKING: Update minimum Node.js version to v14 (#225)

9.1.0

Added

• Add deprecation warning for encryption methods (#218)

9.0.0

Changed

• BREAKING: Move stream functionality from BaseProvider to new StreamProvider (#209)
  • BaseProvider is now a transport-agnostic abstract class. StreamProvider accepts a stream and relies on MetaMask's internal JSON-RPC API for its behavior. See the StreamProvider class for more details.
  • MetaMaskInpageProvider should be completely unaffected except that its prototype chain now includes a class named AbstractStreamProvider.

8.1.1 - 2021-05-12

Changed

• Rename package to @metamask/providers (#168)

Fixed

• Restore networkChanged event in MetaMaskInpageProvider (#171)

8.1.0 - 2021-05-05

Added

• BaseProvider, implementing EIP-1193 without any legacy features (#144)
• createExternalExtensionProvider, from the extension-provider package (#152)

8.0.4 - 2021-02-04

Fixed

• Fix warning on second currentProvider access (#138)

8.0.3 - 2021-01-20

Fixed

• Restore 'data' provider event (#135)

8.0.2 - 2021-01-12

Changed

• Reduce window.web3 shim console noise (#133)

8.0.1 - 2020-12-08

Fixed

• Fix 8.0.0 types (#127)

8.0.0 - 2020-12-07

Added

• Add logger parameter to initializeProvider (#116)
• Add window.web3 shim, shimWeb3 export (#113, #115)
  • This is to maintain window.web3.currentProvider once MetaMask stops injecting window.web3 (very soon), and to log attempts to access any properties on the shim other than currentProvider.
  • initializeWeb3 now has a shouldShimWeb3 argument, which causes the shim to be set as window.web3 if true.

Changed

• BREAKING: Rename initProvider export to initializeProvider (#114)
• BREAKING: Replace ethereum.publicConfigStore with new set of JSON-RPC notifications (#109)

Removed

• BREAKING: Remove _metamask.isEnabled and _metamask.isApproved (#112)
• BREAKING: Remove the chainIdChanged event (#111)
• BREAKING: Remove ethereum.publicConfigStore (#109)
• BREAKING: Remove web3.js-related functionality (#106)
  • This functionality caused the page to reload if there was a web3.js instance at window.web3, and kept web3.eth.defaultAccount in sync with ethereum.selectedAddress.
  • This functionality is replicated in @metamask/legacy-web3.

Fixed

• Correctly implement connect and disconnect events (#120)
  • See EIP-1193 for the specification of these events.
  • disconnect emits with an RPC error. Like all such errors emitted by this module, they have a code property with a number value. There are currently two codes:
    • 1013 indicates that MetaMask is attempting to reestablish the connection
    • 1011 indicates that a page reload is required
• Send page metadata even if page is already loaded (#119)
• Convert MetaMaskInpageProvider logger to instance variable (#118)
  • Previously, it was erroneously a singleton across all class instances.
• Stop emitting state change events on initialization (#117)
  • Includes accountsChanged, chainChanged, and networkChanged.
  • This prevents sites that handle any of these events by reloading the page from entering into a reload loop.

7.0.0 - 2020-09-08

Changed

• BREAKING: Changed casing of Metamask in all exports to MetaMask
  • A brand is a brand ¯\_(ツ)_/¯

6.3.0 - 2020-09-04

Added

• Types

Changed

• ethereum.networkVersion and .chainId now default to null instead of undefined
• Improved JSDoc comments and tags

6.2.0 - 2020-08-04

Added

• Package consumers can now provide a logger object to the provider constructor, to override the default logger
  • The default logger is the console global
  • The following methods are required: debug, error, info, log, trace

6.1.1 - 2020-07-28

Changed

• Updated dependencies, which produces a smaller bundle size

6.1.0 - 2020-07-21

Changed

• Only emit data event for notifications present in ^4.0.0 (#73)
  • Some consumers make assumptions about the shape of the object emitted with the event that do not hold for all notifications in ^6.0.0.
• Select icon using rel~="icon" when retrieving site metadata (#76)
  • This is instead of defaulting to rel="shortcut icon".

Fixed

• Emit accountsChanged event after all related state has been updated (#72)
  • For example, ethereum.selectedAddress will now have been updated by the time the event is emitted.
• Enable retrieval of site icons not hosted on the same origin (#78)
  • For example, icons hosted on assets.foo.com that are used on foo.com will now be retrieved successfully.

6.0.1 - 2020-07-15

Fixed

• Warning message for the data event
  • This deprecated event was added back in 6.0.0, but the warning message was not defined.
• Restore publicConfigStore property as alias for _publicConfigStore
  • The _publicConfigStore was named publicConfigStore before 4.0.0. The original property turned out to be used by consumers. The store is scheduled to be removed completely, and accessing publicConfigStore emits a warning.

6.0.0 - 2020-07-04

Added

• The data event
  • This event was removed in 4.0.0, as it was thought to only be used internally. This assumption was incorrect, and the event is now restored.

Changed

• BREAKING: Restore the notification event value to its pre-4.0.0 state
  • Prior to 4.0.0 this event was emitted by code in the MetaMask extension. Its value was inadvertently changed when it was moved to this package.

5.2.1 - 2020-06-29

Changed

• Un-deprecate isConnected method.

5.2.0 - 2020-06-24

Changed

• Remove property protections
  • Unless we lock down the entire provide object, which we can't do, a determined consumer can break our provider. Thus, protected properties are pointless.
• Fix requests params type checks
• Update deprecation warning messages per most recent deprecation plans

5.1.0 - 2020-06-01

Changed

• Update request params type to unknown[] | object
  • This is not breaking in practice, since no RPC methods with other params values exist.

5.0.2 - 2020-05-22

Changed

• Fix ethereum.send return value for certain argument combination
  • Reverted to pre-4.0.0 state
• Stop protecting overwrites of the following properties, that existed prior to 4.0.0:
  • ethereum.isMetaMask
  • ethereum._metamask
• Protect the following new, private properties required for ethereum.request to work:
  • ethereum._rpcRequest
  • ethereum._rpcEngine

5.0.1 - 2020-05-11

Changed

• Rename package to @metamask/inpage-provider
• Prevent overwrite of certain properties on the Provider
  • ethereum.request
  • ethereum.isMetaMask
  • ethereum._metamask

5.0.0 - 2020-04-22

Added

• The most recent EIP 1193 API (#30)
  • The method request
  • The events disconnect and message
• A global initialization event, ethereum#initialized, for asynchronous injection (#31)
• Helper methods for initializing the provider (#31)

Changed

• BREAKING: Use named instead of default exports (#31)
• BREAKING: MetaMaskInpage constructor now takes a connectionStream and an options object (#31)
• BREAKING: _metamask.sendBatch -> _metamask.requestBatch (#30)
• BREAKING: Revert send to match provider in v7.7.8 of metamask-extension (#29)
• The connect event now emits with a ProviderConnectInfo object per EIP 1193 (#30)
• Deprecated the send method (#30)
• Deprecated the events close, networkChanged, and notification, and added deprecation warnings for them (#30)
• Un-deprecated sendAsync (#29)