@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
88 lines • 3.12 kB
JavaScript
import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
import { ComponentOrElementStruct, InterfaceContextStruct } from "@metamask/snaps-sdk";
import { StructError, create, object, optional } from "@metamask/superstruct";
import { UI_PERMISSIONS } from "../utils.mjs";
/**
* Create the interactive interface for use in the
* [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
*
* @example
* ```tsx
* import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';
*
* const interfaceId = snap.request({
* method: 'snap_createInterface',
* params: {
* ui: (
* <Box>
* <Heading>Example Interface</Heading>
* <Text>This is an example interface created by "snap_createInterface".</Text>
* </Box>
* ),
* },
* });
* ```
*/
export const createInterfaceHandler = {
implementation: getCreateInterfaceImplementation,
actionNames: [
'PermissionController:hasPermission',
'SnapInterfaceController:createInterface',
],
};
const CreateInterfaceParametersStruct = object({
ui: ComponentOrElementStruct,
context: optional(InterfaceContextStruct),
});
/**
* The `snap_createInterface` 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 getCreateInterfaceImplementation(req, res, _next, end, _hooks, messenger) {
const { params, origin } = req;
const isPermitted = UI_PERMISSIONS.some((permission) => messenger.call('PermissionController:hasPermission', origin, permission));
if (!isPermitted) {
return end(providerErrors.unauthorized({
message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,
}));
}
try {
const validatedParams = getValidatedParams(params);
const { ui, context } = validatedParams;
res.result = messenger.call('SnapInterfaceController:createInterface', origin, ui, context);
}
catch (error) {
return end(error);
}
return end();
}
/**
* Validate the createInterface 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 createInterface method parameter object.
*/
function getValidatedParams(params) {
try {
return create(params, CreateInterfaceParametersStruct);
}
catch (error) {
if (error instanceof StructError) {
throw rpcErrors.invalidParams({
message: `Invalid params: ${error.message}.`,
});
}
/* istanbul ignore next */
throw rpcErrors.internal();
}
}
//# sourceMappingURL=createInterface.mjs.map