@metamask/snaps-sdk 6.3.0 → 6.5.0

package/dist/error-wrappers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-wrappers.d.mts","sourceRoot":"","sources":["../src/error-wrappers.ts"],"names":[],"mappings":";AAIA;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAsC,CAAC;AAEjE;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA0C,CAAC;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA2C,CAAC;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA4C,CAAC;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA2C,CAAC;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA4C,CAAC;AAE7E;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAEnC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAmC,CAAC;AAE3D;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAEjC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAEpC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAE/B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAElC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA+C,CAAC;AAE9E;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAA+C,CAAC;AAE9E;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAElC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAEpC,CAAC"}

package/dist/error-wrappers.mjs

@@ -0,0 +1,143 @@
+import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
+import { createSnapError } from "./internals/index.mjs";
+/**
+ * A JSON-RPC 2.0 Internal (-32603) error.
+ *
+ * This can be thrown by a Snap to indicate that an internal error occurred,
+ * without crashing the Snap.
+ *
+ * @see https://www.jsonrpc.org/specification#error_object
+ */
+export const InternalError = createSnapError(rpcErrors.internal);
+/**
+ * An Ethereum JSON-RPC Invalid Input (-32000) error.
+ *
+ * This can be thrown by a Snap to indicate that the input to a method is
+ * invalid, without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export const InvalidInputError = createSnapError(rpcErrors.invalidInput);
+/**
+ * A JSON-RPC 2.0 Invalid Params (-32602) error.
+ *
+ * This can be thrown by a Snap to indicate that the parameters to a method are
+ * invalid, without crashing the Snap.
+ *
+ * @see https://www.jsonrpc.org/specification#error_object
+ */
+export const InvalidParamsError = createSnapError(rpcErrors.invalidParams);
+/**
+ * A JSON-RPC 2.0 Invalid Request (-32600) error.
+ *
+ * This can be thrown by a Snap to indicate that the request is invalid, without
+ * crashing the Snap.
+ *
+ * @see https://www.jsonrpc.org/specification#error_object
+ */
+export const InvalidRequestError = createSnapError(rpcErrors.invalidRequest);
+/**
+ * An Ethereum JSON-RPC Limit Exceeded (-32005) error.
+ *
+ * This can be thrown by a Snap to indicate that a limit has been exceeded,
+ * without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export const LimitExceededError = createSnapError(rpcErrors.limitExceeded);
+/**
+ * An Ethereum JSON-RPC Method Not Found (-32601) error.
+ *
+ * This can be thrown by a Snap to indicate that a method does not exist,
+ * without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export const MethodNotFoundError = createSnapError(rpcErrors.methodNotFound);
+/**
+ * An Ethereum JSON-RPC Method Not Supported (-32004) error.
+ *
+ * This can be thrown by a Snap to indicate that a method is not supported,
+ * without crashing the Snap.
+ */
+export const MethodNotSupportedError = createSnapError(rpcErrors.methodNotSupported);
+/**
+ * A JSON-RPC 2.0 Parse (-32700) error.
+ *
+ * This can be thrown by a Snap to indicate that a request is not valid JSON,
+ * without crashing the Snap.
+ *
+ * @see https://www.jsonrpc.org/specification#error_object
+ */
+export const ParseError = createSnapError(rpcErrors.parse);
+/**
+ * An Ethereum JSON-RPC Resource Not Found (-32001) error.
+ *
+ * This can be thrown by a Snap to indicate that a resource does not exist,
+ * without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export const ResourceNotFoundError = createSnapError(rpcErrors.resourceNotFound);
+/**
+ * An Ethereum JSON-RPC Resource Unavailable (-32002) error.
+ *
+ * This can be thrown by a Snap to indicate that a resource is unavailable,
+ * without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export const ResourceUnavailableError = createSnapError(rpcErrors.resourceUnavailable);
+/**
+ * An Ethereum JSON-RPC Transaction Rejected (-32003) error.
+ *
+ * This can be thrown by a Snap to indicate that a transaction was rejected,
+ * without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes
+ */
+export const TransactionRejected = createSnapError(rpcErrors.transactionRejected);
+/**
+ * An Ethereum Provider Chain Disconnected (4901) error.
+ *
+ * This can be thrown by a Snap to indicate that the provider is disconnected
+ * from the requested chain, without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export const ChainDisconnectedError = createSnapError(providerErrors.chainDisconnected);
+/**
+ * An Ethereum Provider Disconnected (4900) error.
+ *
+ * This can be thrown by a Snap to indicate that the provider is disconnected,
+ * without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export const DisconnectedError = createSnapError(providerErrors.disconnected);
+/**
+ * An Ethereum Provider Unauthorized (4100) error.
+ *
+ * This can be thrown by a Snap to indicate that the requested method / account
+ * is not authorized by the user, without crashing the Snap.
+ */
+export const UnauthorizedError = createSnapError(providerErrors.unauthorized);
+/**
+ * An Ethereum Provider Unsupported Method (4200) error.
+ *
+ * This can be thrown by a Snap to indicate that the requested method is not
+ * supported by the provider, without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export const UnsupportedMethodError = createSnapError(providerErrors.unsupportedMethod);
+/**
+ * An Ethereum Provider User Rejected Request (4001) error.
+ *
+ * This can be thrown by a Snap to indicate that the user rejected the request,
+ * without crashing the Snap.
+ *
+ * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors
+ */
+export const UserRejectedRequestError = createSnapError(providerErrors.userRejectedRequest);
+//# sourceMappingURL=error-wrappers.mjs.map

