@metamask/keyring-api 0.2.2 → 0.2.4

package/CHANGELOG.md

@@ -6,53 +6,70 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.4]
+### Changed
+- Fix linting and compatibility with older `tsc` ([#108](https://github.com/MetaMask/keyring-api/pull/108)).
+
+## [0.2.3]
+### Added
+- Add redirection message to snap async response ([#102](https://github.com/MetaMask/keyring-api/pull/102)).
+
+### Changed
+- Use `Omit` instead of `OmitUnion` ([#106](https://github.com/MetaMask/keyring-api/pull/106)).
+- Update `KeyringResponse` comment ([#103](https://github.com/MetaMask/keyring-api/pull/103)).
+- Use `KeyringRpcMethod` enum instead of string ([#105](https://github.com/MetaMask/keyring-api/pull/105)).
+- Refactor tests to match superstruct examples ([#104](https://github.com/MetaMask/keyring-api/pull/104)).
+- Add `exactOptional()` superstruct type ([#100](https://github.com/MetaMask/keyring-api/pull/100)).
+- Bump @metamask/providers from 11.1.2 to 12.0.0 ([#99](https://github.com/MetaMask/keyring-api/pull/99)).
+- Bump @metamask/providers from 11.1.1 to 11.1.2 ([#98](https://github.com/MetaMask/keyring-api/pull/98)).
+
 ## [0.2.2]
 ### Added
-- Add architecture and EVM methods docs ([#86](https://github.com/MetaMask/keyring-api/pull/86))
-- Add `lastSelected` and `lastActive` to metadata ([#92](https://github.com/MetaMask/keyring-api/pull/92))
+- Add architecture and EVM methods docs ([#86](https://github.com/MetaMask/keyring-api/pull/86)).
+- Add `lastSelected` and `lastActive` to metadata ([#92](https://github.com/MetaMask/keyring-api/pull/92)).
 
 ### Changed
-- Make request `params` optional ([#96](https://github.com/MetaMask/keyring-api/pull/96))
-- Remove `lastActive` field from internal account model ([#95](https://github.com/MetaMask/keyring-api/pull/95))
-- Move request ID to outer request ([#94](https://github.com/MetaMask/keyring-api/pull/94))
+- Make request `params` optional ([#96](https://github.com/MetaMask/keyring-api/pull/96)).
+- Remove `lastActive` field from internal account model ([#95](https://github.com/MetaMask/keyring-api/pull/95)).
+- Move request ID to outer request ([#94](https://github.com/MetaMask/keyring-api/pull/94)).
 
 ## [0.2.1]
 ### Changed
-- Set `snap` object keys to be mandatory and move `name` to `metadata` ([#87](https://github.com/MetaMask/keyring-api/pull/87))
+- Set `snap` object keys to be mandatory and move `name` to `metadata` ([#87](https://github.com/MetaMask/keyring-api/pull/87)).
 
 ## [0.2.0]
 ### Added
-- Add `InternalAccount` type and create submodule `internal` ([#65](https://github.com/MetaMask/keyring-api/pull/65))
-- Add keyring events and helper functions ([#74](https://github.com/MetaMask/keyring-api/pull/74))
-- Add a `redirect` field to asynchronous request responses ([#75](https://github.com/MetaMask/keyring-api/pull/75))
-- Add `exportAccount` method ([#60](https://github.com/MetaMask/keyring-api/pull/60))
-- Add `getController` to client ([#43](https://github.com/MetaMask/keyring-api/pull/43))
+- Add `InternalAccount` type and create submodule `internal` ([#65](https://github.com/MetaMask/keyring-api/pull/65)).
+- Add keyring events and helper functions ([#74](https://github.com/MetaMask/keyring-api/pull/74)).
+- Add a `redirect` field to asynchronous request responses ([#75](https://github.com/MetaMask/keyring-api/pull/75)).
+- Add `exportAccount` method ([#60](https://github.com/MetaMask/keyring-api/pull/60)).
+- Add `getController` to client ([#43](https://github.com/MetaMask/keyring-api/pull/43)).
 
 ### Changed
-- Rename `erc4337` -> `eip4337` ([#42](https://github.com/MetaMask/keyring-api/pull/42))
-- Make `options` a mandatory field of `KeyringAccount` ([#30](https://github.com/MetaMask/keyring-api/pull/30))
-- Make `approveRequest` and `rejectRequest` optional ([#63](https://github.com/MetaMask/keyring-api/pull/63))
-- Make `exportAccount`, `listRequests` and `getRequest` optional ([#73](https://github.com/MetaMask/keyring-api/pull/73))
-- Export enums with account methods and types ([#66](https://github.com/MetaMask/keyring-api/pull/66))
-- Make `approveRequest` accept a `result` argument ([#59](https://github.com/MetaMask/keyring-api/pull/59))
-- Remove account name from `KeyringAccount` type ([#55](https://github.com/MetaMask/keyring-api/pull/55))
-- Remove `eth_sendTransaction` method ([#50](https://github.com/MetaMask/keyring-api/pull/50))
-- Rename `supportedMethods` to `methods` ([#35](https://github.com/MetaMask/keyring-api/pull/35))
+- Rename `erc4337` -> `eip4337` ([#42](https://github.com/MetaMask/keyring-api/pull/42)).
+- Make `options` a mandatory field of `KeyringAccount` ([#30](https://github.com/MetaMask/keyring-api/pull/30)).
+- Make `approveRequest` and `rejectRequest` optional ([#63](https://github.com/MetaMask/keyring-api/pull/63)).
+- Make `exportAccount`, `listRequests` and `getRequest` optional ([#73](https://github.com/MetaMask/keyring-api/pull/73)).
+- Export enums with account methods and types ([#66](https://github.com/MetaMask/keyring-api/pull/66)).
+- Make `approveRequest` accept a `result` argument ([#59](https://github.com/MetaMask/keyring-api/pull/59)).
+- Remove account name from `KeyringAccount` type ([#55](https://github.com/MetaMask/keyring-api/pull/55)).
+- Remove `eth_sendTransaction` method ([#50](https://github.com/MetaMask/keyring-api/pull/50)).
+- Rename `supportedMethods` to `methods` ([#35](https://github.com/MetaMask/keyring-api/pull/35)).
 
 ## [0.1.3]
 ### Changed
-- Downgrade snaps dependencies to `0.35.2-flask.1`. ([#25](https://github.com/MetaMask/keyring-api/pull/25))
+- Downgrade snaps dependencies to `0.35.2-flask.1` ([#25](https://github.com/MetaMask/keyring-api/pull/25)).
 
 ## [0.1.2]
 ### Changed
-- Update snaps dependencies. ([#21](https://github.com/MetaMask/keyring-api/pull/21))
+- Update snaps dependencies ([#21](https://github.com/MetaMask/keyring-api/pull/21)).
 
 ## [0.1.1]
 ### Added
-- Validate snap responses for type correctness. ([#15](https://github.com/MetaMask/keyring-api/pull/15))
+- Validate snap responses for type correctness ([#15](https://github.com/MetaMask/keyring-api/pull/15)).
 
 ### Changed
-- Rename RPC handling functions. ([#16](https://github.com/MetaMask/keyring-api/pull/16))
+- Rename RPC handling functions ([#16](https://github.com/MetaMask/keyring-api/pull/16)).
 
 ## [0.1.0] - 2023-06-20
 ### Added
@@ -62,7 +79,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SnapController keyring client. It is intended to be used by MetaMask to talk to the snap.
 - Helper functions to create keyring handler in the snap.
 
-[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v0.2.2...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v0.2.4...HEAD
+[0.2.4]: https://github.com/MetaMask/keyring-api/compare/v0.2.3...v0.2.4
+[0.2.3]: https://github.com/MetaMask/keyring-api/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/MetaMask/keyring-api/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/MetaMask/keyring-api/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/MetaMask/keyring-api/compare/v0.1.3...v0.2.0

package/dist/JsonRpcRequest.d.ts

@@ -3,12 +3,13 @@ export declare const JsonRpcRequestStruct: import("superstruct").Struct<{
     jsonrpc: "2.0";
     id: string | number | null;
     method: string;
-} | {
-    jsonrpc: "2.0";
-    id: string | number | null;
-    method: string;
-    params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
-}, null>;
+    params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+}, {
+    jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
+    id: import("superstruct").Struct<string | number | null, null>;
+    method: import("superstruct").Struct<string, null>;
+    params: import("superstruct").Struct<import("./superstruct").ExactOptionalTag | import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>, null>;
+}>;
 /**
  * JSON-RPC request type.
  */

package/dist/JsonRpcRequest.js

@@ -3,16 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonRpcRequestStruct = void 0;
 const utils_1 = require("@metamask/utils");
 const superstruct_1 = require("superstruct");
-const Common = {
+const superstruct_2 = require("./superstruct");
+exports.JsonRpcRequestStruct = (0, superstruct_2.object)({
     jsonrpc: (0, superstruct_1.literal)('2.0'),
-    id: (0, superstruct_1.nullable)((0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.number)()])),
+    id: (0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.number)(), (0, superstruct_1.literal)(null)]),
     method: (0, superstruct_1.string)(),
-};
-const Params = {
-    params: (0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)]),
-};
-exports.JsonRpcRequestStruct = (0, superstruct_1.union)([
-    (0, superstruct_1.object)({ ...Common }),
-    (0, superstruct_1.object)({ ...Common, ...Params }),
-]);
+    params: (0, superstruct_2.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

@@ -1 +1 @@
-{"version":3,"file":"JsonRpcRequest.js","sourceRoot":"","sources":["../src/JsonRpcRequest.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,6CASqB;AAErB,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;IACvB,EAAE,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,oBAAM,GAAE,CAAC,CAAC,CAAC;IACzC,MAAM,EAAE,IAAA,oBAAM,GAAE;CACjB,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,MAAM,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;CACjE,CAAC;AAEW,QAAA,oBAAoB,GAAG,IAAA,mBAAK,EAAC;IACxC,IAAA,oBAAM,EAAC,EAAE,GAAG,MAAM,EAAE,CAAC;IACrB,IAAA,oBAAM,EAAC,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;CACjC,CAAC,CAAC","sourcesContent":["import { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n  array,\n  literal,\n  nullable,\n  number,\n  object,\n  record,\n  string,\n  union,\n} from 'superstruct';\n\nconst Common = {\n  jsonrpc: literal('2.0'),\n  id: nullable(union([string(), number()])),\n  method: string(),\n};\n\nconst Params = {\n  params: union([array(JsonStruct), record(string(), JsonStruct)]),\n};\n\nexport const JsonRpcRequestStruct = union([\n  object({ ...Common }),\n  object({ ...Common, ...Params }),\n]);\n\n/**\n * JSON-RPC request type.\n */\nexport type JsonRpcRequest = Infer<typeof JsonRpcRequestStruct>;\n"]}
+{"version":3,"file":"JsonRpcRequest.js","sourceRoot":"","sources":["../src/JsonRpcRequest.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,6CAA4E;AAE5E,+CAAsD;AAEzC,QAAA,oBAAoB,GAAG,IAAA,oBAAM,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,2BAAa,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 { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport { array, literal, number, record, string, union } from 'superstruct';\n\nimport { exactOptional, object } from './superstruct';\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/KeyringClient.js

@@ -16,6 +16,7 @@ exports.KeyringClient = void 0;
 const superstruct_1 = require("superstruct");
 const uuid_1 = require("uuid");
 const api_1 = require("./internal/api");
+const rpc_handler_1 = require("./rpc-handler");
 const utils_1 = require("./utils");
 class KeyringClient {
     /**
@@ -30,71 +31,71 @@ class KeyringClient {
     }
     async listAccounts() {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_listAccounts',
+            method: rpc_handler_1.KeyringRpcMethod.ListAccounts,
         }), api_1.ListAccountsResponseStruct);
     }
     async getAccount(id) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_getAccount',
+            method: rpc_handler_1.KeyringRpcMethod.GetAccount,
             params: { id },
         }), api_1.GetAccountResponseStruct);
     }
     async createAccount(options = {}) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_createAccount',
+            method: rpc_handler_1.KeyringRpcMethod.CreateAccount,
             params: { options },
         }), api_1.CreateAccountResponseStruct);
     }
     async filterAccountChains(id, chains) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_filterAccountChains',
+            method: rpc_handler_1.KeyringRpcMethod.FilterAccountChains,
             params: { id, chains },
         }), api_1.FilterAccountChainsResponseStruct);
     }
     async updateAccount(account) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_updateAccount',
+            method: rpc_handler_1.KeyringRpcMethod.UpdateAccount,
             params: { account },
         }), api_1.UpdateAccountResponseStruct);
     }
     async deleteAccount(id) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_deleteAccount',
+            method: rpc_handler_1.KeyringRpcMethod.DeleteAccount,
             params: { id },
         }), api_1.DeleteAccountResponseStruct);
     }
     async exportAccount(id) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_exportAccount',
+            method: rpc_handler_1.KeyringRpcMethod.ExportAccount,
             params: { id },
         }), api_1.ExportAccountResponseStruct);
     }
     async listRequests() {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_listRequests',
+            method: rpc_handler_1.KeyringRpcMethod.ListRequests,
         }), api_1.ListRequestsResponseStruct);
     }
     async getRequest(id) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_getRequest',
+            method: rpc_handler_1.KeyringRpcMethod.GetRequest,
             params: { id },
         }), api_1.GetRequestResponseStruct);
     }
     async submitRequest(request) {
         return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_submitRequest',
+            method: rpc_handler_1.KeyringRpcMethod.SubmitRequest,
             params: request,
         }), api_1.SubmitRequestResponseStruct);
     }
     async approveRequest(id, data = {}) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_approveRequest',
+            method: rpc_handler_1.KeyringRpcMethod.ApproveRequest,
             params: { id, data },
         }), api_1.ApproveRequestResponseStruct);
     }
     async rejectRequest(id) {
         (0, superstruct_1.assert)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
-            method: 'keyring_rejectRequest',
+            method: rpc_handler_1.KeyringRpcMethod.RejectRequest,
             params: { id },
         }), api_1.RejectRequestResponseStruct);
     }

package/dist/KeyringClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyringClient.js","sourceRoot":"","sources":["../src/KeyringClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,6CAAqC;AACrC,+BAAkC;AASlC,wCAawB;AAGxB,mCAAqC;AAMrC,MAAa,aAAa;IAGxB;;;;OAIG;IACH,YAAY,MAAc;;QAP1B,wCAAgB;QAQd,uBAAA,IAAI,yBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAkBD,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAsB;SAC/B,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,UAAgC,EAAE;QAElC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,MAAgB;QACpD,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,6BAA6B;YACrC,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;SACvB,CAAC,EACF,uCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAsB;SAC/B,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,oBAAoB;YAC5B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,OAA6B,EAAE;QAE/B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,wBAAwB;YAChC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;SACrB,CAAC,EACF,kCAA4B,CAC7B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,uBAAuB;YAC/B,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;CACF;AAtJD,sCAsJC;;AA1IC;;;;;GAKG;AACH,KAAK,8BACH,OAAoD;IAEpD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,IAAI,CAAC;QACvB,OAAO,EAAE,KAAK;QACd,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assert } from 'superstruct';\nimport { v4 as uuid } from 'uuid';\n\nimport type {\n  Keyring,\n  KeyringAccount,\n  KeyringRequest,\n  KeyringAccountData,\n  KeyringResponse,\n} from './api';\nimport {\n  ApproveRequestResponseStruct,\n  CreateAccountResponseStruct,\n  DeleteAccountResponseStruct,\n  ExportAccountResponseStruct,\n  FilterAccountChainsResponseStruct,\n  GetAccountResponseStruct,\n  GetRequestResponseStruct,\n  ListAccountsResponseStruct,\n  ListRequestsResponseStruct,\n  RejectRequestResponseStruct,\n  SubmitRequestResponseStruct,\n  UpdateAccountResponseStruct,\n} from './internal/api';\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport type { OmitUnion } from './utils';\nimport { strictMask } from './utils';\n\nexport type Sender = {\n  send(request: JsonRpcRequest): Promise<Json>;\n};\n\nexport class KeyringClient implements Keyring {\n  #sender: Sender;\n\n  /**\n   * Create a new instance of `KeyringClient`.\n   *\n   * @param sender - The `Sender` instance to use to send requests to the snap.\n   */\n  constructor(sender: Sender) {\n    this.#sender = sender;\n  }\n\n  /**\n   * Send a request to the snap and return the response.\n   *\n   * @param partial - A partial JSON-RPC request (method and params).\n   * @returns A promise that resolves to the response to the request.\n   */\n  async #send(\n    partial: OmitUnion<JsonRpcRequest, 'jsonrpc' | 'id'>,\n  ): Promise<Json> {\n    return this.#sender.send({\n      jsonrpc: '2.0',\n      id: uuid(),\n      ...partial,\n    });\n  }\n\n  async listAccounts(): Promise<KeyringAccount[]> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_listAccounts',\n      }),\n      ListAccountsResponseStruct,\n    );\n  }\n\n  async getAccount(id: string): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_getAccount',\n        params: { id },\n      }),\n      GetAccountResponseStruct,\n    );\n  }\n\n  async createAccount(\n    options: Record<string, Json> = {},\n  ): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_createAccount',\n        params: { options },\n      }),\n      CreateAccountResponseStruct,\n    );\n  }\n\n  async filterAccountChains(id: string, chains: string[]): Promise<string[]> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_filterAccountChains',\n        params: { id, chains },\n      }),\n      FilterAccountChainsResponseStruct,\n    );\n  }\n\n  async updateAccount(account: KeyringAccount): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_updateAccount',\n        params: { account },\n      }),\n      UpdateAccountResponseStruct,\n    );\n  }\n\n  async deleteAccount(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_deleteAccount',\n        params: { id },\n      }),\n      DeleteAccountResponseStruct,\n    );\n  }\n\n  async exportAccount(id: string): Promise<KeyringAccountData> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_exportAccount',\n        params: { id },\n      }),\n      ExportAccountResponseStruct,\n    );\n  }\n\n  async listRequests(): Promise<KeyringRequest[]> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_listRequests',\n      }),\n      ListRequestsResponseStruct,\n    );\n  }\n\n  async getRequest(id: string): Promise<KeyringRequest> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_getRequest',\n        params: { id },\n      }),\n      GetRequestResponseStruct,\n    );\n  }\n\n  async submitRequest(request: KeyringRequest): Promise<KeyringResponse> {\n    return strictMask(\n      await this.#send({\n        method: 'keyring_submitRequest',\n        params: request,\n      }),\n      SubmitRequestResponseStruct,\n    );\n  }\n\n  async approveRequest(\n    id: string,\n    data: Record<string, Json> = {},\n  ): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_approveRequest',\n        params: { id, data },\n      }),\n      ApproveRequestResponseStruct,\n    );\n  }\n\n  async rejectRequest(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: 'keyring_rejectRequest',\n        params: { id },\n      }),\n      RejectRequestResponseStruct,\n    );\n  }\n}\n"]}
+{"version":3,"file":"KeyringClient.js","sourceRoot":"","sources":["../src/KeyringClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,6CAAqC;AACrC,+BAAkC;AASlC,wCAawB;AAExB,+CAAiD;AACjD,mCAAqC;AAMrC,MAAa,aAAa;IAGxB;;;;OAIG;IACH,YAAY,MAAc;;QAP1B,wCAAgB;QAQd,uBAAA,IAAI,yBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAgBD,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,YAAY;SACtC,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,UAAU;YACnC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,UAAgC,EAAE;QAElC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,MAAgB;QACpD,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,mBAAmB;YAC5C,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;SACvB,CAAC,EACF,uCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,YAAY;SACtC,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,UAAU;YACnC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,OAA6B,EAAE;QAE/B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,cAAc;YACvC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;SACrB,CAAC,EACF,kCAA4B,CAC7B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,8BAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;CACF;AApJD,sCAoJC;;AAxIC;;;;;GAKG;AACH,KAAK,8BAAO,OAA+C;IACzD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,IAAI,CAAC;QACvB,OAAO,EAAE,KAAK;QACd,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assert } from 'superstruct';\nimport { v4 as uuid } from 'uuid';\n\nimport type {\n  Keyring,\n  KeyringAccount,\n  KeyringRequest,\n  KeyringAccountData,\n  KeyringResponse,\n} from './api';\nimport {\n  ApproveRequestResponseStruct,\n  CreateAccountResponseStruct,\n  DeleteAccountResponseStruct,\n  ExportAccountResponseStruct,\n  FilterAccountChainsResponseStruct,\n  GetAccountResponseStruct,\n  GetRequestResponseStruct,\n  ListAccountsResponseStruct,\n  ListRequestsResponseStruct,\n  RejectRequestResponseStruct,\n  SubmitRequestResponseStruct,\n  UpdateAccountResponseStruct,\n} from './internal/api';\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { KeyringRpcMethod } from './rpc-handler';\nimport { strictMask } from './utils';\n\nexport type Sender = {\n  send(request: JsonRpcRequest): Promise<Json>;\n};\n\nexport class KeyringClient implements Keyring {\n  #sender: Sender;\n\n  /**\n   * Create a new instance of `KeyringClient`.\n   *\n   * @param sender - The `Sender` instance to use to send requests to the snap.\n   */\n  constructor(sender: Sender) {\n    this.#sender = sender;\n  }\n\n  /**\n   * Send a request to the snap and return the response.\n   *\n   * @param partial - A partial JSON-RPC request (method and params).\n   * @returns A promise that resolves to the response to the request.\n   */\n  async #send(partial: Omit<JsonRpcRequest, 'jsonrpc' | 'id'>): Promise<Json> {\n    return this.#sender.send({\n      jsonrpc: '2.0',\n      id: uuid(),\n      ...partial,\n    });\n  }\n\n  async listAccounts(): Promise<KeyringAccount[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ListAccounts,\n      }),\n      ListAccountsResponseStruct,\n    );\n  }\n\n  async getAccount(id: string): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.GetAccount,\n        params: { id },\n      }),\n      GetAccountResponseStruct,\n    );\n  }\n\n  async createAccount(\n    options: Record<string, Json> = {},\n  ): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.CreateAccount,\n        params: { options },\n      }),\n      CreateAccountResponseStruct,\n    );\n  }\n\n  async filterAccountChains(id: string, chains: string[]): Promise<string[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.FilterAccountChains,\n        params: { id, chains },\n      }),\n      FilterAccountChainsResponseStruct,\n    );\n  }\n\n  async updateAccount(account: KeyringAccount): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.UpdateAccount,\n        params: { account },\n      }),\n      UpdateAccountResponseStruct,\n    );\n  }\n\n  async deleteAccount(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.DeleteAccount,\n        params: { id },\n      }),\n      DeleteAccountResponseStruct,\n    );\n  }\n\n  async exportAccount(id: string): Promise<KeyringAccountData> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ExportAccount,\n        params: { id },\n      }),\n      ExportAccountResponseStruct,\n    );\n  }\n\n  async listRequests(): Promise<KeyringRequest[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ListRequests,\n      }),\n      ListRequestsResponseStruct,\n    );\n  }\n\n  async getRequest(id: string): Promise<KeyringRequest> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.GetRequest,\n        params: { id },\n      }),\n      GetRequestResponseStruct,\n    );\n  }\n\n  async submitRequest(request: KeyringRequest): Promise<KeyringResponse> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.SubmitRequest,\n        params: request,\n      }),\n      SubmitRequestResponseStruct,\n    );\n  }\n\n  async approveRequest(\n    id: string,\n    data: Record<string, Json> = {},\n  ): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.ApproveRequest,\n        params: { id, data },\n      }),\n      ApproveRequestResponseStruct,\n    );\n  }\n\n  async rejectRequest(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.RejectRequest,\n        params: { id },\n      }),\n      RejectRequestResponseStruct,\n    );\n  }\n}\n"]}

package/dist/api.d.ts

@@ -20,11 +20,11 @@ export declare enum EthAccountType {
     Eip4337 = "eip155:eip4337"
 }
 export declare const KeyringAccountStruct: import("superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:eip4337";
     id: string;
     address: string;
     options: Record<string, Json>;
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-    type: "eip155:eoa" | "eip155:eip4337";
 }, {
     /**
      * Account ID (UUIDv4).
@@ -70,9 +70,7 @@ export declare const KeyringRequestStruct: import("superstruct").Struct<{
     account: string;
     request: {
         method: string;
-    } | {
-        method: string;
-        params: Json[] | Record<string, Json>;
+        params?: Json[] | Record<string, Json>;
     };
 }, {
     /**
@@ -92,10 +90,11 @@ export declare const KeyringRequestStruct: import("superstruct").Struct<{
      */
     request: import("superstruct").Struct<{
         method: string;
-    } | {
-        method: string;
-        params: Json[] | Record<string, Json>;
-    }, null>;
+        params?: Json[] | Record<string, Json>;
+    }, {
+        method: import("superstruct").Struct<string, null>;
+        params: import("superstruct").Struct<import("./superstruct").ExactOptionalTag | Json[] | Record<string, Json>, null>;
+    }>;
 }>;
 /**
  * Keyring request.
@@ -112,7 +111,10 @@ export declare const KeyringAccountDataStruct: import("superstruct").Struct<Reco
 export declare type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;
 export declare const KeyringResponseStruct: import("superstruct").Struct<{
     pending: true;
-    redirect: string | null;
+    redirect?: {
+        message?: string;
+        url?: string;
+    };
 } | {
     pending: false;
     result: Json;
@@ -124,10 +126,10 @@ export declare const KeyringResponseStruct: import("superstruct").Struct<{
  * request will be handled asynchronously. Otherwise, the response must contain
  * the result of the request and `pending: false`.
  *
- * In the asynchronous case, the keyring can return a redirect URL to be shown
- * to the user. The user can choose to follow the link or cancel the request.
- * The main use case for this is to redirect the user to a third-party service
- * to approve the request.
+ * In the asynchronous case, the keyring can return a redirect URL and message
+ * to be shown to the user. The user can choose to follow the link or cancel
+ * the request. The main use case for this is to redirect the user to the snap
+ * dapp to review the request.
  */
 export declare type KeyringResponse = Infer<typeof KeyringResponseStruct>;
 /**

package/dist/api.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringResponseStruct = exports.KeyringAccountDataStruct = exports.KeyringRequestStruct = exports.KeyringAccountStruct = exports.EthAccountType = exports.EthMethod = void 0;
 const utils_1 = require("@metamask/utils");
 const superstruct_1 = require("superstruct");
+const superstruct_2 = require("./superstruct");
 const utils_2 = require("./utils");
 /**
  * Supported Ethereum methods.
@@ -25,7 +26,7 @@ var EthAccountType;
     EthAccountType["Eoa"] = "eip155:eoa";
     EthAccountType["Eip4337"] = "eip155:eip4337";
 })(EthAccountType = exports.EthAccountType || (exports.EthAccountType = {}));
-exports.KeyringAccountStruct = (0, superstruct_1.object)({
+exports.KeyringAccountStruct = (0, superstruct_2.object)({
     /**
      * Account ID (UUIDv4).
      */
@@ -55,7 +56,7 @@ exports.KeyringAccountStruct = (0, superstruct_1.object)({
      */
     type: (0, superstruct_1.enums)([`${EthAccountType.Eoa}`, `${EthAccountType.Eip4337}`]),
 });
-exports.KeyringRequestStruct = (0, superstruct_1.object)({
+exports.KeyringRequestStruct = (0, superstruct_2.object)({
     /**
      * Keyring request ID (UUIDv4).
      */
@@ -71,19 +72,14 @@ exports.KeyringRequestStruct = (0, superstruct_1.object)({
     /**
      * Inner request sent by the client application.
      */
-    request: (0, superstruct_1.union)([
-        (0, superstruct_1.object)({
-            method: (0, superstruct_1.string)(),
-        }),
-        (0, superstruct_1.object)({
-            method: (0, superstruct_1.string)(),
-            params: (0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)]),
-        }),
-    ]),
+    request: (0, superstruct_2.object)({
+        method: (0, superstruct_1.string)(),
+        params: (0, superstruct_2.exactOptional)((0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)])),
+    }),
 });
 exports.KeyringAccountDataStruct = (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct);
 exports.KeyringResponseStruct = (0, superstruct_1.union)([
-    (0, superstruct_1.object)({
+    (0, superstruct_2.object)({
         /**
          * Pending flag.
          *
@@ -99,9 +95,12 @@ exports.KeyringResponseStruct = (0, superstruct_1.union)([
          * with a link to the redirect URL. The user can choose to follow the link
          * or cancel the request.
          */
-        redirect: (0, superstruct_1.nullable)((0, superstruct_1.string)()),
+        redirect: (0, superstruct_2.exactOptional)((0, superstruct_2.object)({
+            message: (0, superstruct_2.exactOptional)((0, superstruct_1.string)()),
+            url: (0, superstruct_2.exactOptional)((0, superstruct_1.string)()),
+        })),
     }),
-    (0, superstruct_1.object)({
+    (0, superstruct_2.object)({
         /**
          * Pending flag.
          *

package/dist/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,2CAA6C;AAE7C,6CASqB;AAErB,mCAAqC;AAErC;;GAEG;AACH,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,2CAA8B,CAAA;IAC9B,8BAAiB,CAAA;IACjB,oDAAuC,CAAA;IACvC,gDAAmC,CAAA;IACnC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;AAC1C,CAAC,EARW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAQpB;AAED;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,oCAAkB,CAAA;IAClB,4CAA0B,CAAA;AAC5B,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAEY,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EACZ,IAAA,mBAAK,EAAC;QACJ,GAAG,SAAS,CAAC,YAAY,EAAE;QAC3B,GAAG,SAAS,CAAC,IAAI,EAAE;QACnB,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,aAAa,EAAE;QAC5B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;KAC/B,CAAC,CACH;IAED;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,GAAG,cAAc,CAAC,GAAG,EAAE,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;CACpE,CAAC,CAAC;AASU,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,KAAK,EAAE,IAAA,oBAAM,GAAE;IAEf;;OAEG;IACH,OAAO,EAAE,kBAAU;IAEnB;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EAAC;QACb,IAAA,oBAAM,EAAC;YACL,MAAM,EAAE,IAAA,oBAAM,GAAE;SACjB,CAAC;QACF,IAAA,oBAAM,EAAC;YACL,MAAM,EAAE,IAAA,oBAAM,GAAE;YAChB,MAAM,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;SACjE,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AASU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;AASxD,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC;QAEtB;;;;;;WAMG;QACH,QAAQ,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;KAC7B,CAAC;IACF,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n  array,\n  enums,\n  literal,\n  object,\n  record,\n  string,\n  union,\n  nullable,\n} from 'superstruct';\n\nimport { UuidStruct } from './utils';\n\n/**\n * Supported Ethereum methods.\n */\nexport enum EthMethod {\n  PersonalSign = 'personal_sign',\n  Sign = 'eth_sign',\n  SignTransaction = 'eth_signTransaction',\n  SignTypedData = 'eth_signTypedData',\n  SignTypedDataV1 = 'eth_signTypedData_v1',\n  SignTypedDataV3 = 'eth_signTypedData_v3',\n  SignTypedDataV4 = 'eth_signTypedData_v4',\n}\n\n/**\n * Supported Ethereum account types.\n */\nexport enum EthAccountType {\n  Eoa = 'eip155:eoa',\n  Eip4337 = 'eip155:eip4337',\n}\n\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Account address or next receive address (UTXO).\n   */\n  address: string(),\n\n  /**\n   * Keyring-dependent account options.\n   */\n  options: record(string(), JsonStruct),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTransaction}`,\n      `${EthMethod.SignTypedData}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n    ]),\n  ),\n\n  /**\n   * Account type.\n   */\n  type: enums([`${EthAccountType.Eoa}`, `${EthAccountType.Eip4337}`]),\n});\n\n/**\n * Account object.\n *\n * Represents an account with its properties and capabilities.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n\nexport const KeyringRequestStruct = object({\n  /**\n   * Keyring request ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Request's scope (CAIP-2 chain ID).\n   */\n  scope: string(),\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Inner request sent by the client application.\n   */\n  request: union([\n    object({\n      method: string(),\n    }),\n    object({\n      method: string(),\n      params: union([array(JsonStruct), record(string(), JsonStruct)]),\n    }),\n  ]),\n});\n\n/**\n * Keyring request.\n *\n * Represents a request made to the keyring for account-related operations.\n */\nexport type KeyringRequest = Infer<typeof KeyringRequestStruct>;\n\nexport const KeyringAccountDataStruct = record(string(), JsonStruct);\n\n/**\n * Response to a call to `exportAccount`.\n *\n * The exact response depends on the keyring implementation.\n */\nexport type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;\n\nexport const KeyringResponseStruct = union([\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to true indicates that the request will be\n     * handled asynchronously. The keyring must be called with `approveRequest`\n     * or `rejectRequest` to resolve the request.\n     */\n    pending: literal(true),\n\n    /**\n     * Redirect URL.\n     *\n     * If present in the response, MetaMask will display a confirmation dialog\n     * with a link to the redirect URL. The user can choose to follow the link\n     * or cancel the request.\n     */\n    redirect: nullable(string()),\n  }),\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to false indicates that the request will be\n     * handled synchronously. The keyring must return the result of the\n     * request execution.\n     */\n    pending: literal(false),\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n]);\n\n/**\n * Response to a call to `submitRequest`.\n *\n * Keyring implementations must return a response with `pending: true` if the\n * request will be handled asynchronously. Otherwise, the response must contain\n * the result of the request and `pending: false`.\n *\n * In the asynchronous case, the keyring can return a redirect URL to be shown\n * to the user. The user can choose to follow the link or cancel the request.\n * The main use case for this is to redirect the user to a third-party service\n * to approve the request.\n */\nexport type KeyringResponse = Infer<typeof KeyringResponseStruct>;\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional).\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,2CAA6C;AAE7C,6CAA2E;AAE3E,+CAAsD;AACtD,mCAAqC;AAErC;;GAEG;AACH,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,2CAA8B,CAAA;IAC9B,8BAAiB,CAAA;IACjB,oDAAuC,CAAA;IACvC,gDAAmC,CAAA;IACnC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;AAC1C,CAAC,EARW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAQpB;AAED;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,oCAAkB,CAAA;IAClB,4CAA0B,CAAA;AAC5B,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAEY,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EACZ,IAAA,mBAAK,EAAC;QACJ,GAAG,SAAS,CAAC,YAAY,EAAE;QAC3B,GAAG,SAAS,CAAC,IAAI,EAAE;QACnB,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,aAAa,EAAE;QAC5B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;KAC/B,CAAC,CACH;IAED;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,GAAG,cAAc,CAAC,GAAG,EAAE,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;CACpE,CAAC,CAAC;AASU,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,KAAK,EAAE,IAAA,oBAAM,GAAE;IAEf;;OAEG;IACH,OAAO,EAAE,kBAAU;IAEnB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC;QACd,MAAM,EAAE,IAAA,oBAAM,GAAE;QAChB,MAAM,EAAE,IAAA,2BAAa,EACnB,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC,CACzD;KACF,CAAC;CACH,CAAC,CAAC;AASU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;AASxD,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC;QAEtB;;;;;;WAMG;QACH,QAAQ,EAAE,IAAA,2BAAa,EACrB,IAAA,oBAAM,EAAC;YACL,OAAO,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;YAChC,GAAG,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;SAC7B,CAAC,CACH;KACF,CAAC;IACF,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport { array, enums, literal, record, string, union } from 'superstruct';\n\nimport { exactOptional, object } from './superstruct';\nimport { UuidStruct } from './utils';\n\n/**\n * Supported Ethereum methods.\n */\nexport enum EthMethod {\n  PersonalSign = 'personal_sign',\n  Sign = 'eth_sign',\n  SignTransaction = 'eth_signTransaction',\n  SignTypedData = 'eth_signTypedData',\n  SignTypedDataV1 = 'eth_signTypedData_v1',\n  SignTypedDataV3 = 'eth_signTypedData_v3',\n  SignTypedDataV4 = 'eth_signTypedData_v4',\n}\n\n/**\n * Supported Ethereum account types.\n */\nexport enum EthAccountType {\n  Eoa = 'eip155:eoa',\n  Eip4337 = 'eip155:eip4337',\n}\n\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Account address or next receive address (UTXO).\n   */\n  address: string(),\n\n  /**\n   * Keyring-dependent account options.\n   */\n  options: record(string(), JsonStruct),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTransaction}`,\n      `${EthMethod.SignTypedData}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n    ]),\n  ),\n\n  /**\n   * Account type.\n   */\n  type: enums([`${EthAccountType.Eoa}`, `${EthAccountType.Eip4337}`]),\n});\n\n/**\n * Account object.\n *\n * Represents an account with its properties and capabilities.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n\nexport const KeyringRequestStruct = object({\n  /**\n   * Keyring request ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Request's scope (CAIP-2 chain ID).\n   */\n  scope: string(),\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Inner request sent by the client application.\n   */\n  request: object({\n    method: string(),\n    params: exactOptional(\n      union([array(JsonStruct), record(string(), JsonStruct)]),\n    ),\n  }),\n});\n\n/**\n * Keyring request.\n *\n * Represents a request made to the keyring for account-related operations.\n */\nexport type KeyringRequest = Infer<typeof KeyringRequestStruct>;\n\nexport const KeyringAccountDataStruct = record(string(), JsonStruct);\n\n/**\n * Response to a call to `exportAccount`.\n *\n * The exact response depends on the keyring implementation.\n */\nexport type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;\n\nexport const KeyringResponseStruct = union([\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to true indicates that the request will be\n     * handled asynchronously. The keyring must be called with `approveRequest`\n     * or `rejectRequest` to resolve the request.\n     */\n    pending: literal(true),\n\n    /**\n     * Redirect URL.\n     *\n     * If present in the response, MetaMask will display a confirmation dialog\n     * with a link to the redirect URL. The user can choose to follow the link\n     * or cancel the request.\n     */\n    redirect: exactOptional(\n      object({\n        message: exactOptional(string()),\n        url: exactOptional(string()),\n      }),\n    ),\n  }),\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to false indicates that the request will be\n     * handled synchronously. The keyring must return the result of the\n     * request execution.\n     */\n    pending: literal(false),\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n]);\n\n/**\n * Response to a call to `submitRequest`.\n *\n * Keyring implementations must return a response with `pending: true` if the\n * request will be handled asynchronously. Otherwise, the response must contain\n * the result of the request and `pending: false`.\n *\n * In the asynchronous case, the keyring can return a redirect URL and message\n * to be shown to the user. The user can choose to follow the link or cancel\n * the request. The main use case for this is to redirect the user to the snap\n * dapp to review the request.\n */\nexport type KeyringResponse = Infer<typeof KeyringResponseStruct>;\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional).\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}

package/dist/index.d.ts

@@ -4,3 +4,5 @@ export * from './rpc-handler';
 export * from './KeyringSnapControllerClient';
 export * from './KeyringSnapRpcClient';
 export * from './internal';
+export * from './snap-utils';
+export * from './superstruct';

package/dist/index.js

@@ -20,4 +20,6 @@ __exportStar(require("./rpc-handler"), exports);
 __exportStar(require("./KeyringSnapControllerClient"), exports);
 __exportStar(require("./KeyringSnapRpcClient"), exports);
 __exportStar(require("./internal"), exports);
+__exportStar(require("./snap-utils"), exports);
+__exportStar(require("./superstruct"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,kDAAgC;AAChC,gDAA8B;AAC9B,gEAA8C;AAC9C,yDAAuC;AACvC,6CAA2B","sourcesContent":["export * from './api';\nexport * from './KeyringClient';\nexport * from './rpc-handler';\nexport * from './KeyringSnapControllerClient';\nexport * from './KeyringSnapRpcClient';\nexport * from './internal';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,kDAAgC;AAChC,gDAA8B;AAC9B,gEAA8C;AAC9C,yDAAuC;AACvC,6CAA2B;AAC3B,+CAA6B;AAC7B,gDAA8B","sourcesContent":["export * from './api';\nexport * from './KeyringClient';\nexport * from './rpc-handler';\nexport * from './KeyringSnapControllerClient';\nexport * from './KeyringSnapRpcClient';\nexport * from './internal';\nexport * from './snap-utils';\nexport * from './superstruct';\n"]}

package/dist/internal/api.d.ts

@@ -10,17 +10,17 @@ export declare const ListAccountsRequestStruct: import("superstruct").Struct<{
 }>;
 export declare type ListAccountsRequest = Infer<typeof ListAccountsRequestStruct>;
 export declare const ListAccountsResponseStruct: import("superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:eip4337";
     id: string;
     address: string;
     options: Record<string, import("@metamask/utils").Json>;
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-    type: "eip155:eoa" | "eip155:eip4337";
 }[], import("superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:eip4337";
     id: string;
     address: string;
     options: Record<string, import("@metamask/utils").Json>;
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-    type: "eip155:eoa" | "eip155:eip4337";
 }, {
     id: import("superstruct").Struct<string, null>;
     address: import("superstruct").Struct<string, null>;
@@ -59,11 +59,11 @@ export declare const GetAccountRequestStruct: import("superstruct").Struct<{
 }>;
 export declare type GetAccountRequest = Infer<typeof GetAccountRequestStruct>;
 export declare const GetAccountResponseStruct: import("superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:eip4337";
     id: string;
     address: string;
     options: Record<string, import("@metamask/utils").Json>;
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-    type: "eip155:eoa" | "eip155:eip4337";
 }, {
     id: import("superstruct").Struct<string, null>;
     address: import("superstruct").Struct<string, null>;
@@ -102,11 +102,11 @@ export declare const CreateAccountRequestStruct: import("superstruct").Struct<{
 }>;
 export declare type CreateAccountRequest = Infer<typeof CreateAccountRequestStruct>;
 export declare const CreateAccountResponseStruct: import("superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:eip4337";
     id: string;
     address: string;
     options: Record<string, import("@metamask/utils").Json>;
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-    type: "eip155:eoa" | "eip155:eip4337";
 }, {
     id: import("superstruct").Struct<string, null>;
     address: import("superstruct").Struct<string, null>;
@@ -155,30 +155,30 @@ export declare const UpdateAccountRequestStruct: import("superstruct").Struct<{
     method: "keyring_updateAccount";
     params: {
         account: {
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         };
     };
 }, {
     method: import("superstruct").Struct<"keyring_updateAccount", "keyring_updateAccount">;
     params: import("superstruct").Struct<{
         account: {
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         };
     }, {
         account: import("superstruct").Struct<{
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         }, {
             id: import("superstruct").Struct<string, null>;
             address: import("superstruct").Struct<string, null>;
@@ -260,9 +260,7 @@ export declare const ListRequestsResponseStruct: import("superstruct").Struct<{
     account: string;
     request: {
         method: string;
-    } | {
-        method: string;
-        params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+        params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
     };
 }[], import("superstruct").Struct<{
     id: string;
@@ -270,9 +268,7 @@ export declare const ListRequestsResponseStruct: import("superstruct").Struct<{
     account: string;
     request: {
         method: string;
-    } | {
-        method: string;
-        params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+        params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
     };
 }, {
     id: import("superstruct").Struct<string, null>;
@@ -280,10 +276,11 @@ export declare const ListRequestsResponseStruct: import("superstruct").Struct<{
     account: import("superstruct").Struct<string, null>;
     request: import("superstruct").Struct<{
         method: string;
-    } | {
-        method: string;
-        params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
-    }, null>;
+        params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+    }, {
+        method: import("superstruct").Struct<string, null>;
+        params: import("superstruct").Struct<import("..").ExactOptionalTag | import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>, null>;
+    }>;
 }>>;
 export declare type ListRequestsResponse = Infer<typeof ListRequestsResponseStruct>;
 export declare const GetRequestRequestStruct: import("superstruct").Struct<{
@@ -310,9 +307,7 @@ export declare const GetRequestResponseStruct: import("superstruct").Struct<{
     account: string;
     request: {
         method: string;
-    } | {
-        method: string;
-        params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+        params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
     };
 }, {
     id: import("superstruct").Struct<string, null>;
@@ -320,10 +315,11 @@ export declare const GetRequestResponseStruct: import("superstruct").Struct<{
     account: import("superstruct").Struct<string, null>;
     request: import("superstruct").Struct<{
         method: string;
-    } | {
-        method: string;
-        params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
-    }, null>;
+        params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+    }, {
+        method: import("superstruct").Struct<string, null>;
+        params: import("superstruct").Struct<import("..").ExactOptionalTag | import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>, null>;
+    }>;
 }>;
 export declare type GetRequestResponse = Infer<typeof GetRequestResponseStruct>;
 export declare const SubmitRequestRequestStruct: import("superstruct").Struct<{
@@ -336,9 +332,7 @@ export declare const SubmitRequestRequestStruct: import("superstruct").Struct<{
         account: string;
         request: {
             method: string;
-        } | {
-            method: string;
-            params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+            params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
         };
     };
 }, {
@@ -349,9 +343,7 @@ export declare const SubmitRequestRequestStruct: import("superstruct").Struct<{
         account: string;
         request: {
             method: string;
-        } | {
-            method: string;
-            params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+            params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
         };
     }, {
         id: import("superstruct").Struct<string, null>;
@@ -359,10 +351,11 @@ export declare const SubmitRequestRequestStruct: import("superstruct").Struct<{
         account: import("superstruct").Struct<string, null>;
         request: import("superstruct").Struct<{
             method: string;
-        } | {
-            method: string;
-            params: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
-        }, null>;
+            params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+        }, {
+            method: import("superstruct").Struct<string, null>;
+            params: import("superstruct").Struct<import("..").ExactOptionalTag | import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>, null>;
+        }>;
     }>;
     jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
     id: import("superstruct").Struct<string, null>;
@@ -370,7 +363,10 @@ export declare const SubmitRequestRequestStruct: import("superstruct").Struct<{
 export declare type SubmitRequestRequest = Infer<typeof SubmitRequestRequestStruct>;
 export declare const SubmitRequestResponseStruct: import("superstruct").Struct<{
     pending: true;
-    redirect: string | null;
+    redirect?: {
+        message?: string;
+        url?: string;
+    };
 } | {
     pending: false;
     result: import("@metamask/utils").Json;

package/dist/internal/events.d.ts

@@ -2,39 +2,37 @@ export declare const AccountCreatedEventStruct: import("superstruct").Struct<{
     method: "event:accountCreated";
     params: {
         account: {
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         };
     };
 }, {
     method: import("superstruct").Struct<"event:accountCreated", "event:accountCreated">;
     params: import("superstruct").Struct<{
         account: {
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         };
     }, {
         /**
          * New account object.
          */
         account: import("superstruct").Struct<{
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         }, {
             id: import("superstruct").Struct<string, null>;
             address: import("superstruct").Struct<string, null>;
-            options: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>; /**
-             * Request result.
-             */
+            options: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
             methods: import("superstruct").Struct<("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], import("superstruct").Struct<"personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
                 personal_sign: "personal_sign";
                 eth_sign: "eth_sign";
@@ -55,39 +53,37 @@ export declare const AccountUpdatedEventStruct: import("superstruct").Struct<{
     method: "event:accountUpdated";
     params: {
         account: {
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         };
     };
 }, {
     method: import("superstruct").Struct<"event:accountUpdated", "event:accountUpdated">;
     params: import("superstruct").Struct<{
         account: {
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         };
     }, {
         /**
          * Updated account object.
          */
         account: import("superstruct").Struct<{
+            type: "eip155:eoa" | "eip155:eip4337";
             id: string;
             address: string;
             options: Record<string, import("@metamask/utils").Json>;
             methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-            type: "eip155:eoa" | "eip155:eip4337";
         }, {
             id: import("superstruct").Struct<string, null>;
             address: import("superstruct").Struct<string, null>;
-            options: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>; /**
-             * Request result.
-             */
+            options: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
             methods: import("superstruct").Struct<("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], import("superstruct").Struct<"personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
                 personal_sign: "personal_sign";
                 eth_sign: "eth_sign";

package/dist/internal/types.d.ts

@@ -1,10 +1,10 @@
 import type { Infer } from 'superstruct';
 export declare const InternalAccountStruct: import("superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:eip4337";
     id: string;
     address: string;
     options: Record<string, import("@metamask/utils").Json>;
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-    type: "eip155:eoa" | "eip155:eip4337";
     metadata: {
         name: string;
         keyring: {
@@ -14,8 +14,8 @@ export declare const InternalAccountStruct: import("superstruct").Struct<{
             id: string;
             enabled: boolean;
             name: string;
-        } | undefined;
-        lastSelected?: number | undefined;
+        };
+        lastSelected?: number;
     };
 }, {
     metadata: import("superstruct").Struct<{
@@ -27,20 +27,20 @@ export declare const InternalAccountStruct: import("superstruct").Struct<{
             id: string;
             enabled: boolean;
             name: string;
-        } | undefined;
-        lastSelected?: number | undefined;
+        };
+        lastSelected?: number;
     }, {
-        snap: import("superstruct").Struct<{
+        name: import("superstruct").Struct<string, null>;
+        snap: import("superstruct").Struct<import("../superstruct").ExactOptionalTag | {
             id: string;
             enabled: boolean;
             name: string;
-        } | undefined, {
+        }, {
             id: import("superstruct").Struct<string, null>;
             enabled: import("superstruct").Struct<boolean, null>;
             name: import("superstruct").Struct<string, null>;
         }>;
-        name: import("superstruct").Struct<string, null>;
-        lastSelected: import("superstruct").Struct<number | undefined, null>;
+        lastSelected: import("superstruct").Struct<number | import("../superstruct").ExactOptionalTag, null>;
         keyring: import("superstruct").Struct<{
             type: string;
         }, {

package/dist/internal/types.js

@@ -3,17 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalAccountStruct = void 0;
 const superstruct_1 = require("superstruct");
 const api_1 = require("../api");
-exports.InternalAccountStruct = (0, superstruct_1.object)({
+const superstruct_2 = require("../superstruct");
+exports.InternalAccountStruct = (0, superstruct_2.object)({
     ...api_1.KeyringAccountStruct.schema,
-    metadata: (0, superstruct_1.object)({
-        snap: (0, superstruct_1.optional)((0, superstruct_1.object)({
+    metadata: (0, superstruct_2.object)({
+        name: (0, superstruct_1.string)(),
+        snap: (0, superstruct_2.exactOptional)((0, superstruct_2.object)({
             id: (0, superstruct_1.string)(),
             enabled: (0, superstruct_1.boolean)(),
             name: (0, superstruct_1.string)(),
         })),
-        name: (0, superstruct_1.string)(),
-        lastSelected: (0, superstruct_1.optional)((0, superstruct_1.number)()),
-        keyring: (0, superstruct_1.object)({
+        lastSelected: (0, superstruct_2.exactOptional)((0, superstruct_1.number)()),
+        keyring: (0, superstruct_2.object)({
             type: (0, superstruct_1.string)(),
         }),
     }),

package/dist/internal/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":";;;AACA,6CAAwE;AAExE,gCAA8C;AAEjC,QAAA,qBAAqB,GAAG,IAAA,oBAAM,EAAC;IAC1C,GAAG,0BAAoB,CAAC,MAAM;IAC9B,QAAQ,EAAE,IAAA,oBAAM,EAAC;QACf,IAAI,EAAE,IAAA,sBAAQ,EACZ,IAAA,oBAAM,EAAC;YACL,EAAE,EAAE,IAAA,oBAAM,GAAE;YACZ,OAAO,EAAE,IAAA,qBAAO,GAAE;YAClB,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC,CACH;QACD,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd,YAAY,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;QAChC,OAAO,EAAE,IAAA,oBAAM,EAAC;YACd,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Infer } from 'superstruct';\nimport { boolean, object, optional, string, number } from 'superstruct';\n\nimport { KeyringAccountStruct } from '../api';\n\nexport const InternalAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n  metadata: object({\n    snap: optional(\n      object({\n        id: string(),\n        enabled: boolean(),\n        name: string(),\n      }),\n    ),\n    name: string(),\n    lastSelected: optional(number()),\n    keyring: object({\n      type: string(),\n    }),\n  }),\n});\n\n/**\n * Internal account representation.\n *\n * This type is used internally by MetaMask to add additional metadata to the\n * account object. It's should not be used by external applications.\n */\nexport type InternalAccount = Infer<typeof InternalAccountStruct>;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":";;;AACA,6CAAsD;AAEtD,gCAA8C;AAC9C,gDAAuD;AAE1C,QAAA,qBAAqB,GAAG,IAAA,oBAAM,EAAC;IAC1C,GAAG,0BAAoB,CAAC,MAAM;IAC9B,QAAQ,EAAE,IAAA,oBAAM,EAAC;QACf,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd,IAAI,EAAE,IAAA,2BAAa,EACjB,IAAA,oBAAM,EAAC;YACL,EAAE,EAAE,IAAA,oBAAM,GAAE;YACZ,OAAO,EAAE,IAAA,qBAAO,GAAE;YAClB,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC,CACH;QACD,YAAY,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QACrC,OAAO,EAAE,IAAA,oBAAM,EAAC;YACd,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Infer } from 'superstruct';\nimport { boolean, string, number } from 'superstruct';\n\nimport { KeyringAccountStruct } from '../api';\nimport { exactOptional, object } from '../superstruct';\n\nexport const InternalAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n  metadata: object({\n    name: string(),\n    snap: exactOptional(\n      object({\n        id: string(),\n        enabled: boolean(),\n        name: string(),\n      }),\n    ),\n    lastSelected: exactOptional(number()),\n    keyring: object({\n      type: string(),\n    }),\n  }),\n});\n\n/**\n * Internal account representation.\n *\n * This type is used internally by MetaMask to add additional metadata to the\n * account object. It's should not be used by external applications.\n */\nexport type InternalAccount = Infer<typeof InternalAccountStruct>;\n"]}

package/dist/superstruct.d.ts

@@ -0,0 +1,58 @@
+import type { Infer } from 'superstruct';
+import { Struct } from 'superstruct';
+import type { ObjectSchema, OmitBy, Optionalize, PickBy, Simplify } from 'superstruct/dist/utils';
+declare const ExactOptionalSymbol: unique symbol;
+export declare type ExactOptionalTag = {
+    type: typeof ExactOptionalSymbol;
+};
+/**
+ * Exclude type `Type` from the properties of `Obj`.
+ *
+ * ```ts
+ * type Foo = { a: string | null; b: number };
+ * type Bar = ExcludeType<Foo, null>;
+ * // Bar = { a: string, b: number }
+ * ```
+ */
+export declare type ExcludeType<Obj, Type> = {
+    [K in keyof Obj]: Exclude<Obj[K], Type>;
+};
+/**
+ * Make optional all properties that have the `ExactOptionalTag` type.
+ *
+ * ```ts
+ * type Foo = { a: string | ExactOptionalTag; b: number};
+ * type Bar = ExactOptionalize<Foo>;
+ * // Bar = { a?: string; b: number}
+ * ```
+ */
+export declare type ExactOptionalize<Schema extends object> = OmitBy<Schema, ExactOptionalTag> & Partial<ExcludeType<PickBy<Schema, ExactOptionalTag>, ExactOptionalTag>>;
+/**
+ * Infer a type from an superstruct object schema.
+ */
+export declare type ObjectType<Schema extends ObjectSchema> = Simplify<ExactOptionalize<Optionalize<{
+    [K in keyof Schema]: Infer<Schema[K]>;
+}>>>;
+/**
+ * Change the return type of a superstruct object struct to support exact
+ * optional properties.
+ *
+ * @param schema - The object schema.
+ * @returns A struct representing an object with a known set of properties.
+ */
+export declare function object<Schema extends ObjectSchema>(schema: Schema): Struct<ObjectType<Schema>, Schema>;
+/**
+ * Augment a struct to allow exact-optional values. Exact-optional values can
+ * be omitted but cannot be `undefined`.
+ *
+ * ```ts
+ * const foo = object({ bar: exactOptional(string()) });
+ * type Foo = Infer<typeof foo>;
+ * // Foo = { bar?: string }
+ * ```
+ *
+ * @param struct - The struct to augment.
+ * @returns The augmented struct.
+ */
+export declare function exactOptional<Type, Schema>(struct: Struct<Type, Schema>): Struct<Type | ExactOptionalTag, Schema>;
+export {};

package/dist/superstruct.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exactOptional = exports.object = void 0;
+const superstruct_1 = require("superstruct");
+/**
+ * Change the return type of a superstruct object struct to support exact
+ * optional properties.
+ *
+ * @param schema - The object schema.
+ * @returns A struct representing an object with a known set of properties.
+ */
+function object(schema) {
+    return (0, superstruct_1.object)(schema);
+}
+exports.object = object;
+/**
+ * Check if the current property is present in its parent object.
+ *
+ * @param ctx - The context to check.
+ * @returns `true` if the property is present, `false` otherwise.
+ */
+function hasOptional(ctx) {
+    const property = ctx.path[ctx.path.length - 1];
+    const parent = ctx.branch[ctx.branch.length - 2];
+    return property in parent;
+}
+/**
+ * Augment a struct to allow exact-optional values. Exact-optional values can
+ * be omitted but cannot be `undefined`.
+ *
+ * ```ts
+ * const foo = object({ bar: exactOptional(string()) });
+ * type Foo = Infer<typeof foo>;
+ * // Foo = { bar?: string }
+ * ```
+ *
+ * @param struct - The struct to augment.
+ * @returns The augmented struct.
+ */
+function exactOptional(struct) {
+    return new superstruct_1.Struct({
+        ...struct,
+        validator: (value, ctx) => !hasOptional(ctx) || struct.validator(value, ctx),
+        refiner: (value, ctx) => !hasOptional(ctx) || struct.refiner(value, ctx),
+    });
+}
+exports.exactOptional = exactOptional;
+//# sourceMappingURL=superstruct.js.map

package/dist/superstruct.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"superstruct.js","sourceRoot":"","sources":["../src/superstruct.ts"],"names":[],"mappings":";;;AACA,6CAAyD;AAkDzD;;;;;;GAMG;AACH,SAAgB,MAAM,CACpB,MAAc;IAEd,OAAO,IAAA,oBAAQ,EAAC,MAAM,CAAQ,CAAC;AACjC,CAAC;AAJD,wBAIC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,GAAY;IAC/B,MAAM,QAAQ,GAAW,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvD,MAAM,MAAM,GAA4B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE1E,OAAO,QAAQ,IAAI,MAAM,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,MAA4B;IAE5B,OAAO,IAAI,oBAAM,CAAC;QAChB,GAAG,MAAM;QAET,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACxB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;QAEnD,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACtB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAa,EAAE,GAAG,CAAC;KAC1D,CAAC,CAAC;AACL,CAAC;AAZD,sCAYC","sourcesContent":["import type { Infer, Context } from 'superstruct';\nimport { Struct, object as stObject } from 'superstruct';\nimport type {\n  ObjectSchema,\n  OmitBy,\n  Optionalize,\n  PickBy,\n  Simplify,\n} from 'superstruct/dist/utils';\n\ndeclare const ExactOptionalSymbol: unique symbol;\n\nexport type ExactOptionalTag = {\n  type: typeof ExactOptionalSymbol;\n};\n\n/**\n * Exclude type `Type` from the properties of `Obj`.\n *\n * ```ts\n * type Foo = { a: string | null; b: number };\n * type Bar = ExcludeType<Foo, null>;\n * // Bar = { a: string, b: number }\n * ```\n */\nexport type ExcludeType<Obj, Type> = {\n  [K in keyof Obj]: Exclude<Obj[K], Type>;\n};\n\n/**\n * Make optional all properties that have the `ExactOptionalTag` type.\n *\n * ```ts\n * type Foo = { a: string | ExactOptionalTag; b: number};\n * type Bar = ExactOptionalize<Foo>;\n * // Bar = { a?: string; b: number}\n * ```\n */\nexport type ExactOptionalize<Schema extends object> = OmitBy<\n  Schema,\n  ExactOptionalTag\n> &\n  Partial<ExcludeType<PickBy<Schema, ExactOptionalTag>, ExactOptionalTag>>;\n\n/**\n * Infer a type from an superstruct object schema.\n */\nexport type ObjectType<Schema extends ObjectSchema> = Simplify<\n  ExactOptionalize<Optionalize<{ [K in keyof Schema]: Infer<Schema[K]> }>>\n>;\n\n/**\n * Change the return type of a superstruct object struct to support exact\n * optional properties.\n *\n * @param schema - The object schema.\n * @returns A struct representing an object with a known set of properties.\n */\nexport function object<Schema extends ObjectSchema>(\n  schema: Schema,\n): Struct<ObjectType<Schema>, Schema> {\n  return stObject(schema) as any;\n}\n\n/**\n * Check if the current property is present in its parent object.\n *\n * @param ctx - The context to check.\n * @returns `true` if the property is present, `false` otherwise.\n */\nfunction hasOptional(ctx: Context): boolean {\n  const property: string = ctx.path[ctx.path.length - 1];\n  const parent: Record<string, unknown> = ctx.branch[ctx.branch.length - 2];\n\n  return property in parent;\n}\n\n/**\n * Augment a struct to allow exact-optional values. Exact-optional values can\n * be omitted but cannot be `undefined`.\n *\n * ```ts\n * const foo = object({ bar: exactOptional(string()) });\n * type Foo = Infer<typeof foo>;\n * // Foo = { bar?: string }\n * ```\n *\n * @param struct - The struct to augment.\n * @returns The augmented struct.\n */\nexport function exactOptional<Type, Schema>(\n  struct: Struct<Type, Schema>,\n): Struct<Type | ExactOptionalTag, Schema> {\n  return new Struct({\n    ...struct,\n\n    validator: (value, ctx) =>\n      !hasOptional(ctx) || struct.validator(value, ctx),\n\n    refiner: (value, ctx) =>\n      !hasOptional(ctx) || struct.refiner(value as Type, ctx),\n  });\n}\n"]}

package/dist/superstruct.test-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/superstruct.test-d.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const superstruct_1 = require("superstruct");
+const tsd_1 = require("tsd");
+const _1 = require(".");
+const exactOptionalObject = (0, _1.object)({
+    a: (0, superstruct_1.number)(),
+    b: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    c: (0, _1.exactOptional)((0, superstruct_1.boolean)()),
+});
+(0, tsd_1.expectAssignable)({ a: 0 });
+(0, tsd_1.expectAssignable)({ a: 0, b: 'test' });
+(0, tsd_1.expectAssignable)({ a: 0, b: 'test', c: true });
+(0, tsd_1.expectAssignable)({ a: 0, b: undefined });
+(0, tsd_1.expectNotAssignable)({ a: 0, b: 'test', c: 0 });
+(0, tsd_1.expectNotAssignable)({ a: 0, b: 'test', c: undefined });
+//# sourceMappingURL=superstruct.test-d.js.map

package/dist/superstruct.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"superstruct.test-d.js","sourceRoot":"","sources":["../src/superstruct.test-d.ts"],"names":[],"mappings":";;AACA,6CAAgE;AAChE,6BAA4D;AAE5D,wBAA0C;AAE1C,MAAM,mBAAmB,GAAG,IAAA,SAAM,EAAC;IACjC,CAAC,EAAE,IAAA,oBAAM,GAAE;IACX,CAAC,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACrB,CAAC,EAAE,IAAA,gBAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC5B,CAAC,CAAC;AAIH,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AAChD,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3D,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AACpE,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AAC9D,IAAA,yBAAmB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AACpE,IAAA,yBAAmB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC","sourcesContent":["import type { Infer } from 'superstruct';\nimport { boolean, number, optional, string } from 'superstruct';\nimport { expectAssignable, expectNotAssignable } from 'tsd';\n\nimport { exactOptional, object } from '.';\n\nconst exactOptionalObject = object({\n  a: number(),\n  b: optional(string()),\n  c: exactOptional(boolean()),\n});\n\ntype ExactOptionalObject = Infer<typeof exactOptionalObject>;\n\nexpectAssignable<ExactOptionalObject>({ a: 0 });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: 'test' });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: true });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: undefined });\nexpectNotAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: 0 });\nexpectNotAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: undefined });\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",
@@ -32,15 +32,17 @@
     "lint:fix": "yarn lint:eslint --fix && yarn lint:constraints --fix && yarn lint:misc --write && yarn lint:dependencies && yarn lint:changelog",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
-    "test": "jest && jest-it-up",
+    "test": "yarn test:source && yarn test:types",
+    "test:source": "jest && jest-it-up",
+    "test:types": "tsd",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/providers": "^11.0.0",
+    "@metamask/providers": "^12.0.0",
     "@metamask/rpc-methods": "^0.38.1-flask.1",
     "@metamask/snaps-controllers": "^0.38.2-flask.1",
     "@metamask/snaps-utils": "^0.38.2-flask.1",
-    "@metamask/utils": "^8.0.0",
+    "@metamask/utils": "^8.1.0",
     "@types/uuid": "^9.0.1",
     "superstruct": "^1.0.3",
     "uuid": "^9.0.0"
@@ -73,6 +75,7 @@
     "rimraf": "^3.0.2",
     "ts-jest": "^28.0.7",
     "ts-node": "^10.7.0",
+    "tsd": "^0.29.0",
     "typedoc": "^0.23.15",
     "typescript": "~4.8.4"
   },
@@ -96,5 +99,8 @@
       "@metamask/rpc-methods>@metamask/permission-controller>@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>keccak": false,
       "@metamask/rpc-methods>@metamask/permission-controller>@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>secp256k1": false
     }
+  },
+  "tsd": {
+    "directory": "src"
   }
 }