@metamask/snaps-controllers 5.0.1 → 6.0.0

package/dist/chunk-LFWLV3SS.js

@@ -0,0 +1,273 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return 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 _chunkEXN2TFDJjs = require('./chunk-EXN2TFDJ.js');
+
+// src/snaps/registry/json.ts
+var _basecontroller = require('@metamask/base-controller');
+var _snapsregistry = require('@metamask/snaps-registry');
+var _snapsutils = require('@metamask/snaps-utils');
+
+
+
+
+
+
+var _utils = require('@metamask/utils');
+var SNAP_REGISTRY_URL = "https://cdn.jsdelivr.net/gh/MetaMask/snaps-registry@gh-pages/latest/registry.json";
+var SNAP_REGISTRY_SIGNATURE_URL = "https://cdn.jsdelivr.net/gh/MetaMask/snaps-registry@gh-pages/latest/signature.json";
+var controllerName = "SnapsRegistry";
+var defaultState = {
+  database: null,
+  lastUpdated: null
+};
+var _url, _publicKey, _fetchFunction, _recentFetchThreshold, _refetchOnAllowlistMiss, _failOnUnavailableRegistry, _currentUpdate, _wasRecentlyFetched, wasRecentlyFetched_fn, _triggerUpdate, triggerUpdate_fn, _update, update_fn, _getDatabase, getDatabase_fn, _getSingle, getSingle_fn, _get, get_fn, _resolveVersion, resolveVersion_fn, _getMetadata, getMetadata_fn, _verifySignature, verifySignature_fn, _safeFetch, safeFetch_fn;
+var JsonSnapsRegistry = class extends _basecontroller.BaseController {
+  constructor({
+    messenger,
+    state,
+    url = {
+      registry: SNAP_REGISTRY_URL,
+      signature: SNAP_REGISTRY_SIGNATURE_URL
+    },
+    publicKey,
+    fetchFunction = globalThis.fetch.bind(globalThis),
+    recentFetchThreshold = _utils.inMilliseconds.call(void 0, 5, _utils.Duration.Minute),
+    failOnUnavailableRegistry = true,
+    refetchOnAllowlistMiss = true
+  }) {
+    super({
+      messenger,
+      metadata: {
+        database: { persist: true, anonymous: false },
+        lastUpdated: { persist: true, anonymous: false }
+      },
+      name: controllerName,
+      state: {
+        ...defaultState,
+        ...state
+      }
+    });
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _wasRecentlyFetched);
+    /**
+     * Triggers an update of the registry database.
+     *
+     * If an existing update is in progress this function will await that update.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _triggerUpdate);
+    /**
+     * Updates the registry database if the registry hasn't been updated recently.
+     *
+     * NOTE: SHOULD NOT be called directly, instead `triggerUpdate` should be used.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _update);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _getDatabase);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _getSingle);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _get);
+    /**
+     * Find an allowlisted version within a specified version range. Otherwise return the version range itself.
+     *
+     * @param snapId - The ID of the snap we are trying to resolve a version for.
+     * @param versionRange - The version range.
+     * @param refetch - An optional flag used to determine if we are refetching the registry.
+     * @returns An allowlisted version within the specified version range if available otherwise returns the input version range.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _resolveVersion);
+    /**
+     * Get metadata for the given snap ID.
+     *
+     * @param snapId - The ID of the snap to get metadata for.
+     * @returns The metadata for the given snap ID, or `null` if the snap is not
+     * verified.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _getMetadata);
+    /**
+     * Verify the signature of the registry.
+     *
+     * @param database - The registry database.
+     * @param signature - The signature of the registry.
+     * @throws If the signature is invalid.
+     * @private
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _verifySignature);
+    /**
+     * Fetch the given URL, throwing if the response is not OK.
+     *
+     * @param url - The URL to fetch.
+     * @returns The response body.
+     * @private
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _safeFetch);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _url, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _publicKey, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _fetchFunction, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _recentFetchThreshold, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _refetchOnAllowlistMiss, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _failOnUnavailableRegistry, void 0);
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _currentUpdate, void 0);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _url, url);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _publicKey, publicKey);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _fetchFunction, fetchFunction);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _recentFetchThreshold, recentFetchThreshold);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _refetchOnAllowlistMiss, refetchOnAllowlistMiss);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _failOnUnavailableRegistry, failOnUnavailableRegistry);
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _currentUpdate, null);
+    this.messagingSystem.registerActionHandler(
+      "SnapsRegistry:get",
+      async (...args) => _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _get, get_fn).call(this, ...args)
+    );
+    this.messagingSystem.registerActionHandler(
+      "SnapsRegistry:getMetadata",
+      async (...args) => _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _getMetadata, getMetadata_fn).call(this, ...args)
+    );
+    this.messagingSystem.registerActionHandler(
+      "SnapsRegistry:resolveVersion",
+      async (...args) => _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _resolveVersion, resolveVersion_fn).call(this, ...args)
+    );
+    this.messagingSystem.registerActionHandler(
+      "SnapsRegistry:update",
+      async () => _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _triggerUpdate, triggerUpdate_fn).call(this)
+    );
+  }
+};
+_url = new WeakMap();
+_publicKey = new WeakMap();
+_fetchFunction = new WeakMap();
+_recentFetchThreshold = new WeakMap();
+_refetchOnAllowlistMiss = new WeakMap();
+_failOnUnavailableRegistry = new WeakMap();
+_currentUpdate = new WeakMap();
+_wasRecentlyFetched = new WeakSet();
+wasRecentlyFetched_fn = function() {
+  return this.state.lastUpdated && Date.now() - this.state.lastUpdated < _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _recentFetchThreshold);
+};
+_triggerUpdate = new WeakSet();
+triggerUpdate_fn = async function() {
+  if (_chunkEXN2TFDJjs.__privateGet.call(void 0, this, _currentUpdate)) {
+    await _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _currentUpdate);
+    return;
+  }
+  if (_chunkEXN2TFDJjs.__privateGet.call(void 0, this, _currentUpdate) === null) {
+    _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _currentUpdate, _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _update, update_fn).call(this));
+  }
+  await _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _currentUpdate);
+  _chunkEXN2TFDJjs.__privateSet.call(void 0, this, _currentUpdate, null);
+};
+_update = new WeakSet();
+update_fn = async function() {
+  if (_chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _wasRecentlyFetched, wasRecentlyFetched_fn).call(this)) {
+    return;
+  }
+  try {
+    const database = await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _safeFetch, safeFetch_fn).call(this, _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _url).registry);
+    if (_chunkEXN2TFDJjs.__privateGet.call(void 0, this, _publicKey)) {
+      const signature = await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _safeFetch, safeFetch_fn).call(this, _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _url).signature);
+      _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _verifySignature, verifySignature_fn).call(this, database, signature);
+    }
+    this.update((state) => {
+      state.database = JSON.parse(database);
+      state.lastUpdated = Date.now();
+    });
+  } catch (e) {
+  }
+};
+_getDatabase = new WeakSet();
+getDatabase_fn = async function() {
+  if (this.state.database === null) {
+    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _triggerUpdate, triggerUpdate_fn).call(this);
+  }
+  if (_chunkEXN2TFDJjs.__privateGet.call(void 0, this, _failOnUnavailableRegistry) && this.state.database === null) {
+    throw new Error("Snaps registry is unavailable, installation blocked.");
+  }
+  return this.state.database;
+};
+_getSingle = new WeakSet();
+getSingle_fn = async function(snapId, snapInfo, refetch = false) {
+  const database = await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _getDatabase, getDatabase_fn).call(this);
+  const blockedEntry = _optionalChain([database, 'optionalAccess', _ => _.blockedSnaps, 'access', _2 => _2.find, 'call', _3 => _3((blocked) => {
+    if ("id" in blocked) {
+      return blocked.id === snapId && _utils.satisfiesVersionRange.call(void 0, snapInfo.version, blocked.versionRange);
+    }
+    return blocked.checksum === snapInfo.checksum;
+  })]);
+  if (blockedEntry) {
+    return {
+      status: 1 /* Blocked */,
+      reason: blockedEntry.reason
+    };
+  }
+  const verified = _optionalChain([database, 'optionalAccess', _4 => _4.verifiedSnaps, 'access', _5 => _5[snapId]]);
+  const version = _optionalChain([verified, 'optionalAccess', _6 => _6.versions, 'optionalAccess', _7 => _7[snapInfo.version]]);
+  if (version && version.checksum === snapInfo.checksum) {
+    return { status: 2 /* Verified */ };
+  }
+  if (_chunkEXN2TFDJjs.__privateGet.call(void 0, this, _refetchOnAllowlistMiss) && !refetch) {
+    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _triggerUpdate, triggerUpdate_fn).call(this);
+    return _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _getSingle, getSingle_fn).call(this, snapId, snapInfo, true);
+  }
+  return { status: 0 /* Unverified */ };
+};
+_get = new WeakSet();
+get_fn = async function(snaps) {
+  return Object.entries(snaps).reduce(async (previousPromise, [snapId, snapInfo]) => {
+    const result = await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _getSingle, getSingle_fn).call(this, snapId, snapInfo);
+    const acc = await previousPromise;
+    acc[snapId] = result;
+    return acc;
+  }, Promise.resolve({}));
+};
+_resolveVersion = new WeakSet();
+resolveVersion_fn = async function(snapId, versionRange, refetch = false) {
+  const database = await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _getDatabase, getDatabase_fn).call(this);
+  const versions = _nullishCoalesce(_optionalChain([database, 'optionalAccess', _8 => _8.verifiedSnaps, 'access', _9 => _9[snapId], 'optionalAccess', _10 => _10.versions]), () => ( null));
+  if (!versions && _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _refetchOnAllowlistMiss) && !refetch) {
+    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _triggerUpdate, triggerUpdate_fn).call(this);
+    return _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _resolveVersion, resolveVersion_fn).call(this, snapId, versionRange, true);
+  }
+  if (!versions) {
+    return versionRange;
+  }
+  const targetVersion = _snapsutils.getTargetVersion.call(void 0, 
+    Object.keys(versions),
+    versionRange
+  );
+  if (!targetVersion && _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _refetchOnAllowlistMiss) && !refetch) {
+    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _triggerUpdate, triggerUpdate_fn).call(this);
+    return _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _resolveVersion, resolveVersion_fn).call(this, snapId, versionRange, true);
+  }
+  if (!targetVersion) {
+    return versionRange;
+  }
+  _utils.assertIsSemVerRange.call(void 0, targetVersion);
+  return targetVersion;
+};
+_getMetadata = new WeakSet();
+getMetadata_fn = async function(snapId) {
+  const database = await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _getDatabase, getDatabase_fn).call(this);
+  return _nullishCoalesce(_optionalChain([database, 'optionalAccess', _11 => _11.verifiedSnaps, 'access', _12 => _12[snapId], 'optionalAccess', _13 => _13.metadata]), () => ( null));
+};
+_verifySignature = new WeakSet();
+verifySignature_fn = function(database, signature) {
+  _utils.assert.call(void 0, _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _publicKey), "No public key provided.");
+  const valid = _snapsregistry.verify.call(void 0, {
+    registry: database,
+    signature: JSON.parse(signature),
+    publicKey: _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _publicKey)
+  });
+  _utils.assert.call(void 0, valid, "Invalid registry signature.");
+};
+_safeFetch = new WeakSet();
+safeFetch_fn = async function(url) {
+  const response = await _chunkEXN2TFDJjs.__privateGet.call(void 0, this, _fetchFunction).call(this, url);
+  if (!response.ok) {
+    throw new Error(`Failed to fetch ${url}.`);
+  }
+  return await response.text();
+};
+
+
+
+exports.JsonSnapsRegistry = JsonSnapsRegistry;
+//# sourceMappingURL=chunk-LFWLV3SS.js.map

