@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
51 lines • 2.34 kB
text/typescript
import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
import type { Messenger } from "@metamask/messenger";
import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
import type { CloseWebSocketParams, CloseWebSocketResult } from "@metamask/snaps-sdk";
import type { InferMatching } from "@metamask/snaps-utils";
import type { PendingJsonRpcResponse } from "@metamask/utils";
import type { JsonRpcRequestWithOrigin, WebSocketServiceCloseAction } from "../types.mjs";
export type CloseWebSocketMethodActions = PermissionControllerHasPermissionAction | WebSocketServiceCloseAction;
declare const CloseWebSocketParametersStruct: import("@metamask/superstruct").Struct<{
id: string;
}, {
id: import("@metamask/superstruct").Struct<string, null>;
}>;
export type CloseWebSocketParameters = InferMatching<typeof CloseWebSocketParametersStruct, CloseWebSocketParams>;
/**
* 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 declare const closeWebSocketHandler: {
implementation: typeof closeWebSocketImplementation;
actionNames: ("WebSocketService:close" | "PermissionController:hasPermission")[];
};
/**
* 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.
*/
declare function closeWebSocketImplementation(req: JsonRpcRequestWithOrigin<CloseWebSocketParameters>, res: PendingJsonRpcResponse<CloseWebSocketResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, CloseWebSocketMethodActions>): void;
export {};
//# sourceMappingURL=closeWebSocket.d.mts.map