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.

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

Unblock wallet_switchEthereumChain #2634

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Unblock wallet_switchEthereumChain #2634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2d6bce8
Unblock `wallet_switchEthereumChain`
Mrtenz Aug 13, 2024
0a82e70
Update Ethereum provider example
Mrtenz Aug 16, 2024
525ef12
Grant permitted chains permission on install/update
Mrtenz Aug 16, 2024
9473208
Add a test
Mrtenz Aug 20, 2024
26dbd80
Use PERMITTED_CHAINS_ENDOWMENT constant
Mrtenz Aug 21, 2024
fba304e
Add some more tests
Mrtenz Aug 21, 2024
1dcbeda
Add `wallet_switchEthereumChain` support to `snaps-jest`
Mrtenz Aug 21, 2024
736f8f1
Dedupe yarn.lock
Mrtenz Jan 15, 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
2 changes: 1 addition & 1 deletion packages/examples/packages/ethereum-provider/snap.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "8f7Fo6y40+L0x+KHkDCq2wjEMrkTL+L6e2NSNBZYVLA=",
"shasum": "hVuKuTyTaza8ezHZLGeC5Yq4E7LZPgO/spV7qwOEDlE=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
21 changes: 20 additions & 1 deletion packages/examples/packages/ethereum-provider/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,23 @@ import {
hexToNumber,
} from '@metamask/utils';

import type { PersonalSignParams, SignTypedDataParams } from './types';
import type {
BaseParams,
PersonalSignParams,
SignTypedDataParams,
} from './types';

/**
* Set the active Ethereum chain for the Snap.
*
* @param chainId - The chain ID to switch to.
*/
async function switchChain(chainId: Hex) {
await ethereum.request({
method: 'wallet_switchEthereumChain',
params: [{ chainId }],
});
}

/**
* Get the current gas price using the `ethereum` global. This is essentially
Expand Down Expand Up @@ -207,6 +223,9 @@ async function signTypedData(message: string, from: string) {
* @see https://docs.metamask.io/snaps/reference/rpc-api/#wallet_invokesnap
*/
export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
const { chainId = '0x1' } = (request.params as BaseParams) ?? {};
Copy link

@jiexi jiexi Jan 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

i don't know a lot about snaps, but I'm assuming that this type cast has to happen here and can't be moved into the function params type

await switchChain(chainId);
Copy link

Choose a reason for hiding this comment

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

probably not a problem, but i think always using mainnet makes it possible in the extension e2e tests that use this snap to try to hit the mainnet infura endpoint, but I think that's probably only the case if something triggers getGasPrice and i'm not certain there is an extension e2e test that does that. Just pointing this out in case I am wrong


switch (request.method) {
case 'getGasPrice':
return await getGasPrice();
Expand Down
8 changes: 7 additions & 1 deletion packages/examples/packages/ethereum-provider/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
export type PersonalSignParams = {
import type { Hex } from '@metamask/utils';

export type BaseParams = {
chainId?: Hex;
};

export type PersonalSignParams = BaseParams & {
message: string;
};

Expand Down
6 changes: 3 additions & 3 deletions packages/snaps-controllers/coverage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"branches": 92.96,
"branches": 92.97,
"functions": 96.56,
"lines": 98.05,
"statements": 97.77
"lines": 98.06,
"statements": 97.78
}
2 changes: 2 additions & 0 deletions packages/snaps-controllers/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,13 @@
"@metamask/json-rpc-engine": "^10.0.2",
"@metamask/json-rpc-middleware-stream": "^8.0.6",
"@metamask/key-tree": "^10.0.2",
"@metamask/network-controller": "^22.1.1",
"@metamask/object-multiplex": "^2.1.0",
"@metamask/permission-controller": "^11.0.5",
"@metamask/phishing-controller": "^12.3.1",
"@metamask/post-message-stream": "^9.0.0",
"@metamask/rpc-errors": "^7.0.2",
"@metamask/selected-network-controller": "^20.0.2",
"@metamask/snaps-registry": "^3.2.3",
"@metamask/snaps-rpc-methods": "workspace:^",
"@metamask/snaps-sdk": "workspace:^",
Expand Down
215 changes: 214 additions & 1 deletion packages/snaps-controllers/src/snaps/SnapController.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,10 @@
waitForStateChange,
} from '../test-utils';
import { delay } from '../utils';
import { LEGACY_ENCRYPTION_KEY_DERIVATION_OPTIONS } from './constants';
import {
LEGACY_ENCRYPTION_KEY_DERIVATION_OPTIONS,
PERMITTED_CHAINS_ENDOWMENT,
} from './constants';
import { SnapsRegistryStatus } from './registry';
import type { SnapControllerState } from './SnapController';
import {
Expand Down Expand Up @@ -1842,7 +1845,7 @@
});

