@metamask/snaps-utils 6.1.0 → 7.0.0

package/dist/chunk-FJH6DDEL.mjs

@@ -0,0 +1,193 @@
+import {
+  SnapIdPrefixes,
+  uri
+} from "./chunk-ZVXX2CTH.mjs";
+import {
+  checksumFiles
+} from "./chunk-LHIPBIPS.mjs";
+
+// src/snaps.ts
+import { assert, isObject, assertStruct } from "@metamask/utils";
+import { base64 } from "@scure/base";
+import stableStringify from "fast-json-stable-stringify";
+import {
+  empty,
+  enums,
+  intersection,
+  literal,
+  pattern,
+  refine,
+  string,
+  union,
+  validate
+} from "superstruct";
+import validateNPMPackage from "validate-npm-package-name";
+var PROPOSED_NAME_REGEX = /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u;
+var SnapStatus = /* @__PURE__ */ ((SnapStatus2) => {
+  SnapStatus2["Installing"] = "installing";
+  SnapStatus2["Updating"] = "updating";
+  SnapStatus2["Running"] = "running";
+  SnapStatus2["Stopped"] = "stopped";
+  SnapStatus2["Crashed"] = "crashed";
+  return SnapStatus2;
+})(SnapStatus || {});
+var SnapStatusEvents = /* @__PURE__ */ ((SnapStatusEvents2) => {
+  SnapStatusEvents2["Start"] = "START";
+  SnapStatusEvents2["Stop"] = "STOP";
+  SnapStatusEvents2["Crash"] = "CRASH";
+  SnapStatusEvents2["Update"] = "UPDATE";
+  return SnapStatusEvents2;
+})(SnapStatusEvents || {});
+var ProgrammaticallyFixableSnapError = class extends Error {
+  constructor(message, reason) {
+    super(message);
+    this.reason = reason;
+  }
+};
+function getChecksummableManifest(manifest) {
+  const manifestCopy = manifest.clone();
+  delete manifestCopy.result.source.shasum;
+  manifestCopy.value = stableStringify(manifestCopy.result);
+  return manifestCopy;
+}
+async function getSnapChecksum(files) {
+  const { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles } = files;
+  const all = [
+    getChecksummableManifest(manifest),
+    sourceCode,
+    svgIcon,
+    ...auxiliaryFiles,
+    ...localizationFiles
+  ].filter((file) => file !== void 0);
+  return base64.encode(await checksumFiles(all));
+}
+async function validateSnapShasum(files, errorMessage = "Invalid Snap manifest: manifest shasum does not match computed shasum.") {
+  if (files.manifest.result.source.shasum !== await getSnapChecksum(files)) {
+    throw new ProgrammaticallyFixableSnapError(
+      errorMessage,
+      '"shasum" field mismatch' /* ShasumMismatch */
+    );
+  }
+}
+var LOCALHOST_HOSTNAMES = ["localhost", "127.0.0.1", "[::1]"];
+var BaseSnapIdStruct = pattern(string(), /^[\x21-\x7E]*$/u);
+var LocalSnapIdSubUrlStruct = uri({
+  protocol: enums(["http:", "https:"]),
+  hostname: enums(LOCALHOST_HOSTNAMES),
+  hash: empty(string()),
+  search: empty(string())
+});
+var LocalSnapIdStruct = refine(
+  BaseSnapIdStruct,
+  "local Snap Id",
+  (value) => {
+    if (!value.startsWith("local:" /* local */)) {
+      return `Expected local snap ID, got "${value}".`;
+    }
+    const [error] = validate(
+      value.slice("local:" /* local */.length),
+      LocalSnapIdSubUrlStruct
+    );
+    return error ?? true;
+  }
+);
+var NpmSnapIdStruct = intersection([
+  BaseSnapIdStruct,
+  uri({
+    protocol: literal("npm:" /* npm */),
+    pathname: refine(string(), "package name", function* (value) {
+      const normalized = value.startsWith("/") ? value.slice(1) : value;
+      const { errors, validForNewPackages, warnings } = validateNPMPackage(normalized);
+      if (!validForNewPackages) {
+        if (errors === void 0) {
+          assert(warnings !== void 0);
+          yield* warnings;
+        } else {
+          yield* errors;
+        }
+      }
+      return true;
+    }),
+    search: empty(string()),
+    hash: empty(string())
+  })
+]);
+var HttpSnapIdStruct = intersection([
+  BaseSnapIdStruct,
+  uri({
+    protocol: enums(["http:", "https:"]),
+    search: empty(string()),
+    hash: empty(string())
+  })
+]);
+var SnapIdStruct = union([NpmSnapIdStruct, LocalSnapIdStruct]);
+function getSnapPrefix(snapId) {
+  const prefix = Object.values(SnapIdPrefixes).find(
+    (possiblePrefix) => snapId.startsWith(possiblePrefix)
+  );
+  if (prefix !== void 0) {
+    return prefix;
+  }
+  throw new Error(`Invalid or no prefix found for "${snapId}"`);
+}
+function stripSnapPrefix(snapId) {
+  return snapId.replace(getSnapPrefix(snapId), "");
+}
+function assertIsValidSnapId(value) {
+  assertStruct(value, SnapIdStruct, "Invalid snap ID");
+}
+function isCaipChainId(chainId) {
+  return typeof chainId === "string" && /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(
+    chainId
+  );
+}
+function isSnapPermitted(permissions, snapId) {
+  return Boolean(
+    (permissions?.wallet_snap?.caveats?.find(
+      (caveat) => caveat.type === "snapIds" /* SnapIds */
+    ) ?? {}).value?.[snapId]
+  );
+}
+function verifyRequestedSnapPermissions(requestedPermissions) {
+  assert(
+    isObject(requestedPermissions),
+    "Requested permissions must be an object."
+  );
+  const { wallet_snap: walletSnapPermission } = requestedPermissions;
+  assert(
+    isObject(walletSnapPermission),
+    "wallet_snap is missing from the requested permissions."
+  );
+  const { caveats } = walletSnapPermission;
+  assert(
+    Array.isArray(caveats) && caveats.length === 1,
+    "wallet_snap must have a caveat property with a single-item array value."
+  );
+  const [caveat] = caveats;
+  assert(
+    isObject(caveat) && caveat.type === "snapIds" /* SnapIds */ && isObject(caveat.value),
+    `The requested permissions do not have a valid ${"snapIds" /* SnapIds */} caveat.`
+  );
+}
+
+export {
+  PROPOSED_NAME_REGEX,
+  SnapStatus,
+  SnapStatusEvents,
+  ProgrammaticallyFixableSnapError,
+  getSnapChecksum,
+  validateSnapShasum,
+  LOCALHOST_HOSTNAMES,
+  BaseSnapIdStruct,
+  LocalSnapIdStruct,
+  NpmSnapIdStruct,
+  HttpSnapIdStruct,
+  SnapIdStruct,
+  getSnapPrefix,
+  stripSnapPrefix,
+  assertIsValidSnapId,
+  isCaipChainId,
+  isSnapPermitted,
+  verifyRequestedSnapPermissions
+};
+//# sourceMappingURL=chunk-FJH6DDEL.mjs.map