package/dist/chunk-LFWLV3SS.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/snaps/registry/json.ts"],"names":[],"mappings":";;;;;;;;AACA,SAAS,sBAAsB;AAE/B,SAAS,cAAc;AACvB,SAAS,wBAAwB;AAEjC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAYP,IAAM,oBACJ;AAEF,IAAM,8BACJ;AA2DF,IAAM,iBAAiB;AAEvB,IAAM,eAAe;AAAA,EACnB,UAAU;AAAA,EACV,aAAa;AACf;AA5FA;AA8FO,IAAM,oBAAN,cAAgC,eAIrC;AAAA,EAeA,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA,MAAM;AAAA,MACJ,UAAU;AAAA,MACV,WAAW;AAAA,IACb;AAAA,IACA;AAAA,IACA,gBAAgB,WAAW,MAAM,KAAK,UAAU;AAAA,IAChD,uBAAuB,eAAe,GAAG,SAAS,MAAM;AAAA,IACxD,4BAA4B;AAAA,IAC5B,yBAAyB;AAAA,EAC3B,GAA0B;AACxB,UAAM;AAAA,MACJ;AAAA,MACA,UAAU;AAAA,QACR,UAAU,EAAE,SAAS,MAAM,WAAW,MAAM;AAAA,QAC5C,aAAa,EAAE,SAAS,MAAM,WAAW,MAAM;AAAA,MACjD;AAAA,MACA,MAAM;AAAA,MACN,OAAO;AAAA,QACL,GAAG;AAAA,QACH,GAAG;AAAA,MACL;AAAA,IACF,CAAC;AA8BH;AAYA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAmBN;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAuBN,uBAAM;AAYN,uBAAM;AAsCN,uBAAM;AAqBN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AA6CN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAaN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAmBA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AA9QN;AAEA;AAEA;AAEA;AAEA;AAEA;AAEA;AA2BE,uBAAK,MAAO;AACZ,uBAAK,YAAa;AAClB,uBAAK,gBAAiB;AACtB,uBAAK,uBAAwB;AAC7B,uBAAK,yBAA0B;AAC/B,uBAAK,4BAA6B;AAClC,uBAAK,gBAAiB;AAEtB,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,UAAU,SAAS,sBAAK,cAAL,WAAU,GAAG;AAAA,IAClC;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,UAAU,SAAS,sBAAK,8BAAL,WAAkB,GAAG;AAAA,IAC1C;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,UAAU,SAAS,sBAAK,oCAAL,WAAqB,GAAG;AAAA,IAC7C;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,YAAY,sBAAK,kCAAL;AAAA,IACd;AAAA,EACF;AAoNF;AAtRE;AAEA;AAEA;AAEA;AAEA;AAEA;AAEA;AAwDA;AAAA,wBAAmB,WAAG;AACpB,SACE,KAAK,MAAM,eACX,KAAK,IAAI,IAAI,KAAK,MAAM,cAAc,mBAAK;AAE/C;AAOM;AAAA,mBAAc,iBAAG;AAErB,MAAI,mBAAK,iBAAgB;AACvB,UAAM,mBAAK;AACX;AAAA,EACF;AAEA,MAAI,mBAAK,oBAAmB,MAAM;AAChC,uBAAK,gBAAiB,sBAAK,oBAAL;AAAA,EACxB;AACA,QAAM,mBAAK;AACX,qBAAK,gBAAiB;AACxB;AAOM;AAAA,YAAO,iBAAG;AAEd,MAAI,sBAAK,4CAAL,YAA4B;AAC9B;AAAA,EACF;AAEA,MAAI;AACF,UAAM,WAAW,MAAM,sBAAK,0BAAL,WAAgB,mBAAK,MAAK;AAEjD,QAAI,mBAAK,aAAY;AACnB,YAAM,YAAY,MAAM,sBAAK,0BAAL,WAAgB,mBAAK,MAAK;AAClD,4BAAK,sCAAL,WAAsB,UAAU;AAAA,IAClC;AAEA,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,WAAW,KAAK,MAAM,QAAQ;AACpC,YAAM,cAAc,KAAK,IAAI;AAAA,IAC/B,CAAC;AAAA,EACH,QAAQ;AAAA,EAER;AACF;AAEM;AAAA,iBAAY,iBAA0C;AAC1D,MAAI,KAAK,MAAM,aAAa,MAAM;AAChC,UAAM,sBAAK,kCAAL;AAAA,EACR;AAGA,MAAI,mBAAK,+BAA8B,KAAK,MAAM,aAAa,MAAM;AACnE,UAAM,IAAI,MAAM,sDAAsD;AAAA,EACxE;AACA,SAAO,KAAK,MAAM;AACpB;AAEM;AAAA,eAAU,eACd,QACA,UACA,UAAU,OACoB;AAC9B,QAAM,WAAW,MAAM,sBAAK,8BAAL;AAEvB,QAAM,eAAe,UAAU,aAAa,KAAK,CAAC,YAAY;AAC5D,QAAI,QAAQ,SAAS;AACnB,aACE,QAAQ,OAAO,UACf,sBAAsB,SAAS,SAAS,QAAQ,YAAY;AAAA,IAEhE;AAEA,WAAO,QAAQ,aAAa,SAAS;AAAA,EACvC,CAAC;AAED,MAAI,cAAc;AAChB,WAAO;AAAA,MACL;AAAA,MACA,QAAQ,aAAa;AAAA,IACvB;AAAA,EACF;AAEA,QAAM,WAAW,UAAU,cAAc,MAAM;AAC/C,QAAM,UAAU,UAAU,WAAW,SAAS,OAAO;AACrD,MAAI,WAAW,QAAQ,aAAa,SAAS,UAAU;AACrD,WAAO,EAAE,yBAAqC;AAAA,EAChD;AAEA,MAAI,mBAAK,4BAA2B,CAAC,SAAS;AAC5C,UAAM,sBAAK,kCAAL;AACN,WAAO,sBAAK,0BAAL,WAAgB,QAAQ,UAAU;AAAA,EAC3C;AACA,SAAO,EAAE,2BAAuC;AAClD;AAEM;AAAA,SAAI,eACR,OAC8C;AAC9C,SAAO,OAAO,QAAQ,KAAK,EAAE,OAE3B,OAAO,iBAAiB,CAAC,QAAQ,QAAQ,MAAM;AAC/C,UAAM,SAAS,MAAM,sBAAK,0BAAL,WAAgB,QAAQ;AAC7C,UAAM,MAAM,MAAM;AAClB,QAAI,MAAM,IAAI;AACd,WAAO;AAAA,EACT,GAAG,QAAQ,QAAQ,CAAC,CAAC,CAAC;AACxB;AAUM;AAAA,oBAAe,eACnB,QACA,cACA,UAAU,OACY;AACtB,QAAM,WAAW,MAAM,sBAAK,8BAAL;AACvB,QAAM,WAAW,UAAU,cAAc,MAAM,GAAG,YAAY;AAE9D,MAAI,CAAC,YAAY,mBAAK,4BAA2B,CAAC,SAAS;AACzD,UAAM,sBAAK,kCAAL;AACN,WAAO,sBAAK,oCAAL,WAAqB,QAAQ,cAAc;AAAA,EACpD;AAGA,MAAI,CAAC,UAAU;AACb,WAAO;AAAA,EACT;AAEA,QAAM,gBAAgB;AAAA,IACpB,OAAO,KAAK,QAAQ;AAAA,IACpB;AAAA,EACF;AAEA,MAAI,CAAC,iBAAiB,mBAAK,4BAA2B,CAAC,SAAS;AAC9D,UAAM,sBAAK,kCAAL;AACN,WAAO,sBAAK,oCAAL,WAAqB,QAAQ,cAAc;AAAA,EACpD;AAGA,MAAI,CAAC,eAAe;AAClB,WAAO;AAAA,EACT;AAGA,sBAAoB,aAAa;AACjC,SAAO;AACT;AASM;AAAA,iBAAY,eAAC,QAAuD;AACxE,QAAM,WAAW,MAAM,sBAAK,8BAAL;AACvB,SAAO,UAAU,cAAc,MAAM,GAAG,YAAY;AACtD;AAUA;AAAA,qBAAgB,SAAC,UAAkB,WAAmB;AACpD,SAAO,mBAAK,aAAY,yBAAyB;AAEjD,QAAM,QAAQ,OAAO;AAAA,IACnB,UAAU;AAAA,IACV,WAAW,KAAK,MAAM,SAAS;AAAA,IAC/B,WAAW,mBAAK;AAAA,EAClB,CAAC;AAED,SAAO,OAAO,6BAA6B;AAC7C;AASM;AAAA,eAAU,eAAC,KAAa;AAC5B,QAAM,WAAW,MAAM,mBAAK,gBAAL,WAAoB;AAC3C,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,IAAI,MAAM,mBAAmB,GAAG,GAAG;AAAA,EAC3C;AAEA,SAAO,MAAM,SAAS,KAAK;AAC7B","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { SnapsRegistryDatabase } from '@metamask/snaps-registry';\nimport { verify } from '@metamask/snaps-registry';\nimport { getTargetVersion } from '@metamask/snaps-utils';\nimport type { Hex, SemVerRange, SemVerVersion } from '@metamask/utils';\nimport {\n  assert,\n  assertIsSemVerRange,\n  Duration,\n  inMilliseconds,\n  satisfiesVersionRange,\n} from '@metamask/utils';\n\nimport type {\n  SnapsRegistry,\n  SnapsRegistryInfo,\n  SnapsRegistryMetadata,\n  SnapsRegistryRequest,\n  SnapsRegistryResult,\n} from './registry';\nimport { SnapsRegistryStatus } from './registry';\n\n// TODO: Replace with a Codefi URL\nconst SNAP_REGISTRY_URL =\n  'https://cdn.jsdelivr.net/gh/MetaMask/snaps-registry@gh-pages/latest/registry.json';\n\nconst SNAP_REGISTRY_SIGNATURE_URL =\n  'https://cdn.jsdelivr.net/gh/MetaMask/snaps-registry@gh-pages/latest/signature.json';\n\ntype JsonSnapsRegistryUrl = {\n  registry: string;\n  signature: string;\n};\n\nexport type JsonSnapsRegistryArgs = {\n  messenger: SnapsRegistryMessenger;\n  state?: SnapsRegistryState;\n  fetchFunction?: typeof fetch;\n  url?: JsonSnapsRegistryUrl;\n  recentFetchThreshold?: number;\n  refetchOnAllowlistMiss?: boolean;\n  failOnUnavailableRegistry?: boolean;\n  publicKey?: Hex;\n};\n\nexport type GetResult = {\n  type: `${typeof controllerName}:get`;\n  handler: SnapsRegistry['get'];\n};\n\nexport type ResolveVersion = {\n  type: `${typeof controllerName}:resolveVersion`;\n  handler: SnapsRegistry['resolveVersion'];\n};\n\nexport type GetMetadata = {\n  type: `${typeof controllerName}:getMetadata`;\n  handler: SnapsRegistry['getMetadata'];\n};\n\nexport type Update = {\n  type: `${typeof controllerName}:update`;\n  handler: SnapsRegistry['update'];\n};\n\nexport type SnapsRegistryActions =\n  | GetResult\n  | GetMetadata\n  | Update\n  | ResolveVersion;\n\nexport type SnapsRegistryEvents = never;\n\nexport type SnapsRegistryMessenger = RestrictedControllerMessenger<\n  'SnapsRegistry',\n  SnapsRegistryActions,\n  SnapsRegistryEvents,\n  SnapsRegistryActions['type'],\n  SnapsRegistryEvents['type']\n>;\n\nexport type SnapsRegistryState = {\n  database: SnapsRegistryDatabase | null;\n  lastUpdated: number | null;\n};\n\nconst controllerName = 'SnapsRegistry';\n\nconst defaultState = {\n  database: null,\n  lastUpdated: null,\n};\n\nexport class JsonSnapsRegistry extends BaseController<\n  typeof controllerName,\n  SnapsRegistryState,\n  SnapsRegistryMessenger\n> {\n  #url: JsonSnapsRegistryUrl;\n\n  #publicKey?: Hex;\n\n  #fetchFunction: typeof fetch;\n\n  #recentFetchThreshold: number;\n\n  #refetchOnAllowlistMiss: boolean;\n\n  #failOnUnavailableRegistry: boolean;\n\n  #currentUpdate: Promise<void> | null;\n\n  constructor({\n    messenger,\n    state,\n    url = {\n      registry: SNAP_REGISTRY_URL,\n      signature: SNAP_REGISTRY_SIGNATURE_URL,\n    },\n    publicKey,\n    fetchFunction = globalThis.fetch.bind(globalThis),\n    recentFetchThreshold = inMilliseconds(5, Duration.Minute),\n    failOnUnavailableRegistry = true,\n    refetchOnAllowlistMiss = true,\n  }: JsonSnapsRegistryArgs) {\n    super({\n      messenger,\n      metadata: {\n        database: { persist: true, anonymous: false },\n        lastUpdated: { persist: true, anonymous: false },\n      },\n      name: controllerName,\n      state: {\n        ...defaultState,\n        ...state,\n      },\n    });\n    this.#url = url;\n    this.#publicKey = publicKey;\n    this.#fetchFunction = fetchFunction;\n    this.#recentFetchThreshold = recentFetchThreshold;\n    this.#refetchOnAllowlistMiss = refetchOnAllowlistMiss;\n    this.#failOnUnavailableRegistry = failOnUnavailableRegistry;\n    this.#currentUpdate = null;\n\n    this.messagingSystem.registerActionHandler(\n      'SnapsRegistry:get',\n      async (...args) => this.#get(...args),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SnapsRegistry:getMetadata',\n      async (...args) => this.#getMetadata(...args),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SnapsRegistry:resolveVersion',\n      async (...args) => this.#resolveVersion(...args),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'SnapsRegistry:update',\n      async () => this.#triggerUpdate(),\n    );\n  }\n\n  #wasRecentlyFetched() {\n    return (\n      this.state.lastUpdated &&\n      Date.now() - this.state.lastUpdated < this.#recentFetchThreshold\n    );\n  }\n\n  /**\n   * Triggers an update of the registry database.\n   *\n   * If an existing update is in progress this function will await that update.\n   */\n  async #triggerUpdate() {\n    // If an update is ongoing, wait for that.\n    if (this.#currentUpdate) {\n      await this.#currentUpdate;\n      return;\n    }\n    // If no update exists, create promise and store globally.\n    if (this.#currentUpdate === null) {\n      this.#currentUpdate = this.#update();\n    }\n    await this.#currentUpdate;\n    this.#currentUpdate = null;\n  }\n\n  /**\n   * Updates the registry database if the registry hasn't been updated recently.\n   *\n   * NOTE: SHOULD NOT be called directly, instead `triggerUpdate` should be used.\n   */\n  async #update() {\n    // No-op if we recently fetched the registry.\n    if (this.#wasRecentlyFetched()) {\n      return;\n    }\n\n    try {\n      const database = await this.#safeFetch(this.#url.registry);\n\n      if (this.#publicKey) {\n        const signature = await this.#safeFetch(this.#url.signature);\n        this.#verifySignature(database, signature);\n      }\n\n      this.update((state) => {\n        state.database = JSON.parse(database);\n        state.lastUpdated = Date.now();\n      });\n    } catch {\n      // Ignore\n    }\n  }\n\n  async #getDatabase(): Promise<SnapsRegistryDatabase | null> {\n    if (this.state.database === null) {\n      await this.#triggerUpdate();\n    }\n\n    // If the database is still null and we require it, throw.\n    if (this.#failOnUnavailableRegistry && this.state.database === null) {\n      throw new Error('Snaps registry is unavailable, installation blocked.');\n    }\n    return this.state.database;\n  }\n\n  async #getSingle(\n    snapId: string,\n    snapInfo: SnapsRegistryInfo,\n    refetch = false,\n  ): Promise<SnapsRegistryResult> {\n    const database = await this.#getDatabase();\n\n    const blockedEntry = database?.blockedSnaps.find((blocked) => {\n      if ('id' in blocked) {\n        return (\n          blocked.id === snapId &&\n          satisfiesVersionRange(snapInfo.version, blocked.versionRange)\n        );\n      }\n\n      return blocked.checksum === snapInfo.checksum;\n    });\n\n    if (blockedEntry) {\n      return {\n        status: SnapsRegistryStatus.Blocked,\n        reason: blockedEntry.reason,\n      };\n    }\n\n    const verified = database?.verifiedSnaps[snapId];\n    const version = verified?.versions?.[snapInfo.version];\n    if (version && version.checksum === snapInfo.checksum) {\n      return { status: SnapsRegistryStatus.Verified };\n    }\n    // For now, if we have an allowlist miss, we can refetch once and try again.\n    if (this.#refetchOnAllowlistMiss && !refetch) {\n      await this.#triggerUpdate();\n      return this.#getSingle(snapId, snapInfo, true);\n    }\n    return { status: SnapsRegistryStatus.Unverified };\n  }\n\n  async #get(\n    snaps: SnapsRegistryRequest,\n  ): Promise<Record<string, SnapsRegistryResult>> {\n    return Object.entries(snaps).reduce<\n      Promise<Record<string, SnapsRegistryResult>>\n    >(async (previousPromise, [snapId, snapInfo]) => {\n      const result = await this.#getSingle(snapId, snapInfo);\n      const acc = await previousPromise;\n      acc[snapId] = result;\n      return acc;\n    }, Promise.resolve({}));\n  }\n\n  /**\n   * Find an allowlisted version within a specified version range. Otherwise return the version range itself.\n   *\n   * @param snapId - The ID of the snap we are trying to resolve a version for.\n   * @param versionRange - The version range.\n   * @param refetch - An optional flag used to determine if we are refetching the registry.\n   * @returns An allowlisted version within the specified version range if available otherwise returns the input version range.\n   */\n  async #resolveVersion(\n    snapId: string,\n    versionRange: SemVerRange,\n    refetch = false,\n  ): Promise<SemVerRange> {\n    const database = await this.#getDatabase();\n    const versions = database?.verifiedSnaps[snapId]?.versions ?? null;\n\n    if (!versions && this.#refetchOnAllowlistMiss && !refetch) {\n      await this.#triggerUpdate();\n      return this.#resolveVersion(snapId, versionRange, true);\n    }\n\n    // If we cannot narrow down the version range we return the unaltered version range.\n    if (!versions) {\n      return versionRange;\n    }\n\n    const targetVersion = getTargetVersion(\n      Object.keys(versions) as SemVerVersion[],\n      versionRange,\n    );\n\n    if (!targetVersion && this.#refetchOnAllowlistMiss && !refetch) {\n      await this.#triggerUpdate();\n      return this.#resolveVersion(snapId, versionRange, true);\n    }\n\n    // If we cannot narrow down the version range we return the unaltered version range.\n    if (!targetVersion) {\n      return versionRange;\n    }\n\n    // A semver version is technically also a valid semver range.\n    assertIsSemVerRange(targetVersion);\n    return targetVersion;\n  }\n\n  /**\n   * Get metadata for the given snap ID.\n   *\n   * @param snapId - The ID of the snap to get metadata for.\n   * @returns The metadata for the given snap ID, or `null` if the snap is not\n   * verified.\n   */\n  async #getMetadata(snapId: string): Promise<SnapsRegistryMetadata | null> {\n    const database = await this.#getDatabase();\n    return database?.verifiedSnaps[snapId]?.metadata ?? null;\n  }\n\n  /**\n   * Verify the signature of the registry.\n   *\n   * @param database - The registry database.\n   * @param signature - The signature of the registry.\n   * @throws If the signature is invalid.\n   * @private\n   */\n  #verifySignature(database: string, signature: string) {\n    assert(this.#publicKey, 'No public key provided.');\n\n    const valid = verify({\n      registry: database,\n      signature: JSON.parse(signature),\n      publicKey: this.#publicKey,\n    });\n\n    assert(valid, 'Invalid registry signature.');\n  }\n\n  /**\n   * Fetch the given URL, throwing if the response is not OK.\n   *\n   * @param url - The URL to fetch.\n   * @returns The response body.\n   * @private\n   */\n  async #safeFetch(url: string) {\n    const response = await this.#fetchFunction(url);\n    if (!response.ok) {\n      throw new Error(`Failed to fetch ${url}.`);\n    }\n\n    return await response.text();\n  }\n}\n"]}

