According to EIP-1193 (permalink), the provider is "connected" when it can "service RPC requests to at least one chain". Currently the inpage provider doesn't make much of an attempt to guarantee this. Instead, 'connectivity' effectively represents whether or not the stream between the provider and MetaMask is active.

Certainly if the provider can't communicate with MetaMask, it can't service RPC requests either. But there remain many cases when the stream is live and the provider is "connected" but servicing RPC requests is impossible (e.g. when MetaMask is in the process of connecting to a network).

Maskbook has needed to import a custom version of this inpage provider in order to conditionally fall back to an older version for older MetaMask users.

This issue is probably caused because we changed the name of our inter-process stream from provider to metamask-provider.

We should probably preserve the backwards-compat of this library if possible.

Can the port stream based provider work in a tab application loaded by the extension?

i.e. when a background script opens a chrome extension app in a tab - can the chrome extension app connect to MetaMask?

I am not talking about content scripts. I am talking about a chrome extension app opening in a new tab.

The reason I wanted to connect to the web browser version of metamask in the tab was so that it is associated with the extension url:

chrome-extension://oahhaapnfpkfnbgeopliehfgenifngde/tab.html#register

and not the url the content script happens to be on.

If it is not possible to connect to Meta Mask in a chrome extension tab app, then is there another way to connect the meta mask browser wallet to a domain url like:

chrome-extension://oahhaapnfpkfnbgeopliehfgenifngde/tab.html#register

I am super struggling finding the answers to this so if anyone can help me I will be super happy.

Thanks for your time.

This is a proposal to do refactoring of the @metamask/providers StreamProvider and make its private methods and properties use #hash approach if possible. That way it would not be exposing methods and properties within its prototype chain which can be a security concern.

It is discovered that harden function from Secure EcmaScript which is used in Snaps and LavaMoat, is freezing some parts of the stream which makes it impossible to work. Because of that, a special way of using Proxy was introduced. By having a real private methods and properties it might be easier to secure this type of issues in the future.

see usage: https://github.com/MetaMask/metamask-module-template

I'm using createExternalExtensionProvider() to create a Provider to interact with MetaMask from another browser extension. This works well, but a side-effect is that a lot of warnings are logged to the console:

ObjectMultiplex - orphaned data for stream "publicConfig"

I looked into this, and my understanding is as follows:

• The communication streams between the in page/extension provider and MetaMask itself multiplex multiple named streams over a single connection using ObjectMultiplex from @metamask/object-multiplex
• The warning occurs when an ObjectMultiplex stream receives a message for a named substream that has not been created, so such messages will be ignored.
• The MetaMask extension itself is sending messages to the Provider I create for the publicConfig named substream
  • I can see such messages being received from the Port opened to communicate with MetaMask from my extension
  • It's not that some legacy thing in my extension is using the publicConfig stream.
• MetaMask's own injected contentscript ignores messages for the publicConfig substream, so web pages using MetaMask's provider don't show these warnings: https://github.com/MetaMask/metamask-extension/blob/c40dbb1ec72b91827debb2fffba4097a838f21c7/app/scripts/contentscript.js#L254
• The StreamProvider in this repo that creates the ObjectMultiplex doesn't ignore publicConfig messages:

  providers/src/StreamProvider.ts

  Line 70 in 126a8c8

  const mux = new ObjectMultiplex();

Should StreamProvider ignore these messages itself, like MetaMask's contentscript does? I was tempted to open a PR to do this, but I don't have enough understanding of the legacy context around these messages to know if that makes sense.

It's not currently possible to customise the stream created by createExternalExtensionProvider() to filter these messages before they get to StreamProvider.

This package should be split into the following packages, or at least classes:

• A BaseProvider, implementing the EIP-1193 API and nothing else
• A MetaMaskInpageProvider, for window environments
  • This class should be the only one that contains our legacy provider features.
• An ExtensionProvider, for other extensions
  • The following should probably be merged into this repo: https://github.com/MetaMask/extension-provider

For future environments, e.g. Snaps, we'll add a class/package in the future.

