@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
97 lines • 3.38 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.resolveInterfaceHandler = void 0;
const rpc_errors_1 = require("@metamask/rpc-errors");
const superstruct_1 = require("@metamask/superstruct");
const utils_1 = require("@metamask/utils");
const utils_2 = require("../utils.cjs");
/**
* Resolve an interactive interface. For use in
* [custom dialogs](https://docs.metamask.io/snaps/features/custom-ui/dialogs/#display-a-custom-dialog).
*
* @example
* ```ts
* const id = await snap.request({
* method: 'snap_createInterface',
* params: {
* // The parameters to create the interface with.
* },
* });
*
* // Later, when the user has interacted with the interface, and you want to
* // resolve it:
* await snap.request({
* method: 'snap_resolveInterface',
* params: {
* id: interfaceId,
* value: {
* // The value to resolve the interface with.
* },
* },
* });
* ```
*/
exports.resolveInterfaceHandler = {
implementation: getResolveInterfaceImplementation,
actionNames: [
'PermissionController:hasPermission',
'SnapInterfaceController:resolveInterface',
],
};
const ResolveInterfaceParametersStruct = (0, superstruct_1.object)({
id: (0, superstruct_1.string)(),
value: utils_1.JsonStruct,
});
/**
* The `snap_resolveInterface` 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.
*/
async function getResolveInterfaceImplementation(req, res, _next, end, _hooks, messenger) {
const { params, origin } = req;
const isPermitted = utils_2.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_2.UI_PERMISSIONS.join(', ')}.`,
}));
}
try {
const validatedParams = getValidatedParams(params);
const { id, value } = validatedParams;
await messenger.call('SnapInterfaceController:resolveInterface', origin, id, value);
res.result = null;
}
catch (error) {
return end(error);
}
return end();
}
/**
* Validate the resolveInterface 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 resolveInterface method parameter object.
*/
function getValidatedParams(params) {
try {
return (0, superstruct_1.create)(params, ResolveInterfaceParametersStruct);
}
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=resolveInterface.cjs.map