@metamask-previews/keyring-snap-sdk 0.0.1-672cc7b

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/accounts/

package/README.md

@@ -0,0 +1,15 @@
+# MetaMask Keyring Snap SDK
+
+Various JavaScript/TypeScript utilities required by the Snap Keyring.
+
+## Installation
+
+`yarn add @metamask/keyring-snap-sdk`
+
+or
+
+`npm install @metamask/keyring-snap-sdk`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/accounts#readme).

package/dist/JsonRpcRequest.d.ts

@@ -0,0 +1,16 @@
+import type { Infer } from '@metamask/superstruct';
+export declare const JsonRpcRequestStruct: import("@metamask/superstruct").Struct<{
+    jsonrpc: "2.0";
+    id: string | number | null;
+    method: string;
+    params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+}, {
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+    method: import("@metamask/superstruct").Struct<string, null>;
+    params: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>, null>;
+}>;
+/**
+ * JSON-RPC request type.
+ */
+export declare type JsonRpcRequest = Infer<typeof JsonRpcRequestStruct>;

package/dist/JsonRpcRequest.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonRpcRequestStruct = void 0;
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+exports.JsonRpcRequestStruct = (0, keyring_utils_1.object)({
+    jsonrpc: (0, superstruct_1.literal)('2.0'),
+    id: (0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.number)(), (0, superstruct_1.literal)(null)]),
+    method: (0, superstruct_1.string)(),
+    params: (0, keyring_utils_1.exactOptional)((0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)])),
+});
+//# sourceMappingURL=JsonRpcRequest.js.map

package/dist/JsonRpcRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonRpcRequest.js","sourceRoot":"","sources":["../src/JsonRpcRequest.ts"],"names":[],"mappings":";;;AAAA,2DAAgE;AAChE,uDAO+B;AAE/B,2CAA6C;AAEhC,QAAA,oBAAoB,GAAG,IAAA,sBAAM,EAAC;IACzC,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;IACvB,EAAE,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,oBAAM,GAAE,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,MAAM,EAAE,IAAA,oBAAM,GAAE;IAChB,MAAM,EAAE,IAAA,6BAAa,EACnB,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC,CACzD;CACF,CAAC,CAAC","sourcesContent":["import { exactOptional, object } from '@metamask/keyring-utils';\nimport {\n  array,\n  literal,\n  number,\n  record,\n  string,\n  union,\n} from '@metamask/superstruct';\nimport type { Infer } from '@metamask/superstruct';\nimport { JsonStruct } from '@metamask/utils';\n\nexport const JsonRpcRequestStruct = object({\n  jsonrpc: literal('2.0'),\n  id: union([string(), number(), literal(null)]),\n  method: string(),\n  params: exactOptional(\n    union([array(JsonStruct), record(string(), JsonStruct)]),\n  ),\n});\n\n/**\n * JSON-RPC request type.\n */\nexport type JsonRpcRequest = Infer<typeof JsonRpcRequestStruct>;\n"]}

package/dist/events.d.ts

@@ -0,0 +1 @@
+export { KeyringEvent } from '@metamask/keyring-internal-api';