I'm trying to use the metamask provider from a background script in a chrome extension, but background scripts have no document object so I'm being thrown a "document is not defined" error. This is due to this line:

This project has moved to @types/webextension-polyfill

This project should have a CircleCI config

A requirement for good third-party connections to MetaMask, like in the metamask-extension-provider.

Currently the inpage provider simply logs any stream disconnects, but this would allow programmatic responses to these events.

This project currently uses v1 of the org's shared ESLint config

The provider property publicConfigStore was renamed in #11 and released in v4.0.0 of the inpage provider. We hadn't realized at the time that dapps were using this property directly, and that this change would break dapps.

We should restore the old property name for now as an alias, and warn that the property will soon be removed. Ultimately we'll still need to remove it at some point, since we're planning on replacing the publicConfigStore altogether.

I am using this package to work around a Firefox issue where the eth provider cannot be injected: MetaMask/metamask-extension#3133

On Chromium with no metamask extension installed, this package still creates a full provider object, though some of the properties are undefined.

I am just wondering what is the correct way to check if the provider is good to use. I am planning for now to check the value of chainId, but I don't know if this is actually a bug.

Here is the console.log output for the provider:

Proxy {_events: {…}, _eventsCount: 1, _maxListeners: 100, isMetaMask: true, _state: {…}, …}
[[Handler]]: Object
deleteProperty: () => true
__proto__: Object
[[Target]]: MetamaskInpageProvider
autoRefreshOnNetworkChange: false
chainId: undefined
enable: ƒ ()
isMetaMask: true
networkVersion: undefined
request: ƒ ()
selectedAddress: null
send: ƒ ()
sendAsync: ƒ ()
_events: {connect: ƒ}
_eventsCount: 1
_handleAccountsChanged: ƒ ()
_handleDisconnect: ƒ ()
_maxListeners: 100
_metamask: Proxy {isUnlocked: ƒ, requestBatch: ƒ, isEnabled: ƒ, isApproved: ƒ}
_publicConfigStore: ObservableStore {_events: {…}, _eventsCount: 1, _maxListeners: undefined, _state: {…}}
_rpcEngine: RpcEngine {_events: {…}, _eventsCount: 0, _maxListeners: undefined, _middleware: Array(3)}
_rpcRequest: ƒ ()
_sendSync: ƒ ()
_state: {sentWarnings: {…}, isConnected: true, accounts: undefined, isUnlocked: undefined}
_warnOfDeprecation: ƒ ()
_web3Ref: undefined
__proto__: SafeEventEmitter
[[IsRevoked]]: false

The BaseProvider throws an error Uncaught TypeError: Class extends value undefined is not a constructor or null.
I'm using Vite.js, Any solution to this?

We should update @metamask/eslint-config and its relevant siblings packages to ^6.0.0. Lint scripts should be updated to follow the module template.

Since the connection IDs are hardcoded, Flask is not currently supported:

Hello, I installed the typings for Metamask provider from this @metamask/providers package. Since we allow multiple providers to be used, we wrap the provider into standardized Web3Provider from ethers package. However, I am unable to pass the MetaMaskInpageProvider to Web3Provider constructor like this:

import { ethers } from 'ethers'
import type { MetaMaskInpageProvider } from '@metamask/providers'
  
const setWalletProvider = async (newWalletProvider: MetaMaskInpageProvider): Promise<void> => {
    walletProvider.value = new ethers.providers.Web3Provider(newWalletProvider) // this throws
}

Error is following:

Argument of type 'MetaMaskInpageProvider' is not assignable to parameter of type 'ExternalProvider | JsonRpcFetchFunc'.   
Type 'MetaMaskInpageProvider' is not assignable to type 'ExternalProvider'.     
Types of property 'sendAsync' are incompatible.       
Type '(payload: JsonRpcRequest<unknown>, callback: (error: Error, result?: JsonRpcResponse<unknown>) => void) => void' is not assignable to type '(request: { method: string; params?: any[]; }, callback: (error: any, response: any) => void) => void'.         
Types of parameters 'payload' and 'request' are incompatible.           
Type '{ method: string; params?: any[]; }' is missing the following properties from type 'JsonRpcRequest<unknown>': jsonrpc, id