package/dist/chunk-FJH6DDEL.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/snaps.ts"],"sourcesContent":["import type {\n  Caveat,\n  SubjectPermissions,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport type { BlockReason } from '@metamask/snaps-registry';\nimport type { SnapId, Snap as TruncatedSnap } from '@metamask/snaps-sdk';\nimport type { Json } from '@metamask/utils';\nimport { assert, isObject, assertStruct } from '@metamask/utils';\nimport { base64 } from '@scure/base';\nimport stableStringify from 'fast-json-stable-stringify';\nimport type { Struct } from 'superstruct';\nimport {\n  empty,\n  enums,\n  intersection,\n  literal,\n  pattern,\n  refine,\n  string,\n  union,\n  validate,\n} from 'superstruct';\nimport validateNPMPackage from 'validate-npm-package-name';\n\nimport { SnapCaveatType } from './caveats';\nimport { checksumFiles } from './checksum';\nimport type { LocalizationFile } from './localization';\nimport type { SnapManifest, SnapPermissions } from './manifest/validation';\nimport type { FetchedSnapFiles, SnapsPermissionRequest } from './types';\nimport { SnapIdPrefixes, SnapValidationFailureReason, uri } from './types';\nimport type { VirtualFile } from './virtual-file';\n\n// This RegEx matches valid npm package names (with some exceptions) and space-\n// separated alphanumerical words, optionally with dashes and underscores.\n// The RegEx consists of two parts. The first part matches space-separated\n// words. It is based on the following Stackoverflow answer:\n// https://stackoverflow.com/a/34974982\n// The second part, after the pipe operator, is the same RegEx used for the\n// `name` field of the official package.json JSON Schema, except that we allow\n// mixed-case letters. It was originally copied from:\n// https://github.com/SchemaStore/schemastore/blob/81a16897c1dabfd98c72242a5fd62eb080ff76d8/src/schemas/json/package.json#L132-L138\nexport const PROPOSED_NAME_REGEX =\n  /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u;\n\nexport enum SnapStatus {\n  Installing = 'installing',\n  Updating = 'updating',\n  Running = 'running',\n  Stopped = 'stopped',\n  Crashed = 'crashed',\n}\n\nexport enum SnapStatusEvents {\n  Start = 'START',\n  Stop = 'STOP',\n  Crash = 'CRASH',\n  Update = 'UPDATE',\n}\n\nexport type StatusContext = { snapId: SnapId };\nexport type StatusEvents = { type: SnapStatusEvents };\nexport type StatusStates = {\n  value: SnapStatus;\n  context: StatusContext;\n};\nexport type Status = StatusStates['value'];\n\nexport type VersionHistory = {\n  origin: string;\n  version: string;\n  // Unix timestamp\n  date: number;\n};\n\nexport type SnapAuxilaryFile = {\n  path: string;\n  // Value here should be stored as base64\n  value: string;\n};\n\nexport type PersistedSnap = Snap;\n\n/**\n * A Snap as it exists in {@link SnapController} state.\n */\nexport type Snap = TruncatedSnap & {\n  /**\n   * The initial permissions of the Snap, which will be requested when it is\n   * installed.\n   */\n  initialPermissions: SnapPermissions;\n\n  /**\n   * The source code of the Snap.\n   */\n  sourceCode: string;\n\n  /**\n   * The Snap's manifest file.\n   */\n  manifest: SnapManifest;\n\n  /**\n   * Information detailing why the snap is blocked.\n   */\n  blockInformation?: BlockReason;\n\n  /**\n   * The current status of the Snap, e.g. whether it's running or stopped.\n   */\n  status: Status;\n\n  /**\n   * The version history of the Snap.\n   * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.\n   */\n  versionHistory: VersionHistory[];\n\n  /**\n   * Static auxiliary files that can be loaded at runtime.\n   */\n  auxiliaryFiles?: SnapAuxilaryFile[];\n\n  /**\n   * Localization files which are used to translate the manifest.\n   */\n  localizationFiles?: LocalizationFile[];\n\n  /**\n   * Flag to signal whether this snap was preinstalled or not.\n   *\n   * A lack of specifying this option will be deemed as not preinstalled.\n   */\n  preinstalled?: boolean;\n\n  /**\n   * Flag to signal whether this snap is removable or not.\n   *\n   * A lack of specifying this option will be deemed as removable.\n   */\n  removable?: boolean;\n};\n\nexport type TruncatedSnapFields =\n  | 'id'\n  | 'initialPermissions'\n  | 'version'\n  | 'enabled'\n  | 'blocked';\n\n/**\n * An error indicating that a Snap validation failure is programmatically\n * fixable during development.\n */\nexport class ProgrammaticallyFixableSnapError extends Error {\n  reason: SnapValidationFailureReason;\n\n  constructor(message: string, reason: SnapValidationFailureReason) {\n    super(message);\n    this.reason = reason;\n  }\n}\n\n/**\n * Gets a checksummable manifest by removing the shasum property and reserializing the JSON using a deterministic algorithm.\n *\n * @param manifest - The manifest itself.\n * @returns A virtual file containing the checksummable manifest.\n */\nfunction getChecksummableManifest(\n  manifest: VirtualFile<SnapManifest>,\n): VirtualFile {\n  const manifestCopy = manifest.clone() as VirtualFile<any>;\n  delete manifestCopy.result.source.shasum;\n\n  // We use fast-json-stable-stringify to deterministically serialize the JSON\n  // This is required before checksumming so we get reproducible checksums across platforms etc\n  manifestCopy.value = stableStringify(manifestCopy.result);\n  return manifestCopy;\n}\n\n/**\n * Calculates the Base64-encoded SHA-256 digest of all required Snap files.\n *\n * @param files - All required Snap files to be included in the checksum.\n * @returns The Base64-encoded SHA-256 digest of the source code.\n */\nexport async function getSnapChecksum(\n  files: FetchedSnapFiles,\n): Promise<string> {\n  const { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles } =\n    files;\n\n  const all = [\n    getChecksummableManifest(manifest),\n    sourceCode,\n    svgIcon,\n    ...auxiliaryFiles,\n    ...localizationFiles,\n  ].filter((file) => file !== undefined);\n\n  return base64.encode(await checksumFiles(all as VirtualFile[]));\n}\n\n/**\n * Checks whether the `source.shasum` property of a Snap manifest matches the\n * shasum of the snap.\n *\n * @param files - All required Snap files to be included in the checksum.\n * @param errorMessage - The error message to throw if validation fails.\n */\nexport async function validateSnapShasum(\n  files: FetchedSnapFiles,\n  errorMessage = 'Invalid Snap manifest: manifest shasum does not match computed shasum.',\n): Promise<void> {\n  if (files.manifest.result.source.shasum !== (await getSnapChecksum(files))) {\n    throw new ProgrammaticallyFixableSnapError(\n      errorMessage,\n      SnapValidationFailureReason.ShasumMismatch,\n    );\n  }\n}\n\nexport const LOCALHOST_HOSTNAMES = ['localhost', '127.0.0.1', '[::1]'] as const;\n\n// Require snap ids to only consist of printable ASCII characters\nexport const BaseSnapIdStruct = pattern(string(), /^[\\x21-\\x7E]*$/u);\n\nconst LocalSnapIdSubUrlStruct = uri({\n  protocol: enums(['http:', 'https:']),\n  hostname: enums(LOCALHOST_HOSTNAMES),\n  hash: empty(string()),\n  search: empty(string()),\n});\n\nexport const LocalSnapIdStruct = refine(\n  BaseSnapIdStruct,\n  'local Snap Id',\n  (value) => {\n    if (!value.startsWith(SnapIdPrefixes.local)) {\n      return `Expected local snap ID, got \"${value}\".`;\n    }\n\n    const [error] = validate(\n      value.slice(SnapIdPrefixes.local.length),\n      LocalSnapIdSubUrlStruct,\n    );\n    return error ?? true;\n  },\n);\nexport const NpmSnapIdStruct = intersection([\n  BaseSnapIdStruct,\n  uri({\n    protocol: literal(SnapIdPrefixes.npm),\n    pathname: refine(string(), 'package name', function* (value) {\n      const normalized = value.startsWith('/') ? value.slice(1) : value;\n      const { errors, validForNewPackages, warnings } =\n        validateNPMPackage(normalized);\n      if (!validForNewPackages) {\n        if (errors === undefined) {\n          assert(warnings !== undefined);\n          yield* warnings;\n        } else {\n          yield* errors;\n        }\n      }\n      return true;\n    }),\n    search: empty(string()),\n    hash: empty(string()),\n  }),\n]) as unknown as Struct<string, null>;\n\nexport const HttpSnapIdStruct = intersection([\n  BaseSnapIdStruct,\n  uri({\n    protocol: enums(['http:', 'https:']),\n    search: empty(string()),\n    hash: empty(string()),\n  }),\n]) as unknown as Struct<string, null>;\n\nexport const SnapIdStruct = union([NpmSnapIdStruct, LocalSnapIdStruct]);\n\n/**\n * Extracts the snap prefix from a snap ID.\n *\n * @param snapId - The snap ID to extract the prefix from.\n * @returns The snap prefix from a snap id, e.g. `npm:`.\n */\nexport function getSnapPrefix(snapId: string): SnapIdPrefixes {\n  const prefix = Object.values(SnapIdPrefixes).find((possiblePrefix) =>\n    snapId.startsWith(possiblePrefix),\n  );\n  if (prefix !== undefined) {\n    return prefix;\n  }\n  throw new Error(`Invalid or no prefix found for \"${snapId}\"`);\n}\n\n/**\n * Strips snap prefix from a full snap ID.\n *\n * @param snapId - The snap ID to strip.\n * @returns The stripped snap ID.\n */\nexport function stripSnapPrefix(snapId: string): string {\n  return snapId.replace(getSnapPrefix(snapId), '');\n}\n\n/**\n * Assert that the given value is a valid snap ID.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid snap ID.\n */\nexport function assertIsValidSnapId(value: unknown): asserts value is SnapId {\n  assertStruct(value, SnapIdStruct, 'Invalid snap ID');\n}\n\n/**\n * Typeguard to ensure a chainId follows the CAIP-2 standard.\n *\n * @param chainId - The chainId being tested.\n * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.\n */\nexport function isCaipChainId(chainId: unknown): chainId is string {\n  return (\n    typeof chainId === 'string' &&\n    /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(\n      chainId,\n    )\n  );\n}\n\n/**\n * Utility function to check if an origin has permission (and caveat) for a particular snap.\n *\n * @param permissions - An origin's permissions object.\n * @param snapId - The id of the snap.\n * @returns A boolean based on if an origin has the specified snap.\n */\nexport function isSnapPermitted(\n  permissions: SubjectPermissions<PermissionConstraint>,\n  snapId: SnapId,\n) {\n  return Boolean(\n    (\n      (\n        (permissions?.wallet_snap?.caveats?.find(\n          (caveat) => caveat.type === SnapCaveatType.SnapIds,\n        ) ?? {}) as Caveat<string, Json>\n      ).value as Record<string, unknown>\n    )?.[snapId],\n  );\n}\n\n/**\n * Checks whether the passed in requestedPermissions is a valid\n * permission request for a `wallet_snap` permission.\n *\n * @param requestedPermissions - The requested permissions.\n * @throws If the criteria is not met.\n */\nexport function verifyRequestedSnapPermissions(\n  requestedPermissions: unknown,\n): asserts requestedPermissions is SnapsPermissionRequest {\n  assert(\n    isObject(requestedPermissions),\n    'Requested permissions must be an object.',\n  );\n\n  const { wallet_snap: walletSnapPermission } = requestedPermissions;\n\n  assert(\n    isObject(walletSnapPermission),\n    'wallet_snap is missing from the requested permissions.',\n  );\n\n  const { caveats } = walletSnapPermission;\n\n  assert(\n    Array.isArray(caveats) && caveats.length === 1,\n    'wallet_snap must have a caveat property with a single-item array value.',\n  );\n\n  const [caveat] = caveats;\n\n  assert(\n    isObject(caveat) &&\n      caveat.type === SnapCaveatType.SnapIds &&\n      isObject(caveat.value),\n    `The requested permissions do not have a valid ${SnapCaveatType.SnapIds} caveat.`,\n  );\n}\n\nexport type { Snap as TruncatedSnap } from '@metamask/snaps-sdk';\n"],"mappings":";;;;;;;;;AAQA,SAAS,QAAQ,UAAU,oBAAoB;AAC/C,SAAS,cAAc;AACvB,OAAO,qBAAqB;AAE5B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,OAAO,wBAAwB;AAmBxB,IAAM,sBACX;AAEK,IAAK,aAAL,kBAAKA,gBAAL;AACL,EAAAA,YAAA,gBAAa;AACb,EAAAA,YAAA,cAAW;AACX,EAAAA,YAAA,aAAU;AACV,EAAAA,YAAA,aAAU;AACV,EAAAA,YAAA,aAAU;AALA,SAAAA;AAAA,GAAA;AAQL,IAAK,mBAAL,kBAAKC,sBAAL;AACL,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,UAAO;AACP,EAAAA,kBAAA,WAAQ;AACR,EAAAA,kBAAA,YAAS;AAJC,SAAAA;AAAA,GAAA;AAsGL,IAAM,mCAAN,cAA+C,MAAM;AAAA,EAG1D,YAAY,SAAiB,QAAqC;AAChE,UAAM,OAAO;AACb,SAAK,SAAS;AAAA,EAChB;AACF;AAQA,SAAS,yBACP,UACa;AACb,QAAM,eAAe,SAAS,MAAM;AACpC,SAAO,aAAa,OAAO,OAAO;AAIlC,eAAa,QAAQ,gBAAgB,aAAa,MAAM;AACxD,SAAO;AACT;AAQA,eAAsB,gBACpB,OACiB;AACjB,QAAM,EAAE,UAAU,YAAY,SAAS,gBAAgB,kBAAkB,IACvE;AAEF,QAAM,MAAM;AAAA,IACV,yBAAyB,QAAQ;AAAA,IACjC;AAAA,IACA;AAAA,IACA,GAAG;AAAA,IACH,GAAG;AAAA,EACL,EAAE,OAAO,CAAC,SAAS,SAAS,MAAS;AAErC,SAAO,OAAO,OAAO,MAAM,cAAc,GAAoB,CAAC;AAChE;AASA,eAAsB,mBACpB,OACA,eAAe,0EACA;AACf,MAAI,MAAM,SAAS,OAAO,OAAO,WAAY,MAAM,gBAAgB,KAAK,GAAI;AAC1E,UAAM,IAAI;AAAA,MACR;AAAA;AAAA,IAEF;AAAA,EACF;AACF;AAEO,IAAM,sBAAsB,CAAC,aAAa,aAAa,OAAO;AAG9D,IAAM,mBAAmB,QAAQ,OAAO,GAAG,iBAAiB;AAEnE,IAAM,0BAA0B,IAAI;AAAA,EAClC,UAAU,MAAM,CAAC,SAAS,QAAQ,CAAC;AAAA,EACnC,UAAU,MAAM,mBAAmB;AAAA,EACnC,MAAM,MAAM,OAAO,CAAC;AAAA,EACpB,QAAQ,MAAM,OAAO,CAAC;AACxB,CAAC;AAEM,IAAM,oBAAoB;AAAA,EAC/B;AAAA,EACA;AAAA,EACA,CAAC,UAAU;AACT,QAAI,CAAC,MAAM,+BAA+B,GAAG;AAC3C,aAAO,gCAAgC,KAAK;AAAA,IAC9C;AAEA,UAAM,CAAC,KAAK,IAAI;AAAA,MACd,MAAM,2BAA2B,MAAM;AAAA,MACvC;AAAA,IACF;AACA,WAAO,SAAS;AAAA,EAClB;AACF;AACO,IAAM,kBAAkB,aAAa;AAAA,EAC1C;AAAA,EACA,IAAI;AAAA,IACF,UAAU,wBAA0B;AAAA,IACpC,UAAU,OAAO,OAAO,GAAG,gBAAgB,WAAW,OAAO;AAC3D,YAAM,aAAa,MAAM,WAAW,GAAG,IAAI,MAAM,MAAM,CAAC,IAAI;AAC5D,YAAM,EAAE,QAAQ,qBAAqB,SAAS,IAC5C,mBAAmB,UAAU;AAC/B,UAAI,CAAC,qBAAqB;AACxB,YAAI,WAAW,QAAW;AACxB,iBAAO,aAAa,MAAS;AAC7B,iBAAO;AAAA,QACT,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO;AAAA,IACT,CAAC;AAAA,IACD,QAAQ,MAAM,OAAO,CAAC;AAAA,IACtB,MAAM,MAAM,OAAO,CAAC;AAAA,EACtB,CAAC;AACH,CAAC;AAEM,IAAM,mBAAmB,aAAa;AAAA,EAC3C;AAAA,EACA,IAAI;AAAA,IACF,UAAU,MAAM,CAAC,SAAS,QAAQ,CAAC;AAAA,IACnC,QAAQ,MAAM,OAAO,CAAC;AAAA,IACtB,MAAM,MAAM,OAAO,CAAC;AAAA,EACtB,CAAC;AACH,CAAC;AAEM,IAAM,eAAe,MAAM,CAAC,iBAAiB,iBAAiB,CAAC;AAQ/D,SAAS,cAAc,QAAgC;AAC5D,QAAM,SAAS,OAAO,OAAO,cAAc,EAAE;AAAA,IAAK,CAAC,mBACjD,OAAO,WAAW,cAAc;AAAA,EAClC;AACA,MAAI,WAAW,QAAW;AACxB,WAAO;AAAA,EACT;AACA,QAAM,IAAI,MAAM,mCAAmC,MAAM,GAAG;AAC9D;AAQO,SAAS,gBAAgB,QAAwB;AACtD,SAAO,OAAO,QAAQ,cAAc,MAAM,GAAG,EAAE;AACjD;AAQO,SAAS,oBAAoB,OAAyC;AAC3E,eAAa,OAAO,cAAc,iBAAiB;AACrD;AAQO,SAAS,cAAc,SAAqC;AACjE,SACE,OAAO,YAAY,YACnB,mEAAmE;AAAA,IACjE;AAAA,EACF;AAEJ;AASO,SAAS,gBACd,aACA,QACA;AACA,SAAO;AAAA,KAGA,aAAa,aAAa,SAAS;AAAA,MAClC,CAAC,WAAW,OAAO;AAAA,IACrB,KAAK,CAAC,GACN,QACA,MAAM;AAAA,EACZ;AACF;AASO,SAAS,+BACd,sBACwD;AACxD;AAAA,IACE,SAAS,oBAAoB;AAAA,IAC7B;AAAA,EACF;AAEA,QAAM,EAAE,aAAa,qBAAqB,IAAI;AAE9C;AAAA,IACE,SAAS,oBAAoB;AAAA,IAC7B;AAAA,EACF;AAEA,QAAM,EAAE,QAAQ,IAAI;AAEpB;AAAA,IACE,MAAM,QAAQ,OAAO,KAAK,QAAQ,WAAW;AAAA,IAC7C;AAAA,EACF;AAEA,QAAM,CAAC,MAAM,IAAI;AAEjB;AAAA,IACE,SAAS,MAAM,KACb,OAAO,oCACP,SAAS,OAAO,KAAK;AAAA,IACvB,wEAAuE;AAAA,EACzE;AACF;","names":["SnapStatus","SnapStatusEvents"]}

package/dist/chunk-FTY3BOF7.js

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/array.ts
+function isEqual(a, b) {
+  return a.length === b.length && a.every((value, index) => value === b[index]);
+}
+
+
+
+exports.isEqual = isEqual;
+//# sourceMappingURL=chunk-FTY3BOF7.js.map

package/dist/chunk-FTY3BOF7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/array.ts"],"names":[],"mappings":";AASO,SAAS,QAAQ,GAAc,GAAuB;AAC3D,SAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,OAAO,UAAU,UAAU,EAAE,KAAK,CAAC;AAC9E","sourcesContent":["/**\n * Checks if array `a` is equal to array `b`. Note that this does not do a deep\n * equality check. It only checks if the arrays are the same length and if each\n * element in `a` is equal to (`===`) the corresponding element in `b`.\n *\n * @param a - The first array to compare.\n * @param b - The second array to compare.\n * @returns `true` if the arrays are equal, `false` otherwise.\n */\nexport function isEqual(a: unknown[], b: unknown[]): boolean {\n  return a.length === b.length && a.every((value, index) => value === b[index]);\n}\n"]}

package/dist/chunk-GK4IJQVW.js

@@ -0,0 +1,409 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } async function _asyncNullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return await rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
+
+var _chunkOQSLMZJNjs = require('./chunk-OQSLMZJN.js');
+
+
+
+
+var _chunkH636DAOGjs = require('./chunk-H636DAOG.js');
+
+
+
+var _chunkKEXZDQANjs = require('./chunk-KEXZDQAN.js');
+
+
+
+var _chunk4UMDRHDRjs = require('./chunk-4UMDRHDR.js');
+
+
+
+var _chunkRS5HE55Ujs = require('./chunk-RS5HE55U.js');
+
+
+var _chunkVMUXXXJCjs = require('./chunk-VMUXXXJC.js');
+
+
+var _chunkR7UAMO2Ujs = require('./chunk-R7UAMO2U.js');
+
+
+var _chunkXWFKTDB3js = require('./chunk-XWFKTDB3.js');
+
+
+var _chunkQ7FGULTVjs = require('./chunk-Q7FGULTV.js');
+
+// src/manifest/manifest.ts
+var _snapssdk = require('@metamask/snaps-sdk');
+var _utils = require('@metamask/utils');
+var _fastdeepequal = require('fast-deep-equal'); var _fastdeepequal2 = _interopRequireDefault(_fastdeepequal);
+var _fs = require('fs');
+var _path = require('path'); var _path2 = _interopRequireDefault(_path);
+var MANIFEST_SORT_ORDER = {
+  $schema: 1,
+  version: 2,
+  description: 3,
+  proposedName: 4,
+  repository: 5,
+  source: 6,
+  initialConnections: 7,
+  initialPermissions: 8,
+  manifestVersion: 9
+};
+async function checkManifest(basePath, writeManifest = true, sourceCode, writeFileFn = _fs.promises.writeFile) {
+  const warnings = [];
+  const errors = [];
+  let updated = false;
+  const manifestPath = _path2.default.join(basePath, "snap.manifest.json" /* Manifest */);
+  const manifestFile = await _chunkVMUXXXJCjs.readJsonFile.call(void 0, manifestPath);
+  const unvalidatedManifest = manifestFile.result;
+  const packageFile = await _chunkVMUXXXJCjs.readJsonFile.call(void 0, 
+    _path2.default.join(basePath, "package.json" /* PackageJson */)
+  );
+  const auxiliaryFilePaths = getSnapFilePaths(
+    unvalidatedManifest,
+    (manifest2) => _optionalChain([manifest2, 'optionalAccess', _ => _.source, 'optionalAccess', _2 => _2.files])
+  );
+  const localizationFilePaths = getSnapFilePaths(
+    unvalidatedManifest,
+    (manifest2) => _optionalChain([manifest2, 'optionalAccess', _3 => _3.source, 'optionalAccess', _4 => _4.locales])
+  );
+  const snapFiles = {
+    manifest: manifestFile,
+    packageJson: packageFile,
+    sourceCode: await getSnapSourceCode(
+      basePath,
+      unvalidatedManifest,
+      sourceCode
+    ),
+    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),
+    // Intentionally pass null as the encoding here since the files may be binary
+    auxiliaryFiles: await _asyncNullishCoalesce(await getSnapFiles(basePath, auxiliaryFilePaths, null), async () => ( [])),
+    localizationFiles: await _asyncNullishCoalesce(await getSnapFiles(basePath, localizationFilePaths), async () => ( []))
+  };
+  let manifest;
+  try {
+    ({ manifest } = await validateNpmSnap(snapFiles));
+  } catch (error) {
+    if (error instanceof _chunkH636DAOGjs.ProgrammaticallyFixableSnapError) {
+      errors.push(error.message);
+      const partiallyValidatedFiles = snapFiles;
+      let isInvalid = true;
+      let currentError = error;
+      const maxAttempts = Object.keys(_chunk4UMDRHDRjs.SnapValidationFailureReason).length;
+      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {
+        manifest = await fixManifest(
+          manifest ? { ...partiallyValidatedFiles, manifest } : partiallyValidatedFiles,
+          currentError
+        );
+        try {
+          await validateNpmSnapManifest({
+            ...partiallyValidatedFiles,
+            manifest
+          });
+          isInvalid = false;
+        } catch (nextValidationError) {
+          currentError = nextValidationError;
+          if (!(nextValidationError instanceof _chunkH636DAOGjs.ProgrammaticallyFixableSnapError) || attempts === maxAttempts && !isInvalid) {
+            throw new Error(
+              `Internal error: Failed to fix manifest. This is a bug, please report it. Reason:
+${error.message}`
+            );
+          }
+          errors.push(currentError.message);
+        }
+      }
+      updated = true;
+    } else {
+      throw error;
+    }
+  }
+  _utils.assert.call(void 0, manifest);
+  const validatedManifest = manifest.result;
+  const recommendedFields = ["repository"];
+  const missingRecommendedFields = recommendedFields.filter(
+    (key) => !validatedManifest[key]
+  );
+  if (missingRecommendedFields.length > 0) {
+    warnings.push(
+      `Missing recommended package.json properties:
+${missingRecommendedFields.reduce(
+        (allMissing, currentField) => {
+          return `${allMissing}	${currentField}
+`;
+        },
+        ""
+      )}`
+    );
+  }
+  if (!snapFiles.svgIcon) {
+    warnings.push(
+      "No icon found in the Snap manifest. It is recommended to include an icon for the Snap. See https://docs.metamask.io/snaps/how-to/design-a-snap/#guidelines-at-a-glance for more information."
+    );
+  }
+  const iconDimensions = snapFiles.svgIcon && _chunkKEXZDQANjs.getSvgDimensions.call(void 0, snapFiles.svgIcon.toString());
+  if (iconDimensions && iconDimensions.height !== iconDimensions.width) {
+    warnings.push(
+      "The icon in the Snap manifest is not square. It is recommended to use a square icon for the Snap."
+    );
+  }
+  if (writeManifest) {
+    try {
+      const newManifest = `${JSON.stringify(
+        getWritableManifest(validatedManifest),
+        null,
+        2
+      )}
+`;
+      if (updated || newManifest !== manifestFile.value) {
+        await writeFileFn(
+          _path2.default.join(basePath, "snap.manifest.json" /* Manifest */),
+          newManifest
+        );
+      }
+    } catch (error) {
+      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);
+    }
+  }
+  return { manifest: validatedManifest, updated, warnings, errors };
+}
+async function fixManifest(snapFiles, error) {
+  const { manifest, packageJson } = snapFiles;
+  const clonedFile = manifest.clone();
+  const manifestCopy = clonedFile.result;
+  switch (error.reason) {
+    case '"name" field mismatch' /* NameMismatch */:
+      manifestCopy.source.location.npm.packageName = packageJson.result.name;
+      break;
+    case '"version" field mismatch' /* VersionMismatch */:
+      manifestCopy.version = packageJson.result.version;
+      break;
+    case '"repository" field mismatch' /* RepositoryMismatch */:
+      manifestCopy.repository = packageJson.result.repository ? _chunkQ7FGULTVjs.deepClone.call(void 0, packageJson.result.repository) : void 0;
+      break;
+    case '"shasum" field mismatch' /* ShasumMismatch */:
+      manifestCopy.source.shasum = await _chunkH636DAOGjs.getSnapChecksum.call(void 0, snapFiles);
+      break;
+    default:
+      _utils.assertExhaustive.call(void 0, error.reason);
+  }
+  clonedFile.result = manifestCopy;
+  clonedFile.value = JSON.stringify(manifestCopy);
+  return clonedFile;
+}
+async function getSnapSourceCode(basePath, manifest, sourceCode) {
+  if (!_utils.isPlainObject.call(void 0, manifest)) {
+    return void 0;
+  }
+  const sourceFilePath = _optionalChain([manifest, 'access', _5 => _5.source, 'optionalAccess', _6 => _6.location, 'optionalAccess', _7 => _7.npm, 'optionalAccess', _8 => _8.filePath]);
+  if (!sourceFilePath) {
+    return void 0;
+  }
+  if (sourceCode) {
+    return new (0, _chunkXWFKTDB3js.VirtualFile)({
+      path: _path2.default.join(basePath, sourceFilePath),
+      value: sourceCode
+    });
+  }
+  try {
+    const virtualFile = await _chunkR7UAMO2Ujs.readVirtualFile.call(void 0, 
+      _path2.default.join(basePath, sourceFilePath),
+      "utf8"
+    );
+    return virtualFile;
+  } catch (error) {
+    throw new Error(
+      `Failed to read snap bundle file: ${_snapssdk.getErrorMessage.call(void 0, error)}`
+    );
+  }
+}
+async function getSnapIcon(basePath, manifest) {
+  if (!_utils.isPlainObject.call(void 0, manifest)) {
+    return void 0;
+  }
+  const iconPath = _optionalChain([manifest, 'access', _9 => _9.source, 'optionalAccess', _10 => _10.location, 'optionalAccess', _11 => _11.npm, 'optionalAccess', _12 => _12.iconPath]);
+  if (!iconPath) {
+    return void 0;
+  }
+  try {
+    const virtualFile = await _chunkR7UAMO2Ujs.readVirtualFile.call(void 0, 
+      _path2.default.join(basePath, iconPath),
+      "utf8"
+    );
+    return virtualFile;
+  } catch (error) {
+    throw new Error(`Failed to read snap icon file: ${_snapssdk.getErrorMessage.call(void 0, error)}`);
+  }
+}
+function getSnapFilePaths(manifest, selector) {
+  if (!_utils.isPlainObject.call(void 0, manifest)) {
+    return void 0;
+  }
+  const snapManifest = manifest;
+  const paths = selector(snapManifest);
+  if (!Array.isArray(paths)) {
+    return void 0;
+  }
+  return paths;
+}
+async function getSnapFiles(basePath, paths, encoding = "utf8") {
+  if (!paths) {
+    return void 0;
+  }
+  try {
+    return await Promise.all(
+      paths.map(
+        async (filePath) => _chunkR7UAMO2Ujs.readVirtualFile.call(void 0, _path2.default.join(basePath, filePath), encoding)
+      )
+    );
+  } catch (error) {
+    throw new Error(`Failed to read snap files: ${_snapssdk.getErrorMessage.call(void 0, error)}`);
+  }
+}
+function getWritableManifest(manifest) {
+  const { repository, ...remaining } = manifest;
+  const keys = Object.keys(
+    repository ? { ...remaining, repository } : remaining
+  );
+  const writableManifest = keys.sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b]).reduce(
+    (result, key) => ({
+      ...result,
+      [key]: manifest[key]
+    }),
+    {}
+  );
+  return writableManifest;
+}
+async function validateNpmSnapManifest({
+  manifest,
+  packageJson,
+  sourceCode,
+  svgIcon,
+  auxiliaryFiles,
+  localizationFiles
+}) {
+  const packageJsonName = packageJson.result.name;
+  const packageJsonVersion = packageJson.result.version;
+  const packageJsonRepository = packageJson.result.repository;
+  const manifestPackageName = manifest.result.source.location.npm.packageName;
+  const manifestPackageVersion = manifest.result.version;
+  const manifestRepository = manifest.result.repository;
+  if (packageJsonName !== manifestPackageName) {
+    throw new (0, _chunkH636DAOGjs.ProgrammaticallyFixableSnapError)(
+      `"${"snap.manifest.json" /* Manifest */}" npm package name ("${manifestPackageName}") does not match the "${"package.json" /* PackageJson */}" "name" field ("${packageJsonName}").`,
+      '"name" field mismatch' /* NameMismatch */
+    );
+  }
+  if (packageJsonVersion !== manifestPackageVersion) {
+    throw new (0, _chunkH636DAOGjs.ProgrammaticallyFixableSnapError)(
+      `"${"snap.manifest.json" /* Manifest */}" npm package version ("${manifestPackageVersion}") does not match the "${"package.json" /* PackageJson */}" "version" field ("${packageJsonVersion}").`,
+      '"version" field mismatch' /* VersionMismatch */
+    );
+  }
+  if (
+    // The repository may be `undefined` in package.json but can only be defined
+    // or `null` in the Snap manifest due to TS@<4.4 issues.
+    (packageJsonRepository || manifestRepository) && !_fastdeepequal2.default.call(void 0, packageJsonRepository, manifestRepository)
+  ) {
+    throw new (0, _chunkH636DAOGjs.ProgrammaticallyFixableSnapError)(
+      `"${"snap.manifest.json" /* Manifest */}" "repository" field does not match the "${"package.json" /* PackageJson */}" "repository" field.`,
+      '"repository" field mismatch' /* RepositoryMismatch */
+    );
+  }
+  await _chunkH636DAOGjs.validateSnapShasum.call(void 0, 
+    { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles },
+    `"${"snap.manifest.json" /* Manifest */}" "shasum" field does not match computed shasum.`
+  );
+}
+
+// src/npm.ts
+var EXPECTED_SNAP_FILES = [
+  "manifest",
+  "packageJson",
+  "sourceCode"
+];
+var SnapFileNameFromKey = {
+  manifest: "snap.manifest.json" /* Manifest */,
+  packageJson: "package.json" /* PackageJson */,
+  sourceCode: "source code bundle"
+};
+async function validateNpmSnap(snapFiles, errorPrefix) {
+  EXPECTED_SNAP_FILES.forEach((key) => {
+    if (!snapFiles[key]) {
+      throw new Error(
+        `${_nullishCoalesce(errorPrefix, () => ( ""))}Missing file "${SnapFileNameFromKey[key]}".`
+      );
+    }
+  });
+  const {
+    manifest,
+    packageJson,
+    sourceCode,
+    svgIcon,
+    auxiliaryFiles,
+    localizationFiles
+  } = snapFiles;
+  try {
+    _chunkOQSLMZJNjs.assertIsSnapManifest.call(void 0, manifest.result);
+  } catch (error) {
+    throw new Error(`${_nullishCoalesce(errorPrefix, () => ( ""))}${error.message}`);
+  }
+  const validatedManifest = manifest;
+  const { iconPath } = validatedManifest.result.source.location.npm;
+  if (iconPath && !svgIcon) {
+    throw new Error(`Missing file "${iconPath}".`);
+  }
+  try {
+    _chunk4UMDRHDRjs.assertIsNpmSnapPackageJson.call(void 0, packageJson.result);
+  } catch (error) {
+    throw new Error(`${_nullishCoalesce(errorPrefix, () => ( ""))}${error.message}`);
+  }
+  const validatedPackageJson = packageJson;
+  await validateNpmSnapManifest({
+    manifest: validatedManifest,
+    packageJson: validatedPackageJson,
+    sourceCode,
+    svgIcon,
+    auxiliaryFiles,
+    localizationFiles
+  });
+  if (svgIcon) {
+    try {
+      _chunkKEXZDQANjs.assertIsSnapIcon.call(void 0, svgIcon);
+    } catch (error) {
+      throw new Error(`${_nullishCoalesce(errorPrefix, () => ( ""))}${error.message}`);
+    }
+  }
+  if (localizationFiles) {
+    try {
+      _chunkRS5HE55Ujs.getValidatedLocalizationFiles.call(void 0, localizationFiles);
+      _chunkRS5HE55Ujs.validateSnapManifestLocalizations.call(void 0, 
+        manifest.result,
+        localizationFiles.map((file) => file.result)
+      );
+    } catch (error) {
+      throw new Error(`${_nullishCoalesce(errorPrefix, () => ( ""))}${error.message}`);
+    }
+  }
+  return {
+    manifest: validatedManifest,
+    packageJson: validatedPackageJson,
+    sourceCode,
+    svgIcon,
+    auxiliaryFiles,
+    localizationFiles
+  };
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+exports.EXPECTED_SNAP_FILES = EXPECTED_SNAP_FILES; exports.SnapFileNameFromKey = SnapFileNameFromKey; exports.validateNpmSnap = validateNpmSnap; exports.checkManifest = checkManifest; exports.fixManifest = fixManifest; exports.getSnapSourceCode = getSnapSourceCode; exports.getSnapIcon = getSnapIcon; exports.getSnapFilePaths = getSnapFilePaths; exports.getSnapFiles = getSnapFiles; exports.getWritableManifest = getWritableManifest; exports.validateNpmSnapManifest = validateNpmSnapManifest;
+//# sourceMappingURL=chunk-GK4IJQVW.js.map