@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
90 lines • 3.22 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.sendWebSocketMessageHandler = void 0;
const rpc_errors_1 = require("@metamask/rpc-errors");
const snaps_sdk_1 = require("@metamask/snaps-sdk");
const superstruct_1 = require("@metamask/superstruct");
const endowments_1 = require("../endowments/index.cjs");
const SendWebSocketMessageParametersStruct = (0, superstruct_1.object)({
id: (0, superstruct_1.string)(),
message: (0, snaps_sdk_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.array)((0, superstruct_1.number)())]),
});
/**
* Send a message to an open WebSocket connection. The message will be sent to
* the WebSocket connection with the specified ID, which must have been
* previously opened by the Snap using the [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket/)
* method.
*
* @example
* ```json name="Manifest"
* {
* "initialPermissions": {
* "endowment:network-access": {}
* }
* }
* ```
* ```ts name="Usage"
* await wallet.request({
* method: 'snap_sendWebSocketMessage',
* params: {
* id: 'websocket-connection-id',
* message: 'Hello, WebSocket!', // or message: [1, 2, 3] for binary data
* },
* });
* ```
*/
exports.sendWebSocketMessageHandler = {
implementation: sendWebSocketMessageImplementation,
actionNames: [
'PermissionController:hasPermission',
'WebSocketService:sendMessage',
],
};
/**
* The `snap_sendWebSocketMessage` 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 sendWebSocketMessageImplementation(req, res, _next, end, _hooks, messenger) {
const { params, origin } = req;
if (!messenger.call('PermissionController:hasPermission', origin, endowments_1.SnapEndowments.NetworkAccess)) {
return end(rpc_errors_1.providerErrors.unauthorized());
}
try {
const { id, message } = getValidatedParams(params);
await messenger.call('WebSocketService:sendMessage', origin, id, message);
res.result = null;
}
catch (error) {
return end(error);
}
return end();
}
/**
* Validates the parameters for the snap_sendWebSocketMessage method.
*
* @param params - Parameters to validate.
* @returns Validated parameters.
* @throws Throws RPC error if validation fails.
*/
function getValidatedParams(params) {
try {
return (0, superstruct_1.create)(params, SendWebSocketMessageParametersStruct);
}
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=sendWebSocketMessage.cjs.map