package/dist/error-wrappers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-wrappers.mjs","sourceRoot":"","sources":["../src/error-wrappers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAEjE,OAAO,EAAE,eAAe,EAAE,8BAAoB;AAE9C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AAEjE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;AAEzE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AAE3E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;AAE7E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AAE3E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CACpD,SAAS,CAAC,kBAAkB,CAC7B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAE3D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAClD,SAAS,CAAC,gBAAgB,CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CACrD,SAAS,CAAC,mBAAmB,CAC9B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAChD,SAAS,CAAC,mBAAmB,CAC9B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CACnD,cAAc,CAAC,iBAAiB,CACjC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;AAE9E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CACnD,cAAc,CAAC,iBAAiB,CACjC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CACrD,cAAc,CAAC,mBAAmB,CACnC,CAAC","sourcesContent":["import { providerErrors, rpcErrors } from '@metamask/rpc-errors';\n\nimport { createSnapError } from './internals';\n\n/**\n * A JSON-RPC 2.0 Internal (-32603) error.\n *\n * This can be thrown by a Snap to indicate that an internal error occurred,\n * without crashing the Snap.\n *\n * @see https://www.jsonrpc.org/specification#error_object\n */\nexport const InternalError = createSnapError(rpcErrors.internal);\n\n/**\n * An Ethereum JSON-RPC Invalid Input (-32000) error.\n *\n * This can be thrown by a Snap to indicate that the input to a method is\n * invalid, without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes\n */\nexport const InvalidInputError = createSnapError(rpcErrors.invalidInput);\n\n/**\n * A JSON-RPC 2.0 Invalid Params (-32602) error.\n *\n * This can be thrown by a Snap to indicate that the parameters to a method are\n * invalid, without crashing the Snap.\n *\n * @see https://www.jsonrpc.org/specification#error_object\n */\nexport const InvalidParamsError = createSnapError(rpcErrors.invalidParams);\n\n/**\n * A JSON-RPC 2.0 Invalid Request (-32600) error.\n *\n * This can be thrown by a Snap to indicate that the request is invalid, without\n * crashing the Snap.\n *\n * @see https://www.jsonrpc.org/specification#error_object\n */\nexport const InvalidRequestError = createSnapError(rpcErrors.invalidRequest);\n\n/**\n * An Ethereum JSON-RPC Limit Exceeded (-32005) error.\n *\n * This can be thrown by a Snap to indicate that a limit has been exceeded,\n * without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes\n */\nexport const LimitExceededError = createSnapError(rpcErrors.limitExceeded);\n\n/**\n * An Ethereum JSON-RPC Method Not Found (-32601) error.\n *\n * This can be thrown by a Snap to indicate that a method does not exist,\n * without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes\n */\nexport const MethodNotFoundError = createSnapError(rpcErrors.methodNotFound);\n\n/**\n * An Ethereum JSON-RPC Method Not Supported (-32004) error.\n *\n * This can be thrown by a Snap to indicate that a method is not supported,\n * without crashing the Snap.\n */\nexport const MethodNotSupportedError = createSnapError(\n  rpcErrors.methodNotSupported,\n);\n\n/**\n * A JSON-RPC 2.0 Parse (-32700) error.\n *\n * This can be thrown by a Snap to indicate that a request is not valid JSON,\n * without crashing the Snap.\n *\n * @see https://www.jsonrpc.org/specification#error_object\n */\nexport const ParseError = createSnapError(rpcErrors.parse);\n\n/**\n * An Ethereum JSON-RPC Resource Not Found (-32001) error.\n *\n * This can be thrown by a Snap to indicate that a resource does not exist,\n * without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes\n */\nexport const ResourceNotFoundError = createSnapError(\n  rpcErrors.resourceNotFound,\n);\n\n/**\n * An Ethereum JSON-RPC Resource Unavailable (-32002) error.\n *\n * This can be thrown by a Snap to indicate that a resource is unavailable,\n * without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes\n */\nexport const ResourceUnavailableError = createSnapError(\n  rpcErrors.resourceUnavailable,\n);\n\n/**\n * An Ethereum JSON-RPC Transaction Rejected (-32003) error.\n *\n * This can be thrown by a Snap to indicate that a transaction was rejected,\n * without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1474#error-codes\n */\nexport const TransactionRejected = createSnapError(\n  rpcErrors.transactionRejected,\n);\n\n/**\n * An Ethereum Provider Chain Disconnected (4901) error.\n *\n * This can be thrown by a Snap to indicate that the provider is disconnected\n * from the requested chain, without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors\n */\nexport const ChainDisconnectedError = createSnapError(\n  providerErrors.chainDisconnected,\n);\n\n/**\n * An Ethereum Provider Disconnected (4900) error.\n *\n * This can be thrown by a Snap to indicate that the provider is disconnected,\n * without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors\n */\nexport const DisconnectedError = createSnapError(providerErrors.disconnected);\n\n/**\n * An Ethereum Provider Unauthorized (4100) error.\n *\n * This can be thrown by a Snap to indicate that the requested method / account\n * is not authorized by the user, without crashing the Snap.\n */\nexport const UnauthorizedError = createSnapError(providerErrors.unauthorized);\n\n/**\n * An Ethereum Provider Unsupported Method (4200) error.\n *\n * This can be thrown by a Snap to indicate that the requested method is not\n * supported by the provider, without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors\n */\nexport const UnsupportedMethodError = createSnapError(\n  providerErrors.unsupportedMethod,\n);\n\n/**\n * An Ethereum Provider User Rejected Request (4001) error.\n *\n * This can be thrown by a Snap to indicate that the user rejected the request,\n * without crashing the Snap.\n *\n * @see https://eips.ethereum.org/EIPS/eip-1193#provider-errors\n */\nexport const UserRejectedRequestError = createSnapError(\n  providerErrors.userRejectedRequest,\n);\n"]}