package/dist/chunk-MJOLPPQK.mjs

@@ -0,0 +1,105 @@
+import {
+  AbstractExecutionService
+} from "./chunk-4ICLRPDE.mjs";
+import {
+  ProxyPostMessageStream
+} from "./chunk-OPH3RY2U.mjs";
+import {
+  __privateAdd,
+  __privateGet,
+  __privateSet
+} from "./chunk-YRZVIDCF.mjs";
+
+// src/services/webworker/WebWorkerExecutionService.ts
+import { WindowPostMessageStream } from "@metamask/post-message-stream";
+import { createWindow } from "@metamask/snaps-utils";
+import { assert } from "@metamask/utils";
+import { nanoid } from "nanoid";
+var WORKER_POOL_ID = "snaps-worker-pool";
+var _documentUrl, _runtimeStream;
+var WebWorkerExecutionService = class extends AbstractExecutionService {
+  /**
+   * Create a new webworker execution service.
+   *
+   * @param args - The constructor arguments.
+   * @param args.documentUrl - The URL of the worker pool document to use as the
+   * execution environment.
+   * @param args.messenger - The messenger to use for communication with the
+   * `SnapController`.
+   * @param args.setupSnapProvider - The function to use to set up the snap
+   * provider.
+   */
+  constructor({
+    documentUrl,
+    messenger,
+    setupSnapProvider
+  }) {
+    super({
+      messenger,
+      setupSnapProvider
+    });
+    __privateAdd(this, _documentUrl, void 0);
+    __privateAdd(this, _runtimeStream, void 0);
+    __privateSet(this, _documentUrl, documentUrl);
+  }
+  /**
+   * Send a termination command to the worker pool document.
+   *
+   * @param job - The job to terminate.
+   */
+  async terminateJob(job) {
+    assert(__privateGet(this, _runtimeStream), "Runtime stream not initialized.");
+    __privateGet(this, _runtimeStream).write({
+      jobId: job.id,
+      data: {
+        jsonrpc: "2.0",
+        method: "terminateJob",
+        id: nanoid()
+      }
+    });
+  }
+  /**
+   * Create a new stream for the specified job. This wraps the runtime stream
+   * in a stream specific to the job.
+   *
+   * @param jobId - The job ID.
+   */
+  async initEnvStream(jobId) {
+    await this.createDocument();
+    assert(__privateGet(this, _runtimeStream), "Runtime stream not initialized.");
+    const stream = new ProxyPostMessageStream({
+      stream: __privateGet(this, _runtimeStream),
+      jobId
+    });
+    return { worker: jobId, stream };
+  }
+  /**
+   * Creates the worker pool document to be used as the execution environment.
+   *
+   * If the document already exists, this does nothing.
+   */
+  async createDocument() {
+    if (document.getElementById(WORKER_POOL_ID)) {
+      return;
+    }
+    const window = await createWindow(
+      __privateGet(this, _documentUrl).href,
+      WORKER_POOL_ID,
+      false
+    );
+    __privateSet(this, _runtimeStream, new WindowPostMessageStream({
+      name: "parent",
+      target: "child",
+      targetWindow: window,
+      targetOrigin: "*"
+    }));
+  }
+};
+_documentUrl = new WeakMap();
+_runtimeStream = new WeakMap();
+
+export {
+  WORKER_POOL_ID,
+  WebWorkerExecutionService
+};
+//# sourceMappingURL=chunk-MJOLPPQK.mjs.map