// This isn't stable in CI unfortunately
it.skip('throws if the Snap is terminated while executing', async () => {

Check warning on line 1848 in packages/snaps-controllers/src/snaps/SnapController.test.tsx

View workflow job for this annotation

GitHub Actions / Build, lint, and test / Lint (@metamask/snaps-controllers) 

Disabled test
const { manifest, sourceCode, svgIcon } =
await getMockSnapFilesWithUpdatedChecksum({
sourceCode: `
Expand Down Expand Up @@ -4877,6 +4880,216 @@
snapController.destroy();
});

it('grants the `endowment:permitted-chains` permission to a Snap with `endowment:ethereum-provider`', async () => {
const rootMessenger = getControllerMessenger();
const messenger = getSnapControllerMessenger(rootMessenger);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
() => ({}),
);

rootMessenger.registerActionHandler(
'SelectedNetworkController:getNetworkClientIdForDomain',
() => 'mainnet',
);

rootMessenger.registerActionHandler(
'NetworkController:getNetworkClientById',
() => ({
// @ts-expect-error - Partial network client.
configuration: {
chainId: '0x1',
},
}),
);

const { manifest } = await getMockSnapFilesWithUpdatedChecksum({
manifest: getSnapManifest({
initialPermissions: {
'endowment:page-home': {},
'endowment:ethereum-provider': {},
},
}),
});

const snapController = getSnapController(
getSnapControllerOptions({
messenger,
detectSnapLocation: loopbackDetect({ manifest }),
}),
);

await snapController.installSnaps(MOCK_ORIGIN, {
[MOCK_SNAP_ID]: {},
});

const approvedPermissions = {
'endowment:page-home': {
caveats: null,
},
'endowment:ethereum-provider': {},
[PERMITTED_CHAINS_ENDOWMENT]: {
caveats: [
{
type: 'restrictNetworkSwitching',
value: ['0x1'],
},
],
},
Comment on lines +4932 to +4939
Copy link

@jiexi jiexi Jan 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

this should now be the CAIP-25 permission type, something like this:

'endowment:caip25': {
  caveats: [
    {
      type: 'authorizedScopes',
      value: {
        requiredScopes: {},
        optionalScopes: {
          'eip155:1': {
               accounts: ['...']
          }
        }
      }
    }
  ]
}

};

expect(messenger.call).toHaveBeenCalledWith(
'PermissionController:grantPermissions',
{
approvedPermissions,
subject: { origin: MOCK_SNAP_ID },
requestData: expect.any(Object),
},
);

snapController.destroy();
});

it('overrides the `endowment:permitted-chains` permission if the Snap specifies it in its manifest', async () => {
const rootMessenger = getControllerMessenger();
const messenger = getSnapControllerMessenger(rootMessenger);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
() => ({}),
);

rootMessenger.registerActionHandler(
'SelectedNetworkController:getNetworkClientIdForDomain',
() => 'mainnet',
);

rootMessenger.registerActionHandler(
'NetworkController:getNetworkClientById',
() => ({
// @ts-expect-error - Partial network client.
configuration: {
chainId: '0x1',
},
}),
);

const { manifest } = await getMockSnapFilesWithUpdatedChecksum({
manifest: getSnapManifest({
initialPermissions: {
'endowment:page-home': {},
'endowment:ethereum-provider': {},
[PERMITTED_CHAINS_ENDOWMENT]: {
caveats: [
{
type: 'restrictNetworkSwitching',
value: ['0x5'],
},
],
},
Comment on lines +4983 to +4990
Copy link

Choose a reason for hiding this comment

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

same

},
}),
});

const snapController = getSnapController(
getSnapControllerOptions({
messenger,
detectSnapLocation: loopbackDetect({ manifest }),
}),
);

await snapController.installSnaps(MOCK_ORIGIN, {
[MOCK_SNAP_ID]: {},
});

const approvedPermissions = {
'endowment:page-home': {
caveats: null,
},
'endowment:ethereum-provider': {},
[PERMITTED_CHAINS_ENDOWMENT]: {
caveats: [
{
type: 'restrictNetworkSwitching',
value: ['0x1'],
},
],
},
Comment on lines +5011 to +5018
Copy link

Choose a reason for hiding this comment

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

same re: which permission is now used

};

expect(messenger.call).toHaveBeenCalledWith(
'PermissionController:grantPermissions',
{
approvedPermissions,
subject: { origin: MOCK_SNAP_ID },
requestData: expect.any(Object),
},
);

snapController.destroy();
});

it('does not grant the `endowment:permitted-chains` permission if the Snap does not have the `endowment:ethereum-provider` permission', async () => {
const rootMessenger = getControllerMessenger();
const messenger = getSnapControllerMessenger(rootMessenger);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
() => ({}),
);

rootMessenger.registerActionHandler(
'SelectedNetworkController:getNetworkClientIdForDomain',
() => {
throw new Error('This should not be called.');
},
);

rootMessenger.registerActionHandler(
'NetworkController:getNetworkClientById',
() => {
throw new Error('This should not be called.');
},
);

const { manifest } = await getMockSnapFilesWithUpdatedChecksum({
manifest: getSnapManifest({
initialPermissions: {
'endowment:page-home': {},
},
}),
});

const snapController = getSnapController(
getSnapControllerOptions({
messenger,
detectSnapLocation: loopbackDetect({ manifest }),
}),
);

await snapController.installSnaps(MOCK_ORIGIN, {
[MOCK_SNAP_ID]: {},
});

const approvedPermissions = {
'endowment:page-home': {
caveats: null,
},
};

expect(messenger.call).toHaveBeenCalledWith(
'PermissionController:grantPermissions',
{
approvedPermissions,
subject: { origin: MOCK_SNAP_ID },
requestData: expect.any(Object),
},
);

snapController.destroy();
});

it('supports preinstalled snaps', async () => {
const rootMessenger = getControllerMessenger();
jest.spyOn(rootMessenger, 'call');
Expand Down
Loading
Loading