Skip to content

Use only 6963, remove code and tests that rely on window.ethereum #562

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.

Sign up for GitHub

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

Closed
Montoya wants to merge 2 commits into from
Closed

Use only 6963, remove code and tests that rely on window.ethereum #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7dba46
Use only 6963, remove code and tests that rely on window.ethereum
Montoya Jun 9, 2025
44991f2
Remove comments
Montoya Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 1 addition & 175 deletions src/utils/snaps.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, it, expect, beforeEach } from '@jest/globals';
import { describe, it, expect } from '@jest/globals';

import type { VerifiedSnap } from './snaps';
import {
Expand Down Expand Up @@ -89,93 +89,6 @@ describe('isMetaMaskProvider', () => {
});

describe('getMetaMaskProvider', () => {
beforeEach(() => {
Object.defineProperty(globalThis, 'window', {
writable: true,
value: undefined,
});
});

it('returns `null` if `window` is undefined', async () => {
expect(await getMetaMaskProvider()).toBeNull();
});

it('returns `null` if no provider is detected', async () => {
Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: undefined,
addEventListener: jest.fn(),
dispatchEvent: jest.fn(),
removeEventListener: jest.fn(),
},
});

expect(await getMetaMaskProvider()).toBeNull();
});

it('returns the provider if it is MetaMask', async () => {
Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
web3_clientVersion: 'MetaMask/11.0.0',
}),
},
});

expect(await getMetaMaskProvider()).not.toBeNull();
});

it('returns the provider if it is in the `window.ethereum.detected` array', async () => {
const provider = getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
web3_clientVersion: 'MetaMask/11.0.0',
});

Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: {
detected: [
getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
web3_clientVersion: 'Foo/11.0.0',
}),
provider,
],
},
},
});

expect(await getMetaMaskProvider()).toBe(provider);
});

it('returns the provider if it is in the `window.ethereum.providers` array', async () => {
const provider = getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
web3_clientVersion: 'MetaMask/11.0.0',
});

Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: {
providers: [
getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
web3_clientVersion: 'Foo/11.0.0',
}),
provider,
],
},
},
});

expect(await getMetaMaskProvider()).toBe(provider);
});

it('returns the provider if it is available via EIP6963', async () => {
Object.defineProperty(globalThis, 'window', {
writable: true,
Expand All @@ -197,93 +110,6 @@ describe('getMetaMaskProvider', () => {
});

describe('getSnapsProvider', () => {
beforeEach(() => {
Object.defineProperty(globalThis, 'window', {
writable: true,
value: undefined,
});
});

it('returns `null` if `window` is undefined', async () => {
expect(await getSnapsProvider()).toBeNull();
});

it('returns `null` if no provider is detected', async () => {
Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: undefined,
addEventListener: jest.fn(),
dispatchEvent: jest.fn(),
removeEventListener: jest.fn(),
},
});

expect(await getSnapsProvider()).toBeNull();
});

it('returns the provider if it supports Snaps', async () => {
Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
wallet_getAllSnaps: [],
}),
},
});

expect(await getSnapsProvider()).not.toBeNull();
});

it('returns the provider if it is in the `window.ethereum.detected` array', async () => {
const provider = getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
wallet_getAllSnaps: [],
});

Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: {
detected: [
getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
wallet_getSnaps: new Error('Unsupported method.'),
}),
provider,
],
},
},
});

expect(await getSnapsProvider()).toBe(provider);
});

it('returns the provider if it is in the `window.ethereum.providers` array', async () => {
const provider = getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
wallet_getSnaps: {},
});

Object.defineProperty(globalThis, 'window', {
writable: true,
value: {
ethereum: {
providers: [
getRequestMethodMock({
// eslint-disable-next-line @typescript-eslint/naming-convention
wallet_getSnaps: new Error('Unsupported method.'),
}),
provider,
],
},
},
});

expect(await getSnapsProvider()).toBe(provider);
});

it('returns the provider if it is available via EIP6963', async () => {
Object.defineProperty(globalThis, 'window', {
writable: true,
Expand Down
70 changes: 5 additions & 65 deletions src/utils/snaps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,10 @@ export type Fields<Query, Name extends keyof Query> = {
/**
* Check if the current provider supports snaps by calling `wallet_getSnaps`.
*
* @param provider - The provider to use to check for snaps support. Defaults to
* `window.ethereum`.
* @param provider - The provider to use to check for snaps support.
* @returns True if the provider supports snaps, false otherwise.
*/
export async function hasSnapsSupport(
provider: MetaMaskInpageProvider = window.ethereum,
) {
export async function hasSnapsSupport(provider: MetaMaskInpageProvider) {
try {
await provider.request({
method: 'wallet_getSnaps',
Expand All @@ -42,13 +39,10 @@ export async function hasSnapsSupport(
/**
* Check if the current provider is MetaMask by calling `web3_clientVersion`.
*
* @param provider - The provider to use to check for MetaMask. Defaults to
* `window.ethereum`.
* @param provider - The provider to use to check for MetaMask.
* @returns True if the provider is MetaMask, false otherwise.
*/
export async function isMetaMaskProvider(
provider: MetaMaskInpageProvider = window.ethereum,
) {
export async function isMetaMaskProvider(provider: MetaMaskInpageProvider) {
try {
const result = await provider.request<string>({
method: 'web3_clientVersion',
Expand Down Expand Up @@ -114,37 +108,7 @@ export async function getMetaMaskEIP6963Provider() {
* and return the first one that is MetaMask.
*/
export async function getMetaMaskProvider() {
if (typeof window === 'undefined') {
return null;
}

if (await isMetaMaskProvider()) {
return window.ethereum;
}

if (window.ethereum?.detected) {
for (const provider of window.ethereum.detected) {
if (await isMetaMaskProvider(provider)) {
return provider;
}
}
}

if (window.ethereum?.providers) {
for (const provider of window.ethereum.providers) {
if (await isMetaMaskProvider(provider)) {
return provider;
}
}
}

const eip6963Provider = await getMetaMaskEIP6963Provider();

if (eip6963Provider) {
return eip6963Provider;
}

return null;
return getMetaMaskEIP6963Provider();
}

/**
Expand All @@ -154,30 +118,6 @@ export async function getMetaMaskProvider() {
* @returns The provider, or `null` if no provider supports snaps.
*/
export async function getSnapsProvider() {
if (typeof window === 'undefined') {
return null;
}

if (await hasSnapsSupport()) {
return window.ethereum;
}

if (window.ethereum?.detected) {
for (const provider of window.ethereum.detected) {
if (await hasSnapsSupport(provider)) {
return provider;
}
}
}

if (window.ethereum?.providers) {
for (const provider of window.ethereum.providers) {
if (await hasSnapsSupport(provider)) {
return provider;
}
}
}

const eip6963Provider = await getMetaMaskEIP6963Provider();

if (eip6963Provider && (await hasSnapsSupport(eip6963Provider))) {
Expand Down
Loading