@metamask/snaps-utils 5.0.0 → 5.1.0

package/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.1.0]
+### Added
+- Add `getSnapDerivationPathName` and `getSlip44ProtocolName` to be shared across clients ([#2033](https://github.com/MetaMask/snaps/pull/2033))
+
+### Changed
+- Bump `snaps-registry` ([#2020](https://hub.com/MetaMask/snaps/pull/2020))
+
+## [5.0.1]
+### Changed
+- Improve base64 encoding/decoding speeds ([#1985](https://github.com/MetaMask/snaps/pull/1985))
+- Bump several MetaMask dependencies ([#1989](https://github.com/MetaMask/snaps/pull/1989), [#1993](https://github.com/MetaMask/snaps/pull/1993))
+
 ## [5.0.0]
 ### Changed
 - Bump several MetaMask dependencies ([#1964](https://github.com/MetaMask/snaps/pull/1964))
@@ -117,7 +129,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.1.0...HEAD
+[5.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.0.1...@metamask/snaps-utils@5.1.0
+[5.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.0.0...@metamask/snaps-utils@5.0.1
 [5.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@4.0.1...@metamask/snaps-utils@5.0.0
 [4.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@4.0.0...@metamask/snaps-utils@4.0.1
 [4.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@3.3.0...@metamask/snaps-utils@4.0.0

package/dist/cjs/auxiliary-files.js

@@ -10,14 +10,14 @@ Object.defineProperty(exports, "encodeAuxiliaryFile", {
 });
 const _snapssdk = require("@metamask/snaps-sdk");
 const _utils = require("@metamask/utils");
-const _base = require("@scure/base");
-function encodeAuxiliaryFile(value, encoding) {
+const _base64 = require("./base64");
+async function encodeAuxiliaryFile(value, encoding) {
     // Input is assumed to be the stored file in base64.
     if (encoding === _snapssdk.AuxiliaryFileEncoding.Base64) {
         return value;
     }
     // TODO: Use @metamask/utils for this
-    const decoded = _base.base64.decode(value);
+    const decoded = await (0, _base64.decodeBase64)(value);
     if (encoding === _snapssdk.AuxiliaryFileEncoding.Utf8) {
         return (0, _utils.bytesToString)(decoded);
     }

package/dist/cjs/auxiliary-files.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/auxiliary-files.ts"],"sourcesContent":["import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';\nimport { bytesToHex, bytesToString } from '@metamask/utils';\nimport { base64 } from '@scure/base';\n\n/**\n * Re-encodes an auxiliary file if needed depending on the requested file encoding.\n *\n * @param value - The base64 value stored for the auxiliary file.\n * @param encoding - The chosen encoding.\n * @returns The file encoded in the requested encoding.\n */\nexport function encodeAuxiliaryFile(\n  value: string,\n  encoding: AuxiliaryFileEncoding,\n) {\n  // Input is assumed to be the stored file in base64.\n  if (encoding === AuxiliaryFileEncoding.Base64) {\n    return value;\n  }\n\n  // TODO: Use @metamask/utils for this\n  const decoded = base64.decode(value);\n  if (encoding === AuxiliaryFileEncoding.Utf8) {\n    return bytesToString(decoded);\n  }\n\n  return bytesToHex(decoded);\n}\n"],"names":["encodeAuxiliaryFile","value","encoding","AuxiliaryFileEncoding","Base64","decoded","base64","decode","Utf8","bytesToString","bytesToHex"],"mappings":";;;;+BAWgBA;;;eAAAA;;;0BAXsB;uBACI;sBACnB;AAShB,SAASA,oBACdC,KAAa,EACbC,QAA+B;IAE/B,oDAAoD;IACpD,IAAIA,aAAaC,+BAAqB,CAACC,MAAM,EAAE;QAC7C,OAAOH;IACT;IAEA,qCAAqC;IACrC,MAAMI,UAAUC,YAAM,CAACC,MAAM,CAACN;IAC9B,IAAIC,aAAaC,+BAAqB,CAACK,IAAI,EAAE;QAC3C,OAAOC,IAAAA,oBAAa,EAACJ;IACvB;IAEA,OAAOK,IAAAA,iBAAU,EAACL;AACpB"}
+{"version":3,"sources":["../../src/auxiliary-files.ts"],"sourcesContent":["import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';\nimport { bytesToHex, bytesToString } from '@metamask/utils';\n\nimport { decodeBase64 } from './base64';\n\n/**\n * Re-encodes an auxiliary file if needed depending on the requested file encoding.\n *\n * @param value - The base64 value stored for the auxiliary file.\n * @param encoding - The chosen encoding.\n * @returns The file encoded in the requested encoding.\n */\nexport async function encodeAuxiliaryFile(\n  value: string,\n  encoding: AuxiliaryFileEncoding,\n) {\n  // Input is assumed to be the stored file in base64.\n  if (encoding === AuxiliaryFileEncoding.Base64) {\n    return value;\n  }\n\n  // TODO: Use @metamask/utils for this\n  const decoded = await decodeBase64(value);\n  if (encoding === AuxiliaryFileEncoding.Utf8) {\n    return bytesToString(decoded);\n  }\n\n  return bytesToHex(decoded);\n}\n"],"names":["encodeAuxiliaryFile","value","encoding","AuxiliaryFileEncoding","Base64","decoded","decodeBase64","Utf8","bytesToString","bytesToHex"],"mappings":";;;;+BAYsBA;;;eAAAA;;;0BAZgB;uBACI;wBAEb;AAStB,eAAeA,oBACpBC,KAAa,EACbC,QAA+B;IAE/B,oDAAoD;IACpD,IAAIA,aAAaC,+BAAqB,CAACC,MAAM,EAAE;QAC7C,OAAOH;IACT;IAEA,qCAAqC;IACrC,MAAMI,UAAU,MAAMC,IAAAA,oBAAY,EAACL;IACnC,IAAIC,aAAaC,+BAAqB,CAACI,IAAI,EAAE;QAC3C,OAAOC,IAAAA,oBAAa,EAACH;IACvB;IAEA,OAAOI,IAAAA,iBAAU,EAACJ;AACpB"}

package/dist/cjs/base64.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    encodeBase64: function() {
+        return encodeBase64;
+    },
+    decodeBase64: function() {
+        return decodeBase64;
+    }
+});
+const _utils = require("@metamask/utils");
+const _bytes = require("./bytes");
+async function encodeBase64(input) {
+    const bytes = (0, _bytes.getBytes)(input);
+    // In the browser, FileReader is much faster than bytesToBase64.
+    if ('FileReader' in globalThis) {
+        return await new Promise((resolve, reject)=>{
+            const reader = Object.assign(new FileReader(), {
+                onload: ()=>resolve(reader.result.replace('data:application/octet-stream;base64,', '')),
+                onerror: ()=>reject(reader.error)
+            });
+            reader.readAsDataURL(new File([
+                bytes
+            ], '', {
+                type: 'application/octet-stream'
+            }));
+        });
+    }
+    return (0, _utils.bytesToBase64)(bytes);
+}
+async function decodeBase64(base64) {
+    const response = await fetch(`data:application/octet-stream;base64,${base64}`);
+    return new Uint8Array(await response.arrayBuffer());
+}
+
+//# sourceMappingURL=base64.js.map

package/dist/cjs/base64.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/base64.ts"],"sourcesContent":["import { bytesToBase64 } from '@metamask/utils';\n\nimport { getBytes } from './bytes';\nimport type { VirtualFile } from './virtual-file';\n\n/**\n * Provides fast, asynchronous base64 encoding.\n *\n * @param input - The input value, assumed to be coercable to bytes.\n * @returns A base64 string.\n */\nexport async function encodeBase64(input: Uint8Array | VirtualFile | string) {\n  const bytes = getBytes(input);\n  // In the browser, FileReader is much faster than bytesToBase64.\n  if ('FileReader' in globalThis) {\n    return await new Promise((resolve, reject) => {\n      const reader = Object.assign(new FileReader(), {\n        onload: () =>\n          resolve(\n            (reader.result as string).replace(\n              'data:application/octet-stream;base64,',\n              '',\n            ),\n          ),\n        onerror: () => reject(reader.error),\n      });\n      reader.readAsDataURL(\n        new File([bytes], '', { type: 'application/octet-stream' }),\n      );\n    });\n  }\n  return bytesToBase64(bytes);\n}\n\n/**\n * Provides fast, asynchronous base64 decoding.\n *\n * @param base64 - A base64 string.\n * @returns A Uint8Array of bytes.\n */\nexport async function decodeBase64(base64: string) {\n  const response = await fetch(\n    `data:application/octet-stream;base64,${base64}`,\n  );\n  return new Uint8Array(await response.arrayBuffer());\n}\n"],"names":["encodeBase64","decodeBase64","input","bytes","getBytes","globalThis","Promise","resolve","reject","reader","Object","assign","FileReader","onload","result","replace","onerror","error","readAsDataURL","File","type","bytesToBase64","base64","response","fetch","Uint8Array","arrayBuffer"],"mappings":";;;;;;;;;;;IAWsBA,YAAY;eAAZA;;IA6BAC,YAAY;eAAZA;;;uBAxCQ;uBAEL;AASlB,eAAeD,aAAaE,KAAwC;IACzE,MAAMC,QAAQC,IAAAA,eAAQ,EAACF;IACvB,gEAAgE;IAChE,IAAI,gBAAgBG,YAAY;QAC9B,OAAO,MAAM,IAAIC,QAAQ,CAACC,SAASC;YACjC,MAAMC,SAASC,OAAOC,MAAM,CAAC,IAAIC,cAAc;gBAC7CC,QAAQ,IACNN,QACE,AAACE,OAAOK,MAAM,CAAYC,OAAO,CAC/B,yCACA;gBAGNC,SAAS,IAAMR,OAAOC,OAAOQ,KAAK;YACpC;YACAR,OAAOS,aAAa,CAClB,IAAIC,KAAK;gBAAChB;aAAM,EAAE,IAAI;gBAAEiB,MAAM;YAA2B;QAE7D;IACF;IACA,OAAOC,IAAAA,oBAAa,EAAClB;AACvB;AAQO,eAAeF,aAAaqB,MAAc;IAC/C,MAAMC,WAAW,MAAMC,MACrB,CAAC,qCAAqC,EAAEF,OAAO,CAAC;IAElD,OAAO,IAAIG,WAAW,MAAMF,SAASG,WAAW;AAClD"}

package/dist/cjs/bytes.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "getBytes", {
+    enumerable: true,
+    get: function() {
+        return getBytes;
+    }
+});
+const _utils = require("@metamask/utils");
+const _virtualfile = require("./virtual-file");
+function getBytes(bytes) {
+    // Unwrap VirtualFiles to extract the content
+    // The content is then either a string or Uint8Array
+    const unwrapped = bytes instanceof _virtualfile.VirtualFile ? bytes.value : bytes;
+    if (typeof unwrapped === 'string') {
+        return (0, _utils.stringToBytes)(unwrapped);
+    }
+    return unwrapped;
+}
+
+//# sourceMappingURL=bytes.js.map

package/dist/cjs/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/bytes.ts"],"sourcesContent":["import { stringToBytes } from '@metamask/utils';\n\nimport { VirtualFile } from './virtual-file';\n\n/**\n * Convert a bytes-like input value to a Uint8Array.\n *\n * @param bytes - A bytes-like value.\n * @returns The input value converted to a Uint8Array if necessary.\n */\nexport function getBytes(bytes: VirtualFile | Uint8Array | string): Uint8Array {\n  // Unwrap VirtualFiles to extract the content\n  // The content is then either a string or Uint8Array\n  const unwrapped = bytes instanceof VirtualFile ? bytes.value : bytes;\n\n  if (typeof unwrapped === 'string') {\n    return stringToBytes(unwrapped);\n  }\n\n  return unwrapped;\n}\n"],"names":["getBytes","bytes","unwrapped","VirtualFile","value","stringToBytes"],"mappings":";;;;+BAUgBA;;;eAAAA;;;uBAVc;6BAEF;AAQrB,SAASA,SAASC,KAAwC;IAC/D,6CAA6C;IAC7C,oDAAoD;IACpD,MAAMC,YAAYD,iBAAiBE,wBAAW,GAAGF,MAAMG,KAAK,GAAGH;IAE/D,IAAI,OAAOC,cAAc,UAAU;QACjC,OAAOG,IAAAA,oBAAa,EAACH;IACvB;IAEA,OAAOA;AACT"}

package/dist/cjs/checksum.js

@@ -9,9 +9,6 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    getChecksumBytes: function() {
-        return getChecksumBytes;
-    },
     checksum: function() {
         return checksum;
     },
@@ -21,18 +18,9 @@ _export(exports, {
 });
 const _utils = require("@metamask/utils");
 const _sha256 = require("@noble/hashes/sha256");
-const _VirtualFile = require("./virtual-file/VirtualFile");
-function getChecksumBytes(bytes) {
-    // Unwrap VirtualFiles to extract the content
-    // The content is then either a string or Uint8Array
-    const unwrapped = bytes instanceof _VirtualFile.VirtualFile ? bytes.value : bytes;
-    if (typeof unwrapped === 'string') {
-        return (0, _utils.stringToBytes)(unwrapped);
-    }
-    return unwrapped;
-}
+const _bytes = require("./bytes");
 async function checksum(bytes) {
-    const value = getChecksumBytes(bytes);
+    const value = (0, _bytes.getBytes)(bytes);
     // Use crypto.subtle.digest whenever possible as it is faster.
     if ('crypto' in globalThis && typeof globalThis.crypto === 'object' && crypto.subtle?.digest) {
         return new Uint8Array(await crypto.subtle.digest('SHA-256', value));

package/dist/cjs/checksum.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/checksum.ts"],"sourcesContent":["import { assert, concatBytes, stringToBytes } from '@metamask/utils';\nimport { sha256 } from '@noble/hashes/sha256';\n\nimport { VirtualFile } from './virtual-file/VirtualFile';\n\n/**\n * Convert an input value to a Uint8Array for use in a checksum.\n *\n * @param bytes - A value to use for a checksum calculation.\n * @returns The input value converted to a Uint8Array if necessary.\n */\nexport function getChecksumBytes(\n  bytes: VirtualFile | Uint8Array | string,\n): Uint8Array {\n  // Unwrap VirtualFiles to extract the content\n  // The content is then either a string or Uint8Array\n  const unwrapped = bytes instanceof VirtualFile ? bytes.value : bytes;\n\n  if (typeof unwrapped === 'string') {\n    return stringToBytes(unwrapped);\n  }\n\n  return unwrapped;\n}\n\n/**\n * Calculates checksum for a single byte array.\n *\n * @param bytes - The byte array to calculate the checksum for.\n * @returns A single sha-256 checksum.\n */\nexport async function checksum(\n  bytes: VirtualFile | Uint8Array | string,\n): Promise<Uint8Array> {\n  const value = getChecksumBytes(bytes);\n  // Use crypto.subtle.digest whenever possible as it is faster.\n  if (\n    'crypto' in globalThis &&\n    typeof globalThis.crypto === 'object' &&\n    crypto.subtle?.digest\n  ) {\n    return new Uint8Array(await crypto.subtle.digest('SHA-256', value));\n  }\n  return sha256(value);\n}\n\n/**\n * Calculates checksum over multiple files in a reproducible way.\n *\n * 1. Sort all the files by their paths.\n * 2. Calculate sha-256 checksum of each file separately.\n * 3. Concatenate all the checksums into one buffer and sha-256 that buffer.\n *\n * The sorting of paths is done using {@link https://tc39.es/ecma262/#sec-islessthan UTF-16 Code Units}.\n *\n * @param files - The files over which to calculate the checksum.\n * @returns A single sha-256 checksum.\n */\nexport async function checksumFiles(files: VirtualFile[]) {\n  const checksums = await Promise.all(\n    [...files]\n      .sort((a, b) => {\n        assert(a.path !== b.path, 'Tried to sort files with non-unique paths.');\n        if (a.path < b.path) {\n          return -1;\n        }\n        return 1;\n      })\n      .map(async (file) => checksum(file)),\n  );\n\n  return checksum(concatBytes(checksums));\n}\n"],"names":["getChecksumBytes","checksum","checksumFiles","bytes","unwrapped","VirtualFile","value","stringToBytes","globalThis","crypto","subtle","digest","Uint8Array","sha256","files","checksums","Promise","all","sort","a","b","assert","path","map","file","concatBytes"],"mappings":";;;;;;;;;;;IAWgBA,gBAAgB;eAAhBA;;IAoBMC,QAAQ;eAARA;;IA2BAC,aAAa;eAAbA;;;uBA1D6B;wBAC5B;6BAEK;AAQrB,SAASF,iBACdG,KAAwC;IAExC,6CAA6C;IAC7C,oDAAoD;IACpD,MAAMC,YAAYD,iBAAiBE,wBAAW,GAAGF,MAAMG,KAAK,GAAGH;IAE/D,IAAI,OAAOC,cAAc,UAAU;QACjC,OAAOG,IAAAA,oBAAa,EAACH;IACvB;IAEA,OAAOA;AACT;AAQO,eAAeH,SACpBE,KAAwC;IAExC,MAAMG,QAAQN,iBAAiBG;IAC/B,8DAA8D;IAC9D,IACE,YAAYK,cACZ,OAAOA,WAAWC,MAAM,KAAK,YAC7BA,OAAOC,MAAM,EAAEC,QACf;QACA,OAAO,IAAIC,WAAW,MAAMH,OAAOC,MAAM,CAACC,MAAM,CAAC,WAAWL;IAC9D;IACA,OAAOO,IAAAA,cAAM,EAACP;AAChB;AAcO,eAAeJ,cAAcY,KAAoB;IACtD,MAAMC,YAAY,MAAMC,QAAQC,GAAG,CACjC;WAAIH;KAAM,CACPI,IAAI,CAAC,CAACC,GAAGC;QACRC,IAAAA,aAAM,EAACF,EAAEG,IAAI,KAAKF,EAAEE,IAAI,EAAE;QAC1B,IAAIH,EAAEG,IAAI,GAAGF,EAAEE,IAAI,EAAE;YACnB,OAAO,CAAC;QACV;QACA,OAAO;IACT,GACCC,GAAG,CAAC,OAAOC,OAASvB,SAASuB;IAGlC,OAAOvB,SAASwB,IAAAA,kBAAW,EAACV;AAC9B"}
+{"version":3,"sources":["../../src/checksum.ts"],"sourcesContent":["import { assert, concatBytes } from '@metamask/utils';\nimport { sha256 } from '@noble/hashes/sha256';\n\nimport { getBytes } from './bytes';\nimport type { VirtualFile } from './virtual-file/VirtualFile';\n\n/**\n * Calculates checksum for a single byte array.\n *\n * @param bytes - The byte array to calculate the checksum for.\n * @returns A single sha-256 checksum.\n */\nexport async function checksum(\n  bytes: VirtualFile | Uint8Array | string,\n): Promise<Uint8Array> {\n  const value = getBytes(bytes);\n  // Use crypto.subtle.digest whenever possible as it is faster.\n  if (\n    'crypto' in globalThis &&\n    typeof globalThis.crypto === 'object' &&\n    crypto.subtle?.digest\n  ) {\n    return new Uint8Array(await crypto.subtle.digest('SHA-256', value));\n  }\n  return sha256(value);\n}\n\n/**\n * Calculates checksum over multiple files in a reproducible way.\n *\n * 1. Sort all the files by their paths.\n * 2. Calculate sha-256 checksum of each file separately.\n * 3. Concatenate all the checksums into one buffer and sha-256 that buffer.\n *\n * The sorting of paths is done using {@link https://tc39.es/ecma262/#sec-islessthan UTF-16 Code Units}.\n *\n * @param files - The files over which to calculate the checksum.\n * @returns A single sha-256 checksum.\n */\nexport async function checksumFiles(files: VirtualFile[]) {\n  const checksums = await Promise.all(\n    [...files]\n      .sort((a, b) => {\n        assert(a.path !== b.path, 'Tried to sort files with non-unique paths.');\n        if (a.path < b.path) {\n          return -1;\n        }\n        return 1;\n      })\n      .map(async (file) => checksum(file)),\n  );\n\n  return checksum(concatBytes(checksums));\n}\n"],"names":["checksum","checksumFiles","bytes","value","getBytes","globalThis","crypto","subtle","digest","Uint8Array","sha256","files","checksums","Promise","all","sort","a","b","assert","path","map","file","concatBytes"],"mappings":";;;;;;;;;;;IAYsBA,QAAQ;eAARA;;IA2BAC,aAAa;eAAbA;;;uBAvCc;wBACb;uBAEE;AASlB,eAAeD,SACpBE,KAAwC;IAExC,MAAMC,QAAQC,IAAAA,eAAQ,EAACF;IACvB,8DAA8D;IAC9D,IACE,YAAYG,cACZ,OAAOA,WAAWC,MAAM,KAAK,YAC7BA,OAAOC,MAAM,EAAEC,QACf;QACA,OAAO,IAAIC,WAAW,MAAMH,OAAOC,MAAM,CAACC,MAAM,CAAC,WAAWL;IAC9D;IACA,OAAOO,IAAAA,cAAM,EAACP;AAChB;AAcO,eAAeF,cAAcU,KAAoB;IACtD,MAAMC,YAAY,MAAMC,QAAQC,GAAG,CACjC;WAAIH;KAAM,CACPI,IAAI,CAAC,CAACC,GAAGC;QACRC,IAAAA,aAAM,EAACF,EAAEG,IAAI,KAAKF,EAAEE,IAAI,EAAE;QAC1B,IAAIH,EAAEG,IAAI,GAAGF,EAAEE,IAAI,EAAE;YACnB,OAAO,CAAC;QACV;QACA,OAAO;IACT,GACCC,GAAG,CAAC,OAAOC,OAASrB,SAASqB;IAGlC,OAAOrB,SAASsB,IAAAA,kBAAW,EAACV;AAC9B"}

package/dist/cjs/derivation-paths.js

@@ -0,0 +1,300 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    SNAPS_DERIVATION_PATHS: function() {
+        return SNAPS_DERIVATION_PATHS;
+    },
+    getSnapDerivationPathName: function() {
+        return getSnapDerivationPathName;
+    },
+    getSlip44ProtocolName: function() {
+        return getSlip44ProtocolName;
+    }
+});
+const _slip44 = /*#__PURE__*/ _interop_require_default(require("@metamask/slip44"));
+const _array = require("./array");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+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',
+            `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'`,
+            `1729'`,
+            `0'`,
+            `0'`
+        ],
+        curve: 'ed25519',
+        name: 'Tezos'
+    },
+    {
+        path: [
+            'm',
+            `1789'`,
+            `0'`
+        ],
+        curve: 'ed25519',
+        name: 'Vega'
+    }
+];
+function getSnapDerivationPathName(path, curve) {
+    const pathMetadata = SNAPS_DERIVATION_PATHS.find((derivationPath)=>derivationPath.curve === curve && (0, _array.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;
+}
+function getSlip44ProtocolName(coinType) {
+    if (String(coinType) === '1') {
+        return 'Test Networks';
+    }
+    return _slip44.default[coinType]?.name ?? null;
+}
+
+//# sourceMappingURL=derivation-paths.js.map

package/dist/cjs/derivation-paths.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/derivation-paths.ts"],"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', `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'`, `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\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"],"names":["SNAPS_DERIVATION_PATHS","getSnapDerivationPathName","getSlip44ProtocolName","path","curve","name","pathMetadata","find","derivationPath","isEqual","endsWith","coinType","slice","String","slip44"],"mappings":";;;;;;;;;;;IAWaA,sBAAsB;eAAtBA;;IAiJGC,yBAAyB;eAAzBA;;IAoCAC,qBAAqB;eAArBA;;;+DA/LG;uBAEK;;;;;;AAQjB,MAAMF,yBAAgD;IAC3D;QACEG,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;YAAE;YAAM;SAAK;QACtCC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACxBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,GAAG,CAAC;SAAC;QACzBC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QAChCC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,EAAE,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QAC9BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,IAAI,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,MAAM,CAAC;SAAC;QAC5BC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,GAAG,CAAC;YAAE,CAAC,KAAK,CAAC;YAAE,CAAC,EAAE,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QACvCC,OAAO;QACPC,MAAM;IACR;IACA;QACEF,MAAM;YAAC;YAAK,CAAC,KAAK,CAAC;YAAE,CAAC,EAAE,CAAC;SAAC;QAC1BC,OAAO;QACPC,MAAM;IACR;CACD;AASM,SAASJ,0BACdE,IAAiC,EACjCC,KAAqB;IAErB,MAAME,eAAeN,uBAAuBO,IAAI,CAC9C,CAACC,iBACCA,eAAeJ,KAAK,KAAKA,SAASK,IAAAA,cAAO,EAACD,eAAeL,IAAI,EAAEA;IAGnE,IAAIG,cAAc;QAChB,OAAOA,aAAaD,IAAI;IAC1B;IAEA,+DAA+D;IAC/D,yDAAyD;IACzD,IACED,UAAU,eACVD,IAAI,CAAC,EAAE,KAAK,OACZA,IAAI,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,IACjBA,IAAI,CAAC,EAAE,CAACO,QAAQ,CAAC,CAAC,CAAC,CAAC,GACpB;QACA,MAAMC,WAAWR,IAAI,CAAC,EAAE,CAACS,KAAK,CAAC,GAAG,CAAC;QACnC,OAAOV,sBAAsBS,aAAa;IAC5C;IAEA,OAAO;AACT;AAUO,SAAST,sBAAsBS,QAAyB;IAC7D,IAAIE,OAAOF,cAAc,KAAK;QAC5B,OAAO;IACT;IAEA,OAAOG,eAAM,CAACH,SAAgC,EAAEN,QAAQ;AAC1D"}

package/dist/cjs/index.browser.js

@@ -4,11 +4,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 _export_star(require("./array"), exports);
 _export_star(require("./auxiliary-files"), exports);
+_export_star(require("./base64"), exports);
+_export_star(require("./bytes"), exports);
 _export_star(require("./caveats"), exports);
 _export_star(require("./checksum"), exports);
 _export_star(require("./cronjob"), exports);
 _export_star(require("./deep-clone"), exports);
 _export_star(require("./default-endowments"), exports);
+_export_star(require("./derivation-paths"), exports);
 _export_star(require("./entropy"), exports);
 _export_star(require("./errors"), exports);
 _export_star(require("./handlers"), exports);

package/dist/cjs/index.browser.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.browser.ts"],"sourcesContent":["export * from './array';\nexport * from './auxiliary-files';\nexport * from './caveats';\nexport * from './checksum';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './errors';\nexport * from './handlers';\nexport * from './handler-types';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './localization';\nexport * from './logging';\nexport * from './manifest/index.browser';\nexport * from './namespace';\nexport * from './path';\nexport * from './snaps';\nexport * from './strings';\nexport * from './structs';\nexport * from './types';\nexport * from './ui';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file/index.browser';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}
+{"version":3,"sources":["../../src/index.browser.ts"],"sourcesContent":["export * from './array';\nexport * from './auxiliary-files';\nexport * from './base64';\nexport * from './bytes';\nexport * from './caveats';\nexport * from './checksum';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './derivation-paths';\nexport * from './entropy';\nexport * from './errors';\nexport * from './handlers';\nexport * from './handler-types';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './localization';\nexport * from './logging';\nexport * from './manifest/index.browser';\nexport * from './namespace';\nexport * from './path';\nexport * from './snaps';\nexport * from './strings';\nexport * from './structs';\nexport * from './types';\nexport * from './ui';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file/index.browser';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/index.js

@@ -4,11 +4,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 _export_star(require("./array"), exports);
 _export_star(require("./auxiliary-files"), exports);
+_export_star(require("./base64"), exports);
+_export_star(require("./bytes"), exports);
 _export_star(require("./caveats"), exports);
 _export_star(require("./cronjob"), exports);
 _export_star(require("./checksum"), exports);
 _export_star(require("./deep-clone"), exports);
 _export_star(require("./default-endowments"), exports);
+_export_star(require("./derivation-paths"), exports);
 _export_star(require("./entropy"), exports);
 _export_star(require("./eval"), exports);
 _export_star(require("./errors"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './array';\nexport * from './auxiliary-files';\nexport * from './caveats';\nexport * from './cronjob';\nexport * from './checksum';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './eval';\nexport * from './errors';\nexport * from './fs';\nexport * from './handlers';\nexport * from './handler-types';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './localization';\nexport * from './logging';\nexport * from './manifest';\nexport * from './mock';\nexport * from './namespace';\nexport * from './npm';\nexport * from './path';\nexport * from './post-process';\nexport * from './snaps';\nexport * from './strings';\nexport * from './structs';\nexport * from './types';\nexport * from './ui';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './array';\nexport * from './auxiliary-files';\nexport * from './base64';\nexport * from './bytes';\nexport * from './caveats';\nexport * from './cronjob';\nexport * from './checksum';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './derivation-paths';\nexport * from './entropy';\nexport * from './eval';\nexport * from './errors';\nexport * from './fs';\nexport * from './handlers';\nexport * from './handler-types';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './localization';\nexport * from './logging';\nexport * from './manifest';\nexport * from './mock';\nexport * from './namespace';\nexport * from './npm';\nexport * from './path';\nexport * from './post-process';\nexport * from './snaps';\nexport * from './strings';\nexport * from './structs';\nexport * from './types';\nexport * from './ui';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/virtual-file/VirtualFile.js

@@ -40,6 +40,7 @@ class VirtualFile {
         } else if (this.value instanceof Uint8Array && encoding === 'hex') {
             return (0, _utils.bytesToHex)(this.value);
         } else if (this.value instanceof Uint8Array && encoding === 'base64') {
+            // For large files, this is quite slow, instead use `encodeBase64()`
             // TODO: Use @metamask/utils for this
             return _base.base64.encode(this.value);
         }

package/dist/cjs/virtual-file/VirtualFile.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/virtual-file/VirtualFile.ts"],"sourcesContent":["// TODO(ritave): Move into separate package @metamask/vfile / @metamask/utils + @metamask/to-vfile when passes code review\n// TODO(ritave): Streaming vfile contents similar to vinyl maybe?\n// TODO(ritave): Move fixing manifest in cli and bundler plugins to write messages to vfile\n//               similar to unified instead of throwing \"ProgrammaticallyFixableErrors\".\n//\n// Using https://github.com/vfile/vfile would be helpful, but they only support ESM and we need to support CommonJS.\n// https://github.com/gulpjs/vinyl is also good, but they normalize paths, which we can't do, because\n// we're calculating checksums based on original path.\nimport { assert, bytesToHex } from '@metamask/utils';\nimport { base64 } from '@scure/base';\n\nimport { deepClone } from '../deep-clone';\n\n/**\n * This map registers the type of the {@link VirtualFile.data} key of a {@link VirtualFile}.\n *\n * This type can be augmented to register custom `data` types.\n *\n * @example\n * declare module '@metamask/snaps-utils' {\n *   interface DataMap {\n *     // `file.data.name` is typed as `string`\n *     name: string\n *   }\n * }\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-interface\nexport interface DataMap {}\n\nexport type Value = string | Uint8Array;\nexport type Compatible<Result = unknown> =\n  | string\n  | Uint8Array\n  | Options<Result>;\nexport type Data = Record<string, unknown> & Partial<DataMap>;\nexport type Options<Result = unknown> = {\n  value: Value;\n  path?: string;\n  data?: Data;\n  result?: Result;\n};\n\nexport class VirtualFile<Result = unknown> {\n  constructor(value?: Compatible<Result>) {\n    let options: Options | undefined;\n    if (typeof value === 'string' || value instanceof Uint8Array) {\n      options = { value };\n    } else {\n      options = value;\n    }\n\n    this.value = options?.value ?? '';\n    // This situations happens when there's no .result used,\n    // we expect the file to have default generic in that situation:\n    // VirtualFile<unknown> which will handle undefined properly\n    //\n    // While not 100% type safe, it'll be way less frustrating to work with.\n    // The alternative would be to have VirtualFile.result be Result | undefined\n    // and that would result in needing to branch out and check in all situations.\n    //\n    // In short, optimizing for most common use case.\n    this.result = options?.result ?? (undefined as any);\n    this.data = options?.data ?? {};\n    this.path = options?.path ?? '/';\n  }\n\n  value: Value;\n\n  result: Result;\n\n  data: Data;\n\n  path: string;\n\n  toString(encoding?: string) {\n    if (typeof this.value === 'string') {\n      assert(encoding === undefined, 'Tried to encode string.');\n      return this.value;\n    } else if (this.value instanceof Uint8Array && encoding === 'hex') {\n      return bytesToHex(this.value);\n    } else if (this.value instanceof Uint8Array && encoding === 'base64') {\n      // TODO: Use @metamask/utils for this\n      return base64.encode(this.value);\n    }\n    const decoder = new TextDecoder(encoding);\n    return decoder.decode(this.value);\n  }\n\n  clone() {\n    const vfile = new VirtualFile<Result>();\n    if (typeof this.value === 'string') {\n      vfile.value = this.value;\n    } else {\n      // deep-clone doesn't clone Buffer properly, even if it's a sub-class of Uint8Array\n      vfile.value = this.value.slice(0);\n    }\n    vfile.result = deepClone(this.result);\n    vfile.data = deepClone(this.data);\n    vfile.path = this.path;\n    return vfile;\n  }\n}\n"],"names":["VirtualFile","toString","encoding","value","assert","undefined","Uint8Array","bytesToHex","base64","encode","decoder","TextDecoder","decode","clone","vfile","slice","result","deepClone","data","path","constructor","options"],"mappings":"AAAA,0HAA0H;AAC1H,iEAAiE;AACjE,2FAA2F;AAC3F,wFAAwF;AACxF,EAAE;AACF,oHAAoH;AACpH,qGAAqG;AACrG,sDAAsD;;;;;+BAmCzCA;;;eAAAA;;;uBAlCsB;sBACZ;2BAEG;;;;;;;;;;;;;;AA+BnB,MAAMA;IAgCXC,SAASC,QAAiB,EAAE;QAC1B,IAAI,OAAO,IAAI,CAACC,KAAK,KAAK,UAAU;YAClCC,IAAAA,aAAM,EAACF,aAAaG,WAAW;YAC/B,OAAO,IAAI,CAACF,KAAK;QACnB,OAAO,IAAI,IAAI,CAACA,KAAK,YAAYG,cAAcJ,aAAa,OAAO;YACjE,OAAOK,IAAAA,iBAAU,EAAC,IAAI,CAACJ,KAAK;QAC9B,OAAO,IAAI,IAAI,CAACA,KAAK,YAAYG,cAAcJ,aAAa,UAAU;YACpE,qCAAqC;YACrC,OAAOM,YAAM,CAACC,MAAM,CAAC,IAAI,CAACN,KAAK;QACjC;QACA,MAAMO,UAAU,IAAIC,YAAYT;QAChC,OAAOQ,QAAQE,MAAM,CAAC,IAAI,CAACT,KAAK;IAClC;IAEAU,QAAQ;QACN,MAAMC,QAAQ,IAAId;QAClB,IAAI,OAAO,IAAI,CAACG,KAAK,KAAK,UAAU;YAClCW,MAAMX,KAAK,GAAG,IAAI,CAACA,KAAK;QAC1B,OAAO;YACL,mFAAmF;YACnFW,MAAMX,KAAK,GAAG,IAAI,CAACA,KAAK,CAACY,KAAK,CAAC;QACjC;QACAD,MAAME,MAAM,GAAGC,IAAAA,oBAAS,EAAC,IAAI,CAACD,MAAM;QACpCF,MAAMI,IAAI,GAAGD,IAAAA,oBAAS,EAAC,IAAI,CAACC,IAAI;QAChCJ,MAAMK,IAAI,GAAG,IAAI,CAACA,IAAI;QACtB,OAAOL;IACT;IAzDAM,YAAYjB,KAA0B,CAAE;QAuBxCA,uBAAAA,SAAAA,KAAAA;QAEAa,uBAAAA,UAAAA,KAAAA;QAEAE,uBAAAA,QAAAA,KAAAA;QAEAC,uBAAAA,QAAAA,KAAAA;QA5BE,IAAIE;QACJ,IAAI,OAAOlB,UAAU,YAAYA,iBAAiBG,YAAY;YAC5De,UAAU;gBAAElB;YAAM;QACpB,OAAO;YACLkB,UAAUlB;QACZ;QAEA,IAAI,CAACA,KAAK,GAAGkB,SAASlB,SAAS;QAC/B,wDAAwD;QACxD,gEAAgE;QAChE,4DAA4D;QAC5D,EAAE;QACF,wEAAwE;QACxE,4EAA4E;QAC5E,8EAA8E;QAC9E,EAAE;QACF,iDAAiD;QACjD,IAAI,CAACa,MAAM,GAAGK,SAASL,UAAWX;QAClC,IAAI,CAACa,IAAI,GAAGG,SAASH,QAAQ,CAAC;QAC9B,IAAI,CAACC,IAAI,GAAGE,SAASF,QAAQ;IAC/B;AAqCF"}
+{"version":3,"sources":["../../../src/virtual-file/VirtualFile.ts"],"sourcesContent":["// TODO(ritave): Move into separate package @metamask/vfile / @metamask/utils + @metamask/to-vfile when passes code review\n// TODO(ritave): Streaming vfile contents similar to vinyl maybe?\n// TODO(ritave): Move fixing manifest in cli and bundler plugins to write messages to vfile\n//               similar to unified instead of throwing \"ProgrammaticallyFixableErrors\".\n//\n// Using https://github.com/vfile/vfile would be helpful, but they only support ESM and we need to support CommonJS.\n// https://github.com/gulpjs/vinyl is also good, but they normalize paths, which we can't do, because\n// we're calculating checksums based on original path.\nimport { assert, bytesToHex } from '@metamask/utils';\nimport { base64 } from '@scure/base';\n\nimport { deepClone } from '../deep-clone';\n\n/**\n * This map registers the type of the {@link VirtualFile.data} key of a {@link VirtualFile}.\n *\n * This type can be augmented to register custom `data` types.\n *\n * @example\n * declare module '@metamask/snaps-utils' {\n *   interface DataMap {\n *     // `file.data.name` is typed as `string`\n *     name: string\n *   }\n * }\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-interface\nexport interface DataMap {}\n\nexport type Value = string | Uint8Array;\nexport type Compatible<Result = unknown> =\n  | string\n  | Uint8Array\n  | Options<Result>;\nexport type Data = Record<string, unknown> & Partial<DataMap>;\nexport type Options<Result = unknown> = {\n  value: Value;\n  path?: string;\n  data?: Data;\n  result?: Result;\n};\n\nexport class VirtualFile<Result = unknown> {\n  constructor(value?: Compatible<Result>) {\n    let options: Options | undefined;\n    if (typeof value === 'string' || value instanceof Uint8Array) {\n      options = { value };\n    } else {\n      options = value;\n    }\n\n    this.value = options?.value ?? '';\n    // This situations happens when there's no .result used,\n    // we expect the file to have default generic in that situation:\n    // VirtualFile<unknown> which will handle undefined properly\n    //\n    // While not 100% type safe, it'll be way less frustrating to work with.\n    // The alternative would be to have VirtualFile.result be Result | undefined\n    // and that would result in needing to branch out and check in all situations.\n    //\n    // In short, optimizing for most common use case.\n    this.result = options?.result ?? (undefined as any);\n    this.data = options?.data ?? {};\n    this.path = options?.path ?? '/';\n  }\n\n  value: Value;\n\n  result: Result;\n\n  data: Data;\n\n  path: string;\n\n  toString(encoding?: string) {\n    if (typeof this.value === 'string') {\n      assert(encoding === undefined, 'Tried to encode string.');\n      return this.value;\n    } else if (this.value instanceof Uint8Array && encoding === 'hex') {\n      return bytesToHex(this.value);\n    } else if (this.value instanceof Uint8Array && encoding === 'base64') {\n      // For large files, this is quite slow, instead use `encodeBase64()`\n      // TODO: Use @metamask/utils for this\n      return base64.encode(this.value);\n    }\n    const decoder = new TextDecoder(encoding);\n    return decoder.decode(this.value);\n  }\n\n  clone() {\n    const vfile = new VirtualFile<Result>();\n    if (typeof this.value === 'string') {\n      vfile.value = this.value;\n    } else {\n      // deep-clone doesn't clone Buffer properly, even if it's a sub-class of Uint8Array\n      vfile.value = this.value.slice(0);\n    }\n    vfile.result = deepClone(this.result);\n    vfile.data = deepClone(this.data);\n    vfile.path = this.path;\n    return vfile;\n  }\n}\n"],"names":["VirtualFile","toString","encoding","value","assert","undefined","Uint8Array","bytesToHex","base64","encode","decoder","TextDecoder","decode","clone","vfile","slice","result","deepClone","data","path","constructor","options"],"mappings":"AAAA,0HAA0H;AAC1H,iEAAiE;AACjE,2FAA2F;AAC3F,wFAAwF;AACxF,EAAE;AACF,oHAAoH;AACpH,qGAAqG;AACrG,sDAAsD;;;;;+BAmCzCA;;;eAAAA;;;uBAlCsB;sBACZ;2BAEG;;;;;;;;;;;;;;AA+BnB,MAAMA;IAgCXC,SAASC,QAAiB,EAAE;QAC1B,IAAI,OAAO,IAAI,CAACC,KAAK,KAAK,UAAU;YAClCC,IAAAA,aAAM,EAACF,aAAaG,WAAW;YAC/B,OAAO,IAAI,CAACF,KAAK;QACnB,OAAO,IAAI,IAAI,CAACA,KAAK,YAAYG,cAAcJ,aAAa,OAAO;YACjE,OAAOK,IAAAA,iBAAU,EAAC,IAAI,CAACJ,KAAK;QAC9B,OAAO,IAAI,IAAI,CAACA,KAAK,YAAYG,cAAcJ,aAAa,UAAU;YACpE,oEAAoE;YACpE,qCAAqC;YACrC,OAAOM,YAAM,CAACC,MAAM,CAAC,IAAI,CAACN,KAAK;QACjC;QACA,MAAMO,UAAU,IAAIC,YAAYT;QAChC,OAAOQ,QAAQE,MAAM,CAAC,IAAI,CAACT,KAAK;IAClC;IAEAU,QAAQ;QACN,MAAMC,QAAQ,IAAId;QAClB,IAAI,OAAO,IAAI,CAACG,KAAK,KAAK,UAAU;YAClCW,MAAMX,KAAK,GAAG,IAAI,CAACA,KAAK;QAC1B,OAAO;YACL,mFAAmF;YACnFW,MAAMX,KAAK,GAAG,IAAI,CAACA,KAAK,CAACY,KAAK,CAAC;QACjC;QACAD,MAAME,MAAM,GAAGC,IAAAA,oBAAS,EAAC,IAAI,CAACD,MAAM;QACpCF,MAAMI,IAAI,GAAGD,IAAAA,oBAAS,EAAC,IAAI,CAACC,IAAI;QAChCJ,MAAMK,IAAI,GAAG,IAAI,CAACA,IAAI;QACtB,OAAOL;IACT;IA1DAM,YAAYjB,KAA0B,CAAE;QAuBxCA,uBAAAA,SAAAA,KAAAA;QAEAa,uBAAAA,UAAAA,KAAAA;QAEAE,uBAAAA,QAAAA,KAAAA;QAEAC,uBAAAA,QAAAA,KAAAA;QA5BE,IAAIE;QACJ,IAAI,OAAOlB,UAAU,YAAYA,iBAAiBG,YAAY;YAC5De,UAAU;gBAAElB;YAAM;QACpB,OAAO;YACLkB,UAAUlB;QACZ;QAEA,IAAI,CAACA,KAAK,GAAGkB,SAASlB,SAAS;QAC/B,wDAAwD;QACxD,gEAAgE;QAChE,4DAA4D;QAC5D,EAAE;QACF,wEAAwE;QACxE,4EAA4E;QAC5E,8EAA8E;QAC9E,EAAE;QACF,iDAAiD;QACjD,IAAI,CAACa,MAAM,GAAGK,SAASL,UAAWX;QAClC,IAAI,CAACa,IAAI,GAAGG,SAASH,QAAQ,CAAC;QAC9B,IAAI,CAACC,IAAI,GAAGE,SAASF,QAAQ;IAC/B;AAsCF"}

package/dist/esm/auxiliary-files.js

@@ -1,19 +1,19 @@
 import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';
 import { bytesToHex, bytesToString } from '@metamask/utils';
-import { base64 } from '@scure/base';
+import { decodeBase64 } from './base64';
 /**
  * Re-encodes an auxiliary file if needed depending on the requested file encoding.
  *
  * @param value - The base64 value stored for the auxiliary file.
  * @param encoding - The chosen encoding.
  * @returns The file encoded in the requested encoding.
- */ export function encodeAuxiliaryFile(value, encoding) {
+ */ export async function encodeAuxiliaryFile(value, encoding) {
     // Input is assumed to be the stored file in base64.
     if (encoding === AuxiliaryFileEncoding.Base64) {
         return value;
     }
     // TODO: Use @metamask/utils for this
-    const decoded = base64.decode(value);
+    const decoded = await decodeBase64(value);
     if (encoding === AuxiliaryFileEncoding.Utf8) {
         return bytesToString(decoded);
     }

package/dist/esm/auxiliary-files.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/auxiliary-files.ts"],"sourcesContent":["import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';\nimport { bytesToHex, bytesToString } from '@metamask/utils';\nimport { base64 } from '@scure/base';\n\n/**\n * Re-encodes an auxiliary file if needed depending on the requested file encoding.\n *\n * @param value - The base64 value stored for the auxiliary file.\n * @param encoding - The chosen encoding.\n * @returns The file encoded in the requested encoding.\n */\nexport function encodeAuxiliaryFile(\n  value: string,\n  encoding: AuxiliaryFileEncoding,\n) {\n  // Input is assumed to be the stored file in base64.\n  if (encoding === AuxiliaryFileEncoding.Base64) {\n    return value;\n  }\n\n  // TODO: Use @metamask/utils for this\n  const decoded = base64.decode(value);\n  if (encoding === AuxiliaryFileEncoding.Utf8) {\n    return bytesToString(decoded);\n  }\n\n  return bytesToHex(decoded);\n}\n"],"names":["AuxiliaryFileEncoding","bytesToHex","bytesToString","base64","encodeAuxiliaryFile","value","encoding","Base64","decoded","decode","Utf8"],"mappings":"AAAA,SAASA,qBAAqB,QAAQ,sBAAsB;AAC5D,SAASC,UAAU,EAAEC,aAAa,QAAQ,kBAAkB;AAC5D,SAASC,MAAM,QAAQ,cAAc;AAErC;;;;;;CAMC,GACD,OAAO,SAASC,oBACdC,KAAa,EACbC,QAA+B;IAE/B,oDAAoD;IACpD,IAAIA,aAAaN,sBAAsBO,MAAM,EAAE;QAC7C,OAAOF;IACT;IAEA,qCAAqC;IACrC,MAAMG,UAAUL,OAAOM,MAAM,CAACJ;IAC9B,IAAIC,aAAaN,sBAAsBU,IAAI,EAAE;QAC3C,OAAOR,cAAcM;IACvB;IAEA,OAAOP,WAAWO;AACpB"}
+{"version":3,"sources":["../../src/auxiliary-files.ts"],"sourcesContent":["import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';\nimport { bytesToHex, bytesToString } from '@metamask/utils';\n\nimport { decodeBase64 } from './base64';\n\n/**\n * Re-encodes an auxiliary file if needed depending on the requested file encoding.\n *\n * @param value - The base64 value stored for the auxiliary file.\n * @param encoding - The chosen encoding.\n * @returns The file encoded in the requested encoding.\n */\nexport async function encodeAuxiliaryFile(\n  value: string,\n  encoding: AuxiliaryFileEncoding,\n) {\n  // Input is assumed to be the stored file in base64.\n  if (encoding === AuxiliaryFileEncoding.Base64) {\n    return value;\n  }\n\n  // TODO: Use @metamask/utils for this\n  const decoded = await decodeBase64(value);\n  if (encoding === AuxiliaryFileEncoding.Utf8) {\n    return bytesToString(decoded);\n  }\n\n  return bytesToHex(decoded);\n}\n"],"names":["AuxiliaryFileEncoding","bytesToHex","bytesToString","decodeBase64","encodeAuxiliaryFile","value","encoding","Base64","decoded","Utf8"],"mappings":"AAAA,SAASA,qBAAqB,QAAQ,sBAAsB;AAC5D,SAASC,UAAU,EAAEC,aAAa,QAAQ,kBAAkB;AAE5D,SAASC,YAAY,QAAQ,WAAW;AAExC;;;;;;CAMC,GACD,OAAO,eAAeC,oBACpBC,KAAa,EACbC,QAA+B;IAE/B,oDAAoD;IACpD,IAAIA,aAAaN,sBAAsBO,MAAM,EAAE;QAC7C,OAAOF;IACT;IAEA,qCAAqC;IACrC,MAAMG,UAAU,MAAML,aAAaE;IACnC,IAAIC,aAAaN,sBAAsBS,IAAI,EAAE;QAC3C,OAAOP,cAAcM;IACvB;IAEA,OAAOP,WAAWO;AACpB"}