package/dist/chunk-MJOLPPQK.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/services/webworker/WebWorkerExecutionService.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\nimport { createWindow } from '@metamask/snaps-utils';\nimport { assert } from '@metamask/utils';\nimport { nanoid } from 'nanoid';\n\nimport type { ExecutionServiceArgs, Job } from '../AbstractExecutionService';\nimport { AbstractExecutionService } from '../AbstractExecutionService';\nimport { ProxyPostMessageStream } from '../ProxyPostMessageStream';\n\ntype WebWorkerExecutionEnvironmentServiceArgs = {\n  documentUrl: URL;\n} & ExecutionServiceArgs;\n\nexport const WORKER_POOL_ID = 'snaps-worker-pool';\n\nexport class WebWorkerExecutionService extends AbstractExecutionService<string> {\n  #documentUrl: URL;\n\n  #runtimeStream?: BasePostMessageStream;\n\n  /**\n   * Create a new webworker execution service.\n   *\n   * @param args - The constructor arguments.\n   * @param args.documentUrl - The URL of the worker pool document to use as the\n   * execution environment.\n   * @param args.messenger - The messenger to use for communication with the\n   * `SnapController`.\n   * @param args.setupSnapProvider - The function to use to set up the snap\n   * provider.\n   */\n  constructor({\n    documentUrl,\n    messenger,\n    setupSnapProvider,\n  }: WebWorkerExecutionEnvironmentServiceArgs) {\n    super({\n      messenger,\n      setupSnapProvider,\n    });\n\n    this.#documentUrl = documentUrl;\n  }\n\n  /**\n   * Send a termination command to the worker pool document.\n   *\n   * @param job - The job to terminate.\n   */\n  protected async terminateJob(job: Job<string>) {\n    // The `AbstractExecutionService` will have already closed the job stream,\n    // so we write to the runtime stream directly.\n    assert(this.#runtimeStream, 'Runtime stream not initialized.');\n    this.#runtimeStream.write({\n      jobId: job.id,\n      data: {\n        jsonrpc: '2.0',\n        method: 'terminateJob',\n        id: nanoid(),\n      },\n    });\n  }\n\n  /**\n   * Create a new stream for the specified job. This wraps the runtime stream\n   * in a stream specific to the job.\n   *\n   * @param jobId - The job ID.\n   */\n  protected async initEnvStream(jobId: string) {\n    // Lazily create the worker pool document.\n    await this.createDocument();\n\n    // `createDocument` should have initialized the runtime stream.\n    assert(this.#runtimeStream, 'Runtime stream not initialized.');\n\n    const stream = new ProxyPostMessageStream({\n      stream: this.#runtimeStream,\n      jobId,\n    });\n\n    return { worker: jobId, stream };\n  }\n\n  /**\n   * Creates the worker pool document to be used as the execution environment.\n   *\n   * If the document already exists, this does nothing.\n   */\n  private async createDocument() {\n    // We only want to create a single pool.\n    if (document.getElementById(WORKER_POOL_ID)) {\n      return;\n    }\n\n    const window = await createWindow(\n      this.#documentUrl.href,\n      WORKER_POOL_ID,\n      false,\n    );\n\n    this.#runtimeStream = new WindowPostMessageStream({\n      name: 'parent',\n      target: 'child',\n      targetWindow: window,\n      targetOrigin: '*',\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AACA,SAAS,+BAA+B;AACxC,SAAS,oBAAoB;AAC7B,SAAS,cAAc;AACvB,SAAS,cAAc;AAUhB,IAAM,iBAAiB;AAd9B;AAgBO,IAAM,4BAAN,cAAwC,yBAAiC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgB9E,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAA6C;AAC3C,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,IACF,CAAC;AAvBH;AAEA;AAuBE,uBAAK,cAAe;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAgB,aAAa,KAAkB;AAG7C,WAAO,mBAAK,iBAAgB,iCAAiC;AAC7D,uBAAK,gBAAe,MAAM;AAAA,MACxB,OAAO,IAAI;AAAA,MACX,MAAM;AAAA,QACJ,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,IAAI,OAAO;AAAA,MACb;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,cAAc,OAAe;AAE3C,UAAM,KAAK,eAAe;AAG1B,WAAO,mBAAK,iBAAgB,iCAAiC;AAE7D,UAAM,SAAS,IAAI,uBAAuB;AAAA,MACxC,QAAQ,mBAAK;AAAA,MACb;AAAA,IACF,CAAC;AAED,WAAO,EAAE,QAAQ,OAAO,OAAO;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,iBAAiB;AAE7B,QAAI,SAAS,eAAe,cAAc,GAAG;AAC3C;AAAA,IACF;AAEA,UAAM,SAAS,MAAM;AAAA,MACnB,mBAAK,cAAa;AAAA,MAClB;AAAA,MACA;AAAA,IACF;AAEA,uBAAK,gBAAiB,IAAI,wBAAwB;AAAA,MAChD,MAAM;AAAA,MACN,QAAQ;AAAA,MACR,cAAc;AAAA,MACd,cAAc;AAAA,IAChB,CAAC;AAAA,EACH;AACF;AA5FE;AAEA;","names":[]}

package/dist/chunk-N3MAPSR3.js

@@ -0,0 +1,197 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkOZPD234Wjs = require('./chunk-OZPD234W.js');
+
+
+
+var _chunkEXN2TFDJjs = require('./chunk-EXN2TFDJ.js');
+
+// src/interface/SnapInterfaceController.ts
+var _basecontroller = require('@metamask/base-controller');
+
+
+
+var _snapsutils = require('@metamask/snaps-utils');
+var _utils = require('@metamask/utils');
+var _nanoid = require('nanoid');
+var MAX_UI_CONTENT_SIZE = 25e4;
+var MAX_TEXT_LENGTH = 5e4;
+var controllerName = "SnapInterfaceController";
+var _registerMessageHandlers, registerMessageHandlers_fn, _validateArgs, validateArgs_fn, _triggerPhishingListUpdate, triggerPhishingListUpdate_fn, _checkPhishingList, checkPhishingList_fn, _validateContent, validateContent_fn;
+var SnapInterfaceController = class extends _basecontroller.BaseController {
+  constructor({ messenger, state }) {
+    super({
+      messenger,
+      metadata: {
+        interfaces: { persist: false, anonymous: false }
+      },
+      name: controllerName,
+      state: { interfaces: {}, ...state }
+    });
+    /**
+     * Constructor helper for registering this controller's messaging system
+     * actions.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _registerMessageHandlers);
+    /**
+     * Utility function to validate the args passed to the other methods.
+     *
+     * @param snapId - The snap id.
+     * @param id - The interface id.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _validateArgs);
+    /**
+     * Trigger a Phishing list update if needed.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _triggerPhishingListUpdate);
+    /**
+     * Check an origin against the phishing list.
+     *
+     * @param origin - The origin to check.
+     * @returns True if the origin is on the phishing list, otherwise false.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _checkPhishingList);
+    /**
+     * Utility function to validate the components of an interface.
+     * Throws if something is invalid.
+     *
+     * Right now this only checks links against the phighing list.
+     *
+     * @param content - The components to verify.
+     */
+    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _validateContent);
+    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _registerMessageHandlers, registerMessageHandlers_fn).call(this);
+  }
+  /**
+   * Create an interface in the controller state with the associated data.
+   *
+   * @param snapId - The snap id that created the interface.
+   * @param content - The interface content.
+   * @returns The newly interface id.
+   */
+  async createInterface(snapId, content) {
+    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateContent, validateContent_fn).call(this, content);
+    const id = _nanoid.nanoid.call(void 0, );
+    const componentState = _chunkOZPD234Wjs.constructState.call(void 0, {}, content);
+    this.update((draftState) => {
+      draftState.interfaces[id] = {
+        snapId,
+        content,
+        state: componentState
+      };
+    });
+    return id;
+  }
+  /**
+   * Get the data of a given interface id.
+   *
+   * @param snapId - The snap id requesting the interface data.
+   * @param id - The interface id.
+   * @returns The interface state.
+   */
+  getInterface(snapId, id) {
+    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateArgs, validateArgs_fn).call(this, snapId, id);
+    return this.state.interfaces[id];
+  }
+  /**
+   * Update the interface with the given content.
+   *
+   * @param snapId - The snap id requesting the update.
+   * @param id - The interface id.
+   * @param content - The new content.
+   */
+  async updateInterface(snapId, id, content) {
+    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateArgs, validateArgs_fn).call(this, snapId, id);
+    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateContent, validateContent_fn).call(this, content);
+    const oldState = this.state.interfaces[id].state;
+    const newState = _chunkOZPD234Wjs.constructState.call(void 0, oldState, content);
+    this.update((draftState) => {
+      draftState.interfaces[id].state = newState;
+      draftState.interfaces[id].content = content;
+    });
+  }
+  /**
+   * Delete an interface from state.
+   *
+   * @param id - The interface id.
+   */
+  deleteInterface(id) {
+    this.update((draftState) => {
+      delete draftState.interfaces[id];
+    });
+  }
+  /**
+   * Update the interface state.
+   *
+   * @param id - The interface id.
+   * @param state - The new state.
+   */
+  updateInterfaceState(id, state) {
+    this.update((draftState) => {
+      draftState.interfaces[id].state = state;
+    });
+  }
+};
+_registerMessageHandlers = new WeakSet();
+registerMessageHandlers_fn = function() {
+  this.messagingSystem.registerActionHandler(
+    `${controllerName}:createInterface`,
+    this.createInterface.bind(this)
+  );
+  this.messagingSystem.registerActionHandler(
+    `${controllerName}:getInterface`,
+    this.getInterface.bind(this)
+  );
+  this.messagingSystem.registerActionHandler(
+    `${controllerName}:updateInterface`,
+    this.updateInterface.bind(this)
+  );
+  this.messagingSystem.registerActionHandler(
+    `${controllerName}:deleteInterface`,
+    this.deleteInterface.bind(this)
+  );
+  this.messagingSystem.registerActionHandler(
+    `${controllerName}:updateInterfaceState`,
+    this.updateInterfaceState.bind(this)
+  );
+};
+_validateArgs = new WeakSet();
+validateArgs_fn = function(snapId, id) {
+  const existingInterface = this.state.interfaces[id];
+  _utils.assert.call(void 0, 
+    existingInterface !== void 0,
+    `Interface with id '${id}' not found.`
+  );
+  _utils.assert.call(void 0, 
+    existingInterface.snapId === snapId,
+    `Interface not created by ${snapId}.`
+  );
+};
+_triggerPhishingListUpdate = new WeakSet();
+triggerPhishingListUpdate_fn = async function() {
+  await this.messagingSystem.call("PhishingController:maybeUpdateState");
+};
+_checkPhishingList = new WeakSet();
+checkPhishingList_fn = function(origin) {
+  return this.messagingSystem.call("PhishingController:testOrigin", origin).result;
+};
+_validateContent = new WeakSet();
+validateContent_fn = async function(content) {
+  const size = _utils.getJsonSize.call(void 0, content);
+  _utils.assert.call(void 0, 
+    size <= MAX_UI_CONTENT_SIZE,
+    `A Snap UI may not be larger than ${MAX_UI_CONTENT_SIZE / 1e3} kB.`
+  );
+  const textSize = _snapsutils.getTotalTextLength.call(void 0, content);
+  _utils.assert.call(void 0, 
+    textSize <= MAX_TEXT_LENGTH,
+    `The text in a Snap UI may not be larger than ${MAX_TEXT_LENGTH / 1e3} kB.`
+  );
+  await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _triggerPhishingListUpdate, triggerPhishingListUpdate_fn).call(this);
+  _snapsutils.validateComponentLinks.call(void 0, content, _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _checkPhishingList, checkPhishingList_fn).bind(this));
+};
+
+
+
+exports.SnapInterfaceController = SnapInterfaceController;
+//# sourceMappingURL=chunk-N3MAPSR3.js.map

