Skip to content

Ad/fix selected network middleware tweaked#3935

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 3 commits into from
Feb 20, 2024
Merged

Ad/fix selected network middleware tweaked #3935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56762d7
trying to cleanup and make more logical
adonesky1 Feb 19, 2024
31929d3
i guess proxies dont need to stay synced when feature flag is off
adonesky1 Feb 19, 2024
7838c92
add errors + fix tests
adonesky1 Feb 20, 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
102 changes: 24 additions & 78 deletions packages/selected-network-controller/src/SelectedNetworkController.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,6 @@ export const SelectedNetworkControllerActionTypes = {
getState: `${controllerName}:getState` as const,
getNetworkClientIdForDomain:
`${controllerName}:getNetworkClientIdForDomain` as const,
getNetworkClientIdForMetamask:
`${controllerName}:getNetworkClientIdForMetamask` as const,
setNetworkClientIdForDomain:
`${controllerName}:setNetworkClientIdForDomain` as const,
};
Expand DownExpand Up@@ -66,11 +64,6 @@ export type SelectedNetworkControllerGetNetworkClientIdForDomainAction = {
handler: SelectedNetworkController['getNetworkClientIdForDomain'];
};

export type SelectedNetworkControllerGetNetworkClientIdForMetamaskAction = {
type: typeof SelectedNetworkControllerActionTypes.getNetworkClientIdForMetamask;
handler: SelectedNetworkController['getNetworkClientIdForMetamask'];
};

export type SelectedNetworkControllerSetNetworkClientIdForDomainAction = {
type: typeof SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain;
handler: SelectedNetworkController['setNetworkClientIdForDomain'];
Expand All@@ -84,7 +77,6 @@ type PermissionControllerHasPermissions = {
export type SelectedNetworkControllerActions =
| SelectedNetworkControllerGetSelectedNetworkStateAction
| SelectedNetworkControllerGetNetworkClientIdForDomainAction
| SelectedNetworkControllerGetNetworkClientIdForMetamaskAction
| SelectedNetworkControllerSetNetworkClientIdForDomainAction;

export type AllowedActions =
Expand DownExpand Up@@ -143,44 +135,19 @@ export class SelectedNetworkController extends BaseController<
state,
});
this.#registerMessageHandlers();

// if the network for metamask is not set, set it to the currently selected network upon initialization
if (this.state.domains[METAMASK_DOMAIN] === undefined) {
const { selectedNetworkClientId } = this.messagingSystem.call(
'NetworkController:getState',
);
this.setNetworkClientIdForMetamask(selectedNetworkClientId);
}

this.messagingSystem.subscribe(
'NetworkController:stateChange',
({ selectedNetworkClientId }) => {
if (this.getNetworkClientIdForMetamask() !== selectedNetworkClientId) {
this.setNetworkClientIdForMetamask(selectedNetworkClientId);
}
},
);
}

#registerMessageHandlers(): void {
this.messagingSystem.registerActionHandler(
SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain,
this.getNetworkClientIdForDomain.bind(this),
);
this.messagingSystem.registerActionHandler(
SelectedNetworkControllerActionTypes.getNetworkClientIdForMetamask,
this.getNetworkClientIdForMetamask.bind(this),
);
this.messagingSystem.registerActionHandler(
SelectedNetworkControllerActionTypes.setNetworkClientIdForDomain,
this.setNetworkClientIdForDomain.bind(this),
);
}

setNetworkClientIdForMetamask(networkClientId: NetworkClientId) {
this.setNetworkClientIdForDomain(METAMASK_DOMAIN, networkClientId);
}

