mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +01:00
05fae3fa1e
Adds a property, `hookNames`, to each RPC method handler export in `app/scripts/lib/rpc-method-middleware` and a function, `selectHooks`, to select from them. `createMethodMiddleware` receives a giant `opts` object that includes a bunch of different methods from `MetaMaskController` and its subcontrollers. Each method implementation only requires a subset of these methods to do its work. Because they need some kind of name, we call these methods "hooks". With this change, whenever an RPC method is called, `selectHooks` will be called to ensure that each method only receives the hooks that it needs in order to do its job. This implementation is based on [work in `snaps-skunkworks`](https://github.com/MetaMask/snaps-skunkworks/blob/a3e1248/packages/rpc-methods/src/utils.ts#L17-L34) that will be merged in the near future.
128 lines
3.3 KiB
JavaScript
128 lines
3.3 KiB
JavaScript
import { ethErrors } from 'eth-rpc-errors';
|
|
import { omit } from 'lodash';
|
|
import { MESSAGE_TYPE } from '../../../../../shared/constants/app';
|
|
import {
|
|
ETH_SYMBOL,
|
|
CHAIN_ID_TO_TYPE_MAP,
|
|
NETWORK_TO_NAME_MAP,
|
|
CHAIN_ID_TO_RPC_URL_MAP,
|
|
} from '../../../../../shared/constants/network';
|
|
import {
|
|
isPrefixedFormattedHexString,
|
|
isSafeChainId,
|
|
} from '../../../../../shared/modules/network.utils';
|
|
|
|
const switchEthereumChain = {
|
|
methodNames: [MESSAGE_TYPE.SWITCH_ETHEREUM_CHAIN],
|
|
implementation: switchEthereumChainHandler,
|
|
hookNames: {
|
|
getCurrentChainId: true,
|
|
findCustomRpcBy: true,
|
|
setProviderType: true,
|
|
updateRpcTarget: true,
|
|
requestUserApproval: true,
|
|
},
|
|
};
|
|
export default switchEthereumChain;
|
|
|
|
function findExistingNetwork(chainId, findCustomRpcBy) {
|
|
if (chainId in CHAIN_ID_TO_TYPE_MAP) {
|
|
return {
|
|
chainId,
|
|
ticker: ETH_SYMBOL,
|
|
nickname: NETWORK_TO_NAME_MAP[chainId],
|
|
rpcUrl: CHAIN_ID_TO_RPC_URL_MAP[chainId],
|
|
type: CHAIN_ID_TO_TYPE_MAP[chainId],
|
|
};
|
|
}
|
|
|
|
return findCustomRpcBy({ chainId });
|
|
}
|
|
|
|
async function switchEthereumChainHandler(
|
|
req,
|
|
res,
|
|
_next,
|
|
end,
|
|
{
|
|
getCurrentChainId,
|
|
findCustomRpcBy,
|
|
setProviderType,
|
|
updateRpcTarget,
|
|
requestUserApproval,
|
|
},
|
|
) {
|
|
if (!req.params?.[0] || typeof req.params[0] !== 'object') {
|
|
return end(
|
|
ethErrors.rpc.invalidParams({
|
|
message: `Expected single, object parameter. Received:\n${JSON.stringify(
|
|
req.params,
|
|
)}`,
|
|
}),
|
|
);
|
|
}
|
|
|
|
const { origin } = req;
|
|
|
|
const { chainId } = req.params[0];
|
|
|
|
const otherKeys = Object.keys(omit(req.params[0], ['chainId']));
|
|
|
|
if (otherKeys.length > 0) {
|
|
return end(
|
|
ethErrors.rpc.invalidParams({
|
|
message: `Received unexpected keys on object parameter. Unsupported keys:\n${otherKeys}`,
|
|
}),
|
|
);
|
|
}
|
|
|
|
const _chainId = typeof chainId === 'string' && chainId.toLowerCase();
|
|
|
|
if (!isPrefixedFormattedHexString(_chainId)) {
|
|
return end(
|
|
ethErrors.rpc.invalidParams({
|
|
message: `Expected 0x-prefixed, unpadded, non-zero hexadecimal string 'chainId'. Received:\n${chainId}`,
|
|
}),
|
|
);
|
|
}
|
|
|
|
if (!isSafeChainId(parseInt(_chainId, 16))) {
|
|
return end(
|
|
ethErrors.rpc.invalidParams({
|
|
message: `Invalid chain ID "${_chainId}": numerical value greater than max safe value. Received:\n${chainId}`,
|
|
}),
|
|
);
|
|
}
|
|
|
|
const requestData = findExistingNetwork(_chainId, findCustomRpcBy);
|
|
if (requestData) {
|
|
const currentChainId = getCurrentChainId();
|
|
if (currentChainId === _chainId) {
|
|
res.result = null;
|
|
return end();
|
|
}
|
|
try {
|
|
const approvedRequestData = await requestUserApproval({
|
|
origin,
|
|
type: MESSAGE_TYPE.SWITCH_ETHEREUM_CHAIN,
|
|
requestData,
|
|
});
|
|
if (chainId in CHAIN_ID_TO_TYPE_MAP) {
|
|
setProviderType(approvedRequestData.type);
|
|
} else {
|
|
await updateRpcTarget(approvedRequestData);
|
|
}
|
|
res.result = null;
|
|
} catch (error) {
|
|
return end(error);
|
|
}
|
|
return end();
|
|
}
|
|
return end(
|
|
ethErrors.provider.custom({
|
|
code: 4902, // To-be-standardized "unrecognized chain ID" error
|
|
message: `Unrecognized chain ID "${chainId}". Try adding the chain using ${MESSAGE_TYPE.ADD_ETHEREUM_CHAIN} first.`,
|
|
}),
|
|
);
|
|
}
|