package/dist/chunk-N3MAPSR3.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/interface/SnapInterfaceController.ts"],"names":[],"mappings":";;;;;;;;;AACA,SAAS,sBAAsB;AAM/B;AAAA,EACE;AAAA,EACA;AAAA,OACK;AACP,SAAS,QAAQ,mBAAmB;AACpC,SAAS,cAAc;AAIvB,IAAM,sBAAsB;AAC5B,IAAM,kBAAkB;AAExB,IAAM,iBAAiB;AAnBvB;AAmFO,IAAM,0BAAN,cAAsC,eAI3C;AAAA,EACA,YAAY,EAAE,WAAW,MAAM,GAAgC;AAC7D,UAAM;AAAA,MACJ;AAAA,MACA,UAAU;AAAA,QACR,YAAY,EAAE,SAAS,OAAO,WAAW,MAAM;AAAA,MACjD;AAAA,MACA,MAAM;AAAA,MACN,OAAO,EAAE,YAAY,CAAC,GAAG,GAAG,MAAM;AAAA,IACpC,CAAC;AASH;AAAA;AAAA;AAAA;AAAA;AAmHA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA;AAAA;AAAA;AAAA,uBAAM;AAUN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAaA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAjKJ,0BAAK,sDAAL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwCA,MAAM,gBAAgB,QAAgB,SAAoB;AACxD,UAAM,sBAAK,sCAAL,WAAsB;AAE5B,UAAM,KAAK,OAAO;AAElB,UAAM,iBAAiB,eAAe,CAAC,GAAG,OAAO;AAEjD,SAAK,OAAO,CAAC,eAAe;AAC1B,iBAAW,WAAW,EAAE,IAAI;AAAA,QAC1B;AAAA,QACA;AAAA,QACA,OAAO;AAAA,MACT;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,aAAa,QAAgB,IAAY;AACvC,0BAAK,gCAAL,WAAmB,QAAQ;AAE3B,WAAO,KAAK,MAAM,WAAW,EAAE;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,gBAAgB,QAAgB,IAAY,SAAoB;AACpE,0BAAK,gCAAL,WAAmB,QAAQ;AAC3B,UAAM,sBAAK,sCAAL,WAAsB;AAE5B,UAAM,WAAW,KAAK,MAAM,WAAW,EAAE,EAAE;AAE3C,UAAM,WAAW,eAAe,UAAU,OAAO;AAEjD,SAAK,OAAO,CAAC,eAAe;AAC1B,iBAAW,WAAW,EAAE,EAAE,QAAQ;AAClC,iBAAW,WAAW,EAAE,EAAE,UAAU;AAAA,IACtC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,gBAAgB,IAAY;AAC1B,SAAK,OAAO,CAAC,eAAe;AAC1B,aAAO,WAAW,WAAW,EAAE;AAAA,IACjC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,qBAAqB,IAAY,OAAuB;AACtD,SAAK,OAAO,CAAC,eAAe;AAC1B,iBAAW,WAAW,EAAE,EAAE,QAAQ;AAAA,IACpC,CAAC;AAAA,EACH;AAoEF;AA/KE;AAAA,6BAAwB,WAAG;AACzB,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,gBAAgB,KAAK,IAAI;AAAA,EAChC;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,aAAa,KAAK,IAAI;AAAA,EAC7B;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,gBAAgB,KAAK,IAAI;AAAA,EAChC;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,gBAAgB,KAAK,IAAI;AAAA,EAChC;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,qBAAqB,KAAK,IAAI;AAAA,EACrC;AACF;AA0FA;AAAA,kBAAa,SAAC,QAAgB,IAAY;AACxC,QAAM,oBAAoB,KAAK,MAAM,WAAW,EAAE;AAElD;AAAA,IACE,sBAAsB;AAAA,IACtB,sBAAsB,EAAE;AAAA,EAC1B;AACA;AAAA,IACE,kBAAkB,WAAW;AAAA,IAC7B,4BAA4B,MAAM;AAAA,EACpC;AACF;AAKM;AAAA,+BAA0B,iBAAG;AACjC,QAAM,KAAK,gBAAgB,KAAK,qCAAqC;AACvE;AAQA;AAAA,uBAAkB,SAAC,QAAgB;AACjC,SAAO,KAAK,gBAAgB,KAAK,iCAAiC,MAAM,EACrE;AACL;AAUM;AAAA,qBAAgB,eAAC,SAAoB;AACzC,QAAM,OAAO,YAAY,OAAO;AAEhC;AAAA,IACE,QAAQ;AAAA,IACR,oCAAoC,sBAAsB,GAAI;AAAA,EAChE;AAEA,QAAM,WAAW,mBAAmB,OAAO;AAE3C;AAAA,IACE,YAAY;AAAA,IACZ,gDACE,kBAAkB,GACpB;AAAA,EACF;AAEA,QAAM,sBAAK,0DAAL;AAEN,yBAAuB,SAAS,sBAAK,0CAAmB,KAAK,IAAI,CAAC;AACpE","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  MaybeUpdateState,\n  TestOrigin,\n} from '@metamask/phishing-controller';\nimport type { Component, InterfaceState, SnapId } from '@metamask/snaps-sdk';\nimport {\n  getTotalTextLength,\n  validateComponentLinks,\n} from '@metamask/snaps-utils';\nimport { assert, getJsonSize } from '@metamask/utils';\nimport { nanoid } from 'nanoid';\n\nimport { constructState } from './utils';\n\nconst MAX_UI_CONTENT_SIZE = 250_000; // 250 kb\nconst MAX_TEXT_LENGTH = 50_000; // 50 kb\n\nconst controllerName = 'SnapInterfaceController';\n\nexport type CreateInterface = {\n  type: `${typeof controllerName}:createInterface`;\n  handler: SnapInterfaceController['createInterface'];\n};\n\nexport type GetInterface = {\n  type: `${typeof controllerName}:getInterface`;\n  handler: SnapInterfaceController['getInterface'];\n};\n\nexport type UpdateInterface = {\n  type: `${typeof controllerName}:updateInterface`;\n  handler: SnapInterfaceController['updateInterface'];\n};\n\nexport type DeleteInterface = {\n  type: `${typeof controllerName}:deleteInterface`;\n  handler: SnapInterfaceController['deleteInterface'];\n};\n\nexport type UpdateInterfaceState = {\n  type: `${typeof controllerName}:updateInterfaceState`;\n  handler: SnapInterfaceController['updateInterfaceState'];\n};\n\nexport type SnapInterfaceControllerAllowedActions =\n  | TestOrigin\n  | MaybeUpdateState;\n\nexport type SnapInterfaceControllerActions =\n  | CreateInterface\n  | GetInterface\n  | UpdateInterface\n  | DeleteInterface\n  | UpdateInterfaceState;\n\nexport type SnapInterfaceControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  SnapInterfaceControllerActions | SnapInterfaceControllerAllowedActions,\n  never,\n  SnapInterfaceControllerAllowedActions['type'],\n  never\n>;\n\nexport type StoredInterface = {\n  snapId: SnapId;\n  content: Component;\n  state: InterfaceState;\n};\n\nexport type SnapInterfaceControllerState = {\n  interfaces: Record<string, StoredInterface>;\n};\n\nexport type SnapInterfaceControllerArgs = {\n  messenger: SnapInterfaceControllerMessenger;\n  state?: SnapInterfaceControllerState;\n};\n\n/**\n * Use this controller to manage snaps UI interfaces using RPC method hooks.\n */\nexport class SnapInterfaceController extends BaseController<\n  typeof controllerName,\n  SnapInterfaceControllerState,\n  SnapInterfaceControllerMessenger\n> {\n  constructor({ messenger, state }: SnapInterfaceControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        interfaces: { persist: false, anonymous: false },\n      },\n      name: controllerName,\n      state: { interfaces: {}, ...state },\n    });\n\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers() {\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:createInterface`,\n      this.createInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:getInterface`,\n      this.getInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateInterface`,\n      this.updateInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:deleteInterface`,\n      this.deleteInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateInterfaceState`,\n      this.updateInterfaceState.bind(this),\n    );\n  }\n\n  /**\n   * Create an interface in the controller state with the associated data.\n   *\n   * @param snapId - The snap id that created the interface.\n   * @param content - The interface content.\n   * @returns The newly interface id.\n   */\n  async createInterface(snapId: SnapId, content: Component) {\n    await this.#validateContent(content);\n\n    const id = nanoid();\n\n    const componentState = constructState({}, content);\n\n    this.update((draftState) => {\n      draftState.interfaces[id] = {\n        snapId,\n        content,\n        state: componentState,\n      };\n    });\n\n    return id;\n  }\n\n  /**\n   * Get the data of a given interface id.\n   *\n   * @param snapId - The snap id requesting the interface data.\n   * @param id - The interface id.\n   * @returns The interface state.\n   */\n  getInterface(snapId: SnapId, id: string) {\n    this.#validateArgs(snapId, id);\n\n    return this.state.interfaces[id];\n  }\n\n  /**\n   * Update the interface with the given content.\n   *\n   * @param snapId - The snap id requesting the update.\n   * @param id - The interface id.\n   * @param content - The new content.\n   */\n  async updateInterface(snapId: SnapId, id: string, content: Component) {\n    this.#validateArgs(snapId, id);\n    await this.#validateContent(content);\n\n    const oldState = this.state.interfaces[id].state;\n\n    const newState = constructState(oldState, content);\n\n    this.update((draftState) => {\n      draftState.interfaces[id].state = newState;\n      draftState.interfaces[id].content = content;\n    });\n  }\n\n  /**\n   * Delete an interface from state.\n   *\n   * @param id - The interface id.\n   */\n  deleteInterface(id: string) {\n    this.update((draftState) => {\n      delete draftState.interfaces[id];\n    });\n  }\n\n  /**\n   * Update the interface state.\n   *\n   * @param id - The interface id.\n   * @param state - The new state.\n   */\n  updateInterfaceState(id: string, state: InterfaceState) {\n    this.update((draftState) => {\n      draftState.interfaces[id].state = state;\n    });\n  }\n\n  /**\n   * Utility function to validate the args passed to the other methods.\n   *\n   * @param snapId - The snap id.\n   * @param id - The interface id.\n   */\n  #validateArgs(snapId: SnapId, id: string) {\n    const existingInterface = this.state.interfaces[id];\n\n    assert(\n      existingInterface !== undefined,\n      `Interface with id '${id}' not found.`,\n    );\n    assert(\n      existingInterface.snapId === snapId,\n      `Interface not created by ${snapId}.`,\n    );\n  }\n\n  /**\n   * Trigger a Phishing list update if needed.\n   */\n  async #triggerPhishingListUpdate() {\n    await this.messagingSystem.call('PhishingController:maybeUpdateState');\n  }\n\n  /**\n   * Check an origin against the phishing list.\n   *\n   * @param origin - The origin to check.\n   * @returns True if the origin is on the phishing list, otherwise false.\n   */\n  #checkPhishingList(origin: string) {\n    return this.messagingSystem.call('PhishingController:testOrigin', origin)\n      .result;\n  }\n\n  /**\n   * Utility function to validate the components of an interface.\n   * Throws if something is invalid.\n   *\n   * Right now this only checks links against the phighing list.\n   *\n   * @param content - The components to verify.\n   */\n  async #validateContent(content: Component) {\n    const size = getJsonSize(content);\n\n    assert(\n      size <= MAX_UI_CONTENT_SIZE,\n      `A Snap UI may not be larger than ${MAX_UI_CONTENT_SIZE / 1000} kB.`,\n    );\n\n    const textSize = getTotalTextLength(content);\n\n    assert(\n      textSize <= MAX_TEXT_LENGTH,\n      `The text in a Snap UI may not be larger than ${\n        MAX_TEXT_LENGTH / 1000\n      } kB.`,\n    );\n\n    await this.#triggerPhishingListUpdate();\n\n    validateComponentLinks(content, this.#checkPhishingList.bind(this));\n  }\n}\n"]}