#setNetworkClientIdForDomain(
domain: Domain,
networkClientId: NetworkClientId,
Expand DownExpand Up@@ -218,50 +185,28 @@ export class SelectedNetworkController extends BaseController<
domain: Domain,
networkClientId: NetworkClientId,
) {
if (domain !== METAMASK_DOMAIN && !this.state.perDomainNetwork) {
return;
}

if (domain !== METAMASK_DOMAIN && !this.#domainHasPermissions(domain)) {
return;
if (domain === METAMASK_DOMAIN) {
throw new Error(
'NetworkClientId for domain "metamask" cannot be set on the SelectedNetworkController',
);
}

// If setting for Metamask and perDomainNetwork is disabled, update all domains to the Metamask networkClientId in order to keep the proxies in sync
if (domain === METAMASK_DOMAIN && !this.state.perDomainNetwork) {
Object.entries(this.state.domains).forEach(
([entryDomain, networkClientIdForDomain]) => {
if (
networkClientIdForDomain !== networkClientId &&
entryDomain !== domain
) {
this.#setNetworkClientIdForDomain(entryDomain, networkClientId);
}
},
if (!this.#domainHasPermissions(domain)) {
throw new Error(
'NetworkClientId for domain cannot be called with a domain that has not yet been granted permissions',
);
}

this.#setNetworkClientIdForDomain(domain, networkClientId);
}

getNetworkClientIdForDomain(domain: Domain): NetworkClientId | undefined {
if (domain === METAMASK_DOMAIN) {
return this.getNetworkClientIdForMetamask();
}
getNetworkClientIdForDomain(domain: Domain): NetworkClientId {
const { selectedNetworkClientId: metamaskSelectedNetworkClientId } =
this.messagingSystem.call('NetworkController:getState');
if (!this.state.perDomainNetwork) {
return undefined;
return metamaskSelectedNetworkClientId;
}
return this.state.domains[domain];
}

getNetworkClientIdForMetamask(): NetworkClientId {
return this.state.domains[METAMASK_DOMAIN];
}

#getNetworkClientIdForDomainOrMetamask(domain: Domain): NetworkClientId {
return (
this.getNetworkClientIdForDomain(domain) ??
this.getNetworkClientIdForMetamask()
);
return this.state.domains[domain] ?? metamaskSelectedNetworkClientId;
}

/**
Expand All@@ -271,11 +216,22 @@ export class SelectedNetworkController extends BaseController<
* @returns The proxy and block tracker proxies.
*/
getProviderAndBlockTracker(domain: Domain): NetworkProxy {
if (!this.state.perDomainNetwork) {
throw new Error(
'Provider and BlockTracker should be fetched from NetworkController when perDomainNetwork is false',
);
}
const networkClientId = this.state.domains[domain];
if (!networkClientId) {
throw new Error(
'NetworkClientId has not been set for the requested domain',
);
}
let networkProxy = this.#proxies.get(domain);
if (networkProxy === undefined) {
const networkClient = this.messagingSystem.call(
'NetworkController:getNetworkClientById',
this.#getNetworkClientIdForDomainOrMetamask(domain),
networkClientId,
);
networkProxy = {
provider: createEventEmitterProxy(networkClient.provider),
Expand All@@ -294,15 +250,5 @@ export class SelectedNetworkController extends BaseController<
state.perDomainNetwork = enabled;
return state;
});
// when perDomainNetwork is toggled on or off we need to update the proxies for all domains
// when toggled on all domains should have their own proxies
// when toggled off all domains should use the same proxies as the metamask domain
Object.keys(this.state.domains).forEach((domain) => {
this.setNetworkClientIdForDomain(
domain,
// when perDomainNetwork is false, getNetworkClientIdForDomainOrMetamask always returns the networkClientId for the domain 'metamask'
this.#getNetworkClientIdForDomainOrMetamask(domain),
);
});
}
}
8 changes: 1 addition & 7 deletions packages/selected-network-controller/src/SelectedNetworkMiddleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,19 +18,13 @@ export const createSelectedNetworkMiddleware = (
SelectedNetworkControllerActionTypes.getNetworkClientIdForDomain,
origin,
);
const getNetworkClientIdForMetamask = () =>
messenger.call(
SelectedNetworkControllerActionTypes.getNetworkClientIdForMetamask,
);

return (req: SelectedNetworkMiddlewareJsonRpcRequest, _, next) => {
if (!req.origin) {
throw new Error("Request object is lacking an 'origin'");
}

req.networkClientId =
getNetworkClientIdForDomain(req.origin) ??
getNetworkClientIdForMetamask();
req.networkClientId = getNetworkClientIdForDomain(req.origin);
return next();
};
};
Loading