I can easily surpress the error by @ts-ignore, but do you think it would be possible to make the MetaMaskInpageProvider compatible with the ethers.providers.Web3Provider? Or should I rather post an issue to the ethers? Thanks!

currently they are in javascript and require stuff out of ../dist

this should be generated from typescript now

Reporting as requested.

I first noticed the issue after merging develop in MetaMask/metamask-extension#7987 (comment) so I suspect the issue is caused in this patch MetaMask/metamask-extension#7997 .

I reproduce the issue on develop by signing in to metamask, visiting https://ratifier.trusttoken.com and adding that site to "Connected Sites". It shows in the console for the page.

Hi,

I noticed that metamask extension injects provider via inpage.js only to the top frame.
How then the iframes have window.ethereum if it's only injected in top frame?
When I try to, I only have window.ethereum in the top frame.

I'm using manifest v3 and my inpage script runs the same way as metamask's
and it does

  const provider = initializeProvider({
    jsonRpcStreamName: RPC_STREAM_NAME,
    connectionStream: myStream as Duplex,
    logger: console,
    shouldShimWeb3: true
  });

Thanks.

Environment:
Brave browser with MetaMask v9.8.4 extension installed. Running code in console

The following fails with a confusing error: MetaMask - RPC Error: Cannot read property 'length' of undefined

window.ethereum
  .request({
    method: "eth_blockNumber",
  })

However, this succeeds:

window.ethereum
  .request({
    method: "eth_blockNumber",
    params: [],
  })

Some methods like ethereum.request({ method: "eth_requestAccounts" }) don't require params to be set, so I spent an embarrassing of time trying to find out why one call worked and the other didn't.

Context:

I was trying to figure out why a convenience library was failing and figured that going down a level down to the RPC level might help. I tried the most basic RPC request I could think of (getting block number) when I got this error.

Possible solutions:

1. One solution might be for the MetaMask to add params: [] when no params are specified.
2. Another solution might be to add some more error checking to the BaseProvider request method?

Hi,
I forked the Metamask wallet repo, and have been adding some features I believe will make the application even more powerful.
I'm trying to connect to my updated version of the wallet using live Dapps but they can't seem to distinguish between the two wallets, when installed on the same browser.
I believe its a provider issue, and i've been working to find a way to distinguish the wallets as separate wallets to Dapps to no avail.
This is the metamask/provider package which handles the connection by Dapps to Metamask in this file Baseprovider.ts.

I found the handleConnect function inside, but can't seem to make sense of how it handles the connection by Dapps, and how I can edit it to suit my needs.
I'm hoping someone that better understands the project can point me to what I need to change to achieve this.
I’ll really appreciate any help.
Thanks.

The json file should not endswith .mjs

refs to web3/web3.js#4780 (comment)

Now we can only sign 32 bytes hash in metamask.

But there's no limit in ETH RPC Api

Is there a reason why metamask give the limit?

Chunk files make creating patches difficult and for that reason we'd like to move to using ts-bridge where possible.

This project has moved to @types/webextension-polyfill

The data event warns upon use because it is deprecated, but the deprecation message itself is missing. Instead undefined is printed to the console as a warning.

We should set up ts-bridge to generate and expose unambiguous .d.cts and .d.mts type declarations only.

Using .d.ts causes issues in downstream projects that have their moduleResolution option set to Node16 or NodeNext.

e.g.

error TS2307: Cannot find module '@metamask/providers' or its corresponding type declarations.

https://github.com/MetaMask/core/actions/runs/9668650800/job/26673339021?pr=3645

This package now contains a base 1193 provider, a window/DOM provider, and an external extension provider.

We should rename this package to @metamask/providers to reflect this.

As identified in Web3 Issue 3573, when using both TruffleContract and web3 functions it is important that they have separate Provider objects.

In the browser, the injected web3 has a web3.currentProvider which is a MetamaskInpageProvider, but passing this same object to a TruffleContract's setProvider function seems likely to produce issues like that one identified in web3.

