@metamask/keyring-api 10.1.0 → 11.0.0

package/dist/rpc-handler.mjs

@@ -0,0 +1,131 @@
+import { assert } from "@metamask/superstruct";
+import { GetAccountRequestStruct, CreateAccountRequestStruct, ApproveRequestRequestStruct, DeleteAccountRequestStruct, ExportAccountRequestStruct, GetRequestRequestStruct, RejectRequestRequestStruct, SubmitRequestRequestStruct, UpdateAccountRequestStruct, FilterAccountChainsStruct, ListAccountsRequestStruct, ListRequestsRequestStruct, GetAccountBalancesRequestStruct } from "./internal/api.mjs";
+import { KeyringRpcMethod } from "./internal/rpc.mjs";
+import { JsonRpcRequestStruct } from "./JsonRpcRequest.mjs";
+/**
+ * Error thrown when a keyring JSON-RPC method is not supported.
+ */
+export class MethodNotSupportedError extends Error {
+    constructor(method) {
+        super(`Method not supported: ${method}`);
+    }
+}
+/**
+ * Inner function that dispatches JSON-RPC request to the associated Keyring
+ * methods.
+ *
+ * @param keyring - Keyring instance.
+ * @param request - Keyring JSON-RPC request.
+ * @returns A promise that resolves to the keyring response.
+ */
+async function dispatchRequest(keyring, request) {
+    // We first have to make sure that the request is a valid JSON-RPC request so
+    // we can check its method name.
+    assert(request, JsonRpcRequestStruct);
+    switch (request.method) {
+        case `${KeyringRpcMethod.ListAccounts}`: {
+            assert(request, ListAccountsRequestStruct);
+            return keyring.listAccounts();
+        }
+        case `${KeyringRpcMethod.GetAccount}`: {
+            assert(request, GetAccountRequestStruct);
+            return keyring.getAccount(request.params.id);
+        }
+        case `${KeyringRpcMethod.CreateAccount}`: {
+            assert(request, CreateAccountRequestStruct);
+            return keyring.createAccount(request.params.options);
+        }
+        case `${KeyringRpcMethod.GetAccountBalances}`: {
+            if (keyring.getAccountBalances === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            assert(request, GetAccountBalancesRequestStruct);
+            return keyring.getAccountBalances(request.params.id, request.params.assets);
+        }
+        case `${KeyringRpcMethod.FilterAccountChains}`: {
+            assert(request, FilterAccountChainsStruct);
+            return keyring.filterAccountChains(request.params.id, request.params.chains);
+        }
+        case `${KeyringRpcMethod.UpdateAccount}`: {
+            assert(request, UpdateAccountRequestStruct);
+            return keyring.updateAccount(request.params.account);
+        }
+        case `${KeyringRpcMethod.DeleteAccount}`: {
+            assert(request, DeleteAccountRequestStruct);
+            return keyring.deleteAccount(request.params.id);
+        }
+        case `${KeyringRpcMethod.ExportAccount}`: {
+            if (keyring.exportAccount === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            assert(request, ExportAccountRequestStruct);
+            return keyring.exportAccount(request.params.id);
+        }
+        case `${KeyringRpcMethod.ListRequests}`: {
+            if (keyring.listRequests === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            assert(request, ListRequestsRequestStruct);
+            return keyring.listRequests();
+        }
+        case `${KeyringRpcMethod.GetRequest}`: {
+            if (keyring.getRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            assert(request, GetRequestRequestStruct);
+            return keyring.getRequest(request.params.id);
+        }
+        case `${KeyringRpcMethod.SubmitRequest}`: {
+            assert(request, SubmitRequestRequestStruct);
+            return keyring.submitRequest(request.params);
+        }
+        case `${KeyringRpcMethod.ApproveRequest}`: {
+            if (keyring.approveRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            assert(request, ApproveRequestRequestStruct);
+            return keyring.approveRequest(request.params.id, request.params.data);
+        }
+        case `${KeyringRpcMethod.RejectRequest}`: {
+            if (keyring.rejectRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            assert(request, RejectRequestRequestStruct);
+            return keyring.rejectRequest(request.params.id);
+        }
+        default: {
+            throw new MethodNotSupportedError(request.method);
+        }
+    }
+}
+/**
+ * Handles a keyring JSON-RPC request.
+ *
+ * This function is meant to be used as a handler for Keyring JSON-RPC requests
+ * in an Accounts Snap.
+ *
+ * @param keyring - Keyring instance.
+ * @param request - Keyring JSON-RPC request.
+ * @returns A promise that resolves to the keyring response.
+ * @example
+ * ```ts
+ * export const onKeyringRequest: OnKeyringRequestHandler = async ({
+ *   origin,
+ *   request,
+ * }) => {
+ *   return await handleKeyringRequest(keyring, request);
+ * };
+ * ```
+ */
+export async function handleKeyringRequest(keyring, request) {
+    try {
+        return await dispatchRequest(keyring, request);
+    }
+    catch (error) {
+        const message = error instanceof Error && typeof error.message === 'string'
+            ? error.message
+            : 'An unknown error occurred while handling the keyring request';
+        throw new Error(message);
+    }
+}
+//# sourceMappingURL=rpc-handler.mjs.map

package/dist/rpc-handler.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-handler.mjs","sourceRoot":"","sources":["../src/rpc-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,8BAA8B;AAI/C,OAAO,EACL,uBAAuB,EACvB,0BAA0B,EAC1B,2BAA2B,EAC3B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,EACzB,yBAAyB,EACzB,yBAAyB,EACzB,+BAA+B,EAChC,2BAAuB;AACxB,OAAO,EAAE,gBAAgB,EAAE,2BAAuB;AAElD,OAAO,EAAE,oBAAoB,EAAE,6BAAyB;AAExD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAChD,YAAY,MAAc;QACxB,KAAK,CAAC,yBAAyB,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAC5B,OAAgB,EAChB,OAAuB;IAEvB,6EAA6E;IAC7E,gCAAgC;IAChC,MAAM,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IAEtC,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,GAAG,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;YACxC,MAAM,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;QAChC,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;YAC9C,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBAC7C,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;YACjD,OAAO,OAAO,CAAC,kBAAkB,CAC/B,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CACtB,CAAC;QACJ,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC;YAC/C,MAAM,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,mBAAmB,CAChC,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CACtB,CAAC;QACJ,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YACzC,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;YACxC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACvC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;QAChC,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YACtC,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACrC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YAC1C,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;gBACzC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;YAC7C,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;YACzC,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAgB,EAChB,OAAuB;IAEvB,IAAI,CAAC;QACH,OAAO,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACzD,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,8DAA8D,CAAC;QAErE,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC","sourcesContent":["import { assert } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\n\nimport type { Keyring } from './api';\nimport {\n  GetAccountRequestStruct,\n  CreateAccountRequestStruct,\n  ApproveRequestRequestStruct,\n  DeleteAccountRequestStruct,\n  ExportAccountRequestStruct,\n  GetRequestRequestStruct,\n  RejectRequestRequestStruct,\n  SubmitRequestRequestStruct,\n  UpdateAccountRequestStruct,\n  FilterAccountChainsStruct,\n  ListAccountsRequestStruct,\n  ListRequestsRequestStruct,\n  GetAccountBalancesRequestStruct,\n} from './internal/api';\nimport { KeyringRpcMethod } from './internal/rpc';\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { JsonRpcRequestStruct } from './JsonRpcRequest';\n\n/**\n * Error thrown when a keyring JSON-RPC method is not supported.\n */\nexport class MethodNotSupportedError extends Error {\n  constructor(method: string) {\n    super(`Method not supported: ${method}`);\n  }\n}\n\n/**\n * Inner function that dispatches JSON-RPC request to the associated Keyring\n * methods.\n *\n * @param keyring - Keyring instance.\n * @param request - Keyring JSON-RPC request.\n * @returns A promise that resolves to the keyring response.\n */\nasync function dispatchRequest(\n  keyring: Keyring,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  // We first have to make sure that the request is a valid JSON-RPC request so\n  // we can check its method name.\n  assert(request, JsonRpcRequestStruct);\n\n  switch (request.method) {\n    case `${KeyringRpcMethod.ListAccounts}`: {\n      assert(request, ListAccountsRequestStruct);\n      return keyring.listAccounts();\n    }\n\n    case `${KeyringRpcMethod.GetAccount}`: {\n      assert(request, GetAccountRequestStruct);\n      return keyring.getAccount(request.params.id);\n    }\n\n    case `${KeyringRpcMethod.CreateAccount}`: {\n      assert(request, CreateAccountRequestStruct);\n      return keyring.createAccount(request.params.options);\n    }\n\n    case `${KeyringRpcMethod.GetAccountBalances}`: {\n      if (keyring.getAccountBalances === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, GetAccountBalancesRequestStruct);\n      return keyring.getAccountBalances(\n        request.params.id,\n        request.params.assets,\n      );\n    }\n\n    case `${KeyringRpcMethod.FilterAccountChains}`: {\n      assert(request, FilterAccountChainsStruct);\n      return keyring.filterAccountChains(\n        request.params.id,\n        request.params.chains,\n      );\n    }\n\n    case `${KeyringRpcMethod.UpdateAccount}`: {\n      assert(request, UpdateAccountRequestStruct);\n      return keyring.updateAccount(request.params.account);\n    }\n\n    case `${KeyringRpcMethod.DeleteAccount}`: {\n      assert(request, DeleteAccountRequestStruct);\n      return keyring.deleteAccount(request.params.id);\n    }\n\n    case `${KeyringRpcMethod.ExportAccount}`: {\n      if (keyring.exportAccount === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ExportAccountRequestStruct);\n      return keyring.exportAccount(request.params.id);\n    }\n\n    case `${KeyringRpcMethod.ListRequests}`: {\n      if (keyring.listRequests === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ListRequestsRequestStruct);\n      return keyring.listRequests();\n    }\n\n    case `${KeyringRpcMethod.GetRequest}`: {\n      if (keyring.getRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, GetRequestRequestStruct);\n      return keyring.getRequest(request.params.id);\n    }\n\n    case `${KeyringRpcMethod.SubmitRequest}`: {\n      assert(request, SubmitRequestRequestStruct);\n      return keyring.submitRequest(request.params);\n    }\n\n    case `${KeyringRpcMethod.ApproveRequest}`: {\n      if (keyring.approveRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ApproveRequestRequestStruct);\n      return keyring.approveRequest(request.params.id, request.params.data);\n    }\n\n    case `${KeyringRpcMethod.RejectRequest}`: {\n      if (keyring.rejectRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, RejectRequestRequestStruct);\n      return keyring.rejectRequest(request.params.id);\n    }\n\n    default: {\n      throw new MethodNotSupportedError(request.method);\n    }\n  }\n}\n\n/**\n * Handles a keyring JSON-RPC request.\n *\n * This function is meant to be used as a handler for Keyring JSON-RPC requests\n * in an Accounts Snap.\n *\n * @param keyring - Keyring instance.\n * @param request - Keyring JSON-RPC request.\n * @returns A promise that resolves to the keyring response.\n * @example\n * ```ts\n * export const onKeyringRequest: OnKeyringRequestHandler = async ({\n *   origin,\n *   request,\n * }) => {\n *   return await handleKeyringRequest(keyring, request);\n * };\n * ```\n */\nexport async function handleKeyringRequest(\n  keyring: Keyring,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  try {\n    return await dispatchRequest(keyring, request);\n  } catch (error) {\n    const message =\n      error instanceof Error && typeof error.message === 'string'\n        ? error.message\n        : 'An unknown error occurred while handling the keyring request';\n\n    throw new Error(message);\n  }\n}\n"]}

package/dist/{snap-utils.js → snap-utils.cjs}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.emitSnapKeyringEvent = void 0;
+exports.emitSnapKeyringEvent = emitSnapKeyringEvent;
 /**
  * Emit a keyring event from a snap.
  *
@@ -17,5 +17,4 @@ async function emitSnapKeyringEvent(snap, event, data) {
         },
     });
 }
-exports.emitSnapKeyringEvent = emitSnapKeyringEvent;
-//# sourceMappingURL=snap-utils.js.map
+//# sourceMappingURL=snap-utils.cjs.map

package/dist/snap-utils.cjs.map

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

package/dist/{snap-utils.d.ts → snap-utils.d.cts}

@@ -1,6 +1,6 @@
-import type { SnapsProvider } from '@metamask/snaps-sdk';
-import type { Json } from '@metamask/utils';
-import type { KeyringEvent } from './events';
+import type { SnapsProvider } from "@metamask/snaps-sdk";
+import type { Json } from "@metamask/utils";
+import type { KeyringEvent } from "./events.cjs";
 /**
  * Emit a keyring event from a snap.
  *
@@ -9,3 +9,4 @@ import type { KeyringEvent } from './events';
  * @param data - The event data.
  */
 export declare function emitSnapKeyringEvent(snap: SnapsProvider, event: KeyringEvent, data: Record<string, Json>): Promise<void>;
+//# sourceMappingURL=snap-utils.d.cts.map

package/dist/snap-utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snap-utils.d.cts","sourceRoot":"","sources":["../src/snap-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,4BAA4B;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAE7C;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,YAAY,EACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GACzB,OAAO,CAAC,IAAI,CAAC,CAQf"}

package/dist/snap-utils.d.mts

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

package/dist/snap-utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snap-utils.d.mts","sourceRoot":"","sources":["../src/snap-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,4BAA4B;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAE7C;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,YAAY,EACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GACzB,OAAO,CAAC,IAAI,CAAC,CAQf"}

package/dist/snap-utils.mjs

@@ -0,0 +1,17 @@
+/**
+ * Emit a keyring event from a snap.
+ *
+ * @param snap - The global snap object.
+ * @param event - The event name.
+ * @param data - The event data.
+ */
+export async function emitSnapKeyringEvent(snap, event, data) {
+    await snap.request({
+        method: 'snap_manageAccounts',
+        params: {
+            method: event,
+            params: { ...data },
+        },
+    });
+}
+//# sourceMappingURL=snap-utils.mjs.map

package/dist/snap-utils.mjs.map

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

package/dist/{btc/index.js → sol/index.cjs}

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require("./types.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/dist/sol/index.cjs.map

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

package/dist/sol/index.d.cts

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

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

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

package/dist/sol/index.d.mts

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

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

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

package/dist/sol/index.mjs

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

package/dist/sol/index.mjs.map

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

package/dist/sol/{types.js → types.cjs}

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SolDataAccountStruct = exports.SolMethod = exports.SolAddressStruct = void 0;
 const superstruct_1 = require("@metamask/superstruct");
-const api_1 = require("../api");
-const superstruct_2 = require("../superstruct");
+const api_1 = require("../api/index.cjs");
+const superstruct_2 = require("../superstruct.cjs");
 /**
  * Solana addresses are represented in the format of a 256-bit ed25519 public key and
  * are encoded using base58.
@@ -33,4 +33,4 @@ exports.SolDataAccountStruct = (0, superstruct_2.object)({
      */
     methods: (0, superstruct_1.array)((0, superstruct_1.enums)([`${SolMethod.SendAndConfirmTransaction}`])),
 });
-//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.cjs.map

package/dist/sol/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../src/sol/types.ts"],"names":[],"mappings":";;;AACA,uDAA8D;AAE9D,0CAA8D;AAC9D,oDAAuD;AAEvD;;;;GAIG;AACU,QAAA,gBAAgB,GAAG,IAAA,2BAAa,EAC3C,YAAY,EACZ,iCAAiC,CAClC,CAAC;AAEF;;GAEG;AACH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,8BAA8B;IAC9B,oEAAuD,CAAA;AACzD,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAEY,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC,GAAG,0BAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,wBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,oBAAc,CAAC,WAAW,EAAE,CAAC;IAE9C;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EAAC,IAAA,mBAAK,EAAC,CAAC,GAAG,SAAS,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC;CAClE,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { array, enums, literal } from '@metamask/superstruct';\n\nimport { KeyringAccountStruct, SolAccountType } from '../api';\nimport { object, definePattern } from '../superstruct';\n\n/**\n * Solana addresses are represented in the format of a 256-bit ed25519 public key and\n * are encoded using base58.\n * They are usually 32 to 44 characters long.\n */\nexport const SolAddressStruct = definePattern(\n  'SolAddress',\n  /^[1-9A-HJ-NP-Za-km-z]{32,44}$/iu,\n);\n\n/**\n * Supported Solana methods.\n */\nexport enum SolMethod {\n  // General transaction methods\n  SendAndConfirmTransaction = 'sendAndConfirmTransaction',\n}\n\nexport const SolDataAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: SolAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${SolAccountType.DataAccount}`),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(enums([`${SolMethod.SendAndConfirmTransaction}`])),\n});\n\nexport type SolDataAccount = Infer<typeof SolDataAccountStruct>;\n"]}

package/dist/sol/{types.d.ts → types.d.cts}

@@ -1,4 +1,4 @@
-import type { Infer } from '@metamask/superstruct';
+import type { Infer } from "@metamask/superstruct";
 /**
  * Solana addresses are represented in the format of a 256-bit ed25519 public key and
  * are encoded using base58.
@@ -36,3 +36,4 @@ export declare const SolDataAccountStruct: import("@metamask/superstruct").Struc
     options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
 }>;
 export type SolDataAccount = Infer<typeof SolDataAccountStruct>;
+//# sourceMappingURL=types.d.cts.map

package/dist/sol/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../src/sol/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAMnD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS;IAEnB,yBAAyB,8BAA8B;CACxD;AAED,eAAO,MAAM,oBAAoB;;;;;;;IAG/B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/sol/types.d.mts

@@ -0,0 +1,39 @@
+import type { Infer } from "@metamask/superstruct";
+/**
+ * Solana addresses are represented in the format of a 256-bit ed25519 public key and
+ * are encoded using base58.
+ * They are usually 32 to 44 characters long.
+ */
+export declare const SolAddressStruct: import("@metamask/superstruct").Struct<string, null>;
+/**
+ * Supported Solana methods.
+ */
+export declare enum SolMethod {
+    SendAndConfirmTransaction = "sendAndConfirmTransaction"
+}
+export declare const SolDataAccountStruct: import("@metamask/superstruct").Struct<{
+    type: "solana:data-account";
+    id: string;
+    address: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    methods: "sendAndConfirmTransaction"[];
+}, {
+    /**
+     * Account address.
+     */
+    address: import("@metamask/superstruct").Struct<string, null>;
+    /**
+     * Account type.
+     */
+    type: import("@metamask/superstruct").Struct<"solana:data-account", "solana:data-account">;
+    /**
+     * Account supported methods.
+     */
+    methods: import("@metamask/superstruct").Struct<"sendAndConfirmTransaction"[], import("@metamask/superstruct").Struct<"sendAndConfirmTransaction", {
+        sendAndConfirmTransaction: "sendAndConfirmTransaction";
+    }>>;
+    id: import("@metamask/superstruct").Struct<string, null>;
+    options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+}>;
+export type SolDataAccount = Infer<typeof SolDataAccountStruct>;
+//# sourceMappingURL=types.d.mts.map

package/dist/sol/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../src/sol/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAMnD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS;IAEnB,yBAAyB,8BAA8B;CACxD;AAED,eAAO,MAAM,oBAAoB;;;;;;;IAG/B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;EAEH,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/sol/types.mjs

@@ -0,0 +1,33 @@
+import { array, enums, literal } from "@metamask/superstruct";
+import { KeyringAccountStruct, SolAccountType } from "../api/index.mjs";
+import { object, definePattern } from "../superstruct.mjs";
+/**
+ * Solana addresses are represented in the format of a 256-bit ed25519 public key and
+ * are encoded using base58.
+ * They are usually 32 to 44 characters long.
+ */
+export const SolAddressStruct = definePattern('SolAddress', /^[1-9A-HJ-NP-Za-km-z]{32,44}$/iu);
+/**
+ * Supported Solana methods.
+ */
+export var SolMethod;
+(function (SolMethod) {
+    // General transaction methods
+    SolMethod["SendAndConfirmTransaction"] = "sendAndConfirmTransaction";
+})(SolMethod || (SolMethod = {}));
+export const SolDataAccountStruct = object({
+    ...KeyringAccountStruct.schema,
+    /**
+     * Account address.
+     */
+    address: SolAddressStruct,
+    /**
+     * Account type.
+     */
+    type: literal(`${SolAccountType.DataAccount}`),
+    /**
+     * Account supported methods.
+     */
+    methods: array(enums([`${SolMethod.SendAndConfirmTransaction}`])),
+});
+//# sourceMappingURL=types.mjs.map

package/dist/sol/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../src/sol/types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,8BAA8B;AAE9D,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,yBAAe;AAC9D,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,2BAAuB;AAEvD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAC3C,YAAY,EACZ,iCAAiC,CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,8BAA8B;IAC9B,oEAAuD,CAAA;AACzD,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC;IACzC,GAAG,oBAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;IAE9C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC;CAClE,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport { array, enums, literal } from '@metamask/superstruct';\n\nimport { KeyringAccountStruct, SolAccountType } from '../api';\nimport { object, definePattern } from '../superstruct';\n\n/**\n * Solana addresses are represented in the format of a 256-bit ed25519 public key and\n * are encoded using base58.\n * They are usually 32 to 44 characters long.\n */\nexport const SolAddressStruct = definePattern(\n  'SolAddress',\n  /^[1-9A-HJ-NP-Za-km-z]{32,44}$/iu,\n);\n\n/**\n * Supported Solana methods.\n */\nexport enum SolMethod {\n  // General transaction methods\n  SendAndConfirmTransaction = 'sendAndConfirmTransaction',\n}\n\nexport const SolDataAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: SolAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${SolAccountType.DataAccount}`),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(enums([`${SolMethod.SendAndConfirmTransaction}`])),\n});\n\nexport type SolDataAccount = Infer<typeof SolDataAccountStruct>;\n"]}

package/dist/{superstruct.js → superstruct.cjs}

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.strictMask = exports.definePattern = exports.exactOptional = exports.object = void 0;
+exports.object = object;
+exports.exactOptional = exactOptional;
+exports.definePattern = definePattern;
+exports.strictMask = strictMask;
 const superstruct_1 = require("@metamask/superstruct");
 /**
  * Change the return type of a superstruct object struct to support exact
@@ -12,7 +15,6 @@ const superstruct_1 = require("@metamask/superstruct");
 function object(schema) {
     return (0, superstruct_1.object)(schema);
 }
-exports.object = object;
 /**
  * Check if the current property is present in its parent object.
  *
@@ -44,7 +46,6 @@ function exactOptional(struct) {
         refiner: (value, ctx) => !hasOptional(ctx) || struct.refiner(value, ctx),
     });
 }
-exports.exactOptional = exactOptional;
 /**
  * Defines a new string-struct matching a regular expression.
  *
@@ -61,7 +62,6 @@ exports.exactOptional = exactOptional;
 function definePattern(name, pattern) {
     return (0, superstruct_1.define)(name, (value) => typeof value === 'string' && pattern.test(value));
 }
-exports.definePattern = definePattern;
 /**
  * Assert that a value is valid according to a struct.
  *
@@ -77,5 +77,4 @@ function strictMask(value, struct, message) {
     (0, superstruct_1.assert)(value, struct, message);
     return value;
 }
-exports.strictMask = strictMask;
-//# sourceMappingURL=superstruct.js.map
+//# sourceMappingURL=superstruct.cjs.map

package/dist/superstruct.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"superstruct.cjs","sourceRoot":"","sources":["../src/superstruct.ts"],"names":[],"mappings":";;AAiEA,wBAIC;AA4BD,sCAYC;AAeD,sCASC;AAaD,gCAOC;AAzJD,uDAK+B;AAqD/B;;;;;;GAMG;AACH,SAAgB,MAAM,CACpB,MAAc;IAEd,OAAO,IAAA,oBAAQ,EAAC,MAAM,CAAQ,CAAC;AACjC,CAAC;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;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,IAAY,EACZ,OAAe;IAEf,OAAO,IAAA,oBAAM,EACX,IAAI,EACJ,CAAC,KAAc,EAAW,EAAE,CAC1B,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CACnD,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,KAAc,EACd,MAA4B,EAC5B,OAAgB;IAEhB,IAAA,oBAAM,EAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import {\n  Struct,\n  assert,\n  define,\n  object as stObject,\n} from '@metamask/superstruct';\nimport type {\n  Infer,\n  Context,\n  ObjectSchema,\n  OmitBy,\n  Optionalize,\n  PickBy,\n  Simplify,\n} from '@metamask/superstruct';\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\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\n/**\n * Defines a new string-struct matching a regular expression.\n *\n * Example:\n *\n * ```ts\n * const EthAddressStruct = definePattern('EthAddress', /^0x[0-9a-f]{40}$/iu);\n * ```\n *\n * @param name - Type name.\n * @param pattern - Regular expression to match.\n * @returns A new string-struct that matches the given pattern.\n */\nexport function definePattern(\n  name: string,\n  pattern: RegExp,\n): Struct<string, null> {\n  return define<string>(\n    name,\n    (value: unknown): boolean =>\n      typeof value === 'string' && pattern.test(value),\n  );\n}\n\n/**\n * Assert that a value is valid according to a struct.\n *\n * It is similar to superstruct's mask function, but it does not ignore extra\n * properties.\n *\n * @param value - Value to check.\n * @param struct - Struct to validate the value against.\n * @param message - Error message to throw if the value is not valid.\n * @returns The value if it is valid.\n */\nexport function strictMask<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  message?: string,\n): Type {\n  assert(value, struct, message);\n  return value;\n}\n"]}

package/dist/{superstruct.d.ts → superstruct.d.cts}

@@ -1,5 +1,5 @@
-import { Struct } from '@metamask/superstruct';
-import type { Infer, ObjectSchema, OmitBy, Optionalize, PickBy, Simplify } from '@metamask/superstruct';
+import { Struct } from "@metamask/superstruct";
+import type { Infer, ObjectSchema, OmitBy, Optionalize, PickBy, Simplify } from "@metamask/superstruct";
 declare const ExactOptionalSymbol: unique symbol;
 export type ExactOptionalTag = {
     type: typeof ExactOptionalSymbol;
@@ -81,3 +81,4 @@ export declare function definePattern(name: string, pattern: RegExp): Struct<str
  */
 export declare function strictMask<Type, Schema>(value: unknown, struct: Struct<Type, Schema>, message?: string): Type;
 export {};
+//# sourceMappingURL=superstruct.d.cts.map

package/dist/superstruct.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"superstruct.d.cts","sourceRoot":"","sources":["../src/superstruct.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EAIP,8BAA8B;AAC/B,OAAO,KAAK,EACV,KAAK,EAEL,YAAY,EACZ,MAAM,EACN,WAAW,EACX,MAAM,EACN,QAAQ,EACT,8BAA8B;AAG/B,OAAO,CAAC,MAAM,mBAAmB,EAAE,OAAO,MAAM,CAAC;AAEjD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,OAAO,mBAAmB,CAAC;CAClC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,EAAE,IAAI,IAAI;KAClC,CAAC,IAAI,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;CACxC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI,MAAM,CAC1D,MAAM,EACN,gBAAgB,CACjB,GACC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,MAAM,SAAS,YAAY,IAAI,QAAQ,CAC5D,gBAAgB,CAAC,WAAW,CAAC;KAAG,CAAC,IAAI,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,CAAC,CACzE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,MAAM,SAAS,YAAY,EAChD,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAEpC;AAeD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EACxC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAC3B,MAAM,CAAC,IAAI,GAAG,gBAAgB,EAAE,MAAM,CAAC,CAUzC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GACd,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAMtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EACrC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAC5B,OAAO,CAAC,EAAE,MAAM,GACf,IAAI,CAGN"}

package/dist/superstruct.d.mts

@@ -0,0 +1,84 @@
+import { Struct } from "@metamask/superstruct";
+import type { Infer, ObjectSchema, OmitBy, Optionalize, PickBy, Simplify } from "@metamask/superstruct";
+declare const ExactOptionalSymbol: unique symbol;
+export 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 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 type ExactOptionalize<Schema extends object> = OmitBy<Schema, ExactOptionalTag> & Partial<ExcludeType<PickBy<Schema, ExactOptionalTag>, ExactOptionalTag>>;
+/**
+ * Infer a type from an superstruct object schema.
+ */
+export 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>;
+/**
+ * Defines a new string-struct matching a regular expression.
+ *
+ * Example:
+ *
+ * ```ts
+ * const EthAddressStruct = definePattern('EthAddress', /^0x[0-9a-f]{40}$/iu);
+ * ```
+ *
+ * @param name - Type name.
+ * @param pattern - Regular expression to match.
+ * @returns A new string-struct that matches the given pattern.
+ */
+export declare function definePattern(name: string, pattern: RegExp): Struct<string, null>;
+/**
+ * Assert that a value is valid according to a struct.
+ *
+ * It is similar to superstruct's mask function, but it does not ignore extra
+ * properties.
+ *
+ * @param value - Value to check.
+ * @param struct - Struct to validate the value against.
+ * @param message - Error message to throw if the value is not valid.
+ * @returns The value if it is valid.
+ */
+export declare function strictMask<Type, Schema>(value: unknown, struct: Struct<Type, Schema>, message?: string): Type;
+export {};
+//# sourceMappingURL=superstruct.d.mts.map

package/dist/superstruct.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"superstruct.d.mts","sourceRoot":"","sources":["../src/superstruct.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EAIP,8BAA8B;AAC/B,OAAO,KAAK,EACV,KAAK,EAEL,YAAY,EACZ,MAAM,EACN,WAAW,EACX,MAAM,EACN,QAAQ,EACT,8BAA8B;AAG/B,OAAO,CAAC,MAAM,mBAAmB,EAAE,OAAO,MAAM,CAAC;AAEjD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,OAAO,mBAAmB,CAAC;CAClC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,EAAE,IAAI,IAAI;KAClC,CAAC,IAAI,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;CACxC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI,MAAM,CAC1D,MAAM,EACN,gBAAgB,CACjB,GACC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,MAAM,SAAS,YAAY,IAAI,QAAQ,CAC5D,gBAAgB,CAAC,WAAW,CAAC;KAAG,CAAC,IAAI,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC,CAAC,CACzE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,MAAM,SAAS,YAAY,EAChD,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAEpC;AAeD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EACxC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAC3B,MAAM,CAAC,IAAI,GAAG,gBAAgB,EAAE,MAAM,CAAC,CAUzC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GACd,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAMtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EACrC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,EAC5B,OAAO,CAAC,EAAE,MAAM,GACf,IAAI,CAGN"}

package/dist/superstruct.mjs

@@ -0,0 +1,74 @@
+import { Struct, assert, define, object as stObject } from "@metamask/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.
+ */
+export function object(schema) {
+    return stObject(schema);
+}
+/**
+ * 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.
+ */
+export function exactOptional(struct) {
+    return new Struct({
+        ...struct,
+        validator: (value, ctx) => !hasOptional(ctx) || struct.validator(value, ctx),
+        refiner: (value, ctx) => !hasOptional(ctx) || struct.refiner(value, ctx),
+    });
+}
+/**
+ * Defines a new string-struct matching a regular expression.
+ *
+ * Example:
+ *
+ * ```ts
+ * const EthAddressStruct = definePattern('EthAddress', /^0x[0-9a-f]{40}$/iu);
+ * ```
+ *
+ * @param name - Type name.
+ * @param pattern - Regular expression to match.
+ * @returns A new string-struct that matches the given pattern.
+ */
+export function definePattern(name, pattern) {
+    return define(name, (value) => typeof value === 'string' && pattern.test(value));
+}
+/**
+ * Assert that a value is valid according to a struct.
+ *
+ * It is similar to superstruct's mask function, but it does not ignore extra
+ * properties.
+ *
+ * @param value - Value to check.
+ * @param struct - Struct to validate the value against.
+ * @param message - Error message to throw if the value is not valid.
+ * @returns The value if it is valid.
+ */
+export function strictMask(value, struct, message) {
+    assert(value, struct, message);
+    return value;
+}
+//# sourceMappingURL=superstruct.mjs.map