package/dist/errors.cjs

@@ -0,0 +1,124 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SnapError_code, _SnapError_message, _SnapError_data, _SnapError_stack;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnapError = void 0;
+const internals_1 = require("./internals/index.cjs");
+/**
+ * A generic error which can be thrown by a Snap, without it causing the Snap to
+ * crash.
+ */
+class SnapError extends Error {
+    /**
+     * Create a new `SnapError`.
+     *
+     * @param error - The error to create the `SnapError` from. If this is a
+     * `string`, it will be used as the error message. If this is an `Error`, its
+     * `message` property will be used as the error message. If this is a
+     * `JsonRpcError`, its `message` property will be used as the error message
+     * and its `code` property will be used as the error code. Otherwise, the
+     * error will be converted to a string and used as the error message.
+     * @param data - Additional data to include in the error. This will be merged
+     * with the error data, if any.
+     */
+    constructor(error, data = {}) {
+        const message = (0, internals_1.getErrorMessage)(error);
+        super(message);
+        _SnapError_code.set(this, void 0);
+        _SnapError_message.set(this, void 0);
+        _SnapError_data.set(this, void 0);
+        _SnapError_stack.set(this, void 0);
+        __classPrivateFieldSet(this, _SnapError_message, message, "f");
+        __classPrivateFieldSet(this, _SnapError_code, (0, internals_1.getErrorCode)(error), "f");
+        const mergedData = { ...(0, internals_1.getErrorData)(error), ...data };
+        if (Object.keys(mergedData).length > 0) {
+            __classPrivateFieldSet(this, _SnapError_data, mergedData, "f");
+        }
+        __classPrivateFieldSet(this, _SnapError_stack, super.stack, "f");
+    }
+    /**
+     * The error name.
+     *
+     * @returns The error name.
+     */
+    get name() {
+        return 'SnapError';
+    }
+    /**
+     * The error code.
+     *
+     * @returns The error code.
+     */
+    get code() {
+        return __classPrivateFieldGet(this, _SnapError_code, "f");
+    }
+    /**
+     * The error message.
+     *
+     * @returns The error message.
+     */
+    // This line is covered, but Jest doesn't pick it up for some reason.
+    /* istanbul ignore next */
+    get message() {
+        return __classPrivateFieldGet(this, _SnapError_message, "f");
+    }
+    /**
+     * Additional data for the error.
+     *
+     * @returns Additional data for the error.
+     */
+    get data() {
+        return __classPrivateFieldGet(this, _SnapError_data, "f");
+    }
+    /**
+     * The error stack.
+     *
+     * @returns The error stack.
+     */
+    // This line is covered, but Jest doesn't pick it up for some reason.
+    /* istanbul ignore next */
+    get stack() {
+        return __classPrivateFieldGet(this, _SnapError_stack, "f");
+    }
+    /**
+     * Convert the error to a JSON object.
+     *
+     * @returns The JSON object.
+     */
+    toJSON() {
+        return {
+            code: internals_1.SNAP_ERROR_CODE,
+            message: internals_1.SNAP_ERROR_MESSAGE,
+            data: {
+                cause: {
+                    code: this.code,
+                    message: this.message,
+                    stack: this.stack,
+                    ...(this.data ? { data: this.data } : {}),
+                },
+            },
+        };
+    }
+    /**
+     * Serialize the error to a JSON object. This is called by
+     * `@metamask/rpc-errors` when serializing the error.
+     *
+     * @returns The JSON object.
+     */
+    serialize() {
+        return this.toJSON();
+    }
+}
+exports.SnapError = SnapError;
+_SnapError_code = new WeakMap(), _SnapError_message = new WeakMap(), _SnapError_data = new WeakMap(), _SnapError_stack = new WeakMap();
+//# sourceMappingURL=errors.cjs.map

