@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
77 lines • 2.47 kB
JavaScript
import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
import { create, object, string, StructError } from "@metamask/superstruct";
import { SnapEndowments } from "../endowments/index.mjs";
const CloseWebSocketParametersStruct = object({
id: string(),
});
/**
* Closes a WebSocket connection that was previously opened with
* [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).
*
* @example
* ```json name="Manifest"
* {
* "initialPermissions": {
* "endowment:network-access": {}
* }
* }
* ```
* ```ts name="Usage"
* await snap.request({
* method: 'snap_closeWebSocket',
* params: { id: 'websocket-1' },
* });
* ```
*/
export const closeWebSocketHandler = {
implementation: closeWebSocketImplementation,
actionNames: ['PermissionController:hasPermission', 'WebSocketService:close'],
};
/**
* The `snap_closeWebSocket` 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 closeWebSocketImplementation(req, res, _next, end, _hooks, messenger) {
const { params, origin } = req;
if (!messenger.call('PermissionController:hasPermission', origin, SnapEndowments.NetworkAccess)) {
return end(providerErrors.unauthorized());
}
try {
const { id } = getValidatedParams(params);
messenger.call('WebSocketService:close', origin, id);
res.result = null;
}
catch (error) {
return end(error);
}
return end();
}
/**
* Validates the parameters for the snap_closeWebSocket method.
*
* @param params - Parameters to validate.
* @returns Validated parameters.
* @throws Throws RPC error if validation fails.
*/
function getValidatedParams(params) {
try {
return create(params, CloseWebSocketParametersStruct);
}
catch (error) {
if (error instanceof StructError) {
throw rpcErrors.invalidParams({
message: `Invalid params: ${error.message}.`,
});
}
/* istanbul ignore next */
throw rpcErrors.internal();
}
}
//# sourceMappingURL=closeWebSocket.mjs.map