@metamask/snaps-controllers 4.0.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +33 -1
- package/dist/cjs/cronjob/CronjobController.js +3 -3
- package/dist/cjs/cronjob/CronjobController.js.map +1 -1
- package/dist/cjs/index.js +1 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/interface/SnapInterfaceController.js +166 -0
- package/dist/cjs/interface/SnapInterfaceController.js.map +1 -0
- package/dist/cjs/interface/index.js +20 -0
- package/dist/cjs/interface/index.js.map +1 -0
- package/dist/cjs/interface/utils.js +59 -0
- package/dist/cjs/interface/utils.js.map +1 -0
- package/dist/cjs/services/ProxyPostMessageStream.js +3 -10
- package/dist/cjs/services/ProxyPostMessageStream.js.map +1 -1
- package/dist/cjs/services/browser.js +1 -0
- package/dist/cjs/services/browser.js.map +1 -1
- package/dist/cjs/services/index.js +1 -0
- package/dist/cjs/services/index.js.map +1 -1
- package/dist/cjs/services/node/NodeProcessExecutionService.js +13 -1
- package/dist/cjs/services/node/NodeProcessExecutionService.js.map +1 -1
- package/dist/cjs/services/node/NodeThreadExecutionService.js +14 -1
- package/dist/cjs/services/node/NodeThreadExecutionService.js.map +1 -1
- package/dist/cjs/services/offscreen/OffscreenExecutionService.js +36 -99
- package/dist/cjs/services/offscreen/OffscreenExecutionService.js.map +1 -1
- package/dist/cjs/services/proxy/ProxyExecutionService.js +110 -0
- package/dist/cjs/services/proxy/ProxyExecutionService.js.map +1 -0
- package/dist/cjs/services/webview/WebViewExecutionService.js +99 -0
- package/dist/cjs/services/webview/WebViewExecutionService.js.map +1 -0
- package/dist/cjs/services/webview/WebViewMessageStream.js +127 -0
- package/dist/cjs/services/webview/WebViewMessageStream.js.map +1 -0
- package/dist/cjs/services/webview/index.js +20 -0
- package/dist/cjs/services/webview/index.js.map +1 -0
- package/dist/cjs/snaps/SnapController.js +303 -138
- package/dist/cjs/snaps/SnapController.js.map +1 -1
- package/dist/cjs/snaps/constants.js +25 -0
- package/dist/cjs/snaps/constants.js.map +1 -0
- package/dist/cjs/snaps/index.js +0 -2
- package/dist/cjs/snaps/index.js.map +1 -1
- package/dist/cjs/snaps/location/npm.js +13 -2
- package/dist/cjs/snaps/location/npm.js.map +1 -1
- package/dist/cjs/utils.js +32 -0
- package/dist/cjs/utils.js.map +1 -1
- package/dist/esm/cronjob/CronjobController.js +2 -2
- package/dist/esm/cronjob/CronjobController.js.map +1 -1
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/interface/SnapInterfaceController.js +158 -0
- package/dist/esm/interface/SnapInterfaceController.js.map +1 -0
- package/dist/esm/interface/index.js +3 -0
- package/dist/esm/interface/index.js.map +1 -0
- package/dist/esm/interface/utils.js +62 -0
- package/dist/esm/interface/utils.js.map +1 -0
- package/dist/esm/services/ProxyPostMessageStream.js +3 -10
- package/dist/esm/services/ProxyPostMessageStream.js.map +1 -1
- package/dist/esm/services/browser.js +1 -0
- package/dist/esm/services/browser.js.map +1 -1
- package/dist/esm/services/index.js +1 -0
- package/dist/esm/services/index.js.map +1 -1
- package/dist/esm/services/node/NodeProcessExecutionService.js +13 -1
- package/dist/esm/services/node/NodeProcessExecutionService.js.map +1 -1
- package/dist/esm/services/node/NodeThreadExecutionService.js +14 -1
- package/dist/esm/services/node/NodeThreadExecutionService.js.map +1 -1
- package/dist/esm/services/offscreen/OffscreenExecutionService.js +36 -99
- package/dist/esm/services/offscreen/OffscreenExecutionService.js.map +1 -1
- package/dist/esm/services/proxy/ProxyExecutionService.js +100 -0
- package/dist/esm/services/proxy/ProxyExecutionService.js.map +1 -0
- package/dist/esm/services/webview/WebViewExecutionService.js +89 -0
- package/dist/esm/services/webview/WebViewExecutionService.js.map +1 -0
- package/dist/esm/services/webview/WebViewMessageStream.js +119 -0
- package/dist/esm/services/webview/WebViewMessageStream.js.map +1 -0
- package/dist/esm/services/webview/index.js +3 -0
- package/dist/esm/services/webview/index.js.map +1 -0
- package/dist/esm/snaps/SnapController.js +299 -134
- package/dist/esm/snaps/SnapController.js.map +1 -1
- package/dist/esm/snaps/constants.js +16 -0
- package/dist/esm/snaps/constants.js.map +1 -0
- package/dist/esm/snaps/index.js +0 -2
- package/dist/esm/snaps/index.js.map +1 -1
- package/dist/esm/snaps/location/npm.js +13 -2
- package/dist/esm/snaps/location/npm.js.map +1 -1
- package/dist/esm/utils.js +37 -0
- package/dist/esm/utils.js.map +1 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/interface/SnapInterfaceController.d.ts +85 -0
- package/dist/types/interface/index.d.ts +1 -0
- package/dist/types/interface/utils.d.ts +36 -0
- package/dist/types/services/ProxyPostMessageStream.d.ts +1 -2
- package/dist/types/services/browser.d.ts +1 -0
- package/dist/types/services/index.d.ts +1 -0
- package/dist/types/services/offscreen/OffscreenExecutionService.d.ts +5 -22
- package/dist/types/services/proxy/ProxyExecutionService.d.ts +39 -0
- package/dist/types/services/webview/WebViewExecutionService.d.ts +20 -0
- package/dist/types/services/webview/WebViewMessageStream.d.ts +32 -0
- package/dist/types/services/webview/index.d.ts +1 -0
- package/dist/types/snaps/SnapController.d.ts +37 -6
- package/dist/types/snaps/constants.d.ts +1 -0
- package/dist/types/snaps/index.d.ts +0 -2
- package/dist/types/utils.d.ts +119 -0
- package/package.json +14 -14
- package/dist/cjs/snaps/endowments/cronjob.js +0 -100
- package/dist/cjs/snaps/endowments/cronjob.js.map +0 -1
- package/dist/cjs/snaps/endowments/enum.js +0 -25
- package/dist/cjs/snaps/endowments/enum.js.map +0 -1
- package/dist/cjs/snaps/endowments/ethereum-provider.js +0 -43
- package/dist/cjs/snaps/endowments/ethereum-provider.js.map +0 -1
- package/dist/cjs/snaps/endowments/home-page.js +0 -37
- package/dist/cjs/snaps/endowments/home-page.js.map +0 -1
- package/dist/cjs/snaps/endowments/index.js +0 -99
- package/dist/cjs/snaps/endowments/index.js.map +0 -1
- package/dist/cjs/snaps/endowments/keyring.js +0 -100
- package/dist/cjs/snaps/endowments/keyring.js.map +0 -1
- package/dist/cjs/snaps/endowments/lifecycle-hooks.js +0 -37
- package/dist/cjs/snaps/endowments/lifecycle-hooks.js.map +0 -1
- package/dist/cjs/snaps/endowments/name-lookup.js +0 -106
- package/dist/cjs/snaps/endowments/name-lookup.js.map +0 -1
- package/dist/cjs/snaps/endowments/network-access.js +0 -44
- package/dist/cjs/snaps/endowments/network-access.js.map +0 -1
- package/dist/cjs/snaps/endowments/rpc.js +0 -99
- package/dist/cjs/snaps/endowments/rpc.js.map +0 -1
- package/dist/cjs/snaps/endowments/transaction-insight.js +0 -106
- package/dist/cjs/snaps/endowments/transaction-insight.js.map +0 -1
- package/dist/cjs/snaps/endowments/web-assembly.js +0 -42
- package/dist/cjs/snaps/endowments/web-assembly.js.map +0 -1
- package/dist/cjs/snaps/permissions.js +0 -61
- package/dist/cjs/snaps/permissions.js.map +0 -1
- package/dist/esm/snaps/endowments/cronjob.js +0 -99
- package/dist/esm/snaps/endowments/cronjob.js.map +0 -1
- package/dist/esm/snaps/endowments/enum.js +0 -15
- package/dist/esm/snaps/endowments/enum.js.map +0 -1
- package/dist/esm/snaps/endowments/ethereum-provider.js +0 -33
- package/dist/esm/snaps/endowments/ethereum-provider.js.map +0 -1
- package/dist/esm/snaps/endowments/home-page.js +0 -27
- package/dist/esm/snaps/endowments/home-page.js.map +0 -1
- package/dist/esm/snaps/endowments/index.js +0 -54
- package/dist/esm/snaps/endowments/index.js.map +0 -1
- package/dist/esm/snaps/endowments/keyring.js +0 -91
- package/dist/esm/snaps/endowments/keyring.js.map +0 -1
- package/dist/esm/snaps/endowments/lifecycle-hooks.js +0 -27
- package/dist/esm/snaps/endowments/lifecycle-hooks.js.map +0 -1
- package/dist/esm/snaps/endowments/name-lookup.js +0 -98
- package/dist/esm/snaps/endowments/name-lookup.js.map +0 -1
- package/dist/esm/snaps/endowments/network-access.js +0 -34
- package/dist/esm/snaps/endowments/network-access.js.map +0 -1
- package/dist/esm/snaps/endowments/rpc.js +0 -88
- package/dist/esm/snaps/endowments/rpc.js.map +0 -1
- package/dist/esm/snaps/endowments/transaction-insight.js +0 -99
- package/dist/esm/snaps/endowments/transaction-insight.js.map +0 -1
- package/dist/esm/snaps/endowments/web-assembly.js +0 -32
- package/dist/esm/snaps/endowments/web-assembly.js.map +0 -1
- package/dist/esm/snaps/permissions.js +0 -50
- package/dist/esm/snaps/permissions.js.map +0 -1
- package/dist/types/snaps/endowments/cronjob.d.ts +0 -51
- package/dist/types/snaps/endowments/enum.d.ts +0 -12
- package/dist/types/snaps/endowments/ethereum-provider.d.ts +0 -14
- package/dist/types/snaps/endowments/home-page.d.ts +0 -15
- package/dist/types/snaps/endowments/index.d.ts +0 -115
- package/dist/types/snaps/endowments/keyring.d.ts +0 -39
- package/dist/types/snaps/endowments/lifecycle-hooks.d.ts +0 -15
- package/dist/types/snaps/endowments/name-lookup.d.ts +0 -38
- package/dist/types/snaps/endowments/network-access.d.ts +0 -14
- package/dist/types/snaps/endowments/rpc.d.ts +0 -38
- package/dist/types/snaps/endowments/transaction-insight.d.ts +0 -39
- package/dist/types/snaps/endowments/web-assembly.d.ts +0 -14
- package/dist/types/snaps/permissions.d.ts +0 -16
|
@@ -1 +0,0 @@
|
|
|
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"}
|
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
function _export(target, all) {
|
|
6
|
-
for(var name in all)Object.defineProperty(target, name, {
|
|
7
|
-
enumerable: true,
|
|
8
|
-
get: all[name]
|
|
9
|
-
});
|
|
10
|
-
}
|
|
11
|
-
_export(exports, {
|
|
12
|
-
keyringEndowmentBuilder: function() {
|
|
13
|
-
return keyringEndowmentBuilder;
|
|
14
|
-
},
|
|
15
|
-
getKeyringCaveatMapper: function() {
|
|
16
|
-
return getKeyringCaveatMapper;
|
|
17
|
-
},
|
|
18
|
-
getKeyringCaveatOrigins: function() {
|
|
19
|
-
return getKeyringCaveatOrigins;
|
|
20
|
-
},
|
|
21
|
-
keyringCaveatSpecifications: function() {
|
|
22
|
-
return keyringCaveatSpecifications;
|
|
23
|
-
}
|
|
24
|
-
});
|
|
25
|
-
const _permissioncontroller = require("@metamask/permission-controller");
|
|
26
|
-
const _rpcerrors = require("@metamask/rpc-errors");
|
|
27
|
-
const _snapsutils = require("@metamask/snaps-utils");
|
|
28
|
-
const _utils = require("@metamask/utils");
|
|
29
|
-
const _enum = require("./enum");
|
|
30
|
-
const permissionName = _enum.SnapEndowments.Keyring;
|
|
31
|
-
/**
|
|
32
|
-
* `endowment:keyring` returns nothing; it is intended to be used as a flag
|
|
33
|
-
* by the client to detect whether the snap has keyring capabilities.
|
|
34
|
-
*
|
|
35
|
-
* @param _builderOptions - Optional specification builder options.
|
|
36
|
-
* @returns The specification for the keyring endowment.
|
|
37
|
-
*/ const specificationBuilder = (_builderOptions)=>{
|
|
38
|
-
return {
|
|
39
|
-
permissionType: _permissioncontroller.PermissionType.Endowment,
|
|
40
|
-
targetName: permissionName,
|
|
41
|
-
allowedCaveats: [
|
|
42
|
-
_snapsutils.SnapCaveatType.KeyringOrigin
|
|
43
|
-
],
|
|
44
|
-
endowmentGetter: (_getterOptions)=>undefined,
|
|
45
|
-
validator: ({ caveats })=>{
|
|
46
|
-
if (caveats?.length !== 1 || caveats[0].type !== _snapsutils.SnapCaveatType.KeyringOrigin) {
|
|
47
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
48
|
-
message: `Expected a single "${_snapsutils.SnapCaveatType.KeyringOrigin}" caveat.`
|
|
49
|
-
});
|
|
50
|
-
}
|
|
51
|
-
},
|
|
52
|
-
subjectTypes: [
|
|
53
|
-
_permissioncontroller.SubjectType.Snap
|
|
54
|
-
]
|
|
55
|
-
};
|
|
56
|
-
};
|
|
57
|
-
const keyringEndowmentBuilder = Object.freeze({
|
|
58
|
-
targetName: permissionName,
|
|
59
|
-
specificationBuilder
|
|
60
|
-
});
|
|
61
|
-
/**
|
|
62
|
-
* Validate the value of a caveat. This does not validate the type of the
|
|
63
|
-
* caveat itself, only the value of the caveat.
|
|
64
|
-
*
|
|
65
|
-
* @param caveat - The caveat to validate.
|
|
66
|
-
* @throws If the caveat value is invalid.
|
|
67
|
-
*/ function validateCaveatOrigins(caveat) {
|
|
68
|
-
if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
|
|
69
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
70
|
-
message: 'Invalid keyring origins: Expected a plain object.'
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
const { value } = caveat;
|
|
74
|
-
(0, _snapsutils.assertIsKeyringOrigins)(value, _rpcerrors.rpcErrors.invalidParams);
|
|
75
|
-
}
|
|
76
|
-
function getKeyringCaveatMapper(value) {
|
|
77
|
-
return {
|
|
78
|
-
caveats: [
|
|
79
|
-
{
|
|
80
|
-
type: _snapsutils.SnapCaveatType.KeyringOrigin,
|
|
81
|
-
value
|
|
82
|
-
}
|
|
83
|
-
]
|
|
84
|
-
};
|
|
85
|
-
}
|
|
86
|
-
function getKeyringCaveatOrigins(permission) {
|
|
87
|
-
(0, _utils.assert)(permission?.caveats);
|
|
88
|
-
(0, _utils.assert)(permission.caveats.length === 1);
|
|
89
|
-
(0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.KeyringOrigin);
|
|
90
|
-
const caveat = permission.caveats[0];
|
|
91
|
-
return caveat.value;
|
|
92
|
-
}
|
|
93
|
-
const keyringCaveatSpecifications = {
|
|
94
|
-
[_snapsutils.SnapCaveatType.KeyringOrigin]: Object.freeze({
|
|
95
|
-
type: _snapsutils.SnapCaveatType.KeyringOrigin,
|
|
96
|
-
validator: (caveat)=>validateCaveatOrigins(caveat)
|
|
97
|
-
})
|
|
98
|
-
};
|
|
99
|
-
|
|
100
|
-
//# sourceMappingURL=keyring.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/snaps/endowments/keyring.ts"],"sourcesContent":["import type {\n Caveat,\n CaveatSpecificationConstraint,\n EndowmentGetterParams,\n PermissionConstraint,\n PermissionSpecificationBuilder,\n PermissionValidatorConstraint,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { KeyringOrigins } from '@metamask/snaps-utils';\nimport { assertIsKeyringOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Keyring;\n\ntype KeyringEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof permissionName;\n endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n validator: PermissionValidatorConstraint;\n subjectTypes: readonly SubjectType[];\n}>;\n\n/**\n * `endowment:keyring` returns nothing; it is intended to be used as a flag\n * by the client to detect whether the snap has keyring capabilities.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the keyring endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n KeyringEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: [SnapCaveatType.KeyringOrigin],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n validator: ({ caveats }) => {\n if (\n caveats?.length !== 1 ||\n caveats[0].type !== SnapCaveatType.KeyringOrigin\n ) {\n throw rpcErrors.invalidParams({\n message: `Expected a single \"${SnapCaveatType.KeyringOrigin}\" caveat.`,\n });\n }\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const keyringEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n throw rpcErrors.invalidParams({\n message: 'Invalid keyring origins: Expected a plain object.',\n });\n }\n\n const { value } = caveat;\n assertIsKeyringOrigins(value, rpcErrors.invalidParams);\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 * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getKeyringCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n return {\n caveats: [\n {\n type: SnapCaveatType.KeyringOrigin,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the {@link KeyringOrigins} caveat value from a\n * permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link KeyringOrigins}\n * caveat.\n */\nexport function getKeyringCaveatOrigins(\n permission?: PermissionConstraint,\n): KeyringOrigins | null {\n assert(permission?.caveats);\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);\n\n const caveat = permission.caveats[0] as Caveat<string, KeyringOrigins>;\n return caveat.value;\n}\n\nexport const keyringCaveatSpecifications: Record<\n SnapCaveatType.KeyringOrigin,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.KeyringOrigin]: Object.freeze({\n type: SnapCaveatType.KeyringOrigin,\n validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n }),\n};\n"],"names":["keyringEndowmentBuilder","getKeyringCaveatMapper","getKeyringCaveatOrigins","keyringCaveatSpecifications","permissionName","SnapEndowments","Keyring","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","KeyringOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpcErrors","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveatOrigins","caveat","hasProperty","isPlainObject","value","assertIsKeyringOrigins","permission","assert"],"mappings":";;;;;;;;;;;IA4DaA,uBAAuB;eAAvBA;;IA+BGC,sBAAsB;eAAtBA;;IAsBAC,uBAAuB;eAAvBA;;IAWHC,2BAA2B;eAA3BA;;;sCAnH+B;2BAClB;4BAE6B;uBAEJ;sBAEpB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,OAAO;AAW7C;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,aAAa;SAAC;QAC9CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,aAAa,EAChD;gBACA,MAAMQ,oBAAS,CAACC,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEX,0BAAc,CAACC,aAAa,CAAC,SAAS,CAAC;gBACxE;YACF;QACF;QACAW,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM5B,0BAA0B6B,OAAOC,MAAM,CAAC;IACnDlB,YAAYR;IACZG;AACF;AAEA;;;;;;CAMC,GACD,SAASwB,sBAAsBC,MAA2B;IACxD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,OAAOG,KAAK,GAAG;QACjE,MAAMZ,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEU,KAAK,EAAE,GAAGH;IAClBI,IAAAA,kCAAsB,EAACD,OAAOZ,oBAAS,CAACC,aAAa;AACvD;AAUO,SAASvB,uBACdkC,KAAW;IAEX,OAAO;QACLf,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,aAAa;gBAClCoB;YACF;SACD;IACH;AACF;AAWO,SAASjC,wBACdmC,UAAiC;IAEjCC,IAAAA,aAAM,EAACD,YAAYjB;IACnBkB,IAAAA,aAAM,EAACD,WAAWjB,OAAO,CAACC,MAAM,KAAK;IACrCiB,IAAAA,aAAM,EAACD,WAAWjB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,aAAa;IAElE,MAAMiB,SAASK,WAAWjB,OAAO,CAAC,EAAE;IACpC,OAAOY,OAAOG,KAAK;AACrB;AAEO,MAAMhC,8BAGT;IACF,CAACW,0BAAc,CAACC,aAAa,CAAC,EAAEc,OAAOC,MAAM,CAAC;QAC5CR,MAAMR,0BAAc,CAACC,aAAa;QAClCI,WAAW,CAACa,SAAgCD,sBAAsBC;IACpE;AACF"}
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
Object.defineProperty(exports, "lifecycleHooksEndowmentBuilder", {
|
|
6
|
-
enumerable: true,
|
|
7
|
-
get: function() {
|
|
8
|
-
return lifecycleHooksEndowmentBuilder;
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
const _permissioncontroller = require("@metamask/permission-controller");
|
|
12
|
-
const _enum = require("./enum");
|
|
13
|
-
const permissionName = _enum.SnapEndowments.LifecycleHooks;
|
|
14
|
-
/**
|
|
15
|
-
* `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a
|
|
16
|
-
* flag by the snap controller to detect whether the snap has the capability to
|
|
17
|
-
* use lifecycle hooks.
|
|
18
|
-
*
|
|
19
|
-
* @param _builderOptions - Optional specification builder options.
|
|
20
|
-
* @returns The specification for the `lifecycle-hooks` endowment.
|
|
21
|
-
*/ const specificationBuilder = (_builderOptions)=>{
|
|
22
|
-
return {
|
|
23
|
-
permissionType: _permissioncontroller.PermissionType.Endowment,
|
|
24
|
-
targetName: permissionName,
|
|
25
|
-
allowedCaveats: null,
|
|
26
|
-
endowmentGetter: (_getterOptions)=>undefined,
|
|
27
|
-
subjectTypes: [
|
|
28
|
-
_permissioncontroller.SubjectType.Snap
|
|
29
|
-
]
|
|
30
|
-
};
|
|
31
|
-
};
|
|
32
|
-
const lifecycleHooksEndowmentBuilder = Object.freeze({
|
|
33
|
-
targetName: permissionName,
|
|
34
|
-
specificationBuilder
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
//# sourceMappingURL=lifecycle-hooks.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/snaps/endowments/lifecycle-hooks.ts"],"sourcesContent":["import type {\n PermissionSpecificationBuilder,\n EndowmentGetterParams,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport type { NonEmptyArray } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.LifecycleHooks;\n\ntype LifecycleHooksEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof permissionName;\n endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a\n * flag by the snap controller to detect whether the snap has the capability to\n * use lifecycle hooks.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the `lifecycle-hooks` endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n LifecycleHooksEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: null,\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const lifecycleHooksEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\n"],"names":["lifecycleHooksEndowmentBuilder","permissionName","SnapEndowments","LifecycleHooks","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BAyCaA;;;eAAAA;;;sCApC+B;sBAGb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,cAAc;AASpD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMhB,iCAAiCiB,OAAOC,MAAM,CAAC;IAC1DT,YAAYR;IACZG;AACF"}
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
function _export(target, all) {
|
|
6
|
-
for(var name in all)Object.defineProperty(target, name, {
|
|
7
|
-
enumerable: true,
|
|
8
|
-
get: all[name]
|
|
9
|
-
});
|
|
10
|
-
}
|
|
11
|
-
_export(exports, {
|
|
12
|
-
nameLookupEndowmentBuilder: function() {
|
|
13
|
-
return nameLookupEndowmentBuilder;
|
|
14
|
-
},
|
|
15
|
-
getNameLookupCaveatMapper: function() {
|
|
16
|
-
return getNameLookupCaveatMapper;
|
|
17
|
-
},
|
|
18
|
-
getChainIdsCaveat: function() {
|
|
19
|
-
return getChainIdsCaveat;
|
|
20
|
-
},
|
|
21
|
-
nameLookupCaveatSpecifications: function() {
|
|
22
|
-
return nameLookupCaveatSpecifications;
|
|
23
|
-
}
|
|
24
|
-
});
|
|
25
|
-
const _permissioncontroller = require("@metamask/permission-controller");
|
|
26
|
-
const _rpcerrors = require("@metamask/rpc-errors");
|
|
27
|
-
const _snapsutils = require("@metamask/snaps-utils");
|
|
28
|
-
const _utils = require("@metamask/utils");
|
|
29
|
-
const _enum = require("./enum");
|
|
30
|
-
const permissionName = _enum.SnapEndowments.NameLookup;
|
|
31
|
-
/**
|
|
32
|
-
* `endowment:name-lookup` returns nothing; it is intended to be used as a flag
|
|
33
|
-
* by the extension to detect whether the snap has the capability to resolve a domain/address.
|
|
34
|
-
*
|
|
35
|
-
* @param _builderOptions - Optional specification builder options.
|
|
36
|
-
* @returns The specification for the name-lookup endowment.
|
|
37
|
-
*/ const specificationBuilder = (_builderOptions)=>{
|
|
38
|
-
return {
|
|
39
|
-
permissionType: _permissioncontroller.PermissionType.Endowment,
|
|
40
|
-
targetName: permissionName,
|
|
41
|
-
allowedCaveats: [
|
|
42
|
-
_snapsutils.SnapCaveatType.ChainIds
|
|
43
|
-
],
|
|
44
|
-
endowmentGetter: (_getterOptions)=>undefined,
|
|
45
|
-
validator: ({ caveats })=>{
|
|
46
|
-
if (!caveats || caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== _snapsutils.SnapCaveatType.ChainIds) {
|
|
47
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
48
|
-
message: `Expected a single "${_snapsutils.SnapCaveatType.ChainIds}" caveat.`
|
|
49
|
-
});
|
|
50
|
-
}
|
|
51
|
-
},
|
|
52
|
-
subjectTypes: [
|
|
53
|
-
_permissioncontroller.SubjectType.Snap
|
|
54
|
-
]
|
|
55
|
-
};
|
|
56
|
-
};
|
|
57
|
-
const nameLookupEndowmentBuilder = Object.freeze({
|
|
58
|
-
targetName: permissionName,
|
|
59
|
-
specificationBuilder
|
|
60
|
-
});
|
|
61
|
-
/**
|
|
62
|
-
* Validates the type of the caveat value.
|
|
63
|
-
*
|
|
64
|
-
* @param caveat - The caveat to validate.
|
|
65
|
-
* @throws If the caveat value is invalid.
|
|
66
|
-
*/ function validateCaveat(caveat) {
|
|
67
|
-
if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat)) {
|
|
68
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
69
|
-
message: 'Expected a plain object.'
|
|
70
|
-
});
|
|
71
|
-
}
|
|
72
|
-
const { value } = caveat;
|
|
73
|
-
(0, _utils.assert)(Array.isArray(value) && value.every((val)=>(0, _snapsutils.isChainId)(val)), 'Expected caveat value to have type "string array"');
|
|
74
|
-
}
|
|
75
|
-
function getNameLookupCaveatMapper(value) {
|
|
76
|
-
if (!value || !Array.isArray(value) || Array.isArray(value) && value.length === 0) {
|
|
77
|
-
return {
|
|
78
|
-
caveats: null
|
|
79
|
-
};
|
|
80
|
-
}
|
|
81
|
-
return {
|
|
82
|
-
caveats: [
|
|
83
|
-
{
|
|
84
|
-
type: _snapsutils.SnapCaveatType.ChainIds,
|
|
85
|
-
value
|
|
86
|
-
}
|
|
87
|
-
]
|
|
88
|
-
};
|
|
89
|
-
}
|
|
90
|
-
function getChainIdsCaveat(permission) {
|
|
91
|
-
if (!permission?.caveats) {
|
|
92
|
-
return null;
|
|
93
|
-
}
|
|
94
|
-
(0, _utils.assert)(permission.caveats.length === 1);
|
|
95
|
-
(0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.ChainIds);
|
|
96
|
-
const caveat = permission.caveats[0];
|
|
97
|
-
return caveat.value ?? null;
|
|
98
|
-
}
|
|
99
|
-
const nameLookupCaveatSpecifications = {
|
|
100
|
-
[_snapsutils.SnapCaveatType.ChainIds]: Object.freeze({
|
|
101
|
-
type: _snapsutils.SnapCaveatType.ChainIds,
|
|
102
|
-
validator: (caveat)=>validateCaveat(caveat)
|
|
103
|
-
})
|
|
104
|
-
};
|
|
105
|
-
|
|
106
|
-
//# sourceMappingURL=name-lookup.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/snaps/endowments/name-lookup.ts"],"sourcesContent":["import type {\n EndowmentGetterParams,\n PermissionSpecificationBuilder,\n PermissionValidatorConstraint,\n ValidPermissionSpecification,\n Caveat,\n CaveatSpecificationConstraint,\n PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { SnapCaveatType, isChainId } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.NameLookup;\n\ntype NameLookupEndowmentSpecification = 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:name-lookup` returns nothing; it is intended to be used as a flag\n * by the extension to detect whether the snap has the capability to resolve a domain/address.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the name-lookup endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n NameLookupEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: [SnapCaveatType.ChainIds],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n validator: ({ caveats }) => {\n if (\n !caveats ||\n (caveats !== null && caveats?.length > 1) ||\n (caveats?.length === 1 && caveats[0].type !== SnapCaveatType.ChainIds)\n ) {\n throw rpcErrors.invalidParams({\n message: `Expected a single \"${SnapCaveatType.ChainIds}\" caveat.`,\n });\n }\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const nameLookupEndowmentBuilder = 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 Array.isArray(value) && value.every((val) => isChainId(val)),\n 'Expected caveat value to have type \"string array\"',\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 * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getNameLookupCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n if (\n !value ||\n !Array.isArray(value) ||\n (Array.isArray(value) && value.length === 0)\n ) {\n return { caveats: null };\n }\n return {\n caveats: [\n {\n type: SnapCaveatType.ChainIds,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the chainIds 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 `chainIds` caveat from.\n * @returns An array of `chainIds` that the snap supports.\n */\nexport function getChainIdsCaveat(\n permission?: PermissionConstraint,\n): string[] | null {\n if (!permission?.caveats) {\n return null;\n }\n\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.ChainIds);\n\n const caveat = permission.caveats[0] as Caveat<string, string[]>;\n\n return caveat.value ?? null;\n}\n\nexport const nameLookupCaveatSpecifications: Record<\n SnapCaveatType.ChainIds,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.ChainIds]: Object.freeze({\n type: SnapCaveatType.ChainIds,\n validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n }),\n};\n"],"names":["nameLookupEndowmentBuilder","getNameLookupCaveatMapper","getChainIdsCaveat","nameLookupCaveatSpecifications","permissionName","SnapEndowments","NameLookup","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","ChainIds","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpcErrors","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveat","caveat","hasProperty","isPlainObject","value","assert","Array","isArray","every","val","isChainId","permission"],"mappings":";;;;;;;;;;;IA2DaA,0BAA0B;eAA1BA;;IAkCGC,yBAAyB;eAAzBA;;IA8BAC,iBAAiB;eAAjBA;;IAeHC,8BAA8B;eAA9BA;;;sCAjI+B;2BAClB;4BACgB;uBAES;sBAEpB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,UAAU;AAUhD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,QAAQ;SAAC;QACzCC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACE,CAACA,WACAA,YAAY,QAAQA,SAASC,SAAS,KACtCD,SAASC,WAAW,KAAKD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,QAAQ,EACrE;gBACA,MAAMQ,oBAAS,CAACC,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEX,0BAAc,CAACC,QAAQ,CAAC,SAAS,CAAC;gBACnE;YACF;QACF;QACAW,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM5B,6BAA6B6B,OAAOC,MAAM,CAAC;IACtDlB,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,EACJC,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAAC,CAACC,MAAQC,IAAAA,qBAAS,EAACD,OACvD;AAEJ;AAUO,SAASvC,0BACdkC,KAAW;IAEX,IACE,CAACA,SACD,CAACE,MAAMC,OAAO,CAACH,UACdE,MAAMC,OAAO,CAACH,UAAUA,MAAMd,MAAM,KAAK,GAC1C;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,QAAQ;gBAC7BoB;YACF;SACD;IACH;AACF;AAYO,SAASjC,kBACdwC,UAAiC;IAEjC,IAAI,CAACA,YAAYtB,SAAS;QACxB,OAAO;IACT;IAEAgB,IAAAA,aAAM,EAACM,WAAWtB,OAAO,CAACC,MAAM,KAAK;IACrCe,IAAAA,aAAM,EAACM,WAAWtB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,QAAQ;IAE7D,MAAMiB,SAASU,WAAWtB,OAAO,CAAC,EAAE;IAEpC,OAAOY,OAAOG,KAAK,IAAI;AACzB;AAEO,MAAMhC,iCAGT;IACF,CAACW,0BAAc,CAACC,QAAQ,CAAC,EAAEc,OAAOC,MAAM,CAAC;QACvCR,MAAMR,0BAAc,CAACC,QAAQ;QAC7BI,WAAW,CAACa,SAAgCD,eAAeC;IAC7D;AACF"}
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
Object.defineProperty(exports, "networkAccessEndowmentBuilder", {
|
|
6
|
-
enumerable: true,
|
|
7
|
-
get: function() {
|
|
8
|
-
return networkAccessEndowmentBuilder;
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
const _permissioncontroller = require("@metamask/permission-controller");
|
|
12
|
-
const _enum = require("./enum");
|
|
13
|
-
const permissionName = _enum.SnapEndowments.NetworkAccess;
|
|
14
|
-
/**
|
|
15
|
-
* `endowment:network-access` returns the name of global browser API(s) that
|
|
16
|
-
* enable network access. This is intended to populate the endowments of the
|
|
17
|
-
* SES Compartment in which a Snap executes.
|
|
18
|
-
*
|
|
19
|
-
* @param _builderOptions - Optional specification builder options.
|
|
20
|
-
* @returns The specification for the network endowment.
|
|
21
|
-
*/ const specificationBuilder = (_builderOptions)=>{
|
|
22
|
-
return {
|
|
23
|
-
permissionType: _permissioncontroller.PermissionType.Endowment,
|
|
24
|
-
targetName: permissionName,
|
|
25
|
-
allowedCaveats: null,
|
|
26
|
-
endowmentGetter: (_getterOptions)=>{
|
|
27
|
-
return [
|
|
28
|
-
'fetch',
|
|
29
|
-
'Request',
|
|
30
|
-
'Headers',
|
|
31
|
-
'Response'
|
|
32
|
-
];
|
|
33
|
-
},
|
|
34
|
-
subjectTypes: [
|
|
35
|
-
_permissioncontroller.SubjectType.Snap
|
|
36
|
-
]
|
|
37
|
-
};
|
|
38
|
-
};
|
|
39
|
-
const networkAccessEndowmentBuilder = Object.freeze({
|
|
40
|
-
targetName: permissionName,
|
|
41
|
-
specificationBuilder
|
|
42
|
-
});
|
|
43
|
-
|
|
44
|
-
//# sourceMappingURL=network-access.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/snaps/endowments/network-access.ts"],"sourcesContent":["import type {\n EndowmentGetterParams,\n PermissionSpecificationBuilder,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.NetworkAccess;\n\ntype NetworkAccessEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof permissionName;\n endowmentGetter: (\n _options?: any,\n ) => ['fetch', 'Request', 'Headers', 'Response'];\n allowedCaveats: null;\n}>;\n\n/**\n * `endowment:network-access` returns the name of global browser API(s) that\n * enable network access. This is intended to populate the endowments of the\n * SES Compartment in which a Snap executes.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the network endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n NetworkAccessEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: null,\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n return ['fetch', 'Request', 'Headers', 'Response'];\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const networkAccessEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\n"],"names":["networkAccessEndowmentBuilder","permissionName","SnapEndowments","NetworkAccess","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BA4CaA;;;eAAAA;;;sCAvC+B;sBAEb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,aAAa;AAWnD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;gBAAS;gBAAW;gBAAW;aAAW;QACpD;QACAC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMf,gCAAgCgB,OAAOC,MAAM,CAAC;IACzDR,YAAYR;IACZG;AACF"}
|
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
function _export(target, all) {
|
|
6
|
-
for(var name in all)Object.defineProperty(target, name, {
|
|
7
|
-
enumerable: true,
|
|
8
|
-
get: all[name]
|
|
9
|
-
});
|
|
10
|
-
}
|
|
11
|
-
_export(exports, {
|
|
12
|
-
rpcEndowmentBuilder: function() {
|
|
13
|
-
return rpcEndowmentBuilder;
|
|
14
|
-
},
|
|
15
|
-
getRpcCaveatMapper: function() {
|
|
16
|
-
return getRpcCaveatMapper;
|
|
17
|
-
},
|
|
18
|
-
getRpcCaveatOrigins: function() {
|
|
19
|
-
return getRpcCaveatOrigins;
|
|
20
|
-
},
|
|
21
|
-
rpcCaveatSpecifications: function() {
|
|
22
|
-
return rpcCaveatSpecifications;
|
|
23
|
-
}
|
|
24
|
-
});
|
|
25
|
-
const _permissioncontroller = require("@metamask/permission-controller");
|
|
26
|
-
const _rpcerrors = require("@metamask/rpc-errors");
|
|
27
|
-
const _snapsutils = require("@metamask/snaps-utils");
|
|
28
|
-
const _utils = require("@metamask/utils");
|
|
29
|
-
const _enum = require("./enum");
|
|
30
|
-
const targetName = _enum.SnapEndowments.Rpc;
|
|
31
|
-
/**
|
|
32
|
-
* The specification builder for the JSON-RPC endowment permission.
|
|
33
|
-
*
|
|
34
|
-
* @param _builderOptions - Optional specification builder options.
|
|
35
|
-
* @returns The specification for the JSON-RPC endowment permission.
|
|
36
|
-
*/ const specificationBuilder = (_builderOptions)=>{
|
|
37
|
-
return {
|
|
38
|
-
permissionType: _permissioncontroller.PermissionType.Endowment,
|
|
39
|
-
targetName,
|
|
40
|
-
allowedCaveats: [
|
|
41
|
-
_snapsutils.SnapCaveatType.RpcOrigin
|
|
42
|
-
],
|
|
43
|
-
endowmentGetter: (_getterOptions)=>undefined,
|
|
44
|
-
validator: ({ caveats })=>{
|
|
45
|
-
if (caveats?.length !== 1 || caveats[0].type !== _snapsutils.SnapCaveatType.RpcOrigin) {
|
|
46
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
47
|
-
message: `Expected a single "${_snapsutils.SnapCaveatType.RpcOrigin}" caveat.`
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
},
|
|
51
|
-
subjectTypes: [
|
|
52
|
-
_permissioncontroller.SubjectType.Snap
|
|
53
|
-
]
|
|
54
|
-
};
|
|
55
|
-
};
|
|
56
|
-
const rpcEndowmentBuilder = Object.freeze({
|
|
57
|
-
targetName,
|
|
58
|
-
specificationBuilder
|
|
59
|
-
});
|
|
60
|
-
/**
|
|
61
|
-
* Validate the value of a caveat. This does not validate the type of the
|
|
62
|
-
* caveat itself, only the value of the caveat.
|
|
63
|
-
*
|
|
64
|
-
* @param caveat - The caveat to validate.
|
|
65
|
-
* @throws If the caveat value is invalid.
|
|
66
|
-
*/ function validateCaveatOrigins(caveat) {
|
|
67
|
-
if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
|
|
68
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
69
|
-
message: 'Invalid JSON-RPC origins: Expected a plain object.'
|
|
70
|
-
});
|
|
71
|
-
}
|
|
72
|
-
const { value } = caveat;
|
|
73
|
-
(0, _snapsutils.assertIsRpcOrigins)(value, _rpcerrors.rpcErrors.invalidParams);
|
|
74
|
-
}
|
|
75
|
-
function getRpcCaveatMapper(value) {
|
|
76
|
-
return {
|
|
77
|
-
caveats: [
|
|
78
|
-
{
|
|
79
|
-
type: _snapsutils.SnapCaveatType.RpcOrigin,
|
|
80
|
-
value
|
|
81
|
-
}
|
|
82
|
-
]
|
|
83
|
-
};
|
|
84
|
-
}
|
|
85
|
-
function getRpcCaveatOrigins(permission) {
|
|
86
|
-
(0, _utils.assert)(permission?.caveats);
|
|
87
|
-
(0, _utils.assert)(permission.caveats.length === 1);
|
|
88
|
-
(0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.RpcOrigin);
|
|
89
|
-
const caveat = permission.caveats[0];
|
|
90
|
-
return caveat.value;
|
|
91
|
-
}
|
|
92
|
-
const rpcCaveatSpecifications = {
|
|
93
|
-
[_snapsutils.SnapCaveatType.RpcOrigin]: Object.freeze({
|
|
94
|
-
type: _snapsutils.SnapCaveatType.RpcOrigin,
|
|
95
|
-
validator: (caveat)=>validateCaveatOrigins(caveat)
|
|
96
|
-
})
|
|
97
|
-
};
|
|
98
|
-
|
|
99
|
-
//# sourceMappingURL=rpc.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/snaps/endowments/rpc.ts"],"sourcesContent":["import type {\n Caveat,\n CaveatSpecificationConstraint,\n EndowmentGetterParams,\n PermissionConstraint,\n PermissionSpecificationBuilder,\n PermissionValidatorConstraint,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { RpcOrigins } from '@metamask/snaps-utils';\nimport { assertIsRpcOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { hasProperty, isPlainObject, assert } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst targetName = SnapEndowments.Rpc;\n\ntype RpcSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof targetName;\n endowmentGetter: (_options?: any) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n validator: PermissionValidatorConstraint;\n subjectTypes: readonly SubjectType[];\n}>;\n\ntype RpcSpecificationBuilderOptions = {\n // Empty for now.\n};\n\n/**\n * The specification builder for the JSON-RPC endowment permission.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the JSON-RPC endowment permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n RpcSpecificationBuilderOptions,\n RpcSpecification\n> = (_builderOptions?: any): RpcSpecification => {\n return {\n permissionType: PermissionType.Endowment,\n targetName,\n allowedCaveats: [SnapCaveatType.RpcOrigin],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n validator: ({ caveats }) => {\n if (\n caveats?.length !== 1 ||\n caveats[0].type !== SnapCaveatType.RpcOrigin\n ) {\n throw rpcErrors.invalidParams({\n message: `Expected a single \"${SnapCaveatType.RpcOrigin}\" caveat.`,\n });\n }\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const rpcEndowmentBuilder = Object.freeze({\n targetName,\n specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n throw rpcErrors.invalidParams({\n message: 'Invalid JSON-RPC origins: Expected a plain object.',\n });\n }\n\n const { value } = caveat;\n assertIsRpcOrigins(value, rpcErrors.invalidParams);\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 * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getRpcCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n return {\n caveats: [\n {\n type: SnapCaveatType.RpcOrigin,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the {@link RpcOrigins} caveat value from a permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link RpcOrigins} caveat.\n */\nexport function getRpcCaveatOrigins(\n permission?: PermissionConstraint,\n): RpcOrigins | null {\n assert(permission?.caveats);\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.RpcOrigin);\n\n const caveat = permission.caveats[0] as Caveat<string, RpcOrigins>;\n return caveat.value;\n}\n\nexport const rpcCaveatSpecifications: Record<\n SnapCaveatType.RpcOrigin,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.RpcOrigin]: Object.freeze({\n type: SnapCaveatType.RpcOrigin,\n validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n }),\n};\n"],"names":["rpcEndowmentBuilder","getRpcCaveatMapper","getRpcCaveatOrigins","rpcCaveatSpecifications","targetName","SnapEndowments","Rpc","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","allowedCaveats","SnapCaveatType","RpcOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpcErrors","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveatOrigins","caveat","hasProperty","isPlainObject","value","assertIsRpcOrigins","permission","assert"],"mappings":";;;;;;;;;;;IA+DaA,mBAAmB;eAAnBA;;IA+BGC,kBAAkB;eAAlBA;;IAoBAC,mBAAmB;eAAnBA;;IAWHC,uBAAuB;eAAvBA;;;sCApH+B;2BAClB;4BAEyB;uBAEA;sBAEpB;AAE/B,MAAMC,aAAaC,oBAAc,CAACC,GAAG;AAerC;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCP;QACAQ,gBAAgB;YAACC,0BAAc,CAACC,SAAS;SAAC;QAC1CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,SAAS,EAC5C;gBACA,MAAMQ,oBAAS,CAACC,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEX,0BAAc,CAACC,SAAS,CAAC,SAAS,CAAC;gBACpE;YACF;QACF;QACAW,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM3B,sBAAsB4B,OAAOC,MAAM,CAAC;IAC/CzB;IACAG;AACF;AAEA;;;;;;CAMC,GACD,SAASuB,sBAAsBC,MAA2B;IACxD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,OAAOG,KAAK,GAAG;QACjE,MAAMZ,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEU,KAAK,EAAE,GAAGH;IAClBI,IAAAA,8BAAkB,EAACD,OAAOZ,oBAAS,CAACC,aAAa;AACnD;AAUO,SAAStB,mBACdiC,KAAW;IAEX,OAAO;QACLf,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,SAAS;gBAC9BoB;YACF;SACD;IACH;AACF;AASO,SAAShC,oBACdkC,UAAiC;IAEjCC,IAAAA,aAAM,EAACD,YAAYjB;IACnBkB,IAAAA,aAAM,EAACD,WAAWjB,OAAO,CAACC,MAAM,KAAK;IACrCiB,IAAAA,aAAM,EAACD,WAAWjB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,SAAS;IAE9D,MAAMiB,SAASK,WAAWjB,OAAO,CAAC,EAAE;IACpC,OAAOY,OAAOG,KAAK;AACrB;AAEO,MAAM/B,0BAGT;IACF,CAACU,0BAAc,CAACC,SAAS,CAAC,EAAEc,OAAOC,MAAM,CAAC;QACxCR,MAAMR,0BAAc,CAACC,SAAS;QAC9BI,WAAW,CAACa,SAAgCD,sBAAsBC;IACpE;AACF"}
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
function _export(target, all) {
|
|
6
|
-
for(var name in all)Object.defineProperty(target, name, {
|
|
7
|
-
enumerable: true,
|
|
8
|
-
get: all[name]
|
|
9
|
-
});
|
|
10
|
-
}
|
|
11
|
-
_export(exports, {
|
|
12
|
-
transactionInsightEndowmentBuilder: function() {
|
|
13
|
-
return transactionInsightEndowmentBuilder;
|
|
14
|
-
},
|
|
15
|
-
getTransactionInsightCaveatMapper: function() {
|
|
16
|
-
return getTransactionInsightCaveatMapper;
|
|
17
|
-
},
|
|
18
|
-
getTransactionOriginCaveat: function() {
|
|
19
|
-
return getTransactionOriginCaveat;
|
|
20
|
-
},
|
|
21
|
-
transactionInsightCaveatSpecifications: function() {
|
|
22
|
-
return transactionInsightCaveatSpecifications;
|
|
23
|
-
}
|
|
24
|
-
});
|
|
25
|
-
const _permissioncontroller = require("@metamask/permission-controller");
|
|
26
|
-
const _rpcerrors = require("@metamask/rpc-errors");
|
|
27
|
-
const _snapsutils = require("@metamask/snaps-utils");
|
|
28
|
-
const _utils = require("@metamask/utils");
|
|
29
|
-
const _enum = require("./enum");
|
|
30
|
-
const permissionName = _enum.SnapEndowments.TransactionInsight;
|
|
31
|
-
/**
|
|
32
|
-
* `endowment:transaction-insight` returns nothing; it is intended to be used as a flag
|
|
33
|
-
* by the extension to detect whether the snap has the capability to show information on the transaction confirmation screen.
|
|
34
|
-
*
|
|
35
|
-
* @param _builderOptions - Optional specification builder options.
|
|
36
|
-
* @returns The specification for the transaction-insight endowment.
|
|
37
|
-
*/ const specificationBuilder = (_builderOptions)=>{
|
|
38
|
-
return {
|
|
39
|
-
permissionType: _permissioncontroller.PermissionType.Endowment,
|
|
40
|
-
targetName: permissionName,
|
|
41
|
-
allowedCaveats: [
|
|
42
|
-
_snapsutils.SnapCaveatType.TransactionOrigin
|
|
43
|
-
],
|
|
44
|
-
endowmentGetter: (_getterOptions)=>undefined,
|
|
45
|
-
validator: ({ caveats })=>{
|
|
46
|
-
if (caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== _snapsutils.SnapCaveatType.TransactionOrigin) {
|
|
47
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
48
|
-
message: `Expected a single "${_snapsutils.SnapCaveatType.TransactionOrigin}" caveat.`
|
|
49
|
-
});
|
|
50
|
-
}
|
|
51
|
-
},
|
|
52
|
-
subjectTypes: [
|
|
53
|
-
_permissioncontroller.SubjectType.Snap
|
|
54
|
-
]
|
|
55
|
-
};
|
|
56
|
-
};
|
|
57
|
-
const transactionInsightEndowmentBuilder = Object.freeze({
|
|
58
|
-
targetName: permissionName,
|
|
59
|
-
specificationBuilder
|
|
60
|
-
});
|
|
61
|
-
/**
|
|
62
|
-
* Validates the type of the caveat value.
|
|
63
|
-
*
|
|
64
|
-
* @param caveat - The caveat to validate.
|
|
65
|
-
* @throws If the caveat value is invalid.
|
|
66
|
-
*/ function validateCaveat(caveat) {
|
|
67
|
-
if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat)) {
|
|
68
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
69
|
-
message: 'Expected a plain object.'
|
|
70
|
-
});
|
|
71
|
-
}
|
|
72
|
-
const { value } = caveat;
|
|
73
|
-
(0, _utils.assert)(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
|
|
74
|
-
}
|
|
75
|
-
function getTransactionInsightCaveatMapper(value) {
|
|
76
|
-
if (!value || !(0, _utils.isObject)(value) || (0, _utils.isObject)(value) && Object.keys(value).length === 0) {
|
|
77
|
-
return {
|
|
78
|
-
caveats: null
|
|
79
|
-
};
|
|
80
|
-
}
|
|
81
|
-
return {
|
|
82
|
-
caveats: [
|
|
83
|
-
{
|
|
84
|
-
type: _snapsutils.SnapCaveatType.TransactionOrigin,
|
|
85
|
-
value: (0, _utils.hasProperty)(value, 'allowTransactionOrigin') && value.allowTransactionOrigin
|
|
86
|
-
}
|
|
87
|
-
]
|
|
88
|
-
};
|
|
89
|
-
}
|
|
90
|
-
function getTransactionOriginCaveat(permission) {
|
|
91
|
-
if (!permission?.caveats) {
|
|
92
|
-
return null;
|
|
93
|
-
}
|
|
94
|
-
(0, _utils.assert)(permission.caveats.length === 1);
|
|
95
|
-
(0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.TransactionOrigin);
|
|
96
|
-
const caveat = permission.caveats[0];
|
|
97
|
-
return caveat.value ?? null;
|
|
98
|
-
}
|
|
99
|
-
const transactionInsightCaveatSpecifications = {
|
|
100
|
-
[_snapsutils.SnapCaveatType.TransactionOrigin]: Object.freeze({
|
|
101
|
-
type: _snapsutils.SnapCaveatType.TransactionOrigin,
|
|
102
|
-
validator: (caveat)=>validateCaveat(caveat)
|
|
103
|
-
})
|
|
104
|
-
};
|
|
105
|
-
|
|
106
|
-
//# sourceMappingURL=transaction-insight.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/snaps/endowments/transaction-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.TransactionInsight;\n\ntype TransactionInsightEndowmentSpecification = 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:transaction-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 transaction confirmation screen.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the transaction-insight endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n TransactionInsightEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: [SnapCaveatType.TransactionOrigin],\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.TransactionOrigin)\n ) {\n throw rpcErrors.invalidParams({\n message: `Expected a single \"${SnapCaveatType.TransactionOrigin}\" caveat.`,\n });\n }\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const transactionInsightEndowmentBuilder = 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 * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getTransactionInsightCaveatMapper(\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.TransactionOrigin,\n value:\n hasProperty(value, 'allowTransactionOrigin') &&\n (value.allowTransactionOrigin as boolean),\n },\n ],\n };\n}\n\n/**\n * Getter function to get the transaction 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 transaction origin caveat from.\n * @returns The transaction origin, or `null` if the permission does not have a\n * transaction origin caveat.\n */\nexport function getTransactionOriginCaveat(\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.TransactionOrigin);\n\n const caveat = permission.caveats[0] as Caveat<string, boolean>;\n\n return caveat.value ?? null;\n}\n\nexport const transactionInsightCaveatSpecifications: Record<\n SnapCaveatType.TransactionOrigin,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.TransactionOrigin]: Object.freeze({\n type: SnapCaveatType.TransactionOrigin,\n validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n }),\n};\n"],"names":["transactionInsightEndowmentBuilder","getTransactionInsightCaveatMapper","getTransactionOriginCaveat","transactionInsightCaveatSpecifications","permissionName","SnapEndowments","TransactionInsight","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","TransactionOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpcErrors","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveat","caveat","hasProperty","isPlainObject","value","assert","isObject","keys","allowTransactionOrigin","permission"],"mappings":";;;;;;;;;;;IA2DaA,kCAAkC;eAAlCA;;IAkCGC,iCAAiC;eAAjCA;;IAiCAC,0BAA0B;eAA1BA;;IAeHC,sCAAsC;eAAtCA;;;sCApI+B;2BAClB;4BACK;uBAE8B;sBAE9B;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,kBAAkB;AAUxD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,iBAAiB;SAAC;QAClDC,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,iBAAiB,EACtD;gBACA,MAAMQ,oBAAS,CAACC,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEX,0BAAc,CAACC,iBAAiB,CAAC,SAAS,CAAC;gBAC5E;YACF;QACF;QACAW,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM5B,qCAAqC6B,OAAOC,MAAM,CAAC;IAC9DlB,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,kCACdkC,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,iBAAiB;gBACtCoB,OACEF,IAAAA,kBAAW,EAACE,OAAO,6BAClBA,MAAMI,sBAAsB;YACjC;SACD;IACH;AACF;AAaO,SAASrC,2BACdsC,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,iBAAiB;IAEtE,MAAMiB,SAASQ,WAAWpB,OAAO,CAAC,EAAE;IAEpC,OAAOY,OAAOG,KAAK,IAAI;AACzB;AAEO,MAAMhC,yCAGT;IACF,CAACW,0BAAc,CAACC,iBAAiB,CAAC,EAAEc,OAAOC,MAAM,CAAC;QAChDR,MAAMR,0BAAc,CAACC,iBAAiB;QACtCI,WAAW,CAACa,SAAgCD,eAAeC;IAC7D;AACF"}
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
Object.defineProperty(exports, "webAssemblyEndowmentBuilder", {
|
|
6
|
-
enumerable: true,
|
|
7
|
-
get: function() {
|
|
8
|
-
return webAssemblyEndowmentBuilder;
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
const _permissioncontroller = require("@metamask/permission-controller");
|
|
12
|
-
const _enum = require("./enum");
|
|
13
|
-
const permissionName = _enum.SnapEndowments.WebAssemblyAccess;
|
|
14
|
-
/**
|
|
15
|
-
* `endowment:webassembly` returns the name of global browser API(s) that
|
|
16
|
-
* enable access to the WebAssembly API.
|
|
17
|
-
* This is intended to populate the endowments of the SES Compartment
|
|
18
|
-
* in which a Snap executes.
|
|
19
|
-
*
|
|
20
|
-
* @param _builderOptions - Optional specification builder options.
|
|
21
|
-
* @returns The specification for the WebAssembly endowment.
|
|
22
|
-
*/ const specificationBuilder = (_builderOptions)=>{
|
|
23
|
-
return {
|
|
24
|
-
permissionType: _permissioncontroller.PermissionType.Endowment,
|
|
25
|
-
targetName: permissionName,
|
|
26
|
-
allowedCaveats: null,
|
|
27
|
-
endowmentGetter: (_getterOptions)=>{
|
|
28
|
-
return [
|
|
29
|
-
'WebAssembly'
|
|
30
|
-
];
|
|
31
|
-
},
|
|
32
|
-
subjectTypes: [
|
|
33
|
-
_permissioncontroller.SubjectType.Snap
|
|
34
|
-
]
|
|
35
|
-
};
|
|
36
|
-
};
|
|
37
|
-
const webAssemblyEndowmentBuilder = Object.freeze({
|
|
38
|
-
targetName: permissionName,
|
|
39
|
-
specificationBuilder
|
|
40
|
-
});
|
|
41
|
-
|
|
42
|
-
//# sourceMappingURL=web-assembly.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/snaps/endowments/web-assembly.ts"],"sourcesContent":["import type {\n EndowmentGetterParams,\n PermissionSpecificationBuilder,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.WebAssemblyAccess;\n\ntype WebAssemblyEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof permissionName;\n endowmentGetter: (_options?: any) => ['WebAssembly'];\n allowedCaveats: null;\n}>;\n\n/**\n * `endowment:webassembly` returns the name of global browser API(s) that\n * enable access to the WebAssembly API.\n * This is intended to populate the endowments of the SES Compartment\n * in which a Snap executes.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the WebAssembly endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n WebAssemblyEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: null,\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n return ['WebAssembly'];\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const webAssemblyEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\n"],"names":["webAssemblyEndowmentBuilder","permissionName","SnapEndowments","WebAssemblyAccess","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BA2CaA;;;eAAAA;;;sCAtC+B;sBAEb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,iBAAiB;AASvD;;;;;;;;CAQC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;aAAc;QACxB;QACAC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMf,8BAA8BgB,OAAOC,MAAM,CAAC;IACvDR,YAAYR;IACZG;AACF"}
|