@metamask-previews/keyring-snap-sdk 7.2.1-6511fbf → 8.0.0-5c366be

package/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `handleKeyringRequestV2` function for dispatching keyring v2 JSON-RPC requests ([#408](https://github.com/MetaMask/accounts/pull/408))
+
+### Changed
+
+- Bump `@metamask/utils` from `^11.1.0` to `^11.10.0` ([#489](https://github.com/MetaMask/accounts/pull/489))
+
+## [8.0.0]
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/keyring-api` from `^21.0.0` to `^22.0.0` ([#482](https://github.com/MetaMask/accounts/pull/482))
+- Bump `@metamask/snaps-sdk` from `^10.4.0` to `^11.0.0` ([#486](https://github.com/MetaMask/accounts/pull/486))
+
 ## [7.2.1]
 
 ### Fixed
@@ -144,7 +159,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - This new version fixes a bug with CJS re-exports.
 - Initial release ([#24](https://github.com/MetaMask/accounts/pull/24))
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-snap-sdk@7.2.1...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-snap-sdk@8.0.0...HEAD
+[8.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-snap-sdk@7.2.1...@metamask/keyring-snap-sdk@8.0.0
 [7.2.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-snap-sdk@7.2.0...@metamask/keyring-snap-sdk@7.2.1
 [7.2.0]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-snap-sdk@7.1.1...@metamask/keyring-snap-sdk@7.2.0
 [7.1.1]: https://github.com/MetaMask/accounts/compare/@metamask/keyring-snap-sdk@7.1.0...@metamask/keyring-snap-sdk@7.1.1

package/dist/index.cjs

@@ -18,4 +18,5 @@ __exportStar(require("./rpc-handler.cjs"), exports);
 __exportStar(require("./snap-utils.cjs"), exports);
 __exportStar(require("./time.cjs"), exports);
 __exportStar(require("./methods.cjs"), exports);
+__exportStar(require("./v2/index.cjs"), exports);
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAA8B;AAC9B,mDAA6B;AAC7B,6CAAuB;AACvB,gDAA0B","sourcesContent":["export * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './time';\nexport * from './methods';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAA8B;AAC9B,mDAA6B;AAC7B,6CAAuB;AACvB,gDAA0B;AAC1B,iDAAqB","sourcesContent":["export * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './time';\nexport * from './methods';\nexport * from './v2';\n"]}

package/dist/index.d.cts

@@ -2,4 +2,5 @@ export * from "./rpc-handler.cjs";
 export * from "./snap-utils.cjs";
 export * from "./time.cjs";
 export * from "./methods.cjs";
+export * from "./v2/index.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kCAA8B;AAC9B,iCAA6B;AAC7B,2BAAuB;AACvB,8BAA0B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kCAA8B;AAC9B,iCAA6B;AAC7B,2BAAuB;AACvB,8BAA0B;AAC1B,+BAAqB"}

package/dist/index.d.mts

@@ -2,4 +2,5 @@ export * from "./rpc-handler.mjs";
 export * from "./snap-utils.mjs";
 export * from "./time.mjs";
 export * from "./methods.mjs";
+export * from "./v2/index.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kCAA8B;AAC9B,iCAA6B;AAC7B,2BAAuB;AACvB,8BAA0B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kCAA8B;AAC9B,iCAA6B;AAC7B,2BAAuB;AACvB,8BAA0B;AAC1B,+BAAqB"}

package/dist/index.mjs

@@ -2,4 +2,5 @@ export * from "./rpc-handler.mjs";
 export * from "./snap-utils.mjs";
 export * from "./time.mjs";
 export * from "./methods.mjs";
+export * from "./v2/index.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kCAA8B;AAC9B,iCAA6B;AAC7B,2BAAuB;AACvB,8BAA0B","sourcesContent":["export * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './time';\nexport * from './methods';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kCAA8B;AAC9B,iCAA6B;AAC7B,2BAAuB;AACvB,8BAA0B;AAC1B,+BAAqB","sourcesContent":["export * from './rpc-handler';\nexport * from './snap-utils';\nexport * from './time';\nexport * from './methods';\nexport * from './v2';\n"]}

package/dist/v2/index.cjs

@@ -0,0 +1,18 @@
+"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("./rpc-handler.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/dist/v2/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAA8B","sourcesContent":["export * from './rpc-handler';\n"]}

package/dist/v2/index.d.cts

@@ -0,0 +1,2 @@
+export * from "./rpc-handler.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/v2/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,kCAA8B"}

package/dist/v2/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./rpc-handler.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/v2/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,kCAA8B"}

package/dist/v2/index.mjs

@@ -0,0 +1,2 @@
+export * from "./rpc-handler.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/v2/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,kCAA8B","sourcesContent":["export * from './rpc-handler';\n"]}

package/dist/v2/rpc-handler.cjs

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleKeyringRequestV2 = handleKeyringRequestV2;
+const keyring_api_1 = require("@metamask/keyring-api");
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const errors_1 = require("../errors.cjs");
+const rpc_handler_1 = require("../rpc-handler.cjs");
+// 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 dispatchKeyringRequestV2(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, keyring_utils_1.JsonRpcRequestStruct);
+    switch (request.method) {
+        case `${keyring_api_1.KeyringRpcV2Method.GetAccounts}`: {
+            (0, superstruct_1.assert)(request, keyring_api_1.GetAccountsV2RequestStruct);
+            return keyring.getAccounts();
+        }
+        case `${keyring_api_1.KeyringRpcV2Method.GetAccount}`: {
+            (0, superstruct_1.assert)(request, keyring_api_1.GetAccountV2RequestStruct);
+            return keyring.getAccount(request.params.id);
+        }
+        case `${keyring_api_1.KeyringRpcV2Method.CreateAccounts}`: {
+            (0, superstruct_1.assert)(request, keyring_api_1.CreateAccountsV2RequestStruct);
+            return keyring.createAccounts(request.params);
+        }
+        case `${keyring_api_1.KeyringRpcV2Method.DeleteAccount}`: {
+            (0, superstruct_1.assert)(request, keyring_api_1.DeleteAccountV2RequestStruct);
+            return keyring.deleteAccount(request.params.id);
+        }
+        case `${keyring_api_1.KeyringRpcV2Method.ExportAccount}`: {
+            if (keyring.exportAccount === undefined) {
+                throw new rpc_handler_1.MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, keyring_api_1.ExportAccountV2RequestStruct);
+            return keyring.exportAccount(request.params.id, request.params.options);
+        }
+        case `${keyring_api_1.KeyringRpcV2Method.SubmitRequest}`: {
+            (0, superstruct_1.assert)(request, keyring_api_1.SubmitRequestV2RequestStruct);
+            return keyring.submitRequest(request.params);
+        }
+        default: {
+            throw new rpc_handler_1.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 handleKeyringRequestV2(keyring, request);
+ * };
+ * ```
+ */
+async function handleKeyringRequestV2(keyring, request) {
+    try {
+        return await dispatchKeyringRequestV2(keyring, request);
+    }
+    catch (error) {
+        if ((0, errors_1.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.cjs.map

package/dist/v2/rpc-handler.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-handler.cjs","sourceRoot":"","sources":["../../src/v2/rpc-handler.ts"],"names":[],"mappings":";;AAgGA,wDAkBC;AAjHD,uDAQ+B;AAE/B,2DAA+D;AAC/D,uDAA+C;AAG/C,0CAAwC;AACxC,oDAAyD;AAEzD,mHAAmH;AACnH,wDAAwD;AAExD;;;;;;;GAOG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAAkB,EAClB,OAAuB;IAEvB,6EAA6E;IAC7E,gCAAgC;IAChC,IAAA,oBAAM,EAAC,OAAO,EAAE,oCAAoB,CAAC,CAAC;IAEtC,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,GAAG,gCAAkB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACzC,IAAA,oBAAM,EAAC,OAAO,EAAE,wCAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;QAC/B,CAAC;QAED,KAAK,GAAG,gCAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YACxC,IAAA,oBAAM,EAAC,OAAO,EAAE,uCAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,KAAK,GAAG,gCAAkB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YAC5C,IAAA,oBAAM,EAAC,OAAO,EAAE,2CAA6B,CAAC,CAAC;YAC/C,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QAED,KAAK,GAAG,gCAAkB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YAC3C,IAAA,oBAAM,EAAC,OAAO,EAAE,0CAA4B,CAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,KAAK,GAAG,gCAAkB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YAC3C,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,IAAI,qCAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,0CAA4B,CAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1E,CAAC;QAED,KAAK,GAAG,gCAAkB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YAC3C,IAAA,oBAAM,EAAC,OAAO,EAAE,0CAA4B,CAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,qCAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,sBAAsB,CAC1C,OAAkB,EAClB,OAAuB;IAEvB,IAAI,CAAC;QACH,OAAO,MAAM,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACzD,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,mEAAmE,CAAC;QAE1E,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC","sourcesContent":["import type { KeyringV2 } from '@metamask/keyring-api';\nimport {\n  KeyringRpcV2Method,\n  GetAccountsV2RequestStruct,\n  GetAccountV2RequestStruct,\n  CreateAccountsV2RequestStruct,\n  DeleteAccountV2RequestStruct,\n  ExportAccountV2RequestStruct,\n  SubmitRequestV2RequestStruct,\n} from '@metamask/keyring-api';\nimport type { JsonRpcRequest } from '@metamask/keyring-utils';\nimport { JsonRpcRequestStruct } from '@metamask/keyring-utils';\nimport { assert } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\n\nimport { isSnapError } from '../errors';\nimport { MethodNotSupportedError } from '../rpc-handler';\n\n// ESLint does not like our custom error classes in this repo for some reason, they do extend Error, so unsure why.\n/* eslint-disable @typescript-eslint/only-throw-error */\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 dispatchKeyringRequestV2(\n  keyring: KeyringV2,\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 `${KeyringRpcV2Method.GetAccounts}`: {\n      assert(request, GetAccountsV2RequestStruct);\n      return keyring.getAccounts();\n    }\n\n    case `${KeyringRpcV2Method.GetAccount}`: {\n      assert(request, GetAccountV2RequestStruct);\n      return keyring.getAccount(request.params.id);\n    }\n\n    case `${KeyringRpcV2Method.CreateAccounts}`: {\n      assert(request, CreateAccountsV2RequestStruct);\n      return keyring.createAccounts(request.params);\n    }\n\n    case `${KeyringRpcV2Method.DeleteAccount}`: {\n      assert(request, DeleteAccountV2RequestStruct);\n      return keyring.deleteAccount(request.params.id);\n    }\n\n    case `${KeyringRpcV2Method.ExportAccount}`: {\n      if (keyring.exportAccount === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ExportAccountV2RequestStruct);\n      return keyring.exportAccount(request.params.id, request.params.options);\n    }\n\n    case `${KeyringRpcV2Method.SubmitRequest}`: {\n      assert(request, SubmitRequestV2RequestStruct);\n      return keyring.submitRequest(request.params);\n    }\n\n    default: {\n      throw new MethodNotSupportedError(request.method);\n    }\n  }\n}\n\n/**\n * Handles a keyring (v2) JSON-RPC request.\n *\n * This function is meant to be used as a handler for Keyring (v2) 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 handleKeyringRequestV2(keyring, request);\n * };\n * ```\n */\nexport async function handleKeyringRequestV2(\n  keyring: KeyringV2,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  try {\n    return await dispatchKeyringRequestV2(keyring, request);\n  } catch (error) {\n    if (isSnapError(error)) {\n      throw error;\n    }\n\n    const message =\n      error instanceof Error && typeof error.message === 'string'\n        ? error.message\n        : 'An unknown error occurred while handling the keyring (v2) request';\n\n    throw new Error(message);\n  }\n}\n"]}

package/dist/v2/rpc-handler.d.cts

@@ -0,0 +1,24 @@
+import type { KeyringV2 } from "@metamask/keyring-api";
+import type { JsonRpcRequest } from "@metamask/keyring-utils";
+import type { Json } from "@metamask/utils";
+/**
+ * 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 handleKeyringRequestV2(keyring, request);
+ * };
+ * ```
+ */
+export declare function handleKeyringRequestV2(keyring: KeyringV2, request: JsonRpcRequest): Promise<Json | void>;
+//# sourceMappingURL=rpc-handler.d.cts.map

package/dist/v2/rpc-handler.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-handler.d.cts","sourceRoot":"","sources":["../../src/v2/rpc-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,8BAA8B;AAUvD,OAAO,KAAK,EAAE,cAAc,EAAE,gCAAgC;AAG9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAgE5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAetB"}

package/dist/v2/rpc-handler.d.mts

@@ -0,0 +1,24 @@
+import type { KeyringV2 } from "@metamask/keyring-api";
+import type { JsonRpcRequest } from "@metamask/keyring-utils";
+import type { Json } from "@metamask/utils";
+/**
+ * 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 handleKeyringRequestV2(keyring, request);
+ * };
+ * ```
+ */
+export declare function handleKeyringRequestV2(keyring: KeyringV2, request: JsonRpcRequest): Promise<Json | void>;
+//# sourceMappingURL=rpc-handler.d.mts.map

package/dist/v2/rpc-handler.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-handler.d.mts","sourceRoot":"","sources":["../../src/v2/rpc-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,8BAA8B;AAUvD,OAAO,KAAK,EAAE,cAAc,EAAE,gCAAgC;AAG9D,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAgE5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAetB"}

package/dist/v2/rpc-handler.mjs

@@ -0,0 +1,86 @@
+import { KeyringRpcV2Method, GetAccountsV2RequestStruct, GetAccountV2RequestStruct, CreateAccountsV2RequestStruct, DeleteAccountV2RequestStruct, ExportAccountV2RequestStruct, SubmitRequestV2RequestStruct } from "@metamask/keyring-api";
+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 dispatchKeyringRequestV2(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 `${KeyringRpcV2Method.GetAccounts}`: {
+            assert(request, GetAccountsV2RequestStruct);
+            return keyring.getAccounts();
+        }
+        case `${KeyringRpcV2Method.GetAccount}`: {
+            assert(request, GetAccountV2RequestStruct);
+            return keyring.getAccount(request.params.id);
+        }
+        case `${KeyringRpcV2Method.CreateAccounts}`: {
+            assert(request, CreateAccountsV2RequestStruct);
+            return keyring.createAccounts(request.params);
+        }
+        case `${KeyringRpcV2Method.DeleteAccount}`: {
+            assert(request, DeleteAccountV2RequestStruct);
+            return keyring.deleteAccount(request.params.id);
+        }
+        case `${KeyringRpcV2Method.ExportAccount}`: {
+            if (keyring.exportAccount === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            assert(request, ExportAccountV2RequestStruct);
+            return keyring.exportAccount(request.params.id, request.params.options);
+        }
+        case `${KeyringRpcV2Method.SubmitRequest}`: {
+            assert(request, SubmitRequestV2RequestStruct);
+            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 handleKeyringRequestV2(keyring, request);
+ * };
+ * ```
+ */
+export async function handleKeyringRequestV2(keyring, request) {
+    try {
+        return await dispatchKeyringRequestV2(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

package/dist/v2/rpc-handler.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-handler.mjs","sourceRoot":"","sources":["../../src/v2/rpc-handler.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,EAClB,0BAA0B,EAC1B,yBAAyB,EACzB,6BAA6B,EAC7B,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC7B,8BAA8B;AAE/B,OAAO,EAAE,oBAAoB,EAAE,gCAAgC;AAC/D,OAAO,EAAE,MAAM,EAAE,8BAA8B;AAG/C,OAAO,EAAE,WAAW,EAAE,sBAAkB;AACxC,OAAO,EAAE,uBAAuB,EAAE,2BAAuB;AAEzD,mHAAmH;AACnH,wDAAwD;AAExD;;;;;;;GAOG;AACH,KAAK,UAAU,wBAAwB,CACrC,OAAkB,EAClB,OAAuB;IAEvB,6EAA6E;IAC7E,gCAAgC;IAChC,MAAM,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IAEtC,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,GAAG,kBAAkB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;QAC/B,CAAC;QAED,KAAK,GAAG,kBAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YACxC,MAAM,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,KAAK,GAAG,kBAAkB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YAC5C,MAAM,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAC;YAC/C,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QAED,KAAK,GAAG,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,KAAK,GAAG,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YAC3C,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1E,CAAC;QAED,KAAK,GAAG,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;YAC9C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAkB,EAClB,OAAuB;IAEvB,IAAI,CAAC;QACH,OAAO,MAAM,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACzD,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,mEAAmE,CAAC;QAE1E,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC","sourcesContent":["import type { KeyringV2 } from '@metamask/keyring-api';\nimport {\n  KeyringRpcV2Method,\n  GetAccountsV2RequestStruct,\n  GetAccountV2RequestStruct,\n  CreateAccountsV2RequestStruct,\n  DeleteAccountV2RequestStruct,\n  ExportAccountV2RequestStruct,\n  SubmitRequestV2RequestStruct,\n} from '@metamask/keyring-api';\nimport type { JsonRpcRequest } from '@metamask/keyring-utils';\nimport { JsonRpcRequestStruct } from '@metamask/keyring-utils';\nimport { assert } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\n\nimport { isSnapError } from '../errors';\nimport { MethodNotSupportedError } from '../rpc-handler';\n\n// ESLint does not like our custom error classes in this repo for some reason, they do extend Error, so unsure why.\n/* eslint-disable @typescript-eslint/only-throw-error */\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 dispatchKeyringRequestV2(\n  keyring: KeyringV2,\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 `${KeyringRpcV2Method.GetAccounts}`: {\n      assert(request, GetAccountsV2RequestStruct);\n      return keyring.getAccounts();\n    }\n\n    case `${KeyringRpcV2Method.GetAccount}`: {\n      assert(request, GetAccountV2RequestStruct);\n      return keyring.getAccount(request.params.id);\n    }\n\n    case `${KeyringRpcV2Method.CreateAccounts}`: {\n      assert(request, CreateAccountsV2RequestStruct);\n      return keyring.createAccounts(request.params);\n    }\n\n    case `${KeyringRpcV2Method.DeleteAccount}`: {\n      assert(request, DeleteAccountV2RequestStruct);\n      return keyring.deleteAccount(request.params.id);\n    }\n\n    case `${KeyringRpcV2Method.ExportAccount}`: {\n      if (keyring.exportAccount === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ExportAccountV2RequestStruct);\n      return keyring.exportAccount(request.params.id, request.params.options);\n    }\n\n    case `${KeyringRpcV2Method.SubmitRequest}`: {\n      assert(request, SubmitRequestV2RequestStruct);\n      return keyring.submitRequest(request.params);\n    }\n\n    default: {\n      throw new MethodNotSupportedError(request.method);\n    }\n  }\n}\n\n/**\n * Handles a keyring (v2) JSON-RPC request.\n *\n * This function is meant to be used as a handler for Keyring (v2) 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 handleKeyringRequestV2(keyring, request);\n * };\n * ```\n */\nexport async function handleKeyringRequestV2(\n  keyring: KeyringV2,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  try {\n    return await dispatchKeyringRequestV2(keyring, request);\n  } catch (error) {\n    if (isSnapError(error)) {\n      throw error;\n    }\n\n    const message =\n      error instanceof Error && typeof error.message === 'string'\n        ? error.message\n        : 'An unknown error occurred while handling the keyring (v2) request';\n\n    throw new Error(message);\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/keyring-snap-sdk",
-  "version": "7.2.1-6511fbf",
+  "version": "8.0.0-5c366be",
   "description": "MetaMask Keyring Snap SDK",
   "keywords": [
     "metamask",
@@ -45,18 +45,18 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/keyring-api": "21.5.0",
+    "@metamask/keyring-api": "22.0.0",
     "@metamask/keyring-utils": "3.2.0",
-    "@metamask/snaps-sdk": "^10.4.0",
+    "@metamask/snaps-sdk": "^11.0.0",
     "@metamask/superstruct": "^3.1.0",
-    "@metamask/utils": "^11.1.0",
+    "@metamask/utils": "^11.10.0",
     "webextension-polyfill": "^0.12.0"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/keyring-api": "21.5.0",
+    "@metamask/keyring-api": "22.0.0",
     "@metamask/providers": "^19.0.0",
     "@ts-bridge/cli": "^0.6.3",
     "@types/jest": "^29.5.12",