mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-02 14:15:06 +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.
50 lines
1.5 KiB
JavaScript
50 lines
1.5 KiB
JavaScript
import { MESSAGE_TYPE } from '../../../../../shared/constants/app';
|
|
|
|
/**
|
|
* This RPC method gets background state relevant to the provider.
|
|
* The background sends RPC notifications on state changes, but the provider
|
|
* first requests state on initialization.
|
|
*/
|
|
|
|
const getProviderState = {
|
|
methodNames: [MESSAGE_TYPE.GET_PROVIDER_STATE],
|
|
implementation: getProviderStateHandler,
|
|
hookNames: {
|
|
getProviderState: true,
|
|
},
|
|
};
|
|
export default getProviderState;
|
|
|
|
/**
|
|
* @typedef {Object} ProviderStateHandlerResult
|
|
* @property {string} chainId - The current chain ID.
|
|
* @property {boolean} isUnlocked - Whether the extension is unlocked or not.
|
|
* @property {string} networkVersion - The current network ID.
|
|
*/
|
|
|
|
/**
|
|
* @typedef {Object} ProviderStateHandlerOptions
|
|
* @property {() => ProviderStateHandlerResult} getProviderState - A function that
|
|
* gets the current provider state.
|
|
*/
|
|
|
|
/**
|
|
* @param {import('json-rpc-engine').JsonRpcRequest<[]>} req - The JSON-RPC request object.
|
|
* @param {import('json-rpc-engine').JsonRpcResponse<ProviderStateHandlerResult>} res - The JSON-RPC response object.
|
|
* @param {Function} _next - The json-rpc-engine 'next' callback.
|
|
* @param {Function} end - The json-rpc-engine 'end' callback.
|
|
* @param {ProviderStateHandlerOptions} options
|
|
*/
|
|
async function getProviderStateHandler(
|
|
req,
|
|
res,
|
|
_next,
|
|
end,
|
|
{ getProviderState: _getProviderState },
|
|
) {
|
|
res.result = {
|
|
...(await _getProviderState(req.origin)),
|
|
};
|
|
return end();
|
|
}
|