@metamask/snaps-utils 8.0.1 → 8.1.1

package/dist/derivation-paths.mjs

@@ -1,13 +1,207 @@
-import {
-  SNAPS_DERIVATION_PATHS,
-  getSlip44ProtocolName,
-  getSnapDerivationPathName
-} from "./chunk-IELPPZJP.mjs";
-import "./chunk-P252LKUT.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  SNAPS_DERIVATION_PATHS,
-  getSlip44ProtocolName,
-  getSnapDerivationPathName
-};
+import slip44 from "@metamask/slip44" with { type: "json" };
+import { isEqual } from "./array.mjs";
+export const SNAPS_DERIVATION_PATHS = [
+    {
+        path: ['m', `44'`, `0'`],
+        curve: 'ed25519',
+        name: 'Test BIP-32 Path (ed25519)',
+    },
+    {
+        path: ['m', `44'`, `1'`],
+        curve: 'secp256k1',
+        name: 'Testnet',
+    },
+    {
+        path: ['m', `44'`, `0'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Legacy',
+    },
+    {
+        path: ['m', `49'`, `0'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Nested SegWit',
+    },
+    {
+        path: ['m', `49'`, `1'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Testnet Nested SegWit',
+    },
+    {
+        path: ['m', `84'`, `0'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Native SegWit',
+    },
+    {
+        path: ['m', `84'`, `1'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Testnet Native SegWit',
+    },
+    {
+        path: ['m', `86'`, `0'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Taproot',
+    },
+    {
+        path: ['m', `86'`, `1'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Testnet Taproot',
+    },
+    {
+        path: ['m', `44'`, `501'`],
+        curve: 'ed25519',
+        name: 'Solana',
+    },
+    {
+        path: ['m', `44'`, `501'`, "0'", "0'"],
+        curve: 'ed25519',
+        name: 'Solana',
+    },
+    {
+        path: ['m', `44'`, `2'`],
+        curve: 'secp256k1',
+        name: 'Litecoin',
+    },
+    {
+        path: ['m', `44'`, `3'`],
+        curve: 'secp256k1',
+        name: 'Dogecoin',
+    },
+    {
+        path: ['m', `44'`, `60'`],
+        curve: 'secp256k1',
+        name: 'Ethereum',
+    },
+    {
+        path: ['m', `44'`, `118'`],
+        curve: 'secp256k1',
+        name: 'Atom',
+    },
+    {
+        path: ['m', `44'`, `145'`],
+        curve: 'secp256k1',
+        name: 'Bitcoin Cash',
+    },
+    {
+        path: ['m', `44'`, `637'`],
+        curve: 'ed25519',
+        name: 'Aptos',
+    },
+    {
+        path: ['m', `44'`, `714'`],
+        curve: 'secp256k1',
+        name: 'Binance (BNB)',
+    },
+    {
+        path: ['m', `44'`, `784'`],
+        curve: 'ed25519',
+        name: 'Sui',
+    },
+    {
+        path: ['m', `44'`, `931'`],
+        curve: 'secp256k1',
+        name: 'THORChain (RUNE)',
+    },
+    {
+        path: ['m', `44'`, `330'`],
+        curve: 'secp256k1',
+        name: 'Terra (LUNA)',
+    },
+    {
+        path: ['m', `44'`, `459'`],
+        curve: 'secp256k1',
+        name: 'Kava',
+    },
+    {
+        path: ['m', `44'`, `529'`],
+        curve: 'secp256k1',
+        name: 'Secret Network',
+    },
+    {
+        path: ['m', `44'`, `397'`, `0'`],
+        curve: 'ed25519',
+        name: 'NEAR Protocol',
+    },
+    {
+        path: ['m', `44'`, `1'`, `0'`],
+        curve: 'ed25519',
+        name: 'Testnet',
+    },
+    {
+        path: ['m', `44'`, `472'`],
+        curve: 'ed25519',
+        name: 'Arweave',
+    },
+    {
+        path: ['m', `44'`, `12586'`],
+        curve: 'secp256k1',
+        name: 'Mina',
+    },
+    {
+        path: ['m', `44'`, `242'`],
+        curve: 'ed25519',
+        name: 'Nimiq',
+    },
+    {
+        path: ['m', `44'`, `1729'`, `0'`, `0'`],
+        curve: 'ed25519',
+        name: 'Tezos',
+    },
+    {
+        path: ['m', `1789'`, `0'`],
+        curve: 'ed25519',
+        name: 'Vega',
+    },
+    {
+        path: ['m', `1852'`, `1815'`],
+        curve: 'ed25519Bip32',
+        name: 'Cardano',
+    },
+    {
+        path: ['m', `44'`, `508'`, `0'`, `0'`, `0'`],
+        curve: 'ed25519',
+        name: 'MultiversX',
+    },
+    {
+        path: ['m', `44'`, `709'`],
+        curve: 'secp256k1',
+        name: 'Avail',
+    },
+];
+/**
+ * Gets the name of a derivation path supported by snaps.
+ *
+ * @param path - The derivation path.
+ * @param curve - The curve used to derive the keys.
+ * @returns The name of the derivation path, otherwise null.
+ */
+export function getSnapDerivationPathName(path, curve) {
+    const pathMetadata = SNAPS_DERIVATION_PATHS.find((derivationPath) => derivationPath.curve === curve && isEqual(derivationPath.path, path));
+    if (pathMetadata) {
+        return pathMetadata.name;
+    }
+    // If the curve is secp256k1 and the path is a valid BIP44 path
+    // we try looking for the network/protocol name in SLIP44
+    if (curve === 'secp256k1' &&
+        path[0] === 'm' &&
+        path[1] === `44'` &&
+        path[2].endsWith(`'`)) {
+        const coinType = path[2].slice(0, -1);
+        return getSlip44ProtocolName(coinType) ?? null;
+    }
+    return null;
+}
+/**
+ * Gets the name of the SLIP-44 protocol corresponding to the specified
+ * `coin_type`.
+ *
+ * @param coinType - The SLIP-44 `coin_type` value whose name
+ * to retrieve.
+ * @returns The name of the protocol, otherwise null.
+ */
+export function getSlip44ProtocolName(coinType) {
+    if (String(coinType) === '1') {
+        return 'Test Networks';
+    }
+    return slip44[coinType]?.name ?? null;
+}
 //# sourceMappingURL=derivation-paths.mjs.map

package/dist/derivation-paths.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"derivation-paths.mjs","sourceRoot":"","sources":["../src/derivation-paths.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,+CAAyB;AAEtC,OAAO,EAAE,OAAO,EAAE,oBAAgB;AAQlC,MAAM,CAAC,MAAM,sBAAsB,GAA0B;IAC3D;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,4BAA4B;KACnC;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,SAAS;KAChB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,gBAAgB;KACvB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,uBAAuB;KAC9B;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,+BAA+B;KACtC;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,uBAAuB;KAC9B;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,+BAA+B;KACtC;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,iBAAiB;KACxB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;KACf;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC;QACtC,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;KACf;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;QACxB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC;QACzB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,MAAM;KACb;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,cAAc;KACrB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,OAAO;KACd;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,eAAe;KACtB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,KAAK;KACZ;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,kBAAkB;KACzB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,cAAc;KACrB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,MAAM;KACb;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,gBAAgB;KACvB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC;QAChC,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,eAAe;KACtB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC;QAC9B,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,SAAS;KAChB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,SAAS;KAChB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC;QAC5B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,MAAM;KACb;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,OAAO;KACd;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC;QACvC,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,OAAO;KACd;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC;QAC1B,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,MAAM;KACb;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC;QAC7B,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,SAAS;KAChB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;QAC5C,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,YAAY;KACnB;IACD;QACE,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QAC1B,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,OAAO;KACd;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,yBAAyB,CACvC,IAAiC,EACjC,KAAqB;IAErB,MAAM,YAAY,GAAG,sBAAsB,CAAC,IAAI,CAC9C,CAAC,cAAc,EAAE,EAAE,CACjB,cAAc,CAAC,KAAK,KAAK,KAAK,IAAI,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CACvE,CAAC;IAEF,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,+DAA+D;IAC/D,yDAAyD;IACzD,IACE,KAAK,KAAK,WAAW;QACrB,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG;QACf,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK;QACjB,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EACrB,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACtC,OAAO,qBAAqB,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC;IACjD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAyB;IAC7D,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,EAAE,CAAC;QAC7B,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC,QAA+B,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC;AAC/D,CAAC","sourcesContent":["import type { SupportedCurve } from '@metamask/key-tree';\nimport slip44 from '@metamask/slip44';\n\nimport { isEqual } from './array';\n\nexport type SnapsDerivationPath = {\n  path: ['m', ...string[]];\n  curve: SupportedCurve;\n  name: string;\n};\n\nexport const SNAPS_DERIVATION_PATHS: SnapsDerivationPath[] = [\n  {\n    path: ['m', `44'`, `0'`],\n    curve: 'ed25519',\n    name: 'Test BIP-32 Path (ed25519)',\n  },\n  {\n    path: ['m', `44'`, `1'`],\n    curve: 'secp256k1',\n    name: 'Testnet',\n  },\n  {\n    path: ['m', `44'`, `0'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Legacy',\n  },\n  {\n    path: ['m', `49'`, `0'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Nested SegWit',\n  },\n  {\n    path: ['m', `49'`, `1'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Testnet Nested SegWit',\n  },\n  {\n    path: ['m', `84'`, `0'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Native SegWit',\n  },\n  {\n    path: ['m', `84'`, `1'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Testnet Native SegWit',\n  },\n  {\n    path: ['m', `86'`, `0'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Taproot',\n  },\n  {\n    path: ['m', `86'`, `1'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Testnet Taproot',\n  },\n  {\n    path: ['m', `44'`, `501'`],\n    curve: 'ed25519',\n    name: 'Solana',\n  },\n  {\n    path: ['m', `44'`, `501'`, \"0'\", \"0'\"],\n    curve: 'ed25519',\n    name: 'Solana',\n  },\n  {\n    path: ['m', `44'`, `2'`],\n    curve: 'secp256k1',\n    name: 'Litecoin',\n  },\n  {\n    path: ['m', `44'`, `3'`],\n    curve: 'secp256k1',\n    name: 'Dogecoin',\n  },\n  {\n    path: ['m', `44'`, `60'`],\n    curve: 'secp256k1',\n    name: 'Ethereum',\n  },\n  {\n    path: ['m', `44'`, `118'`],\n    curve: 'secp256k1',\n    name: 'Atom',\n  },\n  {\n    path: ['m', `44'`, `145'`],\n    curve: 'secp256k1',\n    name: 'Bitcoin Cash',\n  },\n  {\n    path: ['m', `44'`, `637'`],\n    curve: 'ed25519',\n    name: 'Aptos',\n  },\n  {\n    path: ['m', `44'`, `714'`],\n    curve: 'secp256k1',\n    name: 'Binance (BNB)',\n  },\n  {\n    path: ['m', `44'`, `784'`],\n    curve: 'ed25519',\n    name: 'Sui',\n  },\n  {\n    path: ['m', `44'`, `931'`],\n    curve: 'secp256k1',\n    name: 'THORChain (RUNE)',\n  },\n  {\n    path: ['m', `44'`, `330'`],\n    curve: 'secp256k1',\n    name: 'Terra (LUNA)',\n  },\n  {\n    path: ['m', `44'`, `459'`],\n    curve: 'secp256k1',\n    name: 'Kava',\n  },\n  {\n    path: ['m', `44'`, `529'`],\n    curve: 'secp256k1',\n    name: 'Secret Network',\n  },\n  {\n    path: ['m', `44'`, `397'`, `0'`],\n    curve: 'ed25519',\n    name: 'NEAR Protocol',\n  },\n  {\n    path: ['m', `44'`, `1'`, `0'`],\n    curve: 'ed25519',\n    name: 'Testnet',\n  },\n  {\n    path: ['m', `44'`, `472'`],\n    curve: 'ed25519',\n    name: 'Arweave',\n  },\n  {\n    path: ['m', `44'`, `12586'`],\n    curve: 'secp256k1',\n    name: 'Mina',\n  },\n  {\n    path: ['m', `44'`, `242'`],\n    curve: 'ed25519',\n    name: 'Nimiq',\n  },\n  {\n    path: ['m', `44'`, `1729'`, `0'`, `0'`],\n    curve: 'ed25519',\n    name: 'Tezos',\n  },\n  {\n    path: ['m', `1789'`, `0'`],\n    curve: 'ed25519',\n    name: 'Vega',\n  },\n  {\n    path: ['m', `1852'`, `1815'`],\n    curve: 'ed25519Bip32',\n    name: 'Cardano',\n  },\n  {\n    path: ['m', `44'`, `508'`, `0'`, `0'`, `0'`],\n    curve: 'ed25519',\n    name: 'MultiversX',\n  },\n  {\n    path: ['m', `44'`, `709'`],\n    curve: 'secp256k1',\n    name: 'Avail',\n  },\n];\n\n/**\n * Gets the name of a derivation path supported by snaps.\n *\n * @param path - The derivation path.\n * @param curve - The curve used to derive the keys.\n * @returns The name of the derivation path, otherwise null.\n */\nexport function getSnapDerivationPathName(\n  path: SnapsDerivationPath['path'],\n  curve: SupportedCurve,\n): string | null {\n  const pathMetadata = SNAPS_DERIVATION_PATHS.find(\n    (derivationPath) =>\n      derivationPath.curve === curve && isEqual(derivationPath.path, path),\n  );\n\n  if (pathMetadata) {\n    return pathMetadata.name;\n  }\n\n  // If the curve is secp256k1 and the path is a valid BIP44 path\n  // we try looking for the network/protocol name in SLIP44\n  if (\n    curve === 'secp256k1' &&\n    path[0] === 'm' &&\n    path[1] === `44'` &&\n    path[2].endsWith(`'`)\n  ) {\n    const coinType = path[2].slice(0, -1);\n    return getSlip44ProtocolName(coinType) ?? null;\n  }\n\n  return null;\n}\n\n/**\n * Gets the name of the SLIP-44 protocol corresponding to the specified\n * `coin_type`.\n *\n * @param coinType - The SLIP-44 `coin_type` value whose name\n * to retrieve.\n * @returns The name of the protocol, otherwise null.\n */\nexport function getSlip44ProtocolName(coinType: number | string) {\n  if (String(coinType) === '1') {\n    return 'Test Networks';\n  }\n\n  return slip44[coinType as keyof typeof slip44]?.name ?? null;\n}\n"]}

package/dist/entropy.cjs

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STATE_ENCRYPTION_MAGIC_VALUE = exports.SIP_6_MAGIC_VALUE = void 0;
+// 0xd36e6170 - 0x80000000
+exports.SIP_6_MAGIC_VALUE = `1399742832'`;
+// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`
+exports.STATE_ENCRYPTION_MAGIC_VALUE = `572232532'`;
+//# sourceMappingURL=entropy.cjs.map

package/dist/entropy.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.cjs","sourceRoot":"","sources":["../src/entropy.ts"],"names":[],"mappings":";;;AAAA,0BAA0B;AACb,QAAA,iBAAiB,GAAG,aAA6B,CAAC;AAE/D,uEAAuE;AAC1D,QAAA,4BAA4B,GAAG,YAA4B,CAAC","sourcesContent":["// 0xd36e6170 - 0x80000000\nexport const SIP_6_MAGIC_VALUE = `1399742832'` as `${number}'`;\n\n// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`\nexport const STATE_ENCRYPTION_MAGIC_VALUE = `572232532'` as `${number}'`;\n\nexport type MagicValue =\n  | typeof SIP_6_MAGIC_VALUE\n  | typeof STATE_ENCRYPTION_MAGIC_VALUE;\n"]}

package/dist/entropy.d.cts

@@ -0,0 +1,4 @@
+export declare const SIP_6_MAGIC_VALUE: `${number}'`;
+export declare const STATE_ENCRYPTION_MAGIC_VALUE: `${number}'`;
+export type MagicValue = typeof SIP_6_MAGIC_VALUE | typeof STATE_ENCRYPTION_MAGIC_VALUE;
+//# sourceMappingURL=entropy.d.cts.map

package/dist/entropy.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.d.cts","sourceRoot":"","sources":["../src/entropy.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,iBAAiB,cAAgC,CAAC;AAG/D,eAAO,MAAM,4BAA4B,cAA+B,CAAC;AAEzE,MAAM,MAAM,UAAU,GAClB,OAAO,iBAAiB,GACxB,OAAO,4BAA4B,CAAC"}

package/dist/entropy.d.mts

@@ -0,0 +1,4 @@
+export declare const SIP_6_MAGIC_VALUE: `${number}'`;
+export declare const STATE_ENCRYPTION_MAGIC_VALUE: `${number}'`;
+export type MagicValue = typeof SIP_6_MAGIC_VALUE | typeof STATE_ENCRYPTION_MAGIC_VALUE;
+//# sourceMappingURL=entropy.d.mts.map

package/dist/entropy.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entropy.d.mts","sourceRoot":"","sources":["../src/entropy.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,iBAAiB,cAAgC,CAAC;AAG/D,eAAO,MAAM,4BAA4B,cAA+B,CAAC;AAEzE,MAAM,MAAM,UAAU,GAClB,OAAO,iBAAiB,GACxB,OAAO,4BAA4B,CAAC"}

package/dist/entropy.mjs

@@ -1,10 +1,5 @@
-import {
-  SIP_6_MAGIC_VALUE,
-  STATE_ENCRYPTION_MAGIC_VALUE
-} from "./chunk-AS5P6JRP.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  SIP_6_MAGIC_VALUE,
-  STATE_ENCRYPTION_MAGIC_VALUE
-};
+// 0xd36e6170 - 0x80000000
+export const SIP_6_MAGIC_VALUE = `1399742832'`;
+// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`
+export const STATE_ENCRYPTION_MAGIC_VALUE = `572232532'`;
 //# sourceMappingURL=entropy.mjs.map

package/dist/entropy.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"entropy.mjs","sourceRoot":"","sources":["../src/entropy.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAA6B,CAAC;AAE/D,uEAAuE;AACvE,MAAM,CAAC,MAAM,4BAA4B,GAAG,YAA4B,CAAC","sourcesContent":["// 0xd36e6170 - 0x80000000\nexport const SIP_6_MAGIC_VALUE = `1399742832'` as `${number}'`;\n\n// `${bytesToNumber(keccak256('Snaps state encryption').slice(0, 4))}'`\nexport const STATE_ENCRYPTION_MAGIC_VALUE = `572232532'` as `${number}'`;\n\nexport type MagicValue =\n  | typeof SIP_6_MAGIC_VALUE\n  | typeof STATE_ENCRYPTION_MAGIC_VALUE;\n"]}

package/dist/errors.cjs

@@ -0,0 +1,189 @@
+"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 _WrappedSnapError_error, _WrappedSnapError_message, _WrappedSnapError_stack;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unwrapError = exports.isWrappedSnapError = exports.isSerializedSnapError = exports.isSnapError = exports.WrappedSnapError = exports.SNAP_ERROR_WRAPPER_MESSAGE = exports.SNAP_ERROR_WRAPPER_CODE = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const utils_1 = require("@metamask/utils");
+exports.SNAP_ERROR_WRAPPER_CODE = -31001;
+exports.SNAP_ERROR_WRAPPER_MESSAGE = 'Wrapped Snap Error';
+class WrappedSnapError extends Error {
+    /**
+     * Create a new `WrappedSnapError`.
+     *
+     * @param error - The error to create the `WrappedSnapError` from.
+     */
+    constructor(error) {
+        const message = (0, snaps_sdk_1.getErrorMessage)(error);
+        super(message);
+        _WrappedSnapError_error.set(this, void 0);
+        _WrappedSnapError_message.set(this, void 0);
+        _WrappedSnapError_stack.set(this, void 0);
+        __classPrivateFieldSet(this, _WrappedSnapError_error, error, "f");
+        __classPrivateFieldSet(this, _WrappedSnapError_message, message, "f");
+        __classPrivateFieldSet(this, _WrappedSnapError_stack, (0, snaps_sdk_1.getErrorStack)(error), "f");
+    }
+    /**
+     * The error name.
+     *
+     * @returns The error name.
+     */
+    get name() {
+        return 'WrappedSnapError';
+    }
+    /**
+     * The error message.
+     *
+     * @returns The error message.
+     */
+    get message() {
+        return __classPrivateFieldGet(this, _WrappedSnapError_message, "f");
+    }
+    /**
+     * The error stack.
+     *
+     * @returns The error stack.
+     */
+    get stack() {
+        return __classPrivateFieldGet(this, _WrappedSnapError_stack, "f");
+    }
+    /**
+     * Convert the error to a JSON object.
+     *
+     * @returns The JSON object.
+     */
+    toJSON() {
+        const cause = isSnapError(__classPrivateFieldGet(this, _WrappedSnapError_error, "f"))
+            ? __classPrivateFieldGet(this, _WrappedSnapError_error, "f").serialize()
+            : (0, rpc_errors_1.serializeCause)(__classPrivateFieldGet(this, _WrappedSnapError_error, "f"));
+        return {
+            code: exports.SNAP_ERROR_WRAPPER_CODE,
+            message: exports.SNAP_ERROR_WRAPPER_MESSAGE,
+            data: {
+                cause,
+            },
+        };
+    }
+    /**
+     * 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.WrappedSnapError = WrappedSnapError;
+_WrappedSnapError_error = new WeakMap(), _WrappedSnapError_message = new WeakMap(), _WrappedSnapError_stack = new WeakMap();
+/**
+ * Check if an object is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+function isSnapError(error) {
+    if ((0, utils_1.isObject)(error) &&
+        'serialize' in error &&
+        typeof error.serialize === 'function') {
+        const serialized = error.serialize();
+        return (0, utils_1.isJsonRpcError)(serialized) && isSerializedSnapError(serialized);
+    }
+    return false;
+}
+exports.isSnapError = isSnapError;
+/**
+ * Check if a JSON-RPC error is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+function isSerializedSnapError(error) {
+    return error.code === snaps_sdk_1.SNAP_ERROR_CODE && error.message === snaps_sdk_1.SNAP_ERROR_MESSAGE;
+}
+exports.isSerializedSnapError = isSerializedSnapError;
+/**
+ * Check if a JSON-RPC error is a `WrappedSnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `WrappedSnapError`.
+ */
+function isWrappedSnapError(error) {
+    return ((0, utils_1.isJsonRpcError)(error) &&
+        error.code === exports.SNAP_ERROR_WRAPPER_CODE &&
+        error.message === exports.SNAP_ERROR_WRAPPER_MESSAGE);
+}
+exports.isWrappedSnapError = isWrappedSnapError;
+/**
+ * Get a JSON-RPC error with the given code, message, stack, and data.
+ *
+ * @param code - The error code.
+ * @param message - The error message.
+ * @param stack - The error stack.
+ * @param data - Additional data for the error.
+ * @returns The JSON-RPC error.
+ */
+function getJsonRpcError(code, message, stack, data) {
+    const error = new rpc_errors_1.JsonRpcError(code, message, data);
+    error.stack = stack;
+    return error;
+}
+/**
+ * Attempt to unwrap an unknown error to a `JsonRpcError`. This function will
+ * try to get the error code, message, and data from the error, and return a
+ * `JsonRpcError` with those properties.
+ *
+ * @param error - The error to unwrap.
+ * @returns A tuple containing the unwrapped error and a boolean indicating
+ * whether the error was handled.
+ */
+function unwrapError(error) {
+    // This logic is a bit complicated, but it's necessary to handle all the
+    // different types of errors that can be thrown by a Snap.
+    // If the error is a wrapped Snap error, unwrap it.
+    if (isWrappedSnapError(error)) {
+        // The wrapped error can be a JSON-RPC error, or an unknown error. If it's
+        // a JSON-RPC error, we can unwrap it further.
+        if ((0, utils_1.isJsonRpcError)(error.data.cause)) {
+            // If the JSON-RPC error is a wrapped Snap error, unwrap it further.
+            if (isSerializedSnapError(error.data.cause)) {
+                const { code, message, stack, data } = error.data.cause.data.cause;
+                return [getJsonRpcError(code, message, stack, data), true];
+            }
+            // Otherwise, we use the original JSON-RPC error.
+            const { code, message, stack, data } = error.data.cause;
+            return [getJsonRpcError(code, message, stack, data), false];
+        }
+        // Otherwise, we throw an internal error with the wrapped error as the
+        // message.
+        return [
+            getJsonRpcError(rpc_errors_1.errorCodes.rpc.internal, (0, snaps_sdk_1.getErrorMessage)(error.data.cause), (0, snaps_sdk_1.getErrorStack)(error.data.cause)),
+            false,
+        ];
+    }
+    // The error can be a non-wrapped JSON-RPC error, in which case we can just
+    // re-throw it with the same code, message, and data.
+    if ((0, utils_1.isJsonRpcError)(error)) {
+        const { code, message, stack, data } = error;
+        return [getJsonRpcError(code, message, stack, data), false];
+    }
+    // If the error is not a wrapped error, we don't know how to handle it, so we
+    // throw an internal error with the error as the message.
+    return [
+        getJsonRpcError(rpc_errors_1.errorCodes.rpc.internal, (0, snaps_sdk_1.getErrorMessage)(error), (0, snaps_sdk_1.getErrorStack)(error)),
+        false,
+    ];
+}
+exports.unwrapError = unwrapError;
+//# sourceMappingURL=errors.cjs.map

package/dist/errors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.cjs","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,qDAI8B;AAG9B,mDAK6B;AAE7B,2CAA2D;AAE9C,QAAA,uBAAuB,GAAG,CAAC,KAAK,CAAC;AACjC,QAAA,0BAA0B,GAAG,oBAAoB,CAAC;AAU/D,MAAa,gBAAiB,SAAQ,KAAK;IAOzC;;;;OAIG;IACH,YAAY,KAAc;QACxB,MAAM,OAAO,GAAG,IAAA,2BAAe,EAAC,KAAK,CAAC,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAbR,0CAAgB;QAEhB,4CAAiB;QAEjB,0CAAgB;QAWvB,uBAAA,IAAI,2BAAU,KAAK,MAAA,CAAC;QACpB,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,2BAAU,IAAA,yBAAa,EAAC,KAAK,CAAC,MAAA,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,iCAAS,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,+BAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,KAAK,GAAG,WAAW,CAAC,uBAAA,IAAI,+BAAO,CAAC;YACpC,CAAC,CAAC,uBAAA,IAAI,+BAAO,CAAC,SAAS,EAAE;YACzB,CAAC,CAAC,IAAA,2BAAc,EAAC,uBAAA,IAAI,+BAAO,CAAC,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,+BAAuB;YAC7B,OAAO,EAAE,kCAA0B;YACnC,IAAI,EAAE;gBACJ,KAAK;aACN;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF;AA5ED,4CA4EC;;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,IACE,IAAA,gBAAQ,EAAC,KAAK,CAAC;QACf,WAAW,IAAI,KAAK;QACpB,OAAO,KAAK,CAAC,SAAS,KAAK,UAAU,EACrC,CAAC;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QACrC,OAAO,IAAA,sBAAc,EAAC,UAAU,CAAC,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAXD,kCAWC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,KAAmB;IAEnB,OAAO,KAAK,CAAC,IAAI,KAAK,2BAAe,IAAI,KAAK,CAAC,OAAO,KAAK,8BAAkB,CAAC;AAChF,CAAC;AAJD,sDAIC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,KAAc;IAEd,OAAO,CACL,IAAA,sBAAc,EAAC,KAAK,CAAC;QACrB,KAAK,CAAC,IAAI,KAAK,+BAAuB;QACtC,KAAK,CAAC,OAAO,KAAK,kCAA0B,CAC7C,CAAC;AACJ,CAAC;AARD,gDAQC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe,CACtB,IAAY,EACZ,OAAe,EACf,KAAc,EACd,IAAW;IAEX,MAAM,KAAK,GAAG,IAAI,yBAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAChD,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;IAEpB,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CACzB,KAAc;IAEd,wEAAwE;IACxE,0DAA0D;IAE1D,mDAAmD;IACnD,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,0EAA0E;QAC1E,8CAA8C;QAC9C,IAAI,IAAA,sBAAc,EAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,oEAAoE;YACpE,IAAI,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;gBACnE,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;YAC7D,CAAC;YAED,iDAAiD;YACjD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YACxD,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;QAED,sEAAsE;QACtE,WAAW;QACX,OAAO;YACL,eAAe,CACb,uBAAU,CAAC,GAAG,CAAC,QAAQ,EACvB,IAAA,2BAAe,EAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EACjC,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAChC;YACD,KAAK;SACN,CAAC;IACJ,CAAC;IAED,2EAA2E;IAC3E,qDAAqD;IACrD,IAAI,IAAA,sBAAc,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAC7C,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED,6EAA6E;IAC7E,yDAAyD;IACzD,OAAO;QACL,eAAe,CACb,uBAAU,CAAC,GAAG,CAAC,QAAQ,EACvB,IAAA,2BAAe,EAAC,KAAK,CAAC,EACtB,IAAA,yBAAa,EAAC,KAAK,CAAC,CACrB;QACD,KAAK;KACN,CAAC;AACJ,CAAC;AAnDD,kCAmDC","sourcesContent":["import {\n  errorCodes,\n  JsonRpcError as RpcError,\n  serializeCause,\n} from '@metamask/rpc-errors';\nimport type { DataWithOptionalCause } from '@metamask/rpc-errors';\nimport type { SerializedSnapError, SnapError } from '@metamask/snaps-sdk';\nimport {\n  getErrorMessage,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from '@metamask/snaps-sdk';\nimport type { Json, JsonRpcError } from '@metamask/utils';\nimport { isObject, isJsonRpcError } from '@metamask/utils';\n\nexport const SNAP_ERROR_WRAPPER_CODE = -31001;\nexport const SNAP_ERROR_WRAPPER_MESSAGE = 'Wrapped Snap Error';\n\nexport type SerializedSnapErrorWrapper = {\n  code: typeof SNAP_ERROR_WRAPPER_CODE;\n  message: typeof SNAP_ERROR_WRAPPER_MESSAGE;\n  data: {\n    cause: Json;\n  };\n};\n\nexport class WrappedSnapError extends Error {\n  readonly #error: unknown;\n\n  readonly #message: string;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `WrappedSnapError`.\n   *\n   * @param error - The error to create the `WrappedSnapError` from.\n   */\n  constructor(error: unknown) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#error = error;\n    this.#message = message;\n    this.#stack = getErrorStack(error);\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'WrappedSnapError';\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\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(): SerializedSnapErrorWrapper {\n    const cause = isSnapError(this.#error)\n      ? this.#error.serialize()\n      : serializeCause(this.#error);\n\n    return {\n      code: SNAP_ERROR_WRAPPER_CODE,\n      message: SNAP_ERROR_WRAPPER_MESSAGE,\n      data: {\n        cause,\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 * Check if an object is a `SnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `SnapError`.\n */\nexport function isSnapError(error: unknown): error is SnapError {\n  if (\n    isObject(error) &&\n    'serialize' in error &&\n    typeof error.serialize === 'function'\n  ) {\n    const serialized = error.serialize();\n    return isJsonRpcError(serialized) && isSerializedSnapError(serialized);\n  }\n\n  return false;\n}\n\n/**\n * Check if a JSON-RPC error is a `SnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `SnapError`.\n */\nexport function isSerializedSnapError(\n  error: JsonRpcError,\n): error is SerializedSnapError {\n  return error.code === SNAP_ERROR_CODE && error.message === SNAP_ERROR_MESSAGE;\n}\n\n/**\n * Check if a JSON-RPC error is a `WrappedSnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `WrappedSnapError`.\n */\nexport function isWrappedSnapError(\n  error: unknown,\n): error is SerializedSnapErrorWrapper {\n  return (\n    isJsonRpcError(error) &&\n    error.code === SNAP_ERROR_WRAPPER_CODE &&\n    error.message === SNAP_ERROR_WRAPPER_MESSAGE\n  );\n}\n\n/**\n * Get a JSON-RPC error with the given code, message, stack, and data.\n *\n * @param code - The error code.\n * @param message - The error message.\n * @param stack - The error stack.\n * @param data - Additional data for the error.\n * @returns The JSON-RPC error.\n */\nfunction getJsonRpcError(\n  code: number,\n  message: string,\n  stack?: string,\n  data?: Json,\n) {\n  const error = new RpcError(code, message, data);\n  error.stack = stack;\n\n  return error;\n}\n\n/**\n * Attempt to unwrap an unknown error to a `JsonRpcError`. This function will\n * try to get the error code, message, and data from the error, and return a\n * `JsonRpcError` with those properties.\n *\n * @param error - The error to unwrap.\n * @returns A tuple containing the unwrapped error and a boolean indicating\n * whether the error was handled.\n */\nexport function unwrapError(\n  error: unknown,\n): [error: RpcError<DataWithOptionalCause>, isHandled: boolean] {\n  // This logic is a bit complicated, but it's necessary to handle all the\n  // different types of errors that can be thrown by a Snap.\n\n  // If the error is a wrapped Snap error, unwrap it.\n  if (isWrappedSnapError(error)) {\n    // The wrapped error can be a JSON-RPC error, or an unknown error. If it's\n    // a JSON-RPC error, we can unwrap it further.\n    if (isJsonRpcError(error.data.cause)) {\n      // If the JSON-RPC error is a wrapped Snap error, unwrap it further.\n      if (isSerializedSnapError(error.data.cause)) {\n        const { code, message, stack, data } = error.data.cause.data.cause;\n        return [getJsonRpcError(code, message, stack, data), true];\n      }\n\n      // Otherwise, we use the original JSON-RPC error.\n      const { code, message, stack, data } = error.data.cause;\n      return [getJsonRpcError(code, message, stack, data), false];\n    }\n\n    // Otherwise, we throw an internal error with the wrapped error as the\n    // message.\n    return [\n      getJsonRpcError(\n        errorCodes.rpc.internal,\n        getErrorMessage(error.data.cause),\n        getErrorStack(error.data.cause),\n      ),\n      false,\n    ];\n  }\n\n  // The error can be a non-wrapped JSON-RPC error, in which case we can just\n  // re-throw it with the same code, message, and data.\n  if (isJsonRpcError(error)) {\n    const { code, message, stack, data } = error;\n    return [getJsonRpcError(code, message, stack, data), false];\n  }\n\n  // If the error is not a wrapped error, we don't know how to handle it, so we\n  // throw an internal error with the error as the message.\n  return [\n    getJsonRpcError(\n      errorCodes.rpc.internal,\n      getErrorMessage(error),\n      getErrorStack(error),\n    ),\n    false,\n  ];\n}\n"]}

package/dist/errors.d.cts

@@ -0,0 +1,85 @@
+import { JsonRpcError as RpcError } from "@metamask/rpc-errors";
+import type { DataWithOptionalCause } from "@metamask/rpc-errors";
+import type { SerializedSnapError, SnapError } from "@metamask/snaps-sdk";
+import type { Json, JsonRpcError } from "@metamask/utils";
+export declare const SNAP_ERROR_WRAPPER_CODE = -31001;
+export declare const SNAP_ERROR_WRAPPER_MESSAGE = "Wrapped Snap Error";
+export type SerializedSnapErrorWrapper = {
+    code: typeof SNAP_ERROR_WRAPPER_CODE;
+    message: typeof SNAP_ERROR_WRAPPER_MESSAGE;
+    data: {
+        cause: Json;
+    };
+};
+export declare class WrappedSnapError extends Error {
+    #private;
+    /**
+     * Create a new `WrappedSnapError`.
+     *
+     * @param error - The error to create the `WrappedSnapError` from.
+     */
+    constructor(error: unknown);
+    /**
+     * The error name.
+     *
+     * @returns The error name.
+     */
+    get name(): string;
+    /**
+     * The error message.
+     *
+     * @returns The error message.
+     */
+    get message(): string;
+    /**
+     * The error stack.
+     *
+     * @returns The error stack.
+     */
+    get stack(): string | undefined;
+    /**
+     * Convert the error to a JSON object.
+     *
+     * @returns The JSON object.
+     */
+    toJSON(): SerializedSnapErrorWrapper;
+    /**
+     * Serialize the error to a JSON object. This is called by
+     * `@metamask/rpc-errors` when serializing the error.
+     *
+     * @returns The JSON object.
+     */
+    serialize(): SerializedSnapErrorWrapper;
+}
+/**
+ * Check if an object is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export declare function isSnapError(error: unknown): error is SnapError;
+/**
+ * Check if a JSON-RPC error is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export declare function isSerializedSnapError(error: JsonRpcError): error is SerializedSnapError;
+/**
+ * Check if a JSON-RPC error is a `WrappedSnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `WrappedSnapError`.
+ */
+export declare function isWrappedSnapError(error: unknown): error is SerializedSnapErrorWrapper;
+/**
+ * Attempt to unwrap an unknown error to a `JsonRpcError`. This function will
+ * try to get the error code, message, and data from the error, and return a
+ * `JsonRpcError` with those properties.
+ *
+ * @param error - The error to unwrap.
+ * @returns A tuple containing the unwrapped error and a boolean indicating
+ * whether the error was handled.
+ */
+export declare function unwrapError(error: unknown): [error: RpcError<DataWithOptionalCause>, isHandled: boolean];
+//# 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,EAEL,YAAY,IAAI,QAAQ,EAEzB,6BAA6B;AAC9B,OAAO,KAAK,EAAE,qBAAqB,EAAE,6BAA6B;AAClE,OAAO,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,4BAA4B;AAO1E,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,wBAAwB;AAG1D,eAAO,MAAM,uBAAuB,SAAS,CAAC;AAC9C,eAAO,MAAM,0BAA0B,uBAAuB,CAAC;AAE/D,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,OAAO,uBAAuB,CAAC;IACrC,OAAO,EAAE,OAAO,0BAA0B,CAAC;IAC3C,IAAI,EAAE;QACJ,KAAK,EAAE,IAAI,CAAC;KACb,CAAC;CACH,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,KAAK;;IAOzC;;;;OAIG;gBACS,KAAK,EAAE,OAAO;IAS1B;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IACH,IAAI,OAAO,WAEV;IAED;;;;OAIG;IACH,IAAI,KAAK,uBAER;IAED;;;;OAIG;IACH,MAAM,IAAI,0BAA0B;IAcpC;;;;;OAKG;IACH,SAAS;CAGV;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAW9D;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,YAAY,GAClB,KAAK,IAAI,mBAAmB,CAE9B;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,0BAA0B,CAMrC;AAuBD;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,OAAO,GACb,CAAC,KAAK,EAAE,QAAQ,CAAC,qBAAqB,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,CAiD9D"}