@metamask/keyring-snap-sdk/dist/v2/rpc-handler.mjs

MetaMask Keyring Snap SDK

import { KeyringRpcMethod, GetAccountsRequestStruct, GetAccountRequestStruct, CreateAccountsRequestStruct, DeleteAccountRequestStruct, ExportAccountRequestStruct, SubmitRequestRequestStruct } from "@metamask/keyring-api/v2";
import { JsonRpcRequestStruct } from "@metamask/keyring-utils";
import { assert } from "@metamask/superstruct";
import { isSnapError } from "../errors.mjs";
import { MethodNotSupportedError } from "../rpc-handler.mjs";
// ESLint does not like our custom error classes in this repo for some reason, they do extend Error, so unsure why.
/* eslint-disable @typescript-eslint/only-throw-error */
/**
 * Inner function that dispatches JSON-RPC request to the associated Keyring
 * methods.
 *
 * @param keyring - Keyring instance.
 * @param request - Keyring JSON-RPC request.
 * @returns A promise that resolves to the keyring response.
 */
async function dispatchKeyringRequest(keyring, request) {
    // We first have to make sure that the request is a valid JSON-RPC request so
    // we can check its method name.
    assert(request, JsonRpcRequestStruct);
    switch (request.method) {
        case `${KeyringRpcMethod.GetAccounts}`: {
            assert(request, GetAccountsRequestStruct);
            return keyring.getAccounts();
        }
        case `${KeyringRpcMethod.GetAccount}`: {
            assert(request, GetAccountRequestStruct);
            return keyring.getAccount(request.params.id);
        }
        case `${KeyringRpcMethod.CreateAccounts}`: {
            assert(request, CreateAccountsRequestStruct);
            return keyring.createAccounts(request.params);
        }
        case `${KeyringRpcMethod.DeleteAccount}`: {
            assert(request, DeleteAccountRequestStruct);
            return keyring.deleteAccount(request.params.id);
        }
        case `${KeyringRpcMethod.ExportAccount}`: {
            if (keyring.exportAccount === undefined) {
                throw new MethodNotSupportedError(request.method);
            }
            assert(request, ExportAccountRequestStruct);
            return keyring.exportAccount(request.params.id, request.params.options);
        }
        case `${KeyringRpcMethod.SubmitRequest}`: {
            assert(request, SubmitRequestRequestStruct);
            return keyring.submitRequest(request.params);
        }
        default: {
            throw new MethodNotSupportedError(request.method);
        }
    }
}
/**
 * Handles a keyring (v2) JSON-RPC request.
 *
 * This function is meant to be used as a handler for Keyring (v2) JSON-RPC requests
 * in an Accounts Snap.
 *
 * @param keyring - Keyring instance.
 * @param request - Keyring JSON-RPC request.
 * @returns A promise that resolves to the keyring response.
 * @example
 * ```ts
 * export const onKeyringRequest: OnKeyringRequestHandler = async ({
 *   origin,
 *   request,
 * }) => {
 *   return await handleKeyringRequest(keyring, request);
 * };
 * ```
 */
export async function handleKeyringRequest(keyring, request) {
    try {
        return await dispatchKeyringRequest(keyring, request);
    }
    catch (error) {
        if (isSnapError(error)) {
            throw error;
        }
        const message = error instanceof Error && typeof error.message === 'string'
            ? error.message
            : 'An unknown error occurred while handling the keyring (v2) request';
        throw new Error(message);
    }
}
//# sourceMappingURL=rpc-handler.mjs.map