package/dist/events.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringEvent = void 0;
+var keyring_internal_api_1 = require("@metamask/keyring-internal-api");
+Object.defineProperty(exports, "KeyringEvent", { enumerable: true, get: function () { return keyring_internal_api_1.KeyringEvent; } });
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";;;AAAA,uEAA8D;AAArD,oHAAA,YAAY,OAAA","sourcesContent":["export { KeyringEvent } from '@metamask/keyring-internal-api';\n"]}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './JsonRpcRequest';
+export * from './events';
+export * from './rpc-handler';
+export * from './snap-utils';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./JsonRpcRequest"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./rpc-handler"), exports);
+__exportStar(require("./snap-utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,2CAAyB;AACzB,gDAA8B;AAC9B,+CAA6B","sourcesContent":["export * from './JsonRpcRequest';\nexport * from './events';\nexport * from './rpc-handler';\nexport * from './snap-utils';\n"]}

package/dist/rpc-handler.d.ts

@@ -0,0 +1,29 @@
+import type { Keyring } from '@metamask/keyring-api';
+import type { Json } from '@metamask/utils';
+import type { JsonRpcRequest } from './JsonRpcRequest';
+/**
+ * Error thrown when a keyring JSON-RPC method is not supported.
+ */
+export declare class MethodNotSupportedError extends Error {
+    constructor(method: string);
+}
+/**
+ * Handles a keyring JSON-RPC request.
+ *
+ * This function is meant to be used as a handler for Keyring 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 declare function handleKeyringRequest(keyring: Keyring, request: JsonRpcRequest): Promise<Json | void>;

package/dist/rpc-handler.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleKeyringRequest = exports.MethodNotSupportedError = void 0;
+const keyring_internal_api_1 = require("@metamask/keyring-internal-api");
+const superstruct_1 = require("@metamask/superstruct");
+const JsonRpcRequest_1 = require("./JsonRpcRequest");
+/**
+ * Error thrown when a keyring JSON-RPC method is not supported.
+ */
+class MethodNotSupportedError extends Error {
+    constructor(method) {
+        super(`Method not supported: ${method}`);
+    }
+}
+exports.MethodNotSupportedError = MethodNotSupportedError;
+/**
+ * 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 dispatchRequest(keyring, request) {
+    // We first have to make sure that the request is a valid JSON-RPC request so
+    // we can check its method name.
+    (0, superstruct_1.assert)(request, JsonRpcRequest_1.JsonRpcRequestStruct);
+    switch (request.method) {
+        case keyring_internal_api_1.KeyringRpcMethod.ListAccounts: {
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.ListAccountsRequestStruct);
+            return keyring.listAccounts();
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.GetAccount: {
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.GetAccountRequestStruct);
+            return keyring.getAccount(request.params.id);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.CreateAccount: {
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.CreateAccountRequestStruct);
+            return keyring.createAccount(request.params.options);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.GetAccountBalances: {
+            if (keyring.getAccountBalances === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.GetAccountBalancesRequestStruct);
+            return keyring.getAccountBalances(request.params.id, request.params.assets);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.FilterAccountChains: {
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.FilterAccountChainsStruct);
+            return keyring.filterAccountChains(request.params.id, request.params.chains);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.UpdateAccount: {
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.UpdateAccountRequestStruct);
+            return keyring.updateAccount(request.params.account);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.DeleteAccount: {
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.DeleteAccountRequestStruct);
+            return keyring.deleteAccount(request.params.id);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.ExportAccount: {
+            if (keyring.exportAccount === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.ExportAccountRequestStruct);
+            return keyring.exportAccount(request.params.id);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.ListRequests: {
+            if (keyring.listRequests === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.ListRequestsRequestStruct);
+            return keyring.listRequests();
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.GetRequest: {
+            if (keyring.getRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.GetRequestRequestStruct);
+            return keyring.getRequest(request.params.id);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.SubmitRequest: {
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.SubmitRequestRequestStruct);
+            return keyring.submitRequest(request.params);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.ApproveRequest: {
+            if (keyring.approveRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.ApproveRequestRequestStruct);
+            return keyring.approveRequest(request.params.id, request.params.data);
+        }
+        case keyring_internal_api_1.KeyringRpcMethod.RejectRequest: {
+            if (keyring.rejectRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, keyring_internal_api_1.RejectRequestRequestStruct);
+            return keyring.rejectRequest(request.params.id);
+        }
+        default: {
+            throw new MethodNotSupportedError(request.method);
+        }
+    }
+}
+/**
+ * Handles a keyring JSON-RPC request.
+ *
+ * This function is meant to be used as a handler for Keyring 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);
+ * };
+ * ```
+ */
+async function handleKeyringRequest(keyring, request) {
+    try {
+        return await dispatchRequest(keyring, request);
+    }
+    catch (error) {
+        const message = error instanceof Error && typeof error.message === 'string'
+            ? error.message
+            : 'An unknown error occurred while handling the keyring request';
+        throw new Error(message);
+    }
+}
+exports.handleKeyringRequest = handleKeyringRequest;
+//# sourceMappingURL=rpc-handler.js.map

package/dist/rpc-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-handler.js","sourceRoot":"","sources":["../src/rpc-handler.ts"],"names":[],"mappings":";;;AACA,yEAewC;AACxC,uDAA+C;AAI/C,qDAAwD;AAExD;;GAEG;AACH,MAAa,uBAAwB,SAAQ,KAAK;IAChD,YAAY,MAAc;QACxB,KAAK,CAAC,yBAAyB,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF;AAJD,0DAIC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAC5B,OAAgB,EAChB,OAAuB;IAEvB,6EAA6E;IAC7E,gCAAgC;IAChC,IAAA,oBAAM,EAAC,OAAO,EAAE,qCAAoB,CAAC,CAAC;IAEtC,QAAQ,OAAO,CAAC,MAAM,EAAE;QACtB,KAAK,uCAAgB,CAAC,YAAY,CAAC,CAAC;YAClC,IAAA,oBAAM,EAAC,OAAO,EAAE,gDAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;SAC/B;QAED,KAAK,uCAAgB,CAAC,UAAU,CAAC,CAAC;YAChC,IAAA,oBAAM,EAAC,OAAO,EAAE,8CAAuB,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SAC9C;QAED,KAAK,uCAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,iDAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,KAAK,uCAAgB,CAAC,kBAAkB,CAAC,CAAC;YACxC,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS,EAAE;gBAC5C,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,sDAA+B,CAAC,CAAC;YACjD,OAAO,OAAO,CAAC,kBAAkB,CAC/B,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CACtB,CAAC;SACH;QAED,KAAK,uCAAgB,CAAC,mBAAmB,CAAC,CAAC;YACzC,IAAA,oBAAM,EAAC,OAAO,EAAE,gDAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,mBAAmB,CAChC,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CACtB,CAAC;SACH;QAED,KAAK,uCAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,iDAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,KAAK,uCAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,iDAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACjD;QAED,KAAK,uCAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE;gBACvC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,iDAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACjD;QAED,KAAK,uCAAgB,CAAC,YAAY,CAAC,CAAC;YAClC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;gBACtC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,gDAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;SAC/B;QAED,KAAK,uCAAgB,CAAC,UAAU,CAAC,CAAC;YAChC,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE;gBACpC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,8CAAuB,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SAC9C;QAED,KAAK,uCAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,iDAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAC9C;QAED,KAAK,uCAAgB,CAAC,cAAc,CAAC,CAAC;YACpC,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE;gBACxC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,kDAA2B,CAAC,CAAC;YAC7C,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACvE;QAED,KAAK,uCAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE;gBACvC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,iDAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACjD;QAED,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SACnD;KACF;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,oBAAoB,CACxC,OAAgB,EAChB,OAAuB;IAEvB,IAAI;QACF,OAAO,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KAChD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACzD,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,8DAA8D,CAAC;QAErE,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;KAC1B;AACH,CAAC;AAdD,oDAcC","sourcesContent":["import type { Keyring } from '@metamask/keyring-api';\nimport {\n  GetAccountRequestStruct,\n  CreateAccountRequestStruct,\n  ApproveRequestRequestStruct,\n  DeleteAccountRequestStruct,\n  ExportAccountRequestStruct,\n  GetRequestRequestStruct,\n  RejectRequestRequestStruct,\n  SubmitRequestRequestStruct,\n  UpdateAccountRequestStruct,\n  FilterAccountChainsStruct,\n  ListAccountsRequestStruct,\n  ListRequestsRequestStruct,\n  GetAccountBalancesRequestStruct,\n  KeyringRpcMethod,\n} from '@metamask/keyring-internal-api';\nimport { assert } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\n\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { JsonRpcRequestStruct } from './JsonRpcRequest';\n\n/**\n * Error thrown when a keyring JSON-RPC method is not supported.\n */\nexport class MethodNotSupportedError extends Error {\n  constructor(method: string) {\n    super(`Method not supported: ${method}`);\n  }\n}\n\n/**\n * Inner function that dispatches JSON-RPC request to the associated Keyring\n * methods.\n *\n * @param keyring - Keyring instance.\n * @param request - Keyring JSON-RPC request.\n * @returns A promise that resolves to the keyring response.\n */\nasync function dispatchRequest(\n  keyring: Keyring,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  // We first have to make sure that the request is a valid JSON-RPC request so\n  // we can check its method name.\n  assert(request, JsonRpcRequestStruct);\n\n  switch (request.method) {\n    case KeyringRpcMethod.ListAccounts: {\n      assert(request, ListAccountsRequestStruct);\n      return keyring.listAccounts();\n    }\n\n    case KeyringRpcMethod.GetAccount: {\n      assert(request, GetAccountRequestStruct);\n      return keyring.getAccount(request.params.id);\n    }\n\n    case KeyringRpcMethod.CreateAccount: {\n      assert(request, CreateAccountRequestStruct);\n      return keyring.createAccount(request.params.options);\n    }\n\n    case KeyringRpcMethod.GetAccountBalances: {\n      if (keyring.getAccountBalances === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, GetAccountBalancesRequestStruct);\n      return keyring.getAccountBalances(\n        request.params.id,\n        request.params.assets,\n      );\n    }\n\n    case KeyringRpcMethod.FilterAccountChains: {\n      assert(request, FilterAccountChainsStruct);\n      return keyring.filterAccountChains(\n        request.params.id,\n        request.params.chains,\n      );\n    }\n\n    case KeyringRpcMethod.UpdateAccount: {\n      assert(request, UpdateAccountRequestStruct);\n      return keyring.updateAccount(request.params.account);\n    }\n\n    case KeyringRpcMethod.DeleteAccount: {\n      assert(request, DeleteAccountRequestStruct);\n      return keyring.deleteAccount(request.params.id);\n    }\n\n    case KeyringRpcMethod.ExportAccount: {\n      if (keyring.exportAccount === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ExportAccountRequestStruct);\n      return keyring.exportAccount(request.params.id);\n    }\n\n    case KeyringRpcMethod.ListRequests: {\n      if (keyring.listRequests === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ListRequestsRequestStruct);\n      return keyring.listRequests();\n    }\n\n    case KeyringRpcMethod.GetRequest: {\n      if (keyring.getRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, GetRequestRequestStruct);\n      return keyring.getRequest(request.params.id);\n    }\n\n    case KeyringRpcMethod.SubmitRequest: {\n      assert(request, SubmitRequestRequestStruct);\n      return keyring.submitRequest(request.params);\n    }\n\n    case KeyringRpcMethod.ApproveRequest: {\n      if (keyring.approveRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ApproveRequestRequestStruct);\n      return keyring.approveRequest(request.params.id, request.params.data);\n    }\n\n    case KeyringRpcMethod.RejectRequest: {\n      if (keyring.rejectRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, RejectRequestRequestStruct);\n      return keyring.rejectRequest(request.params.id);\n    }\n\n    default: {\n      throw new MethodNotSupportedError(request.method);\n    }\n  }\n}\n\n/**\n * Handles a keyring JSON-RPC request.\n *\n * This function is meant to be used as a handler for Keyring JSON-RPC requests\n * in an Accounts Snap.\n *\n * @param keyring - Keyring instance.\n * @param request - Keyring JSON-RPC request.\n * @returns A promise that resolves to the keyring response.\n * @example\n * ```ts\n * export const onKeyringRequest: OnKeyringRequestHandler = async ({\n *   origin,\n *   request,\n * }) => {\n *   return await handleKeyringRequest(keyring, request);\n * };\n * ```\n */\nexport async function handleKeyringRequest(\n  keyring: Keyring,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  try {\n    return await dispatchRequest(keyring, request);\n  } catch (error) {\n    const message =\n      error instanceof Error && typeof error.message === 'string'\n        ? error.message\n        : 'An unknown error occurred while handling the keyring request';\n\n    throw new Error(message);\n  }\n}\n"]}

package/dist/snap-utils.d.ts

@@ -0,0 +1,11 @@
+import type { SnapsProvider } from '@metamask/snaps-sdk';
+import type { Json } from '@metamask/utils';
+import type { KeyringEvent } from './events';
+/**
+ * Emit a keyring event from a snap.
+ *
+ * @param snap - The global snap object.
+ * @param event - The event name.
+ * @param data - The event data.
+ */
+export declare function emitSnapKeyringEvent(snap: SnapsProvider, event: KeyringEvent, data: Record<string, Json>): Promise<void>;

package/dist/snap-utils.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitSnapKeyringEvent = void 0;
+/**
+ * Emit a keyring event from a snap.
+ *
+ * @param snap - The global snap object.
+ * @param event - The event name.
+ * @param data - The event data.
+ */
+async function emitSnapKeyringEvent(snap, event, data) {
+    await snap.request({
+        method: 'snap_manageAccounts',
+        params: {
+            method: event,
+            params: { ...data },
+        },
+    });
+}
+exports.emitSnapKeyringEvent = emitSnapKeyringEvent;
+//# sourceMappingURL=snap-utils.js.map

package/dist/snap-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snap-utils.js","sourceRoot":"","sources":["../src/snap-utils.ts"],"names":[],"mappings":";;;AAKA;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,IAAmB,EACnB,KAAmB,EACnB,IAA0B;IAE1B,MAAM,IAAI,CAAC,OAAO,CAAC;QACjB,MAAM,EAAE,qBAAqB;QAC7B,MAAM,EAAE;YACN,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,EAAE,GAAG,IAAI,EAAE;SACpB;KACF,CAAC,CAAC;AACL,CAAC;AAZD,oDAYC","sourcesContent":["import type { SnapsProvider } from '@metamask/snaps-sdk';\nimport type { Json } from '@metamask/utils';\n\nimport type { KeyringEvent } from './events';\n\n/**\n * Emit a keyring event from a snap.\n *\n * @param snap - The global snap object.\n * @param event - The event name.\n * @param data - The event data.\n */\nexport async function emitSnapKeyringEvent(\n  snap: SnapsProvider,\n  event: KeyringEvent,\n  data: Record<string, Json>,\n): Promise<void> {\n  await snap.request({\n    method: 'snap_manageAccounts',\n    params: {\n      method: event,\n      params: { ...data },\n    },\n  });\n}\n"]}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@metamask-previews/keyring-snap-sdk",
+  "version": "0.0.1-672cc7b",
+  "description": "MetaMask Keyring Snap SDK",
+  "keywords": [
+    "metamask",
+    "keyring"
+  ],
+  "homepage": "https://github.com/MetaMask/accounts/tree/main/packages/keyring-snap-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/accounts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/accounts.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "build:clean": "rimraf dist && yarn build",
+    "build:docs": "typedoc",
+    "build:force": "tsc --build tsconfig.build.json --force",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/keyring-snap-sdk",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/keyring-snap-sdk",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "yarn test:source && yarn test:types",
+    "test:clean": "jest --clearCache",
+    "test:source": "jest && jest-it-up",
+    "test:types": "tsd",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask/keyring-internal-api": "0.0.1",
+    "@metamask/keyring-utils": "0.0.1",
+    "@metamask/snaps-sdk": "^6.1.0",
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^9.1.0",
+    "deepmerge": "^4.2.2"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^3.0.4",
+    "@lavamoat/preinstall-always-fail": "^2.0.0",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-api": "^8.1.0",
+    "@metamask/providers": "^17.1.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.12",
+    "depcheck": "^1.4.7",
+    "jest": "^28.1.3",
+    "jest-it-up": "^3.1.0",
+    "rimraf": "^5.0.7",
+    "ts-jest": "^28.0.8",
+    "ts-node": "^10.9.2",
+    "tsd": "^0.31.0",
+    "typedoc": "^0.25.13",
+    "typescript": "~4.8.4"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "lavamoat": {
+    "allowScripts": {
+      "@lavamoat/preinstall-always-fail": false
+    }
+  },
+  "tsd": {
+    "directory": "src"
+  }
+}