@metamask/snaps-controllers 4.0.0 → 4.1.0

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

@@ -1,6 +1,7 @@
 export 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/esm/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":"WAAO;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":"WAAO;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/esm/snaps/endowments/index.js

@@ -7,6 +7,7 @@ import { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';
 import { getNameLookupCaveatMapper, nameLookupCaveatSpecifications, nameLookupEndowmentBuilder } from './name-lookup';
 import { networkAccessEndowmentBuilder } from './network-access';
 import { getRpcCaveatMapper, rpcCaveatSpecifications, rpcEndowmentBuilder } from './rpc';
+import { getSignatureInsightCaveatMapper, signatureInsightCaveatSpecifications, signatureInsightEndowmentBuilder } from './signature-insight';
 import { getTransactionInsightCaveatMapper, transactionInsightCaveatSpecifications, transactionInsightEndowmentBuilder } from './transaction-insight';
 import { webAssemblyEndowmentBuilder } from './web-assembly';
 export const endowmentPermissionBuilders = {
@@ -19,21 +20,24 @@ export const endowmentPermissionBuilders = {
     [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,
     [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,
     [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder,
-    [homePageEndowmentBuilder.targetName]: homePageEndowmentBuilder
+    [homePageEndowmentBuilder.targetName]: homePageEndowmentBuilder,
+    [signatureInsightEndowmentBuilder.targetName]: signatureInsightEndowmentBuilder
 };
 export const endowmentCaveatSpecifications = {
     ...cronjobCaveatSpecifications,
     ...transactionInsightCaveatSpecifications,
     ...rpcCaveatSpecifications,
     ...nameLookupCaveatSpecifications,
-    ...keyringCaveatSpecifications
+    ...keyringCaveatSpecifications,
+    ...signatureInsightCaveatSpecifications
 };
 export const endowmentCaveatMappers = {
     [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,
     [transactionInsightEndowmentBuilder.targetName]: getTransactionInsightCaveatMapper,
     [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,
     [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,
-    [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper
+    [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper,
+    [signatureInsightEndowmentBuilder.targetName]: getSignatureInsightCaveatMapper
 };
 export const handlerEndowments = {
     [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,
@@ -43,10 +47,12 @@ export const handlerEndowments = {
     [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,
     [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,
     [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName,
-    [HandlerType.OnHomePage]: homePageEndowmentBuilder.targetName
+    [HandlerType.OnHomePage]: homePageEndowmentBuilder.targetName,
+    [HandlerType.OnSignature]: signatureInsightEndowmentBuilder.targetName
 };
 export * from './enum';
 export { getRpcCaveatOrigins } from './rpc';
+export { getSignatureOriginCaveat } from './signature-insight';
 export { getTransactionOriginCaveat } from './transaction-insight';
 export { getChainIdsCaveat } from './name-lookup';
 export { getKeyringCaveatOrigins } from './keyring';

package/dist/esm/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":["HandlerType","cronjobCaveatSpecifications","cronjobEndowmentBuilder","getCronjobCaveatMapper","ethereumProviderEndowmentBuilder","homePageEndowmentBuilder","getKeyringCaveatMapper","keyringCaveatSpecifications","keyringEndowmentBuilder","lifecycleHooksEndowmentBuilder","getNameLookupCaveatMapper","nameLookupCaveatSpecifications","nameLookupEndowmentBuilder","networkAccessEndowmentBuilder","getRpcCaveatMapper","rpcCaveatSpecifications","rpcEndowmentBuilder","getTransactionInsightCaveatMapper","transactionInsightCaveatSpecifications","transactionInsightEndowmentBuilder","webAssemblyEndowmentBuilder","endowmentPermissionBuilders","targetName","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","getRpcCaveatOrigins","getTransactionOriginCaveat","getChainIdsCaveat","getKeyringCaveatOrigins"],"mappings":"AACA,SAASA,WAAW,QAAQ,wBAAwB;AAGpD,SACEC,2BAA2B,EAC3BC,uBAAuB,EACvBC,sBAAsB,QACjB,YAAY;AACnB,SAASC,gCAAgC,QAAQ,sBAAsB;AACvE,SAASC,wBAAwB,QAAQ,cAAc;AACvD,SACEC,sBAAsB,EACtBC,2BAA2B,EAC3BC,uBAAuB,QAClB,YAAY;AACnB,SAASC,8BAA8B,QAAQ,oBAAoB;AACnE,SACEC,yBAAyB,EACzBC,8BAA8B,EAC9BC,0BAA0B,QACrB,gBAAgB;AACvB,SAASC,6BAA6B,QAAQ,mBAAmB;AACjE,SACEC,kBAAkB,EAClBC,uBAAuB,EACvBC,mBAAmB,QACd,QAAQ;AACf,SACEC,iCAAiC,EACjCC,sCAAsC,EACtCC,kCAAkC,QAC7B,wBAAwB;AAC/B,SAASC,2BAA2B,QAAQ,iBAAiB;AAE7D,OAAO,MAAMC,8BAA8B;IACzC,CAACR,8BAA8BS,UAAU,CAAC,EAAET;IAC5C,CAACM,mCAAmCG,UAAU,CAAC,EAC7CH;IACF,CAACjB,wBAAwBoB,UAAU,CAAC,EAAEpB;IACtC,CAACE,iCAAiCkB,UAAU,CAAC,EAC3ClB;IACF,CAACY,oBAAoBM,UAAU,CAAC,EAAEN;IAClC,CAACI,4BAA4BE,UAAU,CAAC,EAAEF;IAC1C,CAACR,2BAA2BU,UAAU,CAAC,EAAEV;IACzC,CAACH,+BAA+Ba,UAAU,CAAC,EAAEb;IAC7C,CAACD,wBAAwBc,UAAU,CAAC,EAAEd;IACtC,CAACH,yBAAyBiB,UAAU,CAAC,EAAEjB;AACzC,EAAW;AAEX,OAAO,MAAMkB,gCAAgC;IAC3C,GAAGtB,2BAA2B;IAC9B,GAAGiB,sCAAsC;IACzC,GAAGH,uBAAuB;IAC1B,GAAGJ,8BAA8B;IACjC,GAAGJ,2BAA2B;AAChC,EAAE;AAEF,OAAO,MAAMiB,yBAGT;IACF,CAACtB,wBAAwBoB,UAAU,CAAC,EAAEnB;IACtC,CAACgB,mCAAmCG,UAAU,CAAC,EAC7CL;IACF,CAACD,oBAAoBM,UAAU,CAAC,EAAER;IAClC,CAACF,2BAA2BU,UAAU,CAAC,EAAEZ;IACzC,CAACF,wBAAwBc,UAAU,CAAC,EAAEhB;AACxC,EAAE;AAEF,OAAO,MAAMmB,oBAAiD;IAC5D,CAACzB,YAAY0B,YAAY,CAAC,EAAEV,oBAAoBM,UAAU;IAC1D,CAACtB,YAAY2B,aAAa,CAAC,EAAER,mCAAmCG,UAAU;IAC1E,CAACtB,YAAY4B,SAAS,CAAC,EAAE1B,wBAAwBoB,UAAU;IAC3D,CAACtB,YAAY6B,YAAY,CAAC,EAAEjB,2BAA2BU,UAAU;IACjE,CAACtB,YAAY8B,SAAS,CAAC,EAAErB,+BAA+Ba,UAAU;IAClE,CAACtB,YAAY+B,QAAQ,CAAC,EAAEtB,+BAA+Ba,UAAU;IACjE,CAACtB,YAAYgC,gBAAgB,CAAC,EAAExB,wBAAwBc,UAAU;IAClE,CAACtB,YAAYiC,UAAU,CAAC,EAAE5B,yBAAyBiB,UAAU;AAC/D,EAAE;AAEF,cAAc,SAAS;AACvB,SAASY,mBAAmB,QAAQ,QAAQ;AAC5C,SAASC,0BAA0B,QAAQ,wBAAwB;AACnE,SAASC,iBAAiB,QAAQ,gBAAgB;AAClD,SAASC,uBAAuB,QAAQ,YAAY"}
+{"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":["HandlerType","cronjobCaveatSpecifications","cronjobEndowmentBuilder","getCronjobCaveatMapper","ethereumProviderEndowmentBuilder","homePageEndowmentBuilder","getKeyringCaveatMapper","keyringCaveatSpecifications","keyringEndowmentBuilder","lifecycleHooksEndowmentBuilder","getNameLookupCaveatMapper","nameLookupCaveatSpecifications","nameLookupEndowmentBuilder","networkAccessEndowmentBuilder","getRpcCaveatMapper","rpcCaveatSpecifications","rpcEndowmentBuilder","getSignatureInsightCaveatMapper","signatureInsightCaveatSpecifications","signatureInsightEndowmentBuilder","getTransactionInsightCaveatMapper","transactionInsightCaveatSpecifications","transactionInsightEndowmentBuilder","webAssemblyEndowmentBuilder","endowmentPermissionBuilders","targetName","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","OnSignature","getRpcCaveatOrigins","getSignatureOriginCaveat","getTransactionOriginCaveat","getChainIdsCaveat","getKeyringCaveatOrigins"],"mappings":"AACA,SAASA,WAAW,QAAQ,wBAAwB;AAGpD,SACEC,2BAA2B,EAC3BC,uBAAuB,EACvBC,sBAAsB,QACjB,YAAY;AACnB,SAASC,gCAAgC,QAAQ,sBAAsB;AACvE,SAASC,wBAAwB,QAAQ,cAAc;AACvD,SACEC,sBAAsB,EACtBC,2BAA2B,EAC3BC,uBAAuB,QAClB,YAAY;AACnB,SAASC,8BAA8B,QAAQ,oBAAoB;AACnE,SACEC,yBAAyB,EACzBC,8BAA8B,EAC9BC,0BAA0B,QACrB,gBAAgB;AACvB,SAASC,6BAA6B,QAAQ,mBAAmB;AACjE,SACEC,kBAAkB,EAClBC,uBAAuB,EACvBC,mBAAmB,QACd,QAAQ;AACf,SACEC,+BAA+B,EAC/BC,oCAAoC,EACpCC,gCAAgC,QAC3B,sBAAsB;AAC7B,SACEC,iCAAiC,EACjCC,sCAAsC,EACtCC,kCAAkC,QAC7B,wBAAwB;AAC/B,SAASC,2BAA2B,QAAQ,iBAAiB;AAE7D,OAAO,MAAMC,8BAA8B;IACzC,CAACX,8BAA8BY,UAAU,CAAC,EAAEZ;IAC5C,CAACS,mCAAmCG,UAAU,CAAC,EAC7CH;IACF,CAACpB,wBAAwBuB,UAAU,CAAC,EAAEvB;IACtC,CAACE,iCAAiCqB,UAAU,CAAC,EAC3CrB;IACF,CAACY,oBAAoBS,UAAU,CAAC,EAAET;IAClC,CAACO,4BAA4BE,UAAU,CAAC,EAAEF;IAC1C,CAACX,2BAA2Ba,UAAU,CAAC,EAAEb;IACzC,CAACH,+BAA+BgB,UAAU,CAAC,EAAEhB;IAC7C,CAACD,wBAAwBiB,UAAU,CAAC,EAAEjB;IACtC,CAACH,yBAAyBoB,UAAU,CAAC,EAAEpB;IACvC,CAACc,iCAAiCM,UAAU,CAAC,EAC3CN;AACJ,EAAW;AAEX,OAAO,MAAMO,gCAAgC;IAC3C,GAAGzB,2BAA2B;IAC9B,GAAGoB,sCAAsC;IACzC,GAAGN,uBAAuB;IAC1B,GAAGJ,8BAA8B;IACjC,GAAGJ,2BAA2B;IAC9B,GAAGW,oCAAoC;AACzC,EAAE;AAEF,OAAO,MAAMS,yBAGT;IACF,CAACzB,wBAAwBuB,UAAU,CAAC,EAAEtB;IACtC,CAACmB,mCAAmCG,UAAU,CAAC,EAC7CL;IACF,CAACJ,oBAAoBS,UAAU,CAAC,EAAEX;IAClC,CAACF,2BAA2Ba,UAAU,CAAC,EAAEf;IACzC,CAACF,wBAAwBiB,UAAU,CAAC,EAAEnB;IACtC,CAACa,iCAAiCM,UAAU,CAAC,EAC3CR;AACJ,EAAE;AAEF,OAAO,MAAMW,oBAAiD;IAC5D,CAAC5B,YAAY6B,YAAY,CAAC,EAAEb,oBAAoBS,UAAU;IAC1D,CAACzB,YAAY8B,aAAa,CAAC,EAAER,mCAAmCG,UAAU;IAC1E,CAACzB,YAAY+B,SAAS,CAAC,EAAE7B,wBAAwBuB,UAAU;IAC3D,CAACzB,YAAYgC,YAAY,CAAC,EAAEpB,2BAA2Ba,UAAU;IACjE,CAACzB,YAAYiC,SAAS,CAAC,EAAExB,+BAA+BgB,UAAU;IAClE,CAACzB,YAAYkC,QAAQ,CAAC,EAAEzB,+BAA+BgB,UAAU;IACjE,CAACzB,YAAYmC,gBAAgB,CAAC,EAAE3B,wBAAwBiB,UAAU;IAClE,CAACzB,YAAYoC,UAAU,CAAC,EAAE/B,yBAAyBoB,UAAU;IAC7D,CAACzB,YAAYqC,WAAW,CAAC,EAAElB,iCAAiCM,UAAU;AACxE,EAAE;AAEF,cAAc,SAAS;AACvB,SAASa,mBAAmB,QAAQ,QAAQ;AAC5C,SAASC,wBAAwB,QAAQ,sBAAsB;AAC/D,SAASC,0BAA0B,QAAQ,wBAAwB;AACnE,SAASC,iBAAiB,QAAQ,gBAAgB;AAClD,SAASC,uBAAuB,QAAQ,YAAY"}

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

@@ -0,0 +1,99 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { rpcErrors } from '@metamask/rpc-errors';
+import { SnapCaveatType } from '@metamask/snaps-utils';
+import { assert, hasProperty, isObject, isPlainObject } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+const permissionName = 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: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            SnapCaveatType.SignatureOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== SnapCaveatType.SignatureOrigin) {
+                throw rpcErrors.invalidParams({
+                    message: `Expected a single "${SnapCaveatType.SignatureOrigin}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export 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 (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {
+        throw rpcErrors.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    assert(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
+}
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */ export function getSignatureInsightCaveatMapper(value) {
+    if (!value || !isObject(value) || isObject(value) && Object.keys(value).length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.SignatureOrigin,
+                value: hasProperty(value, 'allowSignatureOrigin') && value.allowSignatureOrigin
+            }
+        ]
+    };
+}
+/**
+ * Getter function to get the signature origin caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the signature origin caveat from.
+ * @returns The signature origin, or `null` if the permission does not have a
+ * signature origin caveat.
+ */ export function getSignatureOriginCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    assert(permission.caveats.length === 1);
+    assert(permission.caveats[0].type === SnapCaveatType.SignatureOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value ?? null;
+}
+export const signatureInsightCaveatSpecifications = {
+    [SnapCaveatType.SignatureOrigin]: Object.freeze({
+        type: SnapCaveatType.SignatureOrigin,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=signature-insight.js.map

package/dist/esm/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":["PermissionType","SubjectType","rpcErrors","SnapCaveatType","assert","hasProperty","isObject","isPlainObject","SnapEndowments","permissionName","SignatureInsight","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","SignatureOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","signatureInsightEndowmentBuilder","Object","freeze","validateCaveat","caveat","value","getSignatureInsightCaveatMapper","keys","allowSignatureOrigin","getSignatureOriginCaveat","permission","signatureInsightCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,cAAc,QAAQ,wBAAwB;AAEvD,SAASC,MAAM,EAAEC,WAAW,EAAEC,QAAQ,EAAEC,aAAa,QAAQ,kBAAkB;AAE/E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,gBAAgB;AAUtD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACb,eAAec,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,KAAKrB,eAAec,eAAe,EACpD;gBACA,MAAMf,UAAUuB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEvB,eAAec,eAAe,CAAC,SAAS,CAAC;gBAC1E;YACF;QACF;QACAU,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,mCAAmCC,OAAOC,MAAM,CAAC;IAC5DhB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;CAKC,GACD,SAASqB,eAAeC,MAA2B;IACjD,IAAI,CAAC5B,YAAY4B,QAAQ,YAAY,CAAC1B,cAAc0B,SAAS;QAC3D,MAAM/B,UAAUuB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAElB7B,OACE,OAAO8B,UAAU,WACjB;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,gCACdD,KAAW;IAEX,IACE,CAACA,SACD,CAAC5B,SAAS4B,UACT5B,SAAS4B,UAAUJ,OAAOM,IAAI,CAACF,OAAOX,MAAM,KAAK,GAClD;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMrB,eAAec,eAAe;gBACpCiB,OACE7B,YAAY6B,OAAO,2BAClBA,MAAMG,oBAAoB;YAC/B;SACD;IACH;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,yBACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYjB,SAAS;QACxB,OAAO;IACT;IAEAlB,OAAOmC,WAAWjB,OAAO,CAACC,MAAM,KAAK;IACrCnB,OAAOmC,WAAWjB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKrB,eAAec,eAAe;IAEpE,MAAMgB,SAASM,WAAWjB,OAAO,CAAC,EAAE;IAEpC,OAAOW,OAAOC,KAAK,IAAI;AACzB;AAEA,OAAO,MAAMM,uCAGT;IACF,CAACrC,eAAec,eAAe,CAAC,EAAEa,OAAOC,MAAM,CAAC;QAC9CP,MAAMrB,eAAec,eAAe;QACpCI,WAAW,CAACY,SAAgCD,eAAeC;IAC7D;AACF,EAAE"}

package/dist/esm/utils.js

@@ -1,3 +1,5 @@
+import { getErrorMessage } from '@metamask/snaps-sdk';
+import { encodeBase64, getValidatedLocalizationFiles, validateFetchedSnap } from '@metamask/snaps-utils';
 import { Timer } from './snaps/Timer';
 /**
  * Takes two objects and does a Set Difference of them.
@@ -91,5 +93,40 @@ import { Timer } from './snaps/Timer';
     }
     return await Promise.all(files.map(async (filePath)=>location.fetch(filePath)));
 }
+/**
+ * Fetch the Snap manifest, source code, and any other files from the given
+ * location.
+ *
+ * @param snapId - The ID of the Snap to fetch.
+ * @param location - The location of the Snap.
+ * @returns The Snap files and location.
+ * @throws If the Snap files are invalid, or if the Snap could not be fetched.
+ */ export 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 encodeBase64(file);
+        }));
+        const localizationFiles = await getSnapFiles(location, manifest.result.source.locales);
+        const validatedLocalizationFiles = getValidatedLocalizationFiles(localizationFiles);
+        const files = {
+            manifest,
+            sourceCode,
+            svgIcon,
+            auxiliaryFiles,
+            localizationFiles: validatedLocalizationFiles
+        };
+        await validateFetchedSnap(files);
+        return files;
+    } catch (error) {
+        throw new Error(`Failed to fetch snap "${snapId}": ${getErrorMessage(error)}.`);
+    }
+}
 
 //# sourceMappingURL=utils.js.map

package/dist/esm/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":["Timer","setDiff","objectA","objectB","Object","entries","reduce","acc","key","value","delay","ms","result","delayWithTimer","timer","rejectFunc","promise","Promise","resolve","reject","start","undefined","cancel","status","Error","hasTimedOut","Symbol","withTimeout","timerOrMs","delayPromise","race","getSnapFiles","location","files","length","all","map","filePath","fetch"],"mappings":"AACA,SAASA,KAAK,QAAQ,gBAAgB;AAEtC;;;;;;;;;;;;;CAaC,GACD,OAAO,SAASC,QAGdC,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;AAEA;;;;;;;CAOC,GACD,OAAO,SAASG,MACdC,EAAU,EACVC,MAAe;IAEf,OAAOC,eAAe,IAAIb,MAAMW,KAAKC;AACvC;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,eACdC,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;AAEA;;;CAGC,GACD,OAAO,MAAMS,cAAcC,OACzB,wEACA;AAEF;;;;;;;;;;CAUC,GACD,OAAO,eAAeC,YACpBX,OAA8B,EAC9BY,SAAyB;IAEzB,MAAMd,QACJ,OAAOc,cAAc,WAAW,IAAI5B,MAAM4B,aAAaA;IACzD,MAAMC,eAAehB,eAAeC,OAAOW;IAC3C,IAAI;QACF,OAAO,MAAMR,QAAQa,IAAI,CAAC;YAACd;YAASa;SAAa;IACnD,SAAU;QACRA,aAAaP,MAAM;IACrB;AACF;AA+FA;;;;;;CAMC,GACD,OAAO,eAAeS,aACpBC,QAAsB,EACtBC,KAA4B;IAE5B,IAAI,CAACA,SAASA,MAAMC,MAAM,KAAK,GAAG;QAChC,OAAO,EAAE;IACX;IAEA,OAAO,MAAMjB,QAAQkB,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":["getErrorMessage","encodeBase64","getValidatedLocalizationFiles","validateFetchedSnap","Timer","setDiff","objectA","objectB","Object","entries","reduce","acc","key","value","delay","ms","result","delayWithTimer","timer","rejectFunc","promise","Promise","resolve","reject","start","undefined","cancel","status","Error","hasTimedOut","Symbol","withTimeout","timerOrMs","delayPromise","race","getSnapFiles","location","files","length","all","map","filePath","fetch","fetchSnap","snapId","manifest","sourceCode","source","npm","iconPath","svgIcon","auxiliaryFiles","file","data","base64","localizationFiles","locales","validatedLocalizationFiles","error"],"mappings":"AACA,SAASA,eAAe,QAAQ,sBAAsB;AACtD,SACEC,YAAY,EACZC,6BAA6B,EAC7BC,mBAAmB,QACd,wBAAwB;AAG/B,SAASC,KAAK,QAAQ,gBAAgB;AAEtC;;;;;;;;;;;;;CAaC,GACD,OAAO,SAASC,QAGdC,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;AAEA;;;;;;;CAOC,GACD,OAAO,SAASG,MACdC,EAAU,EACVC,MAAe;IAEf,OAAOC,eAAe,IAAIb,MAAMW,KAAKC;AACvC;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,eACdC,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;AAEA;;;CAGC,GACD,OAAO,MAAMS,cAAcC,OACzB,wEACA;AAEF;;;;;;;;;;CAUC,GACD,OAAO,eAAeC,YACpBX,OAA8B,EAC9BY,SAAyB;IAEzB,MAAMd,QACJ,OAAOc,cAAc,WAAW,IAAI5B,MAAM4B,aAAaA;IACzD,MAAMC,eAAehB,eAAeC,OAAOW;IAC3C,IAAI;QACF,OAAO,MAAMR,QAAQa,IAAI,CAAC;YAACd;YAASa;SAAa;IACnD,SAAU;QACRA,aAAaP,MAAM;IACrB;AACF;AA+FA;;;;;;CAMC,GACD,OAAO,eAAeS,aACpBC,QAAsB,EACtBC,KAA4B;IAE5B,IAAI,CAACA,SAASA,MAAMC,MAAM,KAAK,GAAG;QAChC,OAAO,EAAE;IACX;IAEA,OAAO,MAAMjB,QAAQkB,GAAG,CACtBF,MAAMG,GAAG,CAAC,OAAOC,WAAaL,SAASM,KAAK,CAACD;AAEjD;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAeE,UAAUC,MAAc,EAAER,QAAsB;IACpE,IAAI;QACF,MAAMS,WAAW,MAAMT,SAASS,QAAQ;QACxC,MAAMC,aAAa,MAAMV,SAASM,KAAK,CACrCG,SAAS7B,MAAM,CAAC+B,MAAM,CAACX,QAAQ,CAACY,GAAG,CAACP,QAAQ;QAE9C,MAAM,EAAEQ,QAAQ,EAAE,GAAGJ,SAAS7B,MAAM,CAAC+B,MAAM,CAACX,QAAQ,CAACY,GAAG;QACxD,MAAME,UAAUD,WAAW,MAAMb,SAASM,KAAK,CAACO,YAAYxB;QAE5D,MAAM0B,iBAAiB,MAAMhB,aAC3BC,UACAS,SAAS7B,MAAM,CAAC+B,MAAM,CAACV,KAAK;QAG9B,MAAMhB,QAAQkB,GAAG,CACfY,eAAeX,GAAG,CAAC,OAAOY;YACxB,4BAA4B;YAC5B,kDAAkD;YAClDA,KAAKC,IAAI,CAACC,MAAM,GAAG,MAAMrD,aAAamD;QACxC;QAGF,MAAMG,oBAAoB,MAAMpB,aAC9BC,UACAS,SAAS7B,MAAM,CAAC+B,MAAM,CAACS,OAAO;QAGhC,MAAMC,6BACJvD,8BAA8BqD;QAEhC,MAAMlB,QAAQ;YACZQ;YACAC;YACAI;YACAC;YACAI,mBAAmBE;QACrB;QAEA,MAAMtD,oBAAoBkC;QAE1B,OAAOA;IACT,EAAE,OAAOqB,OAAO;QACd,MAAM,IAAI9B,MACR,CAAC,sBAAsB,EAAEgB,OAAO,GAAG,EAAE5C,gBAAgB0D,OAAO,CAAC,CAAC;IAElE;AACF"}

package/dist/types/services/ProxyPostMessageStream.d.ts

@@ -22,9 +22,8 @@ export declare class ProxyPostMessageStream extends BasePostMessageStream {
      * @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 }: ProxyPostMessageStreamArgs);
+    constructor({ stream, jobId }: ProxyPostMessageStreamArgs);
     /**
      * Write data to the underlying stream. This wraps the data in an object with
      * the job ID.

package/dist/types/services/offscreen/OffscreenExecutionService.d.ts

@@ -1,14 +1,11 @@
-import type { ExecutionServiceArgs, Job } from '../AbstractExecutionService';
-import { AbstractExecutionService } from '../AbstractExecutionService';
-import { ProxyPostMessageStream } from '../ProxyPostMessageStream';
+import type { ExecutionServiceArgs } from '../AbstractExecutionService';
+import { ProxyExecutionService } from '../proxy/ProxyExecutionService';
 declare type OffscreenExecutionEnvironmentServiceArgs = {
     documentUrl: URL;
-    frameUrl: URL;
 } & ExecutionServiceArgs;
-export declare class OffscreenExecutionService extends AbstractExecutionService<string> {
+export declare class OffscreenExecutionService extends ProxyExecutionService {
     #private;
     readonly documentUrl: URL;
-    readonly frameUrl: URL;
     /**
      * Create a new offscreen execution service.
      *
@@ -16,20 +13,12 @@ export declare class OffscreenExecutionService extends AbstractExecutionService<
      * @param args.documentUrl - The URL of the offscreen document to use as the
      * execution environment. This must be a URL relative to the location where
      * this is called. This cannot be a public (http(s)) URL.
-     * @param args.frameUrl - The URL of the iframe to load inside the offscreen
-     * document.
      * @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, frameUrl, messenger, setupSnapProvider, }: OffscreenExecutionEnvironmentServiceArgs);
-    /**
-     * Send a termination command to the offscreen document.
-     *
-     * @param job - The job to terminate.
-     */
-    protected terminateJob(job: Job<string>): Promise<void>;
+    constructor({ documentUrl, messenger, setupSnapProvider, }: OffscreenExecutionEnvironmentServiceArgs);
     /**
      * Create a new stream for the specified job. This wraps the runtime stream
      * in a stream specific to the job.
@@ -38,13 +27,7 @@ export declare class OffscreenExecutionService extends AbstractExecutionService<
      */
     protected initEnvStream(jobId: string): Promise<{
         worker: string;
-        stream: ProxyPostMessageStream;
+        stream: import("..").ProxyPostMessageStream;
     }>;
-    /**
-     * Creates the offscreen document to be used as the execution environment.
-     *
-     * If the document already exists, this does nothing.
-     */
-    private createDocument;
 }
 export {};

package/dist/types/services/proxy/ProxyExecutionService.d.ts

@@ -0,0 +1,39 @@
+import type { BasePostMessageStream } from '@metamask/post-message-stream';
+import type { ExecutionServiceArgs, Job } from '../AbstractExecutionService';
+import { AbstractExecutionService } from '../AbstractExecutionService';
+import { ProxyPostMessageStream } from '../ProxyPostMessageStream';
+declare type ProxyExecutionEnvironmentServiceArgs = {
+    stream: BasePostMessageStream;
+} & ExecutionServiceArgs;
+export declare class ProxyExecutionService extends AbstractExecutionService<string> {
+    #private;
+    /**
+     * Create a new proxy execution service.
+     *
+     * @param args - The constructor arguments.
+     * @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.
+     * @param args.stream - The stream to use for communicating with the proxy
+     * executor.
+     */
+    constructor({ stream, messenger, setupSnapProvider, }: ProxyExecutionEnvironmentServiceArgs);
+    /**
+     * Send a termination command to the proxy stream.
+     *
+     * @param job - The job to terminate.
+     */
+    protected terminateJob(job: Job<string>): Promise<void>;
+    /**
+     * Create a new stream for the specified job. This wraps the root stream
+     * in a stream specific to the job.
+     *
+     * @param jobId - The job ID.
+     */
+    protected initEnvStream(jobId: string): Promise<{
+        worker: string;
+        stream: ProxyPostMessageStream;
+    }>;
+}
+export {};

package/dist/types/snaps/SnapController.d.ts

@@ -6,7 +6,7 @@ import type { MaybeUpdateState, TestOrigin } from '@metamask/phishing-controller
 import type { BlockReason } from '@metamask/snaps-registry';
 import type { RequestSnapsParams, RequestSnapsResult, SnapId } from '@metamask/snaps-sdk';
 import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';
-import type { PersistedSnap, Snap, SnapRpcHook, SnapRpcHookArgs, StatusContext, StatusEvents, StatusStates, TruncatedSnap } from '@metamask/snaps-utils';
+import type { PersistedSnap, Snap, SnapManifest, SnapRpcHook, SnapRpcHookArgs, StatusContext, StatusEvents, StatusStates, TruncatedSnap } from '@metamask/snaps-utils';
 import { SnapStatusEvents } from '@metamask/snaps-utils';
 import type { Json, NonEmptyArray } from '@metamask/utils';
 import type { StateMachine } from '@xstate/fsm';
@@ -24,6 +24,16 @@ export declare type PendingRequest = {
     requestId: unknown;
     timer: Timer;
 };
+export interface PreinstalledSnapFile {
+    path: string;
+    value: string | Uint8Array;
+}
+export interface PreinstalledSnap {
+    snapId: SnapId;
+    manifest: SnapManifest;
+    files: PreinstalledSnapFile[];
+    removable?: boolean;
+}
 /**
  * A wrapper type for any data stored during runtime of Snaps.
  * It is not persisted in state as it contains non-serializable data and is only relevant for the
@@ -188,6 +198,20 @@ export declare type SnapBlocked = {
     type: `${typeof controllerName}:snapBlocked`;
     payload: [snapId: string, blockedSnapInfo?: BlockReason];
 };
+/**
+ * Emitted when a snap installation or update is started.
+ */
+export declare type SnapInstallStarted = {
+    type: `${typeof controllerName}:snapInstallStarted`;
+    payload: [snapId: SnapId, origin: string, isUpdate: boolean];
+};
+/**
+ * Emitted when a snap installation or update failed.
+ */
+export declare type SnapInstallFailed = {
+    type: `${typeof controllerName}:snapInstallFailed`;
+    payload: [snapId: SnapId, origin: string, isUpdate: boolean, error: string];
+};
 /**
  * Emitted when a snap has been started after being added and authorized during
  * installation.
@@ -247,7 +271,7 @@ export declare type SnapDisabled = {
     type: `${typeof controllerName}:snapDisabled`;
     payload: [snap: TruncatedSnap];
 };
-export declare type SnapControllerEvents = SnapBlocked | SnapInstalled | SnapUninstalled | SnapStateChange | SnapUnblocked | SnapUpdated | SnapRolledback | SnapTerminated | SnapEnabled | SnapDisabled;
+export declare type SnapControllerEvents = SnapBlocked | SnapInstalled | SnapUninstalled | SnapInstallStarted | SnapInstallFailed | SnapStateChange | SnapUnblocked | SnapUpdated | SnapRolledback | SnapTerminated | SnapEnabled | SnapDisabled;
 export declare type AllowedActions = GetEndowments | GetPermissions | GetSubjects | GetSubjectMetadata | AddSubjectMetadata | HasPermission | HasPermissions | RevokePermissions | RevokeAllPermissions | RevokePermissionForAllSubjects | GrantPermissions | AddApprovalRequest | HandleRpcRequestAction | ExecuteSnapAction | TerminateAllSnapsAction | TerminateSnapAction | UpdateCaveat | UpdateRequestState | GetResult | GetMetadata | Update | ResolveVersion | TestOrigin | MaybeUpdateState;
 export declare type AllowedEvents = ExecutionServiceEvents | SnapInstalled | SnapUpdated;
 declare type SnapControllerMessenger = RestrictedControllerMessenger<typeof controllerName, SnapControllerActions | AllowedActions, SnapControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
@@ -315,11 +339,15 @@ declare type SnapControllerArgs = {
      * Used for test overrides.
      */
     detectSnapLocation?: typeof detectSnapLocation;
+    /**
+     * A list of snaps to be preinstalled into the SnapController state on initialization.
+     */
+    preinstalledSnaps?: PreinstalledSnap[];
 };
 export declare class SnapController extends BaseController<string, SnapControllerState, SnapControllerMessenger> {
     #private;
     private readonly maxRequestTime;
-    constructor({ closeAllConnections, messenger, state, dynamicPermissions, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, maxIdleTime, maxRequestTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, }: SnapControllerArgs);
+    constructor({ closeAllConnections, messenger, state, dynamicPermissions, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, maxIdleTime, maxRequestTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, preinstalledSnaps, }: SnapControllerArgs);
     /**
      * Checks all installed snaps against the block list and
      * blocks/unblocks snaps as appropriate. See {@link SnapController.blockSnap}

package/dist/types/snaps/endowments/enum.d.ts

@@ -1,5 +1,6 @@
 export declare enum SnapEndowments {
     NetworkAccess = "endowment:network-access",
+    SignatureInsight = "endowment:signature-insight",
     TransactionInsight = "endowment:transaction-insight",
     Cronjob = "endowment:cronjob",
     EthereumProvider = "endowment:ethereum-provider",

package/dist/types/snaps/endowments/index.d.ts

@@ -98,8 +98,19 @@ export declare const endowmentPermissionBuilders: {
             allowedCaveats: readonly [string, ...string[]] | null;
         }>;
     }>;
+    readonly "endowment:signature-insight": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.SignatureInsight;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.SignatureInsight;
+            endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+        }>;
+    }>;
 };
 export declare const endowmentCaveatSpecifications: {
+    signatureOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
     keyringOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
     chainIds: import("@metamask/permission-controller").CaveatSpecificationConstraint;
     rpcOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
@@ -110,6 +121,7 @@ export declare const endowmentCaveatMappers: Record<string, (value: Json) => Pic
 export declare const handlerEndowments: Record<HandlerType, string>;
 export * from './enum';
 export { getRpcCaveatOrigins } from './rpc';
+export { getSignatureOriginCaveat } from './signature-insight';
 export { getTransactionOriginCaveat } from './transaction-insight';
 export { getChainIdsCaveat } from './name-lookup';
 export { getKeyringCaveatOrigins } from './keyring';

package/dist/types/snaps/endowments/signature-insight.d.ts

@@ -0,0 +1,39 @@
+import type { PermissionSpecificationBuilder, EndowmentGetterParams, PermissionValidatorConstraint, PermissionConstraint, CaveatSpecificationConstraint } from '@metamask/permission-controller';
+import { PermissionType } from '@metamask/permission-controller';
+import { SnapCaveatType } from '@metamask/snaps-utils';
+import type { Json, NonEmptyArray } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+declare const permissionName = SnapEndowments.SignatureInsight;
+export declare const signatureInsightEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.SignatureInsight;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+        validator: PermissionValidatorConstraint;
+    }>;
+}>;
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+export declare function getSignatureInsightCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Getter function to get the signature origin caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the signature origin caveat from.
+ * @returns The signature origin, or `null` if the permission does not have a
+ * signature origin caveat.
+ */
+export declare function getSignatureOriginCaveat(permission?: PermissionConstraint): boolean | null;
+export declare const signatureInsightCaveatSpecifications: Record<SnapCaveatType.SignatureOrigin, CaveatSpecificationConstraint>;
+export {};