@metamask/snaps-rpc-methods/dist/permitted/getClientStatus.d.mts

MetaMask Snaps JSON-RPC method implementations

import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
import type { Messenger } from "@metamask/messenger";
import type { GetClientStatusResult } from "@metamask/snaps-sdk";
import type { JsonRpcRequest, PendingJsonRpcResponse } from "@metamask/utils";
import type { KeyringControllerGetStateAction } from "../types.mjs";
import type { MethodHooksObject } from "../utils.mjs";
export type GetClientStatusMethodHooks = {
    /**
     * @returns Whether the client is active or not.
     */
    getIsActive: () => boolean;
    /**
     * @returns The version string for the client.
     */
    getVersion: () => string;
};
export type GetClientStatusMethodActions = KeyringControllerGetStateAction;
/**
 * Get the status of the client running the Snap.
 *
 * @example
 * ```ts
 * import type { OnCronjobHandler } from '@metamask/snaps-sdk'
 * import { MethodNotFoundError } from '@metamask/snaps-sdk'
 *
 * export const onCronjob: OnCronjobHandler = async ({ request }) => {
 *   switch (request.method) {
 *     case 'execute':
 *       // Find out if MetaMask is locked.
 *       const { locked } = await snap.request({
 *         method: 'snap_getClientStatus',
 *       })
 *
 *       if (!locked) {
 *         // Do something that requires MetaMask to be unlocked, such as
 *         // accessing the encrypted state.
 *       }
 *
 *     default:
 *       throw new MethodNotFoundError()
 *   }
 * }
 * ```
 */
export declare const getClientStatusHandler: {
    implementation: typeof getClientStatusImplementation;
    hookNames: MethodHooksObject<GetClientStatusMethodHooks>;
    actionNames: "KeyringController:getState"[];
};
/**
 * The `snap_getClientStatus` method implementation.
 * Returns useful information about the client running the snap.
 *
 * @param _request - The JSON-RPC request object. Not used by this function.
 * @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.getIsActive - A function that returns whether the client is opened or not.
 * @param hooks.getVersion - A function that returns the client version.
 * @param messenger - The messenger used to call controller actions.
 * @returns Nothing.
 */
declare function getClientStatusImplementation(_request: JsonRpcRequest, response: PendingJsonRpcResponse<GetClientStatusResult>, _next: unknown, end: JsonRpcEngineEndCallback, { getIsActive, getVersion }: GetClientStatusMethodHooks, messenger: Messenger<string, GetClientStatusMethodActions>): Promise<void>;
export {};
//# sourceMappingURL=getClientStatus.d.mts.map