@metamask/snaps-rpc-methods/dist/permitted/messengerCall.d.cts

MetaMask Snaps JSON-RPC method implementations

import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
import type { Messenger, NamespacedName } from "@metamask/messenger";
import type { PermissionControllerGetPermissionAction } from "@metamask/permission-controller";
import type { MessengerCallParams } from "@metamask/snaps-sdk";
import type { InferMatching } from "@metamask/snaps-utils";
import type { Json, PendingJsonRpcResponse } from "@metamask/utils";
import type { JsonRpcRequestWithOrigin, SnapControllerGetSnapAction } from "../types.cjs";
import type { MethodHooksObject } from "../utils.cjs";
type GenericMessengerAction = {
    type: NamespacedName;
    handler: (...args: Json[]) => Promise<Json>;
};
export type MessengerCallMethodHooks = {
    getMessenger: (args: {
        actions?: string[] | null;
        events?: string[] | null;
    }) => Messenger<string, GenericMessengerAction>;
};
export type MessengerCallMethodActions = SnapControllerGetSnapAction | PermissionControllerGetPermissionAction;
declare const MessengerCallParametersStruct: import("@metamask/superstruct").Struct<{
    params: Json[];
    action: `${string}:${string}`;
}, {
    action: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
    params: import("@metamask/superstruct").Struct<Json[], import("@metamask/superstruct").Struct<Json, unknown>>;
}>;
export type MessengerCallParameters = InferMatching<typeof MessengerCallParametersStruct, MessengerCallParams>;
/**
 * Handler for the `snap_messengerCall` method.
 *
 * @internal
 */
export declare const messengerCallHandler: {
    implementation: typeof getMessengerCallImplementation;
    hookNames: MethodHooksObject<MessengerCallMethodHooks>;
    actionNames: ("SnapController:getSnap" | "PermissionController:getPermission")[];
};
/**
 * The `snap_messengerCall` method implementation. This method is used to dispatch
 * an action via the messenger. It is only available to preinstalled Snaps.
 *
 * @param request - The JSON-RPC request object.
 * @param response - 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.
 * @param hooks.getMessenger - The hook function to create a custom messenger for the Snap.
 * @param messenger - The messenger used to call controller actions.
 * @returns Nothing.
 */
declare function getMessengerCallImplementation(request: JsonRpcRequestWithOrigin<MessengerCallParams>, response: PendingJsonRpcResponse, _next: unknown, end: JsonRpcEngineEndCallback, { getMessenger }: MessengerCallMethodHooks, messenger: Messenger<string, MessengerCallMethodActions>): Promise<void>;
export {};
//# sourceMappingURL=messengerCall.d.cts.map