@metamask/snaps-controllers 4.0.0 → 4.1.0

package/dist/cjs/snaps/endowments/enum.js

@@ -11,6 +11,7 @@ Object.defineProperty(exports, "SnapEndowments", {
 var SnapEndowments;
 (function(SnapEndowments) {
     SnapEndowments["NetworkAccess"] = 'endowment:network-access';
+    SnapEndowments["SignatureInsight"] = 'endowment:signature-insight';
     SnapEndowments["TransactionInsight"] = 'endowment:transaction-insight';
     SnapEndowments["Cronjob"] = 'endowment:cronjob';
     SnapEndowments["EthereumProvider"] = 'endowment:ethereum-provider';

package/dist/cjs/snaps/endowments/enum.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/enum.ts"],"sourcesContent":["export enum SnapEndowments {\n  NetworkAccess = 'endowment:network-access',\n  TransactionInsight = 'endowment:transaction-insight',\n  Cronjob = 'endowment:cronjob',\n  EthereumProvider = 'endowment:ethereum-provider',\n  Rpc = 'endowment:rpc',\n  WebAssemblyAccess = 'endowment:webassembly',\n  NameLookup = 'endowment:name-lookup',\n  LifecycleHooks = 'endowment:lifecycle-hooks',\n  Keyring = 'endowment:keyring',\n  HomePage = 'endowment:page-home',\n}\n"],"names":["SnapEndowments","NetworkAccess","TransactionInsight","Cronjob","EthereumProvider","Rpc","WebAssemblyAccess","NameLookup","LifecycleHooks","Keyring","HomePage"],"mappings":";;;;;;;;;;IAAO;UAAKA,cAAc;IAAdA,eACVC,mBAAgB;IADND,eAEVE,wBAAqB;IAFXF,eAGVG,aAAU;IAHAH,eAIVI,sBAAmB;IAJTJ,eAKVK,SAAM;IALIL,eAMVM,uBAAoB;IANVN,eAOVO,gBAAa;IAPHP,eAQVQ,oBAAiB;IARPR,eASVS,aAAU;IATAT,eAUVU,cAAW;GAVDV,mBAAAA"}
+{"version":3,"sources":["../../../../src/snaps/endowments/enum.ts"],"sourcesContent":["export enum SnapEndowments {\n  NetworkAccess = 'endowment:network-access',\n  SignatureInsight = 'endowment:signature-insight',\n  TransactionInsight = 'endowment:transaction-insight',\n  Cronjob = 'endowment:cronjob',\n  EthereumProvider = 'endowment:ethereum-provider',\n  Rpc = 'endowment:rpc',\n  WebAssemblyAccess = 'endowment:webassembly',\n  NameLookup = 'endowment:name-lookup',\n  LifecycleHooks = 'endowment:lifecycle-hooks',\n  Keyring = 'endowment:keyring',\n  HomePage = 'endowment:page-home',\n}\n"],"names":["SnapEndowments","NetworkAccess","SignatureInsight","TransactionInsight","Cronjob","EthereumProvider","Rpc","WebAssemblyAccess","NameLookup","LifecycleHooks","Keyring","HomePage"],"mappings":";;;;;;;;;;IAAO;UAAKA,cAAc;IAAdA,eACVC,mBAAgB;IADND,eAEVE,sBAAmB;IAFTF,eAGVG,wBAAqB;IAHXH,eAIVI,aAAU;IAJAJ,eAKVK,sBAAmB;IALTL,eAMVM,SAAM;IANIN,eAOVO,uBAAoB;IAPVP,eAQVQ,gBAAa;IARHR,eASVS,oBAAiB;IATPT,eAUVU,aAAU;IAVAV,eAWVW,cAAW;GAXDX,mBAAAA"}

package/dist/cjs/snaps/endowments/index.js

@@ -24,6 +24,9 @@ _export(exports, {
     getRpcCaveatOrigins: function() {
         return _rpc.getRpcCaveatOrigins;
     },
+    getSignatureOriginCaveat: function() {
+        return _signatureinsight.getSignatureOriginCaveat;
+    },
     getTransactionOriginCaveat: function() {
         return _transactioninsight.getTransactionOriginCaveat;
     },
@@ -43,6 +46,7 @@ const _lifecyclehooks = require("./lifecycle-hooks");
 const _namelookup = require("./name-lookup");
 const _networkaccess = require("./network-access");
 const _rpc = require("./rpc");
+const _signatureinsight = require("./signature-insight");
 const _transactioninsight = require("./transaction-insight");
 const _webassembly = require("./web-assembly");
 _export_star(require("./enum"), exports);
@@ -69,21 +73,24 @@ const endowmentPermissionBuilders = {
     [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.nameLookupEndowmentBuilder,
     [_lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName]: _lifecyclehooks.lifecycleHooksEndowmentBuilder,
     [_keyring.keyringEndowmentBuilder.targetName]: _keyring.keyringEndowmentBuilder,
-    [_homepage.homePageEndowmentBuilder.targetName]: _homepage.homePageEndowmentBuilder
+    [_homepage.homePageEndowmentBuilder.targetName]: _homepage.homePageEndowmentBuilder,
+    [_signatureinsight.signatureInsightEndowmentBuilder.targetName]: _signatureinsight.signatureInsightEndowmentBuilder
 };
 const endowmentCaveatSpecifications = {
     ..._cronjob.cronjobCaveatSpecifications,
     ..._transactioninsight.transactionInsightCaveatSpecifications,
     ..._rpc.rpcCaveatSpecifications,
     ..._namelookup.nameLookupCaveatSpecifications,
-    ..._keyring.keyringCaveatSpecifications
+    ..._keyring.keyringCaveatSpecifications,
+    ..._signatureinsight.signatureInsightCaveatSpecifications
 };
 const endowmentCaveatMappers = {
     [_cronjob.cronjobEndowmentBuilder.targetName]: _cronjob.getCronjobCaveatMapper,
     [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: _transactioninsight.getTransactionInsightCaveatMapper,
     [_rpc.rpcEndowmentBuilder.targetName]: _rpc.getRpcCaveatMapper,
     [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.getNameLookupCaveatMapper,
-    [_keyring.keyringEndowmentBuilder.targetName]: _keyring.getKeyringCaveatMapper
+    [_keyring.keyringEndowmentBuilder.targetName]: _keyring.getKeyringCaveatMapper,
+    [_signatureinsight.signatureInsightEndowmentBuilder.targetName]: _signatureinsight.getSignatureInsightCaveatMapper
 };
 const handlerEndowments = {
     [_snapsutils.HandlerType.OnRpcRequest]: _rpc.rpcEndowmentBuilder.targetName,
@@ -93,7 +100,8 @@ const handlerEndowments = {
     [_snapsutils.HandlerType.OnInstall]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName,
     [_snapsutils.HandlerType.OnUpdate]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName,
     [_snapsutils.HandlerType.OnKeyringRequest]: _keyring.keyringEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnHomePage]: _homepage.homePageEndowmentBuilder.targetName
+    [_snapsutils.HandlerType.OnHomePage]: _homepage.homePageEndowmentBuilder.targetName,
+    [_snapsutils.HandlerType.OnSignature]: _signatureinsight.signatureInsightEndowmentBuilder.targetName
 };
 
 //# sourceMappingURL=index.js.map

package/dist/cjs/snaps/endowments/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/index.ts"],"sourcesContent":["import type { PermissionConstraint } from '@metamask/permission-controller';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\nimport {\n  cronjobCaveatSpecifications,\n  cronjobEndowmentBuilder,\n  getCronjobCaveatMapper,\n} from './cronjob';\nimport { ethereumProviderEndowmentBuilder } from './ethereum-provider';\nimport { homePageEndowmentBuilder } from './home-page';\nimport {\n  getKeyringCaveatMapper,\n  keyringCaveatSpecifications,\n  keyringEndowmentBuilder,\n} from './keyring';\nimport { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';\nimport {\n  getNameLookupCaveatMapper,\n  nameLookupCaveatSpecifications,\n  nameLookupEndowmentBuilder,\n} from './name-lookup';\nimport { networkAccessEndowmentBuilder } from './network-access';\nimport {\n  getRpcCaveatMapper,\n  rpcCaveatSpecifications,\n  rpcEndowmentBuilder,\n} from './rpc';\nimport {\n  getTransactionInsightCaveatMapper,\n  transactionInsightCaveatSpecifications,\n  transactionInsightEndowmentBuilder,\n} from './transaction-insight';\nimport { webAssemblyEndowmentBuilder } from './web-assembly';\n\nexport const endowmentPermissionBuilders = {\n  [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,\n  [transactionInsightEndowmentBuilder.targetName]:\n    transactionInsightEndowmentBuilder,\n  [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,\n  [ethereumProviderEndowmentBuilder.targetName]:\n    ethereumProviderEndowmentBuilder,\n  [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,\n  [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,\n  [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,\n  [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,\n  [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder,\n  [homePageEndowmentBuilder.targetName]: homePageEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n  ...cronjobCaveatSpecifications,\n  ...transactionInsightCaveatSpecifications,\n  ...rpcCaveatSpecifications,\n  ...nameLookupCaveatSpecifications,\n  ...keyringCaveatSpecifications,\n};\n\nexport const endowmentCaveatMappers: Record<\n  string,\n  (value: Json) => Pick<PermissionConstraint, 'caveats'>\n> = {\n  [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,\n  [transactionInsightEndowmentBuilder.targetName]:\n    getTransactionInsightCaveatMapper,\n  [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,\n  [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,\n  [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper,\n};\n\nexport const handlerEndowments: Record<HandlerType, string> = {\n  [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,\n  [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,\n  [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,\n  [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,\n  [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName,\n  [HandlerType.OnHomePage]: homePageEndowmentBuilder.targetName,\n};\n\nexport * from './enum';\nexport { getRpcCaveatOrigins } from './rpc';\nexport { getTransactionOriginCaveat } from './transaction-insight';\nexport { getChainIdsCaveat } from './name-lookup';\nexport { getKeyringCaveatOrigins } from './keyring';\n"],"names":["endowmentPermissionBuilders","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","getRpcCaveatOrigins","getTransactionOriginCaveat","getChainIdsCaveat","getKeyringCaveatOrigins","networkAccessEndowmentBuilder","targetName","transactionInsightEndowmentBuilder","cronjobEndowmentBuilder","ethereumProviderEndowmentBuilder","rpcEndowmentBuilder","webAssemblyEndowmentBuilder","nameLookupEndowmentBuilder","lifecycleHooksEndowmentBuilder","keyringEndowmentBuilder","homePageEndowmentBuilder","cronjobCaveatSpecifications","transactionInsightCaveatSpecifications","rpcCaveatSpecifications","nameLookupCaveatSpecifications","keyringCaveatSpecifications","getCronjobCaveatMapper","getTransactionInsightCaveatMapper","getRpcCaveatMapper","getNameLookupCaveatMapper","getKeyringCaveatMapper","HandlerType","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage"],"mappings":";;;;;;;;;;;IAmCaA,2BAA2B;eAA3BA;;IAeAC,6BAA6B;eAA7BA;;IAQAC,sBAAsB;eAAtBA;;IAYAC,iBAAiB;eAAjBA;;IAYJC,mBAAmB;eAAnBA,wBAAmB;;IACnBC,0BAA0B;eAA1BA,8CAA0B;;IAC1BC,iBAAiB;eAAjBA,6BAAiB;;IACjBC,uBAAuB;eAAvBA,gCAAuB;;;4BApFJ;yBAOrB;kCAC0C;0BACR;yBAKlC;gCACwC;4BAKxC;+BACuC;qBAKvC;oCAKA;6BACqC;qBAgD9B;;;;;;;;;;;;;;AA9CP,MAAMP,8BAA8B;IACzC,CAACQ,4CAA6B,CAACC,UAAU,CAAC,EAAED,4CAA6B;IACzE,CAACE,sDAAkC,CAACD,UAAU,CAAC,EAC7CC,sDAAkC;IACpC,CAACC,gCAAuB,CAACF,UAAU,CAAC,EAAEE,gCAAuB;IAC7D,CAACC,kDAAgC,CAACH,UAAU,CAAC,EAC3CG,kDAAgC;IAClC,CAACC,wBAAmB,CAACJ,UAAU,CAAC,EAAEI,wBAAmB;IACrD,CAACC,wCAA2B,CAACL,UAAU,CAAC,EAAEK,wCAA2B;IACrE,CAACC,sCAA0B,CAACN,UAAU,CAAC,EAAEM,sCAA0B;IACnE,CAACC,8CAA8B,CAACP,UAAU,CAAC,EAAEO,8CAA8B;IAC3E,CAACC,gCAAuB,CAACR,UAAU,CAAC,EAAEQ,gCAAuB;IAC7D,CAACC,kCAAwB,CAACT,UAAU,CAAC,EAAES,kCAAwB;AACjE;AAEO,MAAMjB,gCAAgC;IAC3C,GAAGkB,oCAA2B;IAC9B,GAAGC,0DAAsC;IACzC,GAAGC,4BAAuB;IAC1B,GAAGC,0CAA8B;IACjC,GAAGC,oCAA2B;AAChC;AAEO,MAAMrB,yBAGT;IACF,CAACS,gCAAuB,CAACF,UAAU,CAAC,EAAEe,+BAAsB;IAC5D,CAACd,sDAAkC,CAACD,UAAU,CAAC,EAC7CgB,qDAAiC;IACnC,CAACZ,wBAAmB,CAACJ,UAAU,CAAC,EAAEiB,uBAAkB;IACpD,CAACX,sCAA0B,CAACN,UAAU,CAAC,EAAEkB,qCAAyB;IAClE,CAACV,gCAAuB,CAACR,UAAU,CAAC,EAAEmB,+BAAsB;AAC9D;AAEO,MAAMzB,oBAAiD;IAC5D,CAAC0B,uBAAW,CAACC,YAAY,CAAC,EAAEjB,wBAAmB,CAACJ,UAAU;IAC1D,CAACoB,uBAAW,CAACE,aAAa,CAAC,EAAErB,sDAAkC,CAACD,UAAU;IAC1E,CAACoB,uBAAW,CAACG,SAAS,CAAC,EAAErB,gCAAuB,CAACF,UAAU;IAC3D,CAACoB,uBAAW,CAACI,YAAY,CAAC,EAAElB,sCAA0B,CAACN,UAAU;IACjE,CAACoB,uBAAW,CAACK,SAAS,CAAC,EAAElB,8CAA8B,CAACP,UAAU;IAClE,CAACoB,uBAAW,CAACM,QAAQ,CAAC,EAAEnB,8CAA8B,CAACP,UAAU;IACjE,CAACoB,uBAAW,CAACO,gBAAgB,CAAC,EAAEnB,gCAAuB,CAACR,UAAU;IAClE,CAACoB,uBAAW,CAACQ,UAAU,CAAC,EAAEnB,kCAAwB,CAACT,UAAU;AAC/D"}
+{"version":3,"sources":["../../../../src/snaps/endowments/index.ts"],"sourcesContent":["import type { PermissionConstraint } from '@metamask/permission-controller';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\nimport {\n  cronjobCaveatSpecifications,\n  cronjobEndowmentBuilder,\n  getCronjobCaveatMapper,\n} from './cronjob';\nimport { ethereumProviderEndowmentBuilder } from './ethereum-provider';\nimport { homePageEndowmentBuilder } from './home-page';\nimport {\n  getKeyringCaveatMapper,\n  keyringCaveatSpecifications,\n  keyringEndowmentBuilder,\n} from './keyring';\nimport { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';\nimport {\n  getNameLookupCaveatMapper,\n  nameLookupCaveatSpecifications,\n  nameLookupEndowmentBuilder,\n} from './name-lookup';\nimport { networkAccessEndowmentBuilder } from './network-access';\nimport {\n  getRpcCaveatMapper,\n  rpcCaveatSpecifications,\n  rpcEndowmentBuilder,\n} from './rpc';\nimport {\n  getSignatureInsightCaveatMapper,\n  signatureInsightCaveatSpecifications,\n  signatureInsightEndowmentBuilder,\n} from './signature-insight';\nimport {\n  getTransactionInsightCaveatMapper,\n  transactionInsightCaveatSpecifications,\n  transactionInsightEndowmentBuilder,\n} from './transaction-insight';\nimport { webAssemblyEndowmentBuilder } from './web-assembly';\n\nexport const endowmentPermissionBuilders = {\n  [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,\n  [transactionInsightEndowmentBuilder.targetName]:\n    transactionInsightEndowmentBuilder,\n  [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,\n  [ethereumProviderEndowmentBuilder.targetName]:\n    ethereumProviderEndowmentBuilder,\n  [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,\n  [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,\n  [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,\n  [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,\n  [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder,\n  [homePageEndowmentBuilder.targetName]: homePageEndowmentBuilder,\n  [signatureInsightEndowmentBuilder.targetName]:\n    signatureInsightEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n  ...cronjobCaveatSpecifications,\n  ...transactionInsightCaveatSpecifications,\n  ...rpcCaveatSpecifications,\n  ...nameLookupCaveatSpecifications,\n  ...keyringCaveatSpecifications,\n  ...signatureInsightCaveatSpecifications,\n};\n\nexport const endowmentCaveatMappers: Record<\n  string,\n  (value: Json) => Pick<PermissionConstraint, 'caveats'>\n> = {\n  [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,\n  [transactionInsightEndowmentBuilder.targetName]:\n    getTransactionInsightCaveatMapper,\n  [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,\n  [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,\n  [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper,\n  [signatureInsightEndowmentBuilder.targetName]:\n    getSignatureInsightCaveatMapper,\n};\n\nexport const handlerEndowments: Record<HandlerType, string> = {\n  [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,\n  [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,\n  [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,\n  [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,\n  [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName,\n  [HandlerType.OnHomePage]: homePageEndowmentBuilder.targetName,\n  [HandlerType.OnSignature]: signatureInsightEndowmentBuilder.targetName,\n};\n\nexport * from './enum';\nexport { getRpcCaveatOrigins } from './rpc';\nexport { getSignatureOriginCaveat } from './signature-insight';\nexport { getTransactionOriginCaveat } from './transaction-insight';\nexport { getChainIdsCaveat } from './name-lookup';\nexport { getKeyringCaveatOrigins } from './keyring';\n"],"names":["endowmentPermissionBuilders","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","getRpcCaveatOrigins","getSignatureOriginCaveat","getTransactionOriginCaveat","getChainIdsCaveat","getKeyringCaveatOrigins","networkAccessEndowmentBuilder","targetName","transactionInsightEndowmentBuilder","cronjobEndowmentBuilder","ethereumProviderEndowmentBuilder","rpcEndowmentBuilder","webAssemblyEndowmentBuilder","nameLookupEndowmentBuilder","lifecycleHooksEndowmentBuilder","keyringEndowmentBuilder","homePageEndowmentBuilder","signatureInsightEndowmentBuilder","cronjobCaveatSpecifications","transactionInsightCaveatSpecifications","rpcCaveatSpecifications","nameLookupCaveatSpecifications","keyringCaveatSpecifications","signatureInsightCaveatSpecifications","getCronjobCaveatMapper","getTransactionInsightCaveatMapper","getRpcCaveatMapper","getNameLookupCaveatMapper","getKeyringCaveatMapper","getSignatureInsightCaveatMapper","HandlerType","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","OnSignature"],"mappings":";;;;;;;;;;;IAwCaA,2BAA2B;eAA3BA;;IAiBAC,6BAA6B;eAA7BA;;IASAC,sBAAsB;eAAtBA;;IAcAC,iBAAiB;eAAjBA;;IAaJC,mBAAmB;eAAnBA,wBAAmB;;IACnBC,wBAAwB;eAAxBA,0CAAwB;;IACxBC,0BAA0B;eAA1BA,8CAA0B;;IAC1BC,iBAAiB;eAAjBA,6BAAiB;;IACjBC,uBAAuB;eAAvBA,gCAAuB;;;4BAhGJ;yBAOrB;kCAC0C;0BACR;yBAKlC;gCACwC;4BAKxC;+BACuC;qBAKvC;kCAKA;oCAKA;6BACqC;qBAsD9B;;;;;;;;;;;;;;AApDP,MAAMR,8BAA8B;IACzC,CAACS,4CAA6B,CAACC,UAAU,CAAC,EAAED,4CAA6B;IACzE,CAACE,sDAAkC,CAACD,UAAU,CAAC,EAC7CC,sDAAkC;IACpC,CAACC,gCAAuB,CAACF,UAAU,CAAC,EAAEE,gCAAuB;IAC7D,CAACC,kDAAgC,CAACH,UAAU,CAAC,EAC3CG,kDAAgC;IAClC,CAACC,wBAAmB,CAACJ,UAAU,CAAC,EAAEI,wBAAmB;IACrD,CAACC,wCAA2B,CAACL,UAAU,CAAC,EAAEK,wCAA2B;IACrE,CAACC,sCAA0B,CAACN,UAAU,CAAC,EAAEM,sCAA0B;IACnE,CAACC,8CAA8B,CAACP,UAAU,CAAC,EAAEO,8CAA8B;IAC3E,CAACC,gCAAuB,CAACR,UAAU,CAAC,EAAEQ,gCAAuB;IAC7D,CAACC,kCAAwB,CAACT,UAAU,CAAC,EAAES,kCAAwB;IAC/D,CAACC,kDAAgC,CAACV,UAAU,CAAC,EAC3CU,kDAAgC;AACpC;AAEO,MAAMnB,gCAAgC;IAC3C,GAAGoB,oCAA2B;IAC9B,GAAGC,0DAAsC;IACzC,GAAGC,4BAAuB;IAC1B,GAAGC,0CAA8B;IACjC,GAAGC,oCAA2B;IAC9B,GAAGC,sDAAoC;AACzC;AAEO,MAAMxB,yBAGT;IACF,CAACU,gCAAuB,CAACF,UAAU,CAAC,EAAEiB,+BAAsB;IAC5D,CAAChB,sDAAkC,CAACD,UAAU,CAAC,EAC7CkB,qDAAiC;IACnC,CAACd,wBAAmB,CAACJ,UAAU,CAAC,EAAEmB,uBAAkB;IACpD,CAACb,sCAA0B,CAACN,UAAU,CAAC,EAAEoB,qCAAyB;IAClE,CAACZ,gCAAuB,CAACR,UAAU,CAAC,EAAEqB,+BAAsB;IAC5D,CAACX,kDAAgC,CAACV,UAAU,CAAC,EAC3CsB,iDAA+B;AACnC;AAEO,MAAM7B,oBAAiD;IAC5D,CAAC8B,uBAAW,CAACC,YAAY,CAAC,EAAEpB,wBAAmB,CAACJ,UAAU;IAC1D,CAACuB,uBAAW,CAACE,aAAa,CAAC,EAAExB,sDAAkC,CAACD,UAAU;IAC1E,CAACuB,uBAAW,CAACG,SAAS,CAAC,EAAExB,gCAAuB,CAACF,UAAU;IAC3D,CAACuB,uBAAW,CAACI,YAAY,CAAC,EAAErB,sCAA0B,CAACN,UAAU;IACjE,CAACuB,uBAAW,CAACK,SAAS,CAAC,EAAErB,8CAA8B,CAACP,UAAU;IAClE,CAACuB,uBAAW,CAACM,QAAQ,CAAC,EAAEtB,8CAA8B,CAACP,UAAU;IACjE,CAACuB,uBAAW,CAACO,gBAAgB,CAAC,EAAEtB,gCAAuB,CAACR,UAAU;IAClE,CAACuB,uBAAW,CAACQ,UAAU,CAAC,EAAEtB,kCAAwB,CAACT,UAAU;IAC7D,CAACuB,uBAAW,CAACS,WAAW,CAAC,EAAEtB,kDAAgC,CAACV,UAAU;AACxE"}

package/dist/cjs/snaps/endowments/signature-insight.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    signatureInsightEndowmentBuilder: function() {
+        return signatureInsightEndowmentBuilder;
+    },
+    getSignatureInsightCaveatMapper: function() {
+        return getSignatureInsightCaveatMapper;
+    },
+    getSignatureOriginCaveat: function() {
+        return getSignatureOriginCaveat;
+    },
+    signatureInsightCaveatSpecifications: function() {
+        return signatureInsightCaveatSpecifications;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _rpcerrors = require("@metamask/rpc-errors");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _enum = require("./enum");
+const permissionName = _enum.SnapEndowments.SignatureInsight;
+/**
+ * `endowment:signature-insight` returns nothing; it is intended to be used as a flag
+ * by the extension to detect whether the snap has the capability to show information on the signature confirmation screen.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the signature-insight endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            _snapsutils.SnapCaveatType.SignatureOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== _snapsutils.SnapCaveatType.SignatureOrigin) {
+                throw _rpcerrors.rpcErrors.invalidParams({
+                    message: `Expected a single "${_snapsutils.SnapCaveatType.SignatureOrigin}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+const signatureInsightEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+/**
+ * Validates the type of the caveat value.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */ function validateCaveat(caveat) {
+    if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat)) {
+        throw _rpcerrors.rpcErrors.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    (0, _utils.assert)(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
+}
+function getSignatureInsightCaveatMapper(value) {
+    if (!value || !(0, _utils.isObject)(value) || (0, _utils.isObject)(value) && Object.keys(value).length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    return {
+        caveats: [
+            {
+                type: _snapsutils.SnapCaveatType.SignatureOrigin,
+                value: (0, _utils.hasProperty)(value, 'allowSignatureOrigin') && value.allowSignatureOrigin
+            }
+        ]
+    };
+}
+function getSignatureOriginCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    (0, _utils.assert)(permission.caveats.length === 1);
+    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.SignatureOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value ?? null;
+}
+const signatureInsightCaveatSpecifications = {
+    [_snapsutils.SnapCaveatType.SignatureOrigin]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.SignatureOrigin,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=signature-insight.js.map

package/dist/cjs/snaps/endowments/signature-insight.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/signature-insight.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionValidatorConstraint,\n  PermissionConstraint,\n  CaveatSpecificationConstraint,\n  Caveat,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isObject, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.SignatureInsight;\n\ntype SignatureInsightEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n}>;\n\n/**\n * `endowment:signature-insight` returns nothing; it is intended to be used as a flag\n * by the extension to detect whether the snap has the capability to show information on the signature confirmation screen.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the signature-insight endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  SignatureInsightEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.SignatureOrigin],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: ({ caveats }) => {\n      if (\n        (caveats !== null && caveats?.length > 1) ||\n        (caveats?.length === 1 &&\n          caveats[0].type !== SnapCaveatType.SignatureOrigin)\n      ) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.SignatureOrigin}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const signatureInsightEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validates the type of the caveat value.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveat(caveat: Caveat<string, any>): void {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  assert(\n    typeof value === 'boolean',\n    'Expected caveat value to have type \"boolean\"',\n  );\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getSignatureInsightCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  if (\n    !value ||\n    !isObject(value) ||\n    (isObject(value) && Object.keys(value).length === 0)\n  ) {\n    return { caveats: null };\n  }\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.SignatureOrigin,\n        value:\n          hasProperty(value, 'allowSignatureOrigin') &&\n          (value.allowSignatureOrigin as boolean),\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the signature origin caveat from a permission.\n *\n * This does basic validation of the caveat, but does not validate the type or\n * value of the namespaces object itself, as this is handled by the\n * `PermissionsController` when the permission is requested.\n *\n * @param permission - The permission to get the signature origin caveat from.\n * @returns The signature origin, or `null` if the permission does not have a\n * signature origin caveat.\n */\nexport function getSignatureOriginCaveat(\n  permission?: PermissionConstraint,\n): boolean | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.SignatureOrigin);\n\n  const caveat = permission.caveats[0] as Caveat<string, boolean>;\n\n  return caveat.value ?? null;\n}\n\nexport const signatureInsightCaveatSpecifications: Record<\n  SnapCaveatType.SignatureOrigin,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.SignatureOrigin]: Object.freeze({\n    type: SnapCaveatType.SignatureOrigin,\n    validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n  }),\n};\n"],"names":["signatureInsightEndowmentBuilder","getSignatureInsightCaveatMapper","getSignatureOriginCaveat","signatureInsightCaveatSpecifications","permissionName","SnapEndowments","SignatureInsight","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","SignatureOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpcErrors","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveat","caveat","hasProperty","isPlainObject","value","assert","isObject","keys","allowSignatureOrigin","permission"],"mappings":";;;;;;;;;;;IA2DaA,gCAAgC;eAAhCA;;IAkCGC,+BAA+B;eAA/BA;;IAiCAC,wBAAwB;eAAxBA;;IAeHC,oCAAoC;eAApCA;;;sCApI+B;2BAClB;4BACK;uBAE8B;sBAE9B;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,gBAAgB;AAUtD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,eAAe;SAAC;QAChDC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACE,AAACA,YAAY,QAAQA,SAASC,SAAS,KACtCD,SAASC,WAAW,KACnBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,eAAe,EACpD;gBACA,MAAMQ,oBAAS,CAACC,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEX,0BAAc,CAACC,eAAe,CAAC,SAAS,CAAC;gBAC1E;YACF;QACF;QACAW,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM5B,mCAAmC6B,OAAOC,MAAM,CAAC;IAC5DlB,YAAYR;IACZG;AACF;AAEA;;;;;CAKC,GACD,SAASwB,eAAeC,MAA2B;IACjD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,SAAS;QAC3D,MAAMT,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEU,KAAK,EAAE,GAAGH;IAElBI,IAAAA,aAAM,EACJ,OAAOD,UAAU,WACjB;AAEJ;AAUO,SAASlC,gCACdkC,KAAW;IAEX,IACE,CAACA,SACD,CAACE,IAAAA,eAAQ,EAACF,UACTE,IAAAA,eAAQ,EAACF,UAAUN,OAAOS,IAAI,CAACH,OAAOd,MAAM,KAAK,GAClD;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,eAAe;gBACpCoB,OACEF,IAAAA,kBAAW,EAACE,OAAO,2BAClBA,MAAMI,oBAAoB;YAC/B;SACD;IACH;AACF;AAaO,SAASrC,yBACdsC,UAAiC;IAEjC,IAAI,CAACA,YAAYpB,SAAS;QACxB,OAAO;IACT;IAEAgB,IAAAA,aAAM,EAACI,WAAWpB,OAAO,CAACC,MAAM,KAAK;IACrCe,IAAAA,aAAM,EAACI,WAAWpB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,eAAe;IAEpE,MAAMiB,SAASQ,WAAWpB,OAAO,CAAC,EAAE;IAEpC,OAAOY,OAAOG,KAAK,IAAI;AACzB;AAEO,MAAMhC,uCAGT;IACF,CAACW,0BAAc,CAACC,eAAe,CAAC,EAAEc,OAAOC,MAAM,CAAC;QAC9CR,MAAMR,0BAAc,CAACC,eAAe;QACpCI,WAAW,CAACa,SAAgCD,eAAeC;IAC7D;AACF"}

package/dist/cjs/utils.js

@@ -26,8 +26,13 @@ _export(exports, {
     },
     getSnapFiles: function() {
         return getSnapFiles;
+    },
+    fetchSnap: function() {
+        return fetchSnap;
     }
 });
+const _snapssdk = require("@metamask/snaps-sdk");
+const _snapsutils = require("@metamask/snaps-utils");
 const _Timer = require("./snaps/Timer");
 function setDiff(objectA, objectB) {
     return Object.entries(objectA).reduce((acc, [key, value])=>{
@@ -75,5 +80,32 @@ async function getSnapFiles(location, files) {
     }
     return await Promise.all(files.map(async (filePath)=>location.fetch(filePath)));
 }
+async function fetchSnap(snapId, location) {
+    try {
+        const manifest = await location.manifest();
+        const sourceCode = await location.fetch(manifest.result.source.location.npm.filePath);
+        const { iconPath } = manifest.result.source.location.npm;
+        const svgIcon = iconPath ? await location.fetch(iconPath) : undefined;
+        const auxiliaryFiles = await getSnapFiles(location, manifest.result.source.files);
+        await Promise.all(auxiliaryFiles.map(async (file)=>{
+            // This should still be safe
+            // eslint-disable-next-line require-atomic-updates
+            file.data.base64 = await (0, _snapsutils.encodeBase64)(file);
+        }));
+        const localizationFiles = await getSnapFiles(location, manifest.result.source.locales);
+        const validatedLocalizationFiles = (0, _snapsutils.getValidatedLocalizationFiles)(localizationFiles);
+        const files = {
+            manifest,
+            sourceCode,
+            svgIcon,
+            auxiliaryFiles,
+            localizationFiles: validatedLocalizationFiles
+        };
+        await (0, _snapsutils.validateFetchedSnap)(files);
+        return files;
+    } catch (error) {
+        throw new Error(`Failed to fetch snap "${snapId}": ${(0, _snapssdk.getErrorMessage)(error)}.`);
+    }
+}
 
 //# sourceMappingURL=utils.js.map

package/dist/cjs/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["import type { SnapLocation } from './snaps';\nimport { Timer } from './snaps/Timer';\n\n/**\n * Takes two objects and does a Set Difference of them.\n * Set Difference is generally defined as follows:\n * ```\n * 𝑥 ∈ A ∖ B ⟺ 𝑥 ∈ A ∧ 𝑥 ∉ B\n * ```\n * Meaning that the returned object contains all properties of A expect those that also\n * appear in B. Notice that properties that appear in B, but not in A, have no effect.\n *\n * @see [Set Difference]{@link https://proofwiki.org/wiki/Definition:Set_Difference}\n * @param objectA - The object on which the difference is being calculated.\n * @param objectB - The object whose properties will be removed from objectA.\n * @returns The objectA without properties from objectB.\n */\nexport function setDiff<\n  ObjectA extends Record<any, unknown>,\n  ObjectB extends Record<any, unknown>,\n>(objectA: ObjectA, objectB: ObjectB): Diff<ObjectA, ObjectB> {\n  return Object.entries(objectA).reduce<Record<any, unknown>>(\n    (acc, [key, value]) => {\n      if (!(key in objectB)) {\n        acc[key] = value;\n      }\n      return acc;\n    },\n    {},\n  ) as Diff<ObjectA, ObjectB>;\n}\n\n/**\n * A Promise that delays its return for a given amount of milliseconds.\n *\n * @param ms - Milliseconds to delay the execution for.\n * @param result - The result to return from the Promise after delay.\n * @returns A promise that is void if no result provided, result otherwise.\n * @template Result - The `result`.\n */\nexport function delay<Result = void>(\n  ms: number,\n  result?: Result,\n): Promise<Result> & { cancel: () => void } {\n  return delayWithTimer(new Timer(ms), result);\n}\n\n/**\n * A Promise that delays it's return by using a pausable Timer.\n *\n * @param timer - Timer used to control the delay.\n * @param result - The result to return from the Promise after delay.\n * @returns A promise that is void if no result provided, result otherwise.\n * @template Result - The `result`.\n */\nexport function delayWithTimer<Result = void>(\n  timer: Timer,\n  result?: Result,\n): Promise<Result> & { cancel: () => void } {\n  let rejectFunc: (reason: Error) => void;\n  const promise: any = new Promise<Result>((resolve: any, reject) => {\n    timer.start(() => {\n      result === undefined ? resolve() : resolve(result);\n    });\n    rejectFunc = reject;\n  });\n\n  promise.cancel = () => {\n    if (timer.status !== 'finished') {\n      timer.cancel();\n      rejectFunc(new Error('The delay has been canceled.'));\n    }\n  };\n  return promise;\n}\n\n/*\n * We use a Symbol instead of rejecting the promise so that Errors thrown\n * by the main promise will propagate.\n */\nexport const hasTimedOut = Symbol(\n  'Used to check if the requested promise has timeout (see withTimeout)',\n);\n\n/**\n * Executes the given Promise, if the Timer expires before the Promise settles, we return earlier.\n *\n * NOTE:** The given Promise is not cancelled or interrupted, and will continue to execute uninterrupted. We will just discard its result if it does not complete before the timeout.\n *\n * @param promise - The promise that you want to execute.\n * @param timerOrMs - The timer controlling the timeout or a ms value.\n * @returns The resolved `PromiseValue`, or the hasTimedOut symbol if\n * returning early.\n * @template PromiseValue - The value of the Promise.\n */\nexport async function withTimeout<PromiseValue = void>(\n  promise: Promise<PromiseValue>,\n  timerOrMs: Timer | number,\n): Promise<PromiseValue | typeof hasTimedOut> {\n  const timer =\n    typeof timerOrMs === 'number' ? new Timer(timerOrMs) : timerOrMs;\n  const delayPromise = delayWithTimer(timer, hasTimedOut);\n  try {\n    return await Promise.race([promise, delayPromise]);\n  } finally {\n    delayPromise.cancel();\n  }\n}\n\n/**\n * Checks whether the type is composed of literal types\n *\n * @returns @type {true} if whole type is composed of literals, @type {false} if whole type is not literals, @type {boolean} if mixed\n * @example\n * ```\n * type t1 = IsLiteral<1 | 2 | \"asd\" | true>;\n * // t1 = true\n *\n * type t2 = IsLiteral<number | string>;\n * // t2 = false\n *\n * type t3 = IsLiteral<1 | string>;\n * // t3 = boolean\n *\n * const s = Symbol();\n * type t4 = IsLiteral<typeof s>;\n * // t4 = true\n *\n * type t5 = IsLiteral<symbol>\n * // t5 = false;\n * ```\n */\ntype IsLiteral<Type> = Type extends string | number | boolean | symbol\n  ? Extract<string | number | boolean | symbol, Type> extends never\n    ? true\n    : false\n  : false;\n\n/**\n * Returns all keys of an object, that are literal, as an union\n *\n * @example\n * ```\n * type t1 = _LiteralKeys<{a: number, b: 0, c: 'foo', d: string}>\n * // t1 = 'b' | 'c'\n * ```\n * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}\n */\ntype LiteralKeys<Type> = NonNullable<\n  {\n    [Key in keyof Type]: IsLiteral<Key> extends true ? Key : never;\n  }[keyof Type]\n>;\n\n/**\n * Returns all keys of an object, that are not literal, as an union\n *\n * @example\n * ```\n * type t1 = _NonLiteralKeys<{a: number, b: 0, c: 'foo', d: string}>\n * // t1 = 'a' | 'd'\n * ```\n * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}\n */\ntype NonLiteralKeys<Type> = NonNullable<\n  {\n    [Key in keyof Type]: IsLiteral<Key> extends false ? Key : never;\n  }[keyof Type]\n>;\n\n/**\n * A set difference of two objects based on their keys\n *\n * @example\n * ```\n * type t1 = Diff<{a: string, b: string}, {a: number}>\n * // t1 = {b: string};\n * type t2 = Diff<{a: string, 0: string}, Record<string, unknown>>;\n * // t2 = { a?: string, 0: string};\n * type t3 = Diff<{a: string, 0: string, 1: string}, Record<1 | string, unknown>>;\n * // t3 = {a?: string, 0: string}\n * ```\n * @see {@link setDiff} for the main use-case\n */\nexport type Diff<First, Second> = Omit<First, LiteralKeys<Second>> &\n  Partial<Pick<First, Extract<keyof First, NonLiteralKeys<Second>>>>;\n\n/**\n * Makes every specified property of the specified object type mutable.\n *\n * @template Type - The object whose readonly properties to make mutable.\n * @template TargetKey - The property key(s) to make mutable.\n */\nexport type Mutable<\n  Type extends Record<string, unknown>,\n  TargetKey extends string,\n> = {\n  -readonly [Key in keyof Pick<Type, TargetKey>]: Type[Key];\n} & {\n  [Key in keyof Omit<Type, TargetKey>]: Type[Key];\n};\n\n/**\n * Get all files in a Snap from an array of file paths.\n *\n * @param location - The location of the Snap.\n * @param files - The array of file paths.\n * @returns The array of files as {@link VirtualFile}s.\n */\nexport async function getSnapFiles(\n  location: SnapLocation,\n  files?: string[] | undefined,\n) {\n  if (!files || files.length === 0) {\n    return [];\n  }\n\n  return await Promise.all(\n    files.map(async (filePath) => location.fetch(filePath)),\n  );\n}\n"],"names":["setDiff","delay","delayWithTimer","hasTimedOut","withTimeout","getSnapFiles","objectA","objectB","Object","entries","reduce","acc","key","value","ms","result","Timer","timer","rejectFunc","promise","Promise","resolve","reject","start","undefined","cancel","status","Error","Symbol","timerOrMs","delayPromise","race","location","files","length","all","map","filePath","fetch"],"mappings":";;;;;;;;;;;IAiBgBA,OAAO;eAAPA;;IAuBAC,KAAK;eAALA;;IAeAC,cAAc;eAAdA;;IAyBHC,WAAW;eAAXA;;IAeSC,WAAW;eAAXA;;IAkHAC,YAAY;eAAZA;;;uBAhNA;AAgBf,SAASL,QAGdM,OAAgB,EAAEC,OAAgB;IAClC,OAAOC,OAAOC,OAAO,CAACH,SAASI,MAAM,CACnC,CAACC,KAAK,CAACC,KAAKC,MAAM;QAChB,IAAI,CAAED,CAAAA,OAAOL,OAAM,GAAI;YACrBI,GAAG,CAACC,IAAI,GAAGC;QACb;QACA,OAAOF;IACT,GACA,CAAC;AAEL;AAUO,SAASV,MACda,EAAU,EACVC,MAAe;IAEf,OAAOb,eAAe,IAAIc,YAAK,CAACF,KAAKC;AACvC;AAUO,SAASb,eACde,KAAY,EACZF,MAAe;IAEf,IAAIG;IACJ,MAAMC,UAAe,IAAIC,QAAgB,CAACC,SAAcC;QACtDL,MAAMM,KAAK,CAAC;YACVR,WAAWS,YAAYH,YAAYA,QAAQN;QAC7C;QACAG,aAAaI;IACf;IAEAH,QAAQM,MAAM,GAAG;QACf,IAAIR,MAAMS,MAAM,KAAK,YAAY;YAC/BT,MAAMQ,MAAM;YACZP,WAAW,IAAIS,MAAM;QACvB;IACF;IACA,OAAOR;AACT;AAMO,MAAMhB,cAAcyB,OACzB;AAcK,eAAexB,YACpBe,OAA8B,EAC9BU,SAAyB;IAEzB,MAAMZ,QACJ,OAAOY,cAAc,WAAW,IAAIb,YAAK,CAACa,aAAaA;IACzD,MAAMC,eAAe5B,eAAee,OAAOd;IAC3C,IAAI;QACF,OAAO,MAAMiB,QAAQW,IAAI,CAAC;YAACZ;YAASW;SAAa;IACnD,SAAU;QACRA,aAAaL,MAAM;IACrB;AACF;AAsGO,eAAepB,aACpB2B,QAAsB,EACtBC,KAA4B;IAE5B,IAAI,CAACA,SAASA,MAAMC,MAAM,KAAK,GAAG;QAChC,OAAO,EAAE;IACX;IAEA,OAAO,MAAMd,QAAQe,GAAG,CACtBF,MAAMG,GAAG,CAAC,OAAOC,WAAaL,SAASM,KAAK,CAACD;AAEjD"}
+{"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["import type { SnapId } from '@metamask/snaps-sdk';\nimport { getErrorMessage } from '@metamask/snaps-sdk';\nimport {\n  encodeBase64,\n  getValidatedLocalizationFiles,\n  validateFetchedSnap,\n} from '@metamask/snaps-utils';\n\nimport type { SnapLocation } from './snaps';\nimport { Timer } from './snaps/Timer';\n\n/**\n * Takes two objects and does a Set Difference of them.\n * Set Difference is generally defined as follows:\n * ```\n * 𝑥 ∈ A ∖ B ⟺ 𝑥 ∈ A ∧ 𝑥 ∉ B\n * ```\n * Meaning that the returned object contains all properties of A expect those that also\n * appear in B. Notice that properties that appear in B, but not in A, have no effect.\n *\n * @see [Set Difference]{@link https://proofwiki.org/wiki/Definition:Set_Difference}\n * @param objectA - The object on which the difference is being calculated.\n * @param objectB - The object whose properties will be removed from objectA.\n * @returns The objectA without properties from objectB.\n */\nexport function setDiff<\n  ObjectA extends Record<any, unknown>,\n  ObjectB extends Record<any, unknown>,\n>(objectA: ObjectA, objectB: ObjectB): Diff<ObjectA, ObjectB> {\n  return Object.entries(objectA).reduce<Record<any, unknown>>(\n    (acc, [key, value]) => {\n      if (!(key in objectB)) {\n        acc[key] = value;\n      }\n      return acc;\n    },\n    {},\n  ) as Diff<ObjectA, ObjectB>;\n}\n\n/**\n * A Promise that delays its return for a given amount of milliseconds.\n *\n * @param ms - Milliseconds to delay the execution for.\n * @param result - The result to return from the Promise after delay.\n * @returns A promise that is void if no result provided, result otherwise.\n * @template Result - The `result`.\n */\nexport function delay<Result = void>(\n  ms: number,\n  result?: Result,\n): Promise<Result> & { cancel: () => void } {\n  return delayWithTimer(new Timer(ms), result);\n}\n\n/**\n * A Promise that delays it's return by using a pausable Timer.\n *\n * @param timer - Timer used to control the delay.\n * @param result - The result to return from the Promise after delay.\n * @returns A promise that is void if no result provided, result otherwise.\n * @template Result - The `result`.\n */\nexport function delayWithTimer<Result = void>(\n  timer: Timer,\n  result?: Result,\n): Promise<Result> & { cancel: () => void } {\n  let rejectFunc: (reason: Error) => void;\n  const promise: any = new Promise<Result>((resolve: any, reject) => {\n    timer.start(() => {\n      result === undefined ? resolve() : resolve(result);\n    });\n    rejectFunc = reject;\n  });\n\n  promise.cancel = () => {\n    if (timer.status !== 'finished') {\n      timer.cancel();\n      rejectFunc(new Error('The delay has been canceled.'));\n    }\n  };\n  return promise;\n}\n\n/*\n * We use a Symbol instead of rejecting the promise so that Errors thrown\n * by the main promise will propagate.\n */\nexport const hasTimedOut = Symbol(\n  'Used to check if the requested promise has timeout (see withTimeout)',\n);\n\n/**\n * Executes the given Promise, if the Timer expires before the Promise settles, we return earlier.\n *\n * NOTE:** The given Promise is not cancelled or interrupted, and will continue to execute uninterrupted. We will just discard its result if it does not complete before the timeout.\n *\n * @param promise - The promise that you want to execute.\n * @param timerOrMs - The timer controlling the timeout or a ms value.\n * @returns The resolved `PromiseValue`, or the hasTimedOut symbol if\n * returning early.\n * @template PromiseValue - The value of the Promise.\n */\nexport async function withTimeout<PromiseValue = void>(\n  promise: Promise<PromiseValue>,\n  timerOrMs: Timer | number,\n): Promise<PromiseValue | typeof hasTimedOut> {\n  const timer =\n    typeof timerOrMs === 'number' ? new Timer(timerOrMs) : timerOrMs;\n  const delayPromise = delayWithTimer(timer, hasTimedOut);\n  try {\n    return await Promise.race([promise, delayPromise]);\n  } finally {\n    delayPromise.cancel();\n  }\n}\n\n/**\n * Checks whether the type is composed of literal types\n *\n * @returns @type {true} if whole type is composed of literals, @type {false} if whole type is not literals, @type {boolean} if mixed\n * @example\n * ```\n * type t1 = IsLiteral<1 | 2 | \"asd\" | true>;\n * // t1 = true\n *\n * type t2 = IsLiteral<number | string>;\n * // t2 = false\n *\n * type t3 = IsLiteral<1 | string>;\n * // t3 = boolean\n *\n * const s = Symbol();\n * type t4 = IsLiteral<typeof s>;\n * // t4 = true\n *\n * type t5 = IsLiteral<symbol>\n * // t5 = false;\n * ```\n */\ntype IsLiteral<Type> = Type extends string | number | boolean | symbol\n  ? Extract<string | number | boolean | symbol, Type> extends never\n    ? true\n    : false\n  : false;\n\n/**\n * Returns all keys of an object, that are literal, as an union\n *\n * @example\n * ```\n * type t1 = _LiteralKeys<{a: number, b: 0, c: 'foo', d: string}>\n * // t1 = 'b' | 'c'\n * ```\n * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}\n */\ntype LiteralKeys<Type> = NonNullable<\n  {\n    [Key in keyof Type]: IsLiteral<Key> extends true ? Key : never;\n  }[keyof Type]\n>;\n\n/**\n * Returns all keys of an object, that are not literal, as an union\n *\n * @example\n * ```\n * type t1 = _NonLiteralKeys<{a: number, b: 0, c: 'foo', d: string}>\n * // t1 = 'a' | 'd'\n * ```\n * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}\n */\ntype NonLiteralKeys<Type> = NonNullable<\n  {\n    [Key in keyof Type]: IsLiteral<Key> extends false ? Key : never;\n  }[keyof Type]\n>;\n\n/**\n * A set difference of two objects based on their keys\n *\n * @example\n * ```\n * type t1 = Diff<{a: string, b: string}, {a: number}>\n * // t1 = {b: string};\n * type t2 = Diff<{a: string, 0: string}, Record<string, unknown>>;\n * // t2 = { a?: string, 0: string};\n * type t3 = Diff<{a: string, 0: string, 1: string}, Record<1 | string, unknown>>;\n * // t3 = {a?: string, 0: string}\n * ```\n * @see {@link setDiff} for the main use-case\n */\nexport type Diff<First, Second> = Omit<First, LiteralKeys<Second>> &\n  Partial<Pick<First, Extract<keyof First, NonLiteralKeys<Second>>>>;\n\n/**\n * Makes every specified property of the specified object type mutable.\n *\n * @template Type - The object whose readonly properties to make mutable.\n * @template TargetKey - The property key(s) to make mutable.\n */\nexport type Mutable<\n  Type extends Record<string, unknown>,\n  TargetKey extends string,\n> = {\n  -readonly [Key in keyof Pick<Type, TargetKey>]: Type[Key];\n} & {\n  [Key in keyof Omit<Type, TargetKey>]: Type[Key];\n};\n\n/**\n * Get all files in a Snap from an array of file paths.\n *\n * @param location - The location of the Snap.\n * @param files - The array of file paths.\n * @returns The array of files as {@link VirtualFile}s.\n */\nexport async function getSnapFiles(\n  location: SnapLocation,\n  files?: string[] | undefined,\n) {\n  if (!files || files.length === 0) {\n    return [];\n  }\n\n  return await Promise.all(\n    files.map(async (filePath) => location.fetch(filePath)),\n  );\n}\n\n/**\n * Fetch the Snap manifest, source code, and any other files from the given\n * location.\n *\n * @param snapId - The ID of the Snap to fetch.\n * @param location - The location of the Snap.\n * @returns The Snap files and location.\n * @throws If the Snap files are invalid, or if the Snap could not be fetched.\n */\nexport async function fetchSnap(snapId: SnapId, location: SnapLocation) {\n  try {\n    const manifest = await location.manifest();\n    const sourceCode = await location.fetch(\n      manifest.result.source.location.npm.filePath,\n    );\n    const { iconPath } = manifest.result.source.location.npm;\n    const svgIcon = iconPath ? await location.fetch(iconPath) : undefined;\n\n    const auxiliaryFiles = await getSnapFiles(\n      location,\n      manifest.result.source.files,\n    );\n\n    await Promise.all(\n      auxiliaryFiles.map(async (file) => {\n        // This should still be safe\n        // eslint-disable-next-line require-atomic-updates\n        file.data.base64 = await encodeBase64(file);\n      }),\n    );\n\n    const localizationFiles = await getSnapFiles(\n      location,\n      manifest.result.source.locales,\n    );\n\n    const validatedLocalizationFiles =\n      getValidatedLocalizationFiles(localizationFiles);\n\n    const files = {\n      manifest,\n      sourceCode,\n      svgIcon,\n      auxiliaryFiles,\n      localizationFiles: validatedLocalizationFiles,\n    };\n\n    await validateFetchedSnap(files);\n\n    return files;\n  } catch (error) {\n    throw new Error(\n      `Failed to fetch snap \"${snapId}\": ${getErrorMessage(error)}.`,\n    );\n  }\n}\n"],"names":["setDiff","delay","delayWithTimer","hasTimedOut","withTimeout","getSnapFiles","fetchSnap","objectA","objectB","Object","entries","reduce","acc","key","value","ms","result","Timer","timer","rejectFunc","promise","Promise","resolve","reject","start","undefined","cancel","status","Error","Symbol","timerOrMs","delayPromise","race","location","files","length","all","map","filePath","fetch","snapId","manifest","sourceCode","source","npm","iconPath","svgIcon","auxiliaryFiles","file","data","base64","encodeBase64","localizationFiles","locales","validatedLocalizationFiles","getValidatedLocalizationFiles","validateFetchedSnap","error","getErrorMessage"],"mappings":";;;;;;;;;;;IAyBgBA,OAAO;eAAPA;;IAuBAC,KAAK;eAALA;;IAeAC,cAAc;eAAdA;;IAyBHC,WAAW;eAAXA;;IAeSC,WAAW;eAAXA;;IAkHAC,YAAY;eAAZA;;IAsBAC,SAAS;eAATA;;;0BA9OU;4BAKzB;uBAGe;AAgBf,SAASN,QAGdO,OAAgB,EAAEC,OAAgB;IAClC,OAAOC,OAAOC,OAAO,CAACH,SAASI,MAAM,CACnC,CAACC,KAAK,CAACC,KAAKC,MAAM;QAChB,IAAI,CAAED,CAAAA,OAAOL,OAAM,GAAI;YACrBI,GAAG,CAACC,IAAI,GAAGC;QACb;QACA,OAAOF;IACT,GACA,CAAC;AAEL;AAUO,SAASX,MACdc,EAAU,EACVC,MAAe;IAEf,OAAOd,eAAe,IAAIe,YAAK,CAACF,KAAKC;AACvC;AAUO,SAASd,eACdgB,KAAY,EACZF,MAAe;IAEf,IAAIG;IACJ,MAAMC,UAAe,IAAIC,QAAgB,CAACC,SAAcC;QACtDL,MAAMM,KAAK,CAAC;YACVR,WAAWS,YAAYH,YAAYA,QAAQN;QAC7C;QACAG,aAAaI;IACf;IAEAH,QAAQM,MAAM,GAAG;QACf,IAAIR,MAAMS,MAAM,KAAK,YAAY;YAC/BT,MAAMQ,MAAM;YACZP,WAAW,IAAIS,MAAM;QACvB;IACF;IACA,OAAOR;AACT;AAMO,MAAMjB,cAAc0B,OACzB;AAcK,eAAezB,YACpBgB,OAA8B,EAC9BU,SAAyB;IAEzB,MAAMZ,QACJ,OAAOY,cAAc,WAAW,IAAIb,YAAK,CAACa,aAAaA;IACzD,MAAMC,eAAe7B,eAAegB,OAAOf;IAC3C,IAAI;QACF,OAAO,MAAMkB,QAAQW,IAAI,CAAC;YAACZ;YAASW;SAAa;IACnD,SAAU;QACRA,aAAaL,MAAM;IACrB;AACF;AAsGO,eAAerB,aACpB4B,QAAsB,EACtBC,KAA4B;IAE5B,IAAI,CAACA,SAASA,MAAMC,MAAM,KAAK,GAAG;QAChC,OAAO,EAAE;IACX;IAEA,OAAO,MAAMd,QAAQe,GAAG,CACtBF,MAAMG,GAAG,CAAC,OAAOC,WAAaL,SAASM,KAAK,CAACD;AAEjD;AAWO,eAAehC,UAAUkC,MAAc,EAAEP,QAAsB;IACpE,IAAI;QACF,MAAMQ,WAAW,MAAMR,SAASQ,QAAQ;QACxC,MAAMC,aAAa,MAAMT,SAASM,KAAK,CACrCE,SAASzB,MAAM,CAAC2B,MAAM,CAACV,QAAQ,CAACW,GAAG,CAACN,QAAQ;QAE9C,MAAM,EAAEO,QAAQ,EAAE,GAAGJ,SAASzB,MAAM,CAAC2B,MAAM,CAACV,QAAQ,CAACW,GAAG;QACxD,MAAME,UAAUD,WAAW,MAAMZ,SAASM,KAAK,CAACM,YAAYpB;QAE5D,MAAMsB,iBAAiB,MAAM1C,aAC3B4B,UACAQ,SAASzB,MAAM,CAAC2B,MAAM,CAACT,KAAK;QAG9B,MAAMb,QAAQe,GAAG,CACfW,eAAeV,GAAG,CAAC,OAAOW;YACxB,4BAA4B;YAC5B,kDAAkD;YAClDA,KAAKC,IAAI,CAACC,MAAM,GAAG,MAAMC,IAAAA,wBAAY,EAACH;QACxC;QAGF,MAAMI,oBAAoB,MAAM/C,aAC9B4B,UACAQ,SAASzB,MAAM,CAAC2B,MAAM,CAACU,OAAO;QAGhC,MAAMC,6BACJC,IAAAA,yCAA6B,EAACH;QAEhC,MAAMlB,QAAQ;YACZO;YACAC;YACAI;YACAC;YACAK,mBAAmBE;QACrB;QAEA,MAAME,IAAAA,+BAAmB,EAACtB;QAE1B,OAAOA;IACT,EAAE,OAAOuB,OAAO;QACd,MAAM,IAAI7B,MACR,CAAC,sBAAsB,EAAEY,OAAO,GAAG,EAAEkB,IAAAA,yBAAe,EAACD,OAAO,CAAC,CAAC;IAElE;AACF"}

package/dist/esm/services/ProxyPostMessageStream.js

@@ -49,7 +49,7 @@ function _class_private_method_init(obj, privateSet) {
     privateSet.add(obj);
 }
 import { BasePostMessageStream } from '@metamask/post-message-stream';
-var _stream = /*#__PURE__*/ new WeakMap(), _jobId = /*#__PURE__*/ new WeakMap(), _extra = /*#__PURE__*/ new WeakMap(), /**
+var _stream = /*#__PURE__*/ new WeakMap(), _jobId = /*#__PURE__*/ new WeakMap(), /**
    * Handle incoming data from the underlying stream. This checks that the job
    * ID matches the expected job ID, and pushes the data to the stream if so.
    *
@@ -67,8 +67,7 @@ var _stream = /*#__PURE__*/ new WeakMap(), _jobId = /*#__PURE__*/ new WeakMap(),
    */ _postMessage(data) {
         _class_private_field_get(this, _stream).write({
             jobId: _class_private_field_get(this, _jobId),
-            data,
-            extra: _class_private_field_get(this, _extra)
+            data
         });
     }
     /**
@@ -77,8 +76,7 @@ var _stream = /*#__PURE__*/ new WeakMap(), _jobId = /*#__PURE__*/ new WeakMap(),
    * @param args - The constructor arguments.
    * @param args.stream - The underlying stream to use for communication.
    * @param args.jobId - The ID of the job this stream is associated with.
-   * @param args.extra - Extra data to include in the post message.
-   */ constructor({ stream, jobId, extra }){
+   */ constructor({ stream, jobId }){
         super();
         _class_private_method_init(this, _onData);
         _class_private_field_init(this, _stream, {
@@ -89,13 +87,8 @@ var _stream = /*#__PURE__*/ new WeakMap(), _jobId = /*#__PURE__*/ new WeakMap(),
             writable: true,
             value: void 0
         });
-        _class_private_field_init(this, _extra, {
-            writable: true,
-            value: void 0
-        });
         _class_private_field_set(this, _stream, stream);
         _class_private_field_set(this, _jobId, jobId);
-        _class_private_field_set(this, _extra, extra);
         _class_private_field_get(this, _stream).on('data', _class_private_method_get(this, _onData, onData).bind(this));
     }
 }

package/dist/esm/services/ProxyPostMessageStream.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/ProxyPostMessageStream.ts"],"sourcesContent":["import { BasePostMessageStream } from '@metamask/post-message-stream';\nimport type { JsonRpcRequest } from '@metamask/utils';\n\nexport type ProxyPostMessageStreamArgs = {\n  stream: BasePostMessageStream;\n  jobId: string;\n  extra?: Record<string, unknown>;\n};\n\nexport type ProxyPostMessage = {\n  jobId: string;\n  data: JsonRpcRequest;\n  extra?: Record<string, unknown>;\n};\n\n/**\n * A post message stream that wraps messages in a job ID, before sending them\n * over the underlying stream.\n */\nexport class ProxyPostMessageStream extends BasePostMessageStream {\n  readonly #stream: BasePostMessageStream;\n\n  readonly #jobId: string;\n\n  readonly #extra?: Record<string, unknown>;\n\n  /**\n   * Initializes a new `ProxyPostMessageStream` instance.\n   *\n   * @param args - The constructor arguments.\n   * @param args.stream - The underlying stream to use for communication.\n   * @param args.jobId - The ID of the job this stream is associated with.\n   * @param args.extra - Extra data to include in the post message.\n   */\n  constructor({ stream, jobId, extra }: ProxyPostMessageStreamArgs) {\n    super();\n\n    this.#stream = stream;\n    this.#jobId = jobId;\n    this.#extra = extra;\n\n    this.#stream.on('data', this.#onData.bind(this));\n  }\n\n  /**\n   * Handle incoming data from the underlying stream. This checks that the job\n   * ID matches the expected job ID, and pushes the data to the stream if so.\n   *\n   * @param data - The data to handle.\n   */\n  #onData(data: ProxyPostMessage) {\n    if (data.jobId !== this.#jobId) {\n      return;\n    }\n\n    this.push(data.data);\n  }\n\n  /**\n   * Write data to the underlying stream. This wraps the data in an object with\n   * the job ID.\n   *\n   * @param data - The data to write.\n   */\n  _postMessage(data: ProxyPostMessage) {\n    this.#stream.write({\n      jobId: this.#jobId,\n      data,\n      extra: this.#extra,\n    });\n  }\n}\n"],"names":["BasePostMessageStream","ProxyPostMessageStream","_postMessage","data","stream","write","jobId","extra","constructor","on","onData","bind","push"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAASA,qBAAqB,QAAQ,gCAAgC;IAoB3D,uCAEA,sCAEA,sCAoBT;;;;;GAKC,GACD;AAnCF;;;CAGC,GACD,OAAO,MAAMC,+BAA+BD;IAuC1C;;;;;GAKC,GACDE,aAAaC,IAAsB,EAAE;QACnC,yBAAA,IAAI,EAAEC,SAAOC,KAAK,CAAC;YACjBC,KAAK,2BAAE,IAAI,EAAEA;YACbH;YACAI,KAAK,2BAAE,IAAI,EAAEA;QACf;IACF;IA5CA;;;;;;;GAOC,GACDC,YAAY,EAAEJ,MAAM,EAAEE,KAAK,EAAEC,KAAK,EAA8B,CAAE;QAChE,KAAK;QAeP,iCAAA;QA9BA,gCAAS;;mBAAT,KAAA;;QAEA,gCAAS;;mBAAT,KAAA;;QAEA,gCAAS;;mBAAT,KAAA;;uCAaQH,SAASA;uCACTE,QAAQA;uCACRC,QAAQA;QAEd,yBAAA,IAAI,EAAEH,SAAOK,EAAE,CAAC,QAAQ,0BAAA,IAAI,EAAEC,SAAAA,QAAOC,IAAI,CAAC,IAAI;IAChD;AA6BF;AArBE,SAAA,OAAQR,IAAsB;IAC5B,IAAIA,KAAKG,KAAK,8BAAK,IAAI,EAAEA,SAAO;QAC9B;IACF;IAEA,IAAI,CAACM,IAAI,CAACT,KAAKA,IAAI;AACrB"}
+{"version":3,"sources":["../../../src/services/ProxyPostMessageStream.ts"],"sourcesContent":["import { BasePostMessageStream } from '@metamask/post-message-stream';\nimport type { JsonRpcRequest } from '@metamask/utils';\n\nexport type ProxyPostMessageStreamArgs = {\n  stream: BasePostMessageStream;\n  jobId: string;\n  extra?: Record<string, unknown>;\n};\n\nexport type ProxyPostMessage = {\n  jobId: string;\n  data: JsonRpcRequest;\n  extra?: Record<string, unknown>;\n};\n\n/**\n * A post message stream that wraps messages in a job ID, before sending them\n * over the underlying stream.\n */\nexport class ProxyPostMessageStream extends BasePostMessageStream {\n  readonly #stream: BasePostMessageStream;\n\n  readonly #jobId: string;\n\n  /**\n   * Initializes a new `ProxyPostMessageStream` instance.\n   *\n   * @param args - The constructor arguments.\n   * @param args.stream - The underlying stream to use for communication.\n   * @param args.jobId - The ID of the job this stream is associated with.\n   */\n  constructor({ stream, jobId }: ProxyPostMessageStreamArgs) {\n    super();\n\n    this.#stream = stream;\n    this.#jobId = jobId;\n\n    this.#stream.on('data', this.#onData.bind(this));\n  }\n\n  /**\n   * Handle incoming data from the underlying stream. This checks that the job\n   * ID matches the expected job ID, and pushes the data to the stream if so.\n   *\n   * @param data - The data to handle.\n   */\n  #onData(data: ProxyPostMessage) {\n    if (data.jobId !== this.#jobId) {\n      return;\n    }\n\n    this.push(data.data);\n  }\n\n  /**\n   * Write data to the underlying stream. This wraps the data in an object with\n   * the job ID.\n   *\n   * @param data - The data to write.\n   */\n  _postMessage(data: ProxyPostMessage) {\n    this.#stream.write({\n      jobId: this.#jobId,\n      data,\n    });\n  }\n}\n"],"names":["BasePostMessageStream","ProxyPostMessageStream","_postMessage","data","stream","write","jobId","constructor","on","onData","bind","push"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAASA,qBAAqB,QAAQ,gCAAgC;IAoB3D,uCAEA,sCAkBT;;;;;GAKC,GACD;AA/BF;;;CAGC,GACD,OAAO,MAAMC,+BAA+BD;IAmC1C;;;;;GAKC,GACDE,aAAaC,IAAsB,EAAE;QACnC,yBAAA,IAAI,EAAEC,SAAOC,KAAK,CAAC;YACjBC,KAAK,2BAAE,IAAI,EAAEA;YACbH;QACF;IACF;IAzCA;;;;;;GAMC,GACDI,YAAY,EAAEH,MAAM,EAAEE,KAAK,EAA8B,CAAE;QACzD,KAAK;QAcP,iCAAA;QA1BA,gCAAS;;mBAAT,KAAA;;QAEA,gCAAS;;mBAAT,KAAA;;uCAYQF,SAASA;uCACTE,QAAQA;QAEd,yBAAA,IAAI,EAAEF,SAAOI,EAAE,CAAC,QAAQ,0BAAA,IAAI,EAAEC,SAAAA,QAAOC,IAAI,CAAC,IAAI;IAChD;AA4BF;AApBE,SAAA,OAAQP,IAAsB;IAC5B,IAAIA,KAAKG,KAAK,8BAAK,IAAI,EAAEA,SAAO;QAC9B;IACF;IAEA,IAAI,CAACK,IAAI,CAACR,KAAKA,IAAI;AACrB"}

package/dist/esm/services/node/NodeProcessExecutionService.js

@@ -3,7 +3,19 @@ import { fork } from 'child_process';
 import { AbstractExecutionService } from '..';
 export class NodeProcessExecutionService extends AbstractExecutionService {
     async initEnvStream() {
-        const worker = fork(require.resolve('@metamask/snaps-execution-environments/dist/browserify/node-process/bundle.js'));
+        const worker = fork(require.resolve('@metamask/snaps-execution-environments/dist/browserify/node-process/bundle.js'), {
+            stdio: 'pipe'
+        });
+        // Capturing `stdout` and `stderr` from the worker prevents the worker from
+        // writing to them directly, making it easier to capture them Jest.
+        worker.stdout?.on('data', (data)=>{
+            // eslint-disable-next-line no-console
+            console.log(data.toString());
+        });
+        worker.stderr?.on('data', (data)=>{
+            // eslint-disable-next-line no-console
+            console.error(data.toString());
+        });
         const stream = new ProcessParentMessageStream({
             process: worker
         });

package/dist/esm/services/node/NodeProcessExecutionService.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/services/node/NodeProcessExecutionService.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { ProcessParentMessageStream } from '@metamask/post-message-stream';\nimport type { ChildProcess } from 'child_process';\nimport { fork } from 'child_process';\n\nimport type { Job } from '..';\nimport { AbstractExecutionService } from '..';\n\nexport class NodeProcessExecutionService extends AbstractExecutionService<ChildProcess> {\n  protected async initEnvStream(): Promise<{\n    worker: ChildProcess;\n    stream: BasePostMessageStream;\n  }> {\n    const worker = fork(\n      require.resolve(\n        '@metamask/snaps-execution-environments/dist/browserify/node-process/bundle.js',\n      ),\n    );\n\n    const stream = new ProcessParentMessageStream({ process: worker });\n    return Promise.resolve({ worker, stream });\n  }\n\n  protected terminateJob(jobWrapper: Job<ChildProcess>): void {\n    jobWrapper.worker.kill();\n  }\n}\n"],"names":["ProcessParentMessageStream","fork","AbstractExecutionService","NodeProcessExecutionService","initEnvStream","worker","require","resolve","stream","process","Promise","terminateJob","jobWrapper","kill"],"mappings":"AACA,SAASA,0BAA0B,QAAQ,gCAAgC;AAE3E,SAASC,IAAI,QAAQ,gBAAgB;AAGrC,SAASC,wBAAwB,QAAQ,KAAK;AAE9C,OAAO,MAAMC,oCAAoCD;IAC/C,MAAgBE,gBAGb;QACD,MAAMC,SAASJ,KACbK,QAAQC,OAAO,CACb;QAIJ,MAAMC,SAAS,IAAIR,2BAA2B;YAAES,SAASJ;QAAO;QAChE,OAAOK,QAAQH,OAAO,CAAC;YAAEF;YAAQG;QAAO;IAC1C;IAEUG,aAAaC,UAA6B,EAAQ;QAC1DA,WAAWP,MAAM,CAACQ,IAAI;IACxB;AACF"}
+{"version":3,"sources":["../../../../src/services/node/NodeProcessExecutionService.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { ProcessParentMessageStream } from '@metamask/post-message-stream';\nimport type { ChildProcess } from 'child_process';\nimport { fork } from 'child_process';\n\nimport type { Job } from '..';\nimport { AbstractExecutionService } from '..';\n\nexport class NodeProcessExecutionService extends AbstractExecutionService<ChildProcess> {\n  protected async initEnvStream(): Promise<{\n    worker: ChildProcess;\n    stream: BasePostMessageStream;\n  }> {\n    const worker = fork(\n      require.resolve(\n        '@metamask/snaps-execution-environments/dist/browserify/node-process/bundle.js',\n      ),\n      {\n        stdio: 'pipe',\n      },\n    );\n\n    // Capturing `stdout` and `stderr` from the worker prevents the worker from\n    // writing to them directly, making it easier to capture them Jest.\n    worker.stdout?.on('data', (data) => {\n      // eslint-disable-next-line no-console\n      console.log(data.toString());\n    });\n\n    worker.stderr?.on('data', (data) => {\n      // eslint-disable-next-line no-console\n      console.error(data.toString());\n    });\n\n    const stream = new ProcessParentMessageStream({ process: worker });\n    return Promise.resolve({ worker, stream });\n  }\n\n  protected terminateJob(jobWrapper: Job<ChildProcess>): void {\n    jobWrapper.worker.kill();\n  }\n}\n"],"names":["ProcessParentMessageStream","fork","AbstractExecutionService","NodeProcessExecutionService","initEnvStream","worker","require","resolve","stdio","stdout","on","data","console","log","toString","stderr","error","stream","process","Promise","terminateJob","jobWrapper","kill"],"mappings":"AACA,SAASA,0BAA0B,QAAQ,gCAAgC;AAE3E,SAASC,IAAI,QAAQ,gBAAgB;AAGrC,SAASC,wBAAwB,QAAQ,KAAK;AAE9C,OAAO,MAAMC,oCAAoCD;IAC/C,MAAgBE,gBAGb;QACD,MAAMC,SAASJ,KACbK,QAAQC,OAAO,CACb,kFAEF;YACEC,OAAO;QACT;QAGF,2EAA2E;QAC3E,mEAAmE;QACnEH,OAAOI,MAAM,EAAEC,GAAG,QAAQ,CAACC;YACzB,sCAAsC;YACtCC,QAAQC,GAAG,CAACF,KAAKG,QAAQ;QAC3B;QAEAT,OAAOU,MAAM,EAAEL,GAAG,QAAQ,CAACC;YACzB,sCAAsC;YACtCC,QAAQI,KAAK,CAACL,KAAKG,QAAQ;QAC7B;QAEA,MAAMG,SAAS,IAAIjB,2BAA2B;YAAEkB,SAASb;QAAO;QAChE,OAAOc,QAAQZ,OAAO,CAAC;YAAEF;YAAQY;QAAO;IAC1C;IAEUG,aAAaC,UAA6B,EAAQ;QAC1DA,WAAWhB,MAAM,CAACiB,IAAI;IACxB;AACF"}

package/dist/esm/services/node/NodeThreadExecutionService.js

@@ -4,7 +4,20 @@ import { Worker } from 'worker_threads';
 import { AbstractExecutionService } from '..';
 export class NodeThreadExecutionService extends AbstractExecutionService {
     async initEnvStream() {
-        const worker = new Worker(require.resolve('@metamask/snaps-execution-environments/dist/browserify/node-thread/bundle.js'));
+        const worker = new Worker(require.resolve('@metamask/snaps-execution-environments/dist/browserify/node-thread/bundle.js'), {
+            stdout: true,
+            stderr: true
+        });
+        // Capturing `stdout` and `stderr` from the worker prevents the worker from
+        // writing to them directly, making it easier to capture them Jest.
+        worker.stdout.on('data', (data)=>{
+            // eslint-disable-next-line no-console
+            console.log(data.toString());
+        });
+        worker.stderr.on('data', (data)=>{
+            // eslint-disable-next-line no-console
+            console.error(data.toString());
+        });
         const stream = new ThreadParentMessageStream({
             thread: worker
         });

package/dist/esm/services/node/NodeThreadExecutionService.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/services/node/NodeThreadExecutionService.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { ThreadParentMessageStream } from '@metamask/post-message-stream';\n// eslint-disable-next-line @typescript-eslint/no-shadow\nimport { Worker } from 'worker_threads';\n\nimport type { Job } from '..';\nimport { AbstractExecutionService } from '..';\n\nexport class NodeThreadExecutionService extends AbstractExecutionService<Worker> {\n  protected async initEnvStream(): Promise<{\n    worker: Worker;\n    stream: BasePostMessageStream;\n  }> {\n    const worker = new Worker(\n      require.resolve(\n        '@metamask/snaps-execution-environments/dist/browserify/node-thread/bundle.js',\n      ),\n    );\n    const stream = new ThreadParentMessageStream({ thread: worker });\n    return Promise.resolve({ worker, stream });\n  }\n\n  protected async terminateJob(jobWrapper: Job<Worker>): Promise<void> {\n    await jobWrapper.worker.terminate();\n  }\n}\n"],"names":["ThreadParentMessageStream","Worker","AbstractExecutionService","NodeThreadExecutionService","initEnvStream","worker","require","resolve","stream","thread","Promise","terminateJob","jobWrapper","terminate"],"mappings":"AACA,SAASA,yBAAyB,QAAQ,gCAAgC;AAC1E,wDAAwD;AACxD,SAASC,MAAM,QAAQ,iBAAiB;AAGxC,SAASC,wBAAwB,QAAQ,KAAK;AAE9C,OAAO,MAAMC,mCAAmCD;IAC9C,MAAgBE,gBAGb;QACD,MAAMC,SAAS,IAAIJ,OACjBK,QAAQC,OAAO,CACb;QAGJ,MAAMC,SAAS,IAAIR,0BAA0B;YAAES,QAAQJ;QAAO;QAC9D,OAAOK,QAAQH,OAAO,CAAC;YAAEF;YAAQG;QAAO;IAC1C;IAEA,MAAgBG,aAAaC,UAAuB,EAAiB;QACnE,MAAMA,WAAWP,MAAM,CAACQ,SAAS;IACnC;AACF"}
+{"version":3,"sources":["../../../../src/services/node/NodeThreadExecutionService.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { ThreadParentMessageStream } from '@metamask/post-message-stream';\n// eslint-disable-next-line @typescript-eslint/no-shadow\nimport { Worker } from 'worker_threads';\n\nimport type { Job } from '..';\nimport { AbstractExecutionService } from '..';\n\nexport class NodeThreadExecutionService extends AbstractExecutionService<Worker> {\n  protected async initEnvStream(): Promise<{\n    worker: Worker;\n    stream: BasePostMessageStream;\n  }> {\n    const worker = new Worker(\n      require.resolve(\n        '@metamask/snaps-execution-environments/dist/browserify/node-thread/bundle.js',\n      ),\n      {\n        stdout: true,\n        stderr: true,\n      },\n    );\n\n    // Capturing `stdout` and `stderr` from the worker prevents the worker from\n    // writing to them directly, making it easier to capture them Jest.\n    worker.stdout.on('data', (data) => {\n      // eslint-disable-next-line no-console\n      console.log(data.toString());\n    });\n\n    worker.stderr.on('data', (data) => {\n      // eslint-disable-next-line no-console\n      console.error(data.toString());\n    });\n\n    const stream = new ThreadParentMessageStream({ thread: worker });\n    return Promise.resolve({ worker, stream });\n  }\n\n  protected async terminateJob(jobWrapper: Job<Worker>): Promise<void> {\n    await jobWrapper.worker.terminate();\n  }\n}\n"],"names":["ThreadParentMessageStream","Worker","AbstractExecutionService","NodeThreadExecutionService","initEnvStream","worker","require","resolve","stdout","stderr","on","data","console","log","toString","error","stream","thread","Promise","terminateJob","jobWrapper","terminate"],"mappings":"AACA,SAASA,yBAAyB,QAAQ,gCAAgC;AAC1E,wDAAwD;AACxD,SAASC,MAAM,QAAQ,iBAAiB;AAGxC,SAASC,wBAAwB,QAAQ,KAAK;AAE9C,OAAO,MAAMC,mCAAmCD;IAC9C,MAAgBE,gBAGb;QACD,MAAMC,SAAS,IAAIJ,OACjBK,QAAQC,OAAO,CACb,iFAEF;YACEC,QAAQ;YACRC,QAAQ;QACV;QAGF,2EAA2E;QAC3E,mEAAmE;QACnEJ,OAAOG,MAAM,CAACE,EAAE,CAAC,QAAQ,CAACC;YACxB,sCAAsC;YACtCC,QAAQC,GAAG,CAACF,KAAKG,QAAQ;QAC3B;QAEAT,OAAOI,MAAM,CAACC,EAAE,CAAC,QAAQ,CAACC;YACxB,sCAAsC;YACtCC,QAAQG,KAAK,CAACJ,KAAKG,QAAQ;QAC7B;QAEA,MAAME,SAAS,IAAIhB,0BAA0B;YAAEiB,QAAQZ;QAAO;QAC9D,OAAOa,QAAQX,OAAO,CAAC;YAAEF;YAAQW;QAAO;IAC1C;IAEA,MAAgBG,aAAaC,UAAuB,EAAiB;QACnE,MAAMA,WAAWf,MAAM,CAACgB,SAAS;IACnC;AACF"}