@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
82 lines • 3.02 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.getInterfaceStateHandler = void 0;
const rpc_errors_1 = require("@metamask/rpc-errors");
const superstruct_1 = require("@metamask/superstruct");
const utils_1 = require("../utils.cjs");
/**
* Get the form state of an [interface](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/)
* created by [`snap_createInterface`](https://docs.metamask.io/snaps/reference/snaps-api/snap_createinterface).
*
* @example
* ```ts
* const state = await snap.request({
* method: 'snap_getInterfaceState',
* params: {
* id: interfaceId,
* },
* });
* ```
*/
exports.getInterfaceStateHandler = {
implementation: getGetInterfaceStateImplementation,
actionNames: [
'PermissionController:hasPermission',
'SnapInterfaceController:getInterfaceState',
],
};
const GetInterfaceStateParametersStruct = (0, superstruct_1.object)({
id: (0, superstruct_1.string)(),
});
/**
* The `snap_getInterfaceState` method implementation.
*
* @param req - The JSON-RPC request object.
* @param res - The JSON-RPC response object.
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
* function.
* @param end - The `json-rpc-engine` "end" callback.
* @param _hooks - The RPC method hooks. Not used by this function.
* @param messenger - The messenger used to call controller actions.
* @returns Nothing.
*/
function getGetInterfaceStateImplementation(req, res, _next, end, _hooks, messenger) {
const { params, origin } = req;
const isPermitted = utils_1.UI_PERMISSIONS.some((permission) => messenger.call('PermissionController:hasPermission', origin, permission));
if (!isPermitted) {
return end(rpc_errors_1.providerErrors.unauthorized({
message: `This method can only be used if the Snap has one of the following permissions: ${utils_1.UI_PERMISSIONS.join(', ')}.`,
}));
}
try {
const validatedParams = getValidatedParams(params);
const { id } = validatedParams;
res.result = messenger.call('SnapInterfaceController:getInterfaceState', origin, id);
}
catch (error) {
return end(error);
}
return end();
}
/**
* Validate the getInterfaceState method `params` and returns them cast to the correct
* type. Throws if validation fails.
*
* @param params - The unvalidated params object from the method request.
* @returns The validated getInterfaceState method parameter object.
*/
function getValidatedParams(params) {
try {
return (0, superstruct_1.create)(params, GetInterfaceStateParametersStruct);
}
catch (error) {
if (error instanceof superstruct_1.StructError) {
throw rpc_errors_1.rpcErrors.invalidParams({
message: `Invalid params: ${error.message}.`,
});
}
/* istanbul ignore next */
throw rpc_errors_1.rpcErrors.internal();
}
}
//# sourceMappingURL=getInterfaceState.cjs.map