package/dist/errors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.cjs","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,qDAMqB;AAErB;;;GAGG;AACH,MAAa,SAAU,SAAQ,KAAK;IASlC;;;;;;;;;;;OAWG;IACH,YACE,KAAoC,EACpC,OAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,IAAA,2BAAe,EAAC,KAAK,CAAC,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAzBR,kCAAc;QAEd,qCAAiB;QAEjB,kCAA6B;QAE7B,mCAAgB;QAqBvB,uBAAA,IAAI,sBAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,mBAAS,IAAA,wBAAY,EAAC,KAAK,CAAC,MAAA,CAAC;QAEjC,MAAM,UAAU,GAAG,EAAE,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QACvD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,uBAAA,IAAI,mBAAS,UAAU,MAAA,CAAC;QAC1B,CAAC;QAED,uBAAA,IAAI,oBAAU,KAAK,CAAC,KAAK,MAAA,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,uBAAM,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,0BAAS,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,uBAAM,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,wBAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,2BAAe;YACrB,OAAO,EAAE,8BAAkB;YAC3B,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1C;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF;AArHD,8BAqHC","sourcesContent":["import type { Json, JsonRpcError } from '@metamask/utils';\n\nimport {\n  getErrorCode,\n  getErrorData,\n  getErrorMessage,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from './internals';\n\n/**\n * A generic error which can be thrown by a Snap, without it causing the Snap to\n * crash.\n */\nexport class SnapError extends Error {\n  readonly #code: number;\n\n  readonly #message: string;\n\n  readonly #data?: Record<string, Json>;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `SnapError`.\n   *\n   * @param error - The error to create the `SnapError` from. If this is a\n   * `string`, it will be used as the error message. If this is an `Error`, its\n   * `message` property will be used as the error message. If this is a\n   * `JsonRpcError`, its `message` property will be used as the error message\n   * and its `code` property will be used as the error code. Otherwise, the\n   * error will be converted to a string and used as the error message.\n   * @param data - Additional data to include in the error. This will be merged\n   * with the error data, if any.\n   */\n  constructor(\n    error: string | Error | JsonRpcError,\n    data: Record<string, Json> = {},\n  ) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#message = message;\n    this.#code = getErrorCode(error);\n\n    const mergedData = { ...getErrorData(error), ...data };\n    if (Object.keys(mergedData).length > 0) {\n      this.#data = mergedData;\n    }\n\n    this.#stack = super.stack;\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'SnapError';\n  }\n\n  /**\n   * The error code.\n   *\n   * @returns The error code.\n   */\n  get code() {\n    return this.#code;\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * Additional data for the error.\n   *\n   * @returns Additional data for the error.\n   */\n  get data() {\n    return this.#data;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get stack() {\n    return this.#stack;\n  }\n\n  /**\n   * Convert the error to a JSON object.\n   *\n   * @returns The JSON object.\n   */\n  toJSON(): SerializedSnapError {\n    return {\n      code: SNAP_ERROR_CODE,\n      message: SNAP_ERROR_MESSAGE,\n      data: {\n        cause: {\n          code: this.code,\n          message: this.message,\n          stack: this.stack,\n          ...(this.data ? { data: this.data } : {}),\n        },\n      },\n    };\n  }\n\n  /**\n   * Serialize the error to a JSON object. This is called by\n   * `@metamask/rpc-errors` when serializing the error.\n   *\n   * @returns The JSON object.\n   */\n  serialize() {\n    return this.toJSON();\n  }\n}\n\n/**\n * A serialized {@link SnapError}. It's JSON-serializable, so it can be sent\n * over the RPC. The original error is wrapped in the `cause` property.\n *\n * @property code - The error code. This is always `-31002`.\n * @property message - The error message. This is always `'Snap Error'`.\n * @property data - The error data.\n * @property data.cause - The cause of the error.\n * @property data.cause.code - The error code.\n * @property data.cause.message - The error message.\n * @property data.cause.stack - The error stack.\n * @property data.cause.data - Additional data for the error.\n * @see SnapError\n */\nexport type SerializedSnapError = {\n  code: typeof SNAP_ERROR_CODE;\n  message: typeof SNAP_ERROR_MESSAGE;\n  data: {\n    cause: JsonRpcError;\n  };\n};\n"]}

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

@@ -1,5 +1,5 @@
-import type { Json, JsonRpcError } from '@metamask/utils';
-import { SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE } from './internals';
+import type { Json, JsonRpcError } from "@metamask/utils";
+import { SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE } from "./internals/index.cjs";
 /**
  * A generic error which can be thrown by a Snap, without it causing the Snap to
  * crash.
@@ -84,3 +84,4 @@ export type SerializedSnapError = {
         cause: JsonRpcError;
     };
 };
+//# sourceMappingURL=errors.d.cts.map

package/dist/errors.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.cts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,wBAAwB;AAE1D,OAAO,EAIL,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AAErB;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;;IASlC;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,EACpC,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAM;IAgBjC;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IAGH,IAAI,OAAO,WAEV;IAED;;;;OAIG;IACH,IAAI,IAAI,qCAEP;IAED;;;;OAIG;IAGH,IAAI,KAAK,uBAER;IAED;;;;OAIG;IACH,MAAM,IAAI,mBAAmB;IAe7B;;;;;OAKG;IACH,SAAS;CAGV;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,eAAe,CAAC;IAC7B,OAAO,EAAE,OAAO,kBAAkB,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;CACH,CAAC"}

package/dist/errors.d.mts

@@ -0,0 +1,87 @@
+import type { Json, JsonRpcError } from "@metamask/utils";
+import { SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE } from "./internals/index.mjs";
+/**
+ * A generic error which can be thrown by a Snap, without it causing the Snap to
+ * crash.
+ */
+export declare class SnapError extends Error {
+    #private;
+    /**
+     * Create a new `SnapError`.
+     *
+     * @param error - The error to create the `SnapError` from. If this is a
+     * `string`, it will be used as the error message. If this is an `Error`, its
+     * `message` property will be used as the error message. If this is a
+     * `JsonRpcError`, its `message` property will be used as the error message
+     * and its `code` property will be used as the error code. Otherwise, the
+     * error will be converted to a string and used as the error message.
+     * @param data - Additional data to include in the error. This will be merged
+     * with the error data, if any.
+     */
+    constructor(error: string | Error | JsonRpcError, data?: Record<string, Json>);
+    /**
+     * The error name.
+     *
+     * @returns The error name.
+     */
+    get name(): string;
+    /**
+     * The error code.
+     *
+     * @returns The error code.
+     */
+    get code(): number;
+    /**
+     * The error message.
+     *
+     * @returns The error message.
+     */
+    get message(): string;
+    /**
+     * Additional data for the error.
+     *
+     * @returns Additional data for the error.
+     */
+    get data(): Record<string, Json> | undefined;
+    /**
+     * The error stack.
+     *
+     * @returns The error stack.
+     */
+    get stack(): string | undefined;
+    /**
+     * Convert the error to a JSON object.
+     *
+     * @returns The JSON object.
+     */
+    toJSON(): SerializedSnapError;
+    /**
+     * Serialize the error to a JSON object. This is called by
+     * `@metamask/rpc-errors` when serializing the error.
+     *
+     * @returns The JSON object.
+     */
+    serialize(): SerializedSnapError;
+}
+/**
+ * A serialized {@link SnapError}. It's JSON-serializable, so it can be sent
+ * over the RPC. The original error is wrapped in the `cause` property.
+ *
+ * @property code - The error code. This is always `-31002`.
+ * @property message - The error message. This is always `'Snap Error'`.
+ * @property data - The error data.
+ * @property data.cause - The cause of the error.
+ * @property data.cause.code - The error code.
+ * @property data.cause.message - The error message.
+ * @property data.cause.stack - The error stack.
+ * @property data.cause.data - Additional data for the error.
+ * @see SnapError
+ */
+export type SerializedSnapError = {
+    code: typeof SNAP_ERROR_CODE;
+    message: typeof SNAP_ERROR_MESSAGE;
+    data: {
+        cause: JsonRpcError;
+    };
+};
+//# sourceMappingURL=errors.d.mts.map

package/dist/errors.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.mts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,wBAAwB;AAE1D,OAAO,EAIL,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AAErB;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;;IASlC;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,EACpC,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAM;IAgBjC;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IAGH,IAAI,OAAO,WAEV;IAED;;;;OAIG;IACH,IAAI,IAAI,qCAEP;IAED;;;;OAIG;IAGH,IAAI,KAAK,uBAER;IAED;;;;OAIG;IACH,MAAM,IAAI,mBAAmB;IAe7B;;;;;OAKG;IACH,SAAS;CAGV;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,eAAe,CAAC;IAC7B,OAAO,EAAE,OAAO,kBAAkB,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;CACH,CAAC"}

package/dist/errors.mjs

@@ -0,0 +1,120 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SnapError_code, _SnapError_message, _SnapError_data, _SnapError_stack;
+import { getErrorCode, getErrorData, getErrorMessage, SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE } from "./internals/index.mjs";
+/**
+ * A generic error which can be thrown by a Snap, without it causing the Snap to
+ * crash.
+ */
+export class SnapError extends Error {
+    /**
+     * Create a new `SnapError`.
+     *
+     * @param error - The error to create the `SnapError` from. If this is a
+     * `string`, it will be used as the error message. If this is an `Error`, its
+     * `message` property will be used as the error message. If this is a
+     * `JsonRpcError`, its `message` property will be used as the error message
+     * and its `code` property will be used as the error code. Otherwise, the
+     * error will be converted to a string and used as the error message.
+     * @param data - Additional data to include in the error. This will be merged
+     * with the error data, if any.
+     */
+    constructor(error, data = {}) {
+        const message = getErrorMessage(error);
+        super(message);
+        _SnapError_code.set(this, void 0);
+        _SnapError_message.set(this, void 0);
+        _SnapError_data.set(this, void 0);
+        _SnapError_stack.set(this, void 0);
+        __classPrivateFieldSet(this, _SnapError_message, message, "f");
+        __classPrivateFieldSet(this, _SnapError_code, getErrorCode(error), "f");
+        const mergedData = { ...getErrorData(error), ...data };
+        if (Object.keys(mergedData).length > 0) {
+            __classPrivateFieldSet(this, _SnapError_data, mergedData, "f");
+        }
+        __classPrivateFieldSet(this, _SnapError_stack, super.stack, "f");
+    }
+    /**
+     * The error name.
+     *
+     * @returns The error name.
+     */
+    get name() {
+        return 'SnapError';
+    }
+    /**
+     * The error code.
+     *
+     * @returns The error code.
+     */
+    get code() {
+        return __classPrivateFieldGet(this, _SnapError_code, "f");
+    }
+    /**
+     * The error message.
+     *
+     * @returns The error message.
+     */
+    // This line is covered, but Jest doesn't pick it up for some reason.
+    /* istanbul ignore next */
+    get message() {
+        return __classPrivateFieldGet(this, _SnapError_message, "f");
+    }
+    /**
+     * Additional data for the error.
+     *
+     * @returns Additional data for the error.
+     */
+    get data() {
+        return __classPrivateFieldGet(this, _SnapError_data, "f");
+    }
+    /**
+     * The error stack.
+     *
+     * @returns The error stack.
+     */
+    // This line is covered, but Jest doesn't pick it up for some reason.
+    /* istanbul ignore next */
+    get stack() {
+        return __classPrivateFieldGet(this, _SnapError_stack, "f");
+    }
+    /**
+     * Convert the error to a JSON object.
+     *
+     * @returns The JSON object.
+     */
+    toJSON() {
+        return {
+            code: SNAP_ERROR_CODE,
+            message: SNAP_ERROR_MESSAGE,
+            data: {
+                cause: {
+                    code: this.code,
+                    message: this.message,
+                    stack: this.stack,
+                    ...(this.data ? { data: this.data } : {}),
+                },
+            },
+        };
+    }
+    /**
+     * Serialize the error to a JSON object. This is called by
+     * `@metamask/rpc-errors` when serializing the error.
+     *
+     * @returns The JSON object.
+     */
+    serialize() {
+        return this.toJSON();
+    }
+}
+_SnapError_code = new WeakMap(), _SnapError_message = new WeakMap(), _SnapError_data = new WeakMap(), _SnapError_stack = new WeakMap();
+//# sourceMappingURL=errors.mjs.map

package/dist/errors.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.mjs","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AAErB;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IASlC;;;;;;;;;;;OAWG;IACH,YACE,KAAoC,EACpC,OAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAzBR,kCAAc;QAEd,qCAAiB;QAEjB,kCAA6B;QAE7B,mCAAgB;QAqBvB,uBAAA,IAAI,sBAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,mBAAS,YAAY,CAAC,KAAK,CAAC,MAAA,CAAC;QAEjC,MAAM,UAAU,GAAG,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QACvD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,uBAAA,IAAI,mBAAS,UAAU,MAAA,CAAC;QAC1B,CAAC;QAED,uBAAA,IAAI,oBAAU,KAAK,CAAC,KAAK,MAAA,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,uBAAM,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,0BAAS,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,uBAAM,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,wBAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,kBAAkB;YAC3B,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1C;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF","sourcesContent":["import type { Json, JsonRpcError } from '@metamask/utils';\n\nimport {\n  getErrorCode,\n  getErrorData,\n  getErrorMessage,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from './internals';\n\n/**\n * A generic error which can be thrown by a Snap, without it causing the Snap to\n * crash.\n */\nexport class SnapError extends Error {\n  readonly #code: number;\n\n  readonly #message: string;\n\n  readonly #data?: Record<string, Json>;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `SnapError`.\n   *\n   * @param error - The error to create the `SnapError` from. If this is a\n   * `string`, it will be used as the error message. If this is an `Error`, its\n   * `message` property will be used as the error message. If this is a\n   * `JsonRpcError`, its `message` property will be used as the error message\n   * and its `code` property will be used as the error code. Otherwise, the\n   * error will be converted to a string and used as the error message.\n   * @param data - Additional data to include in the error. This will be merged\n   * with the error data, if any.\n   */\n  constructor(\n    error: string | Error | JsonRpcError,\n    data: Record<string, Json> = {},\n  ) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#message = message;\n    this.#code = getErrorCode(error);\n\n    const mergedData = { ...getErrorData(error), ...data };\n    if (Object.keys(mergedData).length > 0) {\n      this.#data = mergedData;\n    }\n\n    this.#stack = super.stack;\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'SnapError';\n  }\n\n  /**\n   * The error code.\n   *\n   * @returns The error code.\n   */\n  get code() {\n    return this.#code;\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * Additional data for the error.\n   *\n   * @returns Additional data for the error.\n   */\n  get data() {\n    return this.#data;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get stack() {\n    return this.#stack;\n  }\n\n  /**\n   * Convert the error to a JSON object.\n   *\n   * @returns The JSON object.\n   */\n  toJSON(): SerializedSnapError {\n    return {\n      code: SNAP_ERROR_CODE,\n      message: SNAP_ERROR_MESSAGE,\n      data: {\n        cause: {\n          code: this.code,\n          message: this.message,\n          stack: this.stack,\n          ...(this.data ? { data: this.data } : {}),\n        },\n      },\n    };\n  }\n\n  /**\n   * Serialize the error to a JSON object. This is called by\n   * `@metamask/rpc-errors` when serializing the error.\n   *\n   * @returns The JSON object.\n   */\n  serialize() {\n    return this.toJSON();\n  }\n}\n\n/**\n * A serialized {@link SnapError}. It's JSON-serializable, so it can be sent\n * over the RPC. The original error is wrapped in the `cause` property.\n *\n * @property code - The error code. This is always `-31002`.\n * @property message - The error message. This is always `'Snap Error'`.\n * @property data - The error data.\n * @property data.cause - The cause of the error.\n * @property data.cause.code - The error code.\n * @property data.cause.message - The error message.\n * @property data.cause.stack - The error stack.\n * @property data.cause.data - Additional data for the error.\n * @see SnapError\n */\nexport type SerializedSnapError = {\n  code: typeof SNAP_ERROR_CODE;\n  message: typeof SNAP_ERROR_MESSAGE;\n  data: {\n    cause: JsonRpcError;\n  };\n};\n"]}

package/dist/images.cjs

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImageComponent = exports.getImageData = void 0;
+const utils_1 = require("@metamask/utils");
+const ui_1 = require("./ui/index.cjs");
+/**
+ * Get raw image data from a URL.
+ *
+ * @param url - The URL to get the image data from.
+ * @param options - The options to use when fetching the image data. This is
+ * passed directly to `fetch`.
+ * @returns A promise that resolves to the image data as a blob.
+ */
+async function getRawImageData(url, options) {
+    if (typeof fetch !== 'function') {
+        throw new Error(`Failed to fetch image data from "${url}": Using this function requires the "endowment:network-access" permission.`);
+    }
+    return fetch(url, options).then(async (response) => {
+        if (!response.ok) {
+            throw new Error(`Failed to fetch image data from "${url}": ${response.status} ${response.statusText}`);
+        }
+        const blob = await response.blob();
+        (0, utils_1.assert)(blob.type === 'image/jpeg' || blob.type === 'image/png', 'Expected image data to be a JPEG or PNG image.');
+        return blob;
+    });
+}
+/**
+ * Get image data as data-string from a URL. This is useful for embedding images
+ * inside of SVGs. Only JPEG and PNG images are supported.
+ *
+ * Note: This function uses `fetch` to get the image data. This means that using
+ * it requires the `endowment:network-access` permission.
+ *
+ * @example
+ * const imageData = await getImageData('https://cataas.com/cat');
+ * const svg = `
+ *   <svg width="100" height="100" xmlns="http://www.w3.org/2000/svg">
+ *     <image href="${imageData}" />
+ *   </svg>
+ * `;
+ *
+ * // Render the SVG in a Snap UI.
+ * const ui = image(svg);
+ * @param url - The URL to get the image data from.
+ * @param options - The options to use when fetching the image data. This is
+ * passed directly to `fetch`.
+ * @returns A promise that resolves to the image data as a data-string.
+ */
+async function getImageData(url, options) {
+    const blob = await getRawImageData(url, options);
+    const bytes = new Uint8Array(await blob.arrayBuffer());
+    return `data:${blob.type};base64,${(0, utils_1.bytesToBase64)(bytes)}`;
+}
+exports.getImageData = getImageData;
+/**
+ * Get an image component from a URL. This is useful for embedding images inside
+ * Snap UIs. Only JPEG and PNG images are supported.
+ *
+ * Note: This function uses `fetch` to get the image data. This means that using
+ * it requires the `endowment:network-access` permission.
+ *
+ * @example
+ * const component = await getImage('https://cataas.com/cat');
+ *
+ * return await snap.request({
+ *   method: 'snap_dialog',
+ *   params: {
+ *     type: 'alert',
+ *     content: panel([
+ *       component,
+ *     ]),
+ *   },
+ * });
+ * @param url - The URL to get the image data from.
+ * @param options - The options to use when fetching and rendering the image.
+ * @param options.width - The width of the image.
+ * @param options.height - The height of the image. If this is not provided, the
+ * width will be used as the height.
+ * @param options.request - The options to use when fetching the image data.
+ * This is passed directly to `fetch`.
+ * @returns A promise that resolves to the image data as an image component.
+ */
+async function getImageComponent(url, { width, height = width, request }) {
+    (0, utils_1.assert)(typeof width === 'number' && width > 0, 'Expected width to be a number greater than 0.');
+    (0, utils_1.assert)(typeof height === 'number' && height > 0, 'Expected height to be a number greater than 0.');
+    const imageData = await getImageData(url, request);
+    const size = `width="${width}" height="${height}"`;
+    return (0, ui_1.image)(`<svg ${size.trim()} xmlns="http://www.w3.org/2000/svg"><image ${size.trim()} href="${imageData}" /></svg>`);
+}
+exports.getImageComponent = getImageComponent;
+//# sourceMappingURL=images.cjs.map

package/dist/images.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.cjs","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":";;;AAAA,2CAAwD;AAExD,uCAA6B;AAE7B;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,OAAqB;IAC/D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,4EAA4E,CACpH,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,MAAM,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CACtF,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAA,cAAM,EACJ,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EACvD,gDAAgD,CACjD,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,OAAqB;IACnE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvD,OAAO,QAAQ,IAAI,CAAC,IAAI,WAAW,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;AAC5D,CAAC;AALD,oCAKC;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,EAAgB;IAEhD,IAAA,cAAM,EACJ,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,EACtC,+CAA+C,CAChD,CAAC;IAEF,IAAA,cAAM,EACJ,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,EACxC,gDAAgD,CACjD,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,IAAI,GAAG,UAAU,KAAK,aAAa,MAAM,GAAG,CAAC;IAEnD,OAAO,IAAA,UAAK,EACV,QAAQ,IAAI,CAAC,IAAI,EAAE,8CAA8C,IAAI,CAAC,IAAI,EAAE,UAAU,SAAS,YAAY,CAC5G,CAAC;AACJ,CAAC;AApBD,8CAoBC","sourcesContent":["import { assert, bytesToBase64 } from '@metamask/utils';\n\nimport { image } from './ui';\n\n/**\n * Get raw image data from a URL.\n *\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a blob.\n */\nasync function getRawImageData(url: string, options?: RequestInit) {\n  if (typeof fetch !== 'function') {\n    throw new Error(\n      `Failed to fetch image data from \"${url}\": Using this function requires the \"endowment:network-access\" permission.`,\n    );\n  }\n\n  return fetch(url, options).then(async (response) => {\n    if (!response.ok) {\n      throw new Error(\n        `Failed to fetch image data from \"${url}\": ${response.status} ${response.statusText}`,\n      );\n    }\n\n    const blob = await response.blob();\n    assert(\n      blob.type === 'image/jpeg' || blob.type === 'image/png',\n      'Expected image data to be a JPEG or PNG image.',\n    );\n\n    return blob;\n  });\n}\n\n/**\n * Get image data as data-string from a URL. This is useful for embedding images\n * inside of SVGs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const imageData = await getImageData('https://cataas.com/cat');\n * const svg = `\n *   <svg width=\"100\" height=\"100\" xmlns=\"http://www.w3.org/2000/svg\">\n *     <image href=\"${imageData}\" />\n *   </svg>\n * `;\n *\n * // Render the SVG in a Snap UI.\n * const ui = image(svg);\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a data-string.\n */\nexport async function getImageData(url: string, options?: RequestInit) {\n  const blob = await getRawImageData(url, options);\n  const bytes = new Uint8Array(await blob.arrayBuffer());\n\n  return `data:${blob.type};base64,${bytesToBase64(bytes)}`;\n}\n\n/**\n * Options for getting an SVG image element from a URL.\n *\n * @property width - The width of the image.\n * @property height - The height of the image. If this is not provided, the\n * width will be used as the height.\n * @property request - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n */\nexport type ImageOptions = {\n  width: number;\n  height?: number;\n  request?: RequestInit;\n};\n\n/**\n * Get an image component from a URL. This is useful for embedding images inside\n * Snap UIs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const component = await getImage('https://cataas.com/cat');\n *\n * return await snap.request({\n *   method: 'snap_dialog',\n *   params: {\n *     type: 'alert',\n *     content: panel([\n *       component,\n *     ]),\n *   },\n * });\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching and rendering the image.\n * @param options.width - The width of the image.\n * @param options.height - The height of the image. If this is not provided, the\n * width will be used as the height.\n * @param options.request - The options to use when fetching the image data.\n * This is passed directly to `fetch`.\n * @returns A promise that resolves to the image data as an image component.\n */\nexport async function getImageComponent(\n  url: string,\n  { width, height = width, request }: ImageOptions,\n) {\n  assert(\n    typeof width === 'number' && width > 0,\n    'Expected width to be a number greater than 0.',\n  );\n\n  assert(\n    typeof height === 'number' && height > 0,\n    'Expected height to be a number greater than 0.',\n  );\n\n  const imageData = await getImageData(url, request);\n  const size = `width=\"${width}\" height=\"${height}\"`;\n\n  return image(\n    `<svg ${size.trim()} xmlns=\"http://www.w3.org/2000/svg\"><image ${size.trim()} href=\"${imageData}\" /></svg>`,\n  );\n}\n"]}