To address this, the MetamaskInpageProvider might benefit from a clone() function producing another copy of the object, so that there can be independent queues serving overlapping sequences of requests from calls to the web3 object directly + calls to TruffleContract objects.

Describe the bug
Sometimes chainChanged message emits on every page load. So if I have this line in my code: ethereum.on('chainChanged', (_chainId) => window.location.reload()); then user gets endless page refresh loop.

To Reproduce
I couldn't reproduce this, but one of our user shared his screen and I saw this endless page refresh loop. I added console.log('chainChanged'); to that event callback, and console showed this log every time before page refreshed.

Expected behavior
chainChanged event should be sent only on chain change, not on page load

Browser details

• OS: OS X
• Browser: last Chrome
• MetaMask Version: 8.0.8

I don't know if this is a provider issue or a controller issue, so I apologize for the duplication, but I filed the following bug report:

MetaMask/core#880

How can this be fixed?

`Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/BaseProvider.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/BaseProvider.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/MetaMaskInpageProvider.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/MetaMaskInpageProvider.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/extension-provider/createExternalExtensionProvider.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/extension-provider/createExternalExtensionProvider.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/index.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/index.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/initializeInpageProvider.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/initializeInpageProvider.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/messages.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/messages.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/shimWeb3.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/shimWeb3.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/siteMetadata.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/siteMetadata.ts'

Failed to parse source map from '/home/haseeb/work/migration/node_modules/@metamask/providers/src/utils.ts' file: Error: ENOENT: no such file or directory, open '/home/haseeb/work/migration/node_modules/@metamask/providers/src/utils.ts'`

also when i check the .js.map files in the dist folder i realized the source path is incorrect e.g all the source paths are directing to src folder but in reality there is no src folder and no .ts file
e.g {"version":3,"file":"ObjectMultiplex.js","sourceRoot":"","sources":["../src/ObjectMultiplex.ts"],

This project should have a LICENSE file

I use the inpage-provider with the "extension-port-stream" package at my extension's index page.
The application with the provider can't get subscription events (for example at newBlockHeaders, or receive transaction receipts after send).

this.web3.client.eth.subscribe('newBlockHeaders', (error, result) => {
      if (error) {
        console.error("Error happened at new block", error);
        return;
      }
    })
    .on("data", function(blockHeader){
      console.log("blockHeader", blockHeader);
    });

It shows some errors because of wallet_sendDomainMetadata, unexcepted account change
and also the eventemitter memory leak, but the provider also seems initialized correct way, also I can send transactions, etc.

Init process:

    const metamaskPort = chrome.runtime.connect("nkbihfbeogaeaoehlefnkodbefgpgknn");
    const pluginStream = new PortStream(metamaskPort);
    let provider = new MetamaskInpageProvider(pluginStream);
    console.log("provider", provider);
    this.web3.client = new Web3(provider);

version: 4.0.4 (npm)
web3: 1.2.6
browser: Chrome 80.0.3987.87

Hey All,

I have a question about whether or not it is possible to retrieve the RPC URL the user currently has for a particular chain ID?

I've seen a couple of similar questions but no concrete answers so my current knowledge leads to think there is no simple way to get this information from Metamask.

https://ethereum.stackexchange.com/questions/91111/recover-rpc-url-in-metamask?noredirect=1&lq=1
https://ethereum.stackexchange.com/questions/69782/get-rpc-url-ip-of-metamasks-current-provider?noredirect=1&lq=1

The reason I am looking for something like this is because when we ask a user to add a new chain configuration using wallet_addEthereumChain , if the RPC endpoint/node provider we initially supplied stops working then we would like to be able to check this against some other providers, inform users about this and request they find a new public RPC endpoint etc.

Thanks!

Richard

Currently in snaps-monorepo we wrap the Ethereum provider in a Proxy, to prevent access to internal fields. A better alternative would be to protect these fields in the first place using hash names, which are not accessible in any way.

This package has a direct dependency on webextension-polyfill-ts and one indirectly through extension-port-stream which is also a MetaMask project.

That package has been deprecated and moved to @types/webextension-polyfill. MetaMask's dependencies should be updated too.