Skip to content

Exclude Snaps from SelectedNetworkController domains state #4258

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

Merged
adonesky1 merged 2 commits into from
May 6, 2024
Merged

Exclude Snaps from SelectedNetworkController domains state #4258

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
58fc598
Exclude Snaps from SelectedNetworkController domains state
adonesky1 May 6, 2024
cb64ffe
Merge branch 'main' into ad/fix/exclude-snaps-from-selectedNetworkCon…
adonesky1 May 6, 2024
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
7 changes: 7 additions & 0 deletions packages/selected-network-controller/src/SelectedNetworkController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,13 @@ export class SelectedNetworkController extends BaseController<
);
}

// Snaps should be excluded from the domain state
// npm and local are currently the only valid prefixes for snap domains
// https://github.com/MetaMask/snaps/blob/2beee7803bfe9e540788a3558b546b9f55dc3cb4/packages/snaps-utils/src/types.ts#L120
if (domain.startsWith('npm:') || domain.startsWith('local:')) {
return;
}

if (!this.#domainHasPermissions(domain)) {
throw new Error(
'NetworkClientId for domain cannot be called with a domain that has not yet been granted permissions',
Expand Down
28 changes: 28 additions & 0 deletions packages/selected-network-controller/tests/SelectedNetworkController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,34 @@ describe('SelectedNetworkController', () => {
});

describe('when the useRequestQueue is true', () => {
describe('when the requesting domain is a snap (starts with "npm:" or "local:"', () => {
it('skips setting the networkClientId for the passed in domain', () => {
const { controller, mockHasPermissions } = setup({
state: { domains: {} },
useRequestQueuePreference: true,
});
mockHasPermissions.mockReturnValue(true);
const snapDomainOne = 'npm:@metamask/bip32-example-snap';
const snapDomainTwo = 'local:@metamask/bip32-example-snap';
const nonSnapDomain = 'example.com';
const networkClientId = 'network1';
controller.setNetworkClientIdForDomain(
nonSnapDomain,
networkClientId,
);
controller.setNetworkClientIdForDomain(
snapDomainOne,
networkClientId,
);
controller.setNetworkClientIdForDomain(
snapDomainTwo,
networkClientId,
);
expect(controller.state.domains).toStrictEqual({
[nonSnapDomain]: networkClientId,
});
});
});
describe('when the requesting domain has existing permissions', () => {
it('sets the networkClientId for the passed in domain', () => {
const { controller, mockHasPermissions } = setup({
Expand Down