@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.
Files changed (163) hide show
  1. package/CHANGELOG.md +33 -1
  2. package/dist/cjs/cronjob/CronjobController.js +3 -3
  3. package/dist/cjs/cronjob/CronjobController.js.map +1 -1
  4. package/dist/cjs/index.js +1 -0
  5. package/dist/cjs/index.js.map +1 -1
  6. package/dist/cjs/interface/SnapInterfaceController.js +166 -0
  7. package/dist/cjs/interface/SnapInterfaceController.js.map +1 -0
  8. package/dist/cjs/interface/index.js +20 -0
  9. package/dist/cjs/interface/index.js.map +1 -0
  10. package/dist/cjs/interface/utils.js +59 -0
  11. package/dist/cjs/interface/utils.js.map +1 -0
  12. package/dist/cjs/services/ProxyPostMessageStream.js +3 -10
  13. package/dist/cjs/services/ProxyPostMessageStream.js.map +1 -1
  14. package/dist/cjs/services/browser.js +1 -0
  15. package/dist/cjs/services/browser.js.map +1 -1
  16. package/dist/cjs/services/index.js +1 -0
  17. package/dist/cjs/services/index.js.map +1 -1
  18. package/dist/cjs/services/node/NodeProcessExecutionService.js +13 -1
  19. package/dist/cjs/services/node/NodeProcessExecutionService.js.map +1 -1
  20. package/dist/cjs/services/node/NodeThreadExecutionService.js +14 -1
  21. package/dist/cjs/services/node/NodeThreadExecutionService.js.map +1 -1
  22. package/dist/cjs/services/offscreen/OffscreenExecutionService.js +36 -99
  23. package/dist/cjs/services/offscreen/OffscreenExecutionService.js.map +1 -1
  24. package/dist/cjs/services/proxy/ProxyExecutionService.js +110 -0
  25. package/dist/cjs/services/proxy/ProxyExecutionService.js.map +1 -0
  26. package/dist/cjs/services/webview/WebViewExecutionService.js +99 -0
  27. package/dist/cjs/services/webview/WebViewExecutionService.js.map +1 -0
  28. package/dist/cjs/services/webview/WebViewMessageStream.js +127 -0
  29. package/dist/cjs/services/webview/WebViewMessageStream.js.map +1 -0
  30. package/dist/cjs/services/webview/index.js +20 -0
  31. package/dist/cjs/services/webview/index.js.map +1 -0
  32. package/dist/cjs/snaps/SnapController.js +303 -138
  33. package/dist/cjs/snaps/SnapController.js.map +1 -1
  34. package/dist/cjs/snaps/constants.js +25 -0
  35. package/dist/cjs/snaps/constants.js.map +1 -0
  36. package/dist/cjs/snaps/index.js +0 -2
  37. package/dist/cjs/snaps/index.js.map +1 -1
  38. package/dist/cjs/snaps/location/npm.js +13 -2
  39. package/dist/cjs/snaps/location/npm.js.map +1 -1
  40. package/dist/cjs/utils.js +32 -0
  41. package/dist/cjs/utils.js.map +1 -1
  42. package/dist/esm/cronjob/CronjobController.js +2 -2
  43. package/dist/esm/cronjob/CronjobController.js.map +1 -1
  44. package/dist/esm/index.js +1 -0
  45. package/dist/esm/index.js.map +1 -1
  46. package/dist/esm/interface/SnapInterfaceController.js +158 -0
  47. package/dist/esm/interface/SnapInterfaceController.js.map +1 -0
  48. package/dist/esm/interface/index.js +3 -0
  49. package/dist/esm/interface/index.js.map +1 -0
  50. package/dist/esm/interface/utils.js +62 -0
  51. package/dist/esm/interface/utils.js.map +1 -0
  52. package/dist/esm/services/ProxyPostMessageStream.js +3 -10
  53. package/dist/esm/services/ProxyPostMessageStream.js.map +1 -1
  54. package/dist/esm/services/browser.js +1 -0
  55. package/dist/esm/services/browser.js.map +1 -1
  56. package/dist/esm/services/index.js +1 -0
  57. package/dist/esm/services/index.js.map +1 -1
  58. package/dist/esm/services/node/NodeProcessExecutionService.js +13 -1
  59. package/dist/esm/services/node/NodeProcessExecutionService.js.map +1 -1
  60. package/dist/esm/services/node/NodeThreadExecutionService.js +14 -1
  61. package/dist/esm/services/node/NodeThreadExecutionService.js.map +1 -1
  62. package/dist/esm/services/offscreen/OffscreenExecutionService.js +36 -99
  63. package/dist/esm/services/offscreen/OffscreenExecutionService.js.map +1 -1
  64. package/dist/esm/services/proxy/ProxyExecutionService.js +100 -0
  65. package/dist/esm/services/proxy/ProxyExecutionService.js.map +1 -0
  66. package/dist/esm/services/webview/WebViewExecutionService.js +89 -0
  67. package/dist/esm/services/webview/WebViewExecutionService.js.map +1 -0
  68. package/dist/esm/services/webview/WebViewMessageStream.js +119 -0
  69. package/dist/esm/services/webview/WebViewMessageStream.js.map +1 -0
  70. package/dist/esm/services/webview/index.js +3 -0
  71. package/dist/esm/services/webview/index.js.map +1 -0
  72. package/dist/esm/snaps/SnapController.js +299 -134
  73. package/dist/esm/snaps/SnapController.js.map +1 -1
  74. package/dist/esm/snaps/constants.js +16 -0
  75. package/dist/esm/snaps/constants.js.map +1 -0
  76. package/dist/esm/snaps/index.js +0 -2
  77. package/dist/esm/snaps/index.js.map +1 -1
  78. package/dist/esm/snaps/location/npm.js +13 -2
  79. package/dist/esm/snaps/location/npm.js.map +1 -1
  80. package/dist/esm/utils.js +37 -0
  81. package/dist/esm/utils.js.map +1 -1
  82. package/dist/types/index.d.ts +1 -0
  83. package/dist/types/interface/SnapInterfaceController.d.ts +85 -0
  84. package/dist/types/interface/index.d.ts +1 -0
  85. package/dist/types/interface/utils.d.ts +36 -0
  86. package/dist/types/services/ProxyPostMessageStream.d.ts +1 -2
  87. package/dist/types/services/browser.d.ts +1 -0
  88. package/dist/types/services/index.d.ts +1 -0
  89. package/dist/types/services/offscreen/OffscreenExecutionService.d.ts +5 -22
  90. package/dist/types/services/proxy/ProxyExecutionService.d.ts +39 -0
  91. package/dist/types/services/webview/WebViewExecutionService.d.ts +20 -0
  92. package/dist/types/services/webview/WebViewMessageStream.d.ts +32 -0
  93. package/dist/types/services/webview/index.d.ts +1 -0
  94. package/dist/types/snaps/SnapController.d.ts +37 -6
  95. package/dist/types/snaps/constants.d.ts +1 -0
  96. package/dist/types/snaps/index.d.ts +0 -2
  97. package/dist/types/utils.d.ts +119 -0
  98. package/package.json +14 -14
  99. package/dist/cjs/snaps/endowments/cronjob.js +0 -100
  100. package/dist/cjs/snaps/endowments/cronjob.js.map +0 -1
  101. package/dist/cjs/snaps/endowments/enum.js +0 -25
  102. package/dist/cjs/snaps/endowments/enum.js.map +0 -1
  103. package/dist/cjs/snaps/endowments/ethereum-provider.js +0 -43
  104. package/dist/cjs/snaps/endowments/ethereum-provider.js.map +0 -1
  105. package/dist/cjs/snaps/endowments/home-page.js +0 -37
  106. package/dist/cjs/snaps/endowments/home-page.js.map +0 -1
  107. package/dist/cjs/snaps/endowments/index.js +0 -99
  108. package/dist/cjs/snaps/endowments/index.js.map +0 -1
  109. package/dist/cjs/snaps/endowments/keyring.js +0 -100
  110. package/dist/cjs/snaps/endowments/keyring.js.map +0 -1
  111. package/dist/cjs/snaps/endowments/lifecycle-hooks.js +0 -37
  112. package/dist/cjs/snaps/endowments/lifecycle-hooks.js.map +0 -1
  113. package/dist/cjs/snaps/endowments/name-lookup.js +0 -106
  114. package/dist/cjs/snaps/endowments/name-lookup.js.map +0 -1
  115. package/dist/cjs/snaps/endowments/network-access.js +0 -44
  116. package/dist/cjs/snaps/endowments/network-access.js.map +0 -1
  117. package/dist/cjs/snaps/endowments/rpc.js +0 -99
  118. package/dist/cjs/snaps/endowments/rpc.js.map +0 -1
  119. package/dist/cjs/snaps/endowments/transaction-insight.js +0 -106
  120. package/dist/cjs/snaps/endowments/transaction-insight.js.map +0 -1
  121. package/dist/cjs/snaps/endowments/web-assembly.js +0 -42
  122. package/dist/cjs/snaps/endowments/web-assembly.js.map +0 -1
  123. package/dist/cjs/snaps/permissions.js +0 -61
  124. package/dist/cjs/snaps/permissions.js.map +0 -1
  125. package/dist/esm/snaps/endowments/cronjob.js +0 -99
  126. package/dist/esm/snaps/endowments/cronjob.js.map +0 -1
  127. package/dist/esm/snaps/endowments/enum.js +0 -15
  128. package/dist/esm/snaps/endowments/enum.js.map +0 -1
  129. package/dist/esm/snaps/endowments/ethereum-provider.js +0 -33
  130. package/dist/esm/snaps/endowments/ethereum-provider.js.map +0 -1
  131. package/dist/esm/snaps/endowments/home-page.js +0 -27
  132. package/dist/esm/snaps/endowments/home-page.js.map +0 -1
  133. package/dist/esm/snaps/endowments/index.js +0 -54
  134. package/dist/esm/snaps/endowments/index.js.map +0 -1
  135. package/dist/esm/snaps/endowments/keyring.js +0 -91
  136. package/dist/esm/snaps/endowments/keyring.js.map +0 -1
  137. package/dist/esm/snaps/endowments/lifecycle-hooks.js +0 -27
  138. package/dist/esm/snaps/endowments/lifecycle-hooks.js.map +0 -1
  139. package/dist/esm/snaps/endowments/name-lookup.js +0 -98
  140. package/dist/esm/snaps/endowments/name-lookup.js.map +0 -1
  141. package/dist/esm/snaps/endowments/network-access.js +0 -34
  142. package/dist/esm/snaps/endowments/network-access.js.map +0 -1
  143. package/dist/esm/snaps/endowments/rpc.js +0 -88
  144. package/dist/esm/snaps/endowments/rpc.js.map +0 -1
  145. package/dist/esm/snaps/endowments/transaction-insight.js +0 -99
  146. package/dist/esm/snaps/endowments/transaction-insight.js.map +0 -1
  147. package/dist/esm/snaps/endowments/web-assembly.js +0 -32
  148. package/dist/esm/snaps/endowments/web-assembly.js.map +0 -1
  149. package/dist/esm/snaps/permissions.js +0 -50
  150. package/dist/esm/snaps/permissions.js.map +0 -1
  151. package/dist/types/snaps/endowments/cronjob.d.ts +0 -51
  152. package/dist/types/snaps/endowments/enum.d.ts +0 -12
  153. package/dist/types/snaps/endowments/ethereum-provider.d.ts +0 -14
  154. package/dist/types/snaps/endowments/home-page.d.ts +0 -15
  155. package/dist/types/snaps/endowments/index.d.ts +0 -115
  156. package/dist/types/snaps/endowments/keyring.d.ts +0 -39
  157. package/dist/types/snaps/endowments/lifecycle-hooks.d.ts +0 -15
  158. package/dist/types/snaps/endowments/name-lookup.d.ts +0 -38
  159. package/dist/types/snaps/endowments/network-access.d.ts +0 -14
  160. package/dist/types/snaps/endowments/rpc.d.ts +0 -38
  161. package/dist/types/snaps/endowments/transaction-insight.d.ts +0 -39
  162. package/dist/types/snaps/endowments/web-assembly.d.ts +0 -14
  163. package/dist/types/snaps/permissions.d.ts +0 -16
@@ -1,61 +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
- processSnapPermissions: function() {
13
- return processSnapPermissions;
14
- },
15
- buildSnapEndowmentSpecifications: function() {
16
- return buildSnapEndowmentSpecifications;
17
- },
18
- buildSnapRestrictedMethodSpecifications: function() {
19
- return buildSnapRestrictedMethodSpecifications;
20
- }
21
- });
22
- const _snapsrpcmethods = require("@metamask/snaps-rpc-methods");
23
- const _utils = require("@metamask/utils");
24
- const _endowments = require("./endowments");
25
- function processSnapPermissions(initialPermissions) {
26
- return Object.fromEntries(Object.entries(initialPermissions).map(([initialPermission, value])=>{
27
- if ((0, _utils.hasProperty)(_snapsrpcmethods.caveatMappers, initialPermission)) {
28
- return [
29
- initialPermission,
30
- _snapsrpcmethods.caveatMappers[initialPermission](value)
31
- ];
32
- } else if ((0, _utils.hasProperty)(_endowments.endowmentCaveatMappers, initialPermission)) {
33
- return [
34
- initialPermission,
35
- _endowments.endowmentCaveatMappers[initialPermission](value)
36
- ];
37
- }
38
- // If we have no mapping, this may be a non-snap permission, return as-is
39
- return [
40
- initialPermission,
41
- value
42
- ];
43
- }));
44
- }
45
- const buildSnapEndowmentSpecifications = (excludedEndowments)=>Object.values(_endowments.endowmentPermissionBuilders).reduce((allSpecifications, { targetName, specificationBuilder })=>{
46
- if (!excludedEndowments.includes(targetName)) {
47
- allSpecifications[targetName] = specificationBuilder({});
48
- }
49
- return allSpecifications;
50
- }, {});
51
- const buildSnapRestrictedMethodSpecifications = (excludedPermissions, hooks)=>Object.values(_snapsrpcmethods.restrictedMethodPermissionBuilders).reduce((specifications, { targetName, specificationBuilder, methodHooks })=>{
52
- if (!excludedPermissions.includes(targetName)) {
53
- specifications[targetName] = specificationBuilder({
54
- // @ts-expect-error The selectHooks type is wonky
55
- methodHooks: (0, _snapsrpcmethods.selectHooks)(hooks, methodHooks)
56
- });
57
- }
58
- return specifications;
59
- }, {});
60
-
61
- //# sourceMappingURL=permissions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../src/snaps/permissions.ts"],"sourcesContent":["import type {\n PermissionConstraint,\n PermissionSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport {\n caveatMappers,\n restrictedMethodPermissionBuilders,\n selectHooks,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapPermissions } from '@metamask/snaps-utils';\nimport { hasProperty } from '@metamask/utils';\n\nimport {\n endowmentCaveatMappers,\n endowmentPermissionBuilders,\n} from './endowments';\n\n/**\n * Map initial permissions as defined in a Snap manifest to something that can\n * be processed by the PermissionsController. Each caveat mapping function\n * should return a valid permission caveat value.\n *\n * This function does not validate the caveat values, since that is done by\n * the PermissionsController itself, upon requesting the permissions.\n *\n * @param initialPermissions - The initial permissions to process.\n * @returns The processed permissions.\n */\nexport function processSnapPermissions(\n initialPermissions: SnapPermissions,\n): Record<string, Pick<PermissionConstraint, 'caveats'>> {\n return Object.fromEntries(\n Object.entries(initialPermissions).map(([initialPermission, value]) => {\n if (hasProperty(caveatMappers, initialPermission)) {\n return [initialPermission, caveatMappers[initialPermission](value)];\n } else if (hasProperty(endowmentCaveatMappers, initialPermission)) {\n return [\n initialPermission,\n endowmentCaveatMappers[initialPermission](value),\n ];\n }\n\n // If we have no mapping, this may be a non-snap permission, return as-is\n return [\n initialPermission,\n value as Pick<PermissionConstraint, 'caveats'>,\n ];\n }),\n );\n}\n\nexport const buildSnapEndowmentSpecifications = (\n excludedEndowments: string[],\n) =>\n Object.values(endowmentPermissionBuilders).reduce<\n Record<string, PermissionSpecificationConstraint>\n >((allSpecifications, { targetName, specificationBuilder }) => {\n if (!excludedEndowments.includes(targetName)) {\n allSpecifications[targetName] = specificationBuilder({});\n }\n return allSpecifications;\n }, {});\n\nexport const buildSnapRestrictedMethodSpecifications = (\n excludedPermissions: string[],\n hooks: Record<string, unknown>,\n) =>\n Object.values(restrictedMethodPermissionBuilders).reduce<\n Record<string, PermissionSpecificationConstraint>\n >((specifications, { targetName, specificationBuilder, methodHooks }) => {\n if (!excludedPermissions.includes(targetName)) {\n specifications[targetName] = specificationBuilder({\n // @ts-expect-error The selectHooks type is wonky\n methodHooks: selectHooks<typeof hooks, keyof typeof methodHooks>(\n hooks,\n methodHooks,\n ) as Pick<typeof hooks, keyof typeof methodHooks>,\n });\n }\n return specifications;\n }, {});\n"],"names":["processSnapPermissions","buildSnapEndowmentSpecifications","buildSnapRestrictedMethodSpecifications","initialPermissions","Object","fromEntries","entries","map","initialPermission","value","hasProperty","caveatMappers","endowmentCaveatMappers","excludedEndowments","values","endowmentPermissionBuilders","reduce","allSpecifications","targetName","specificationBuilder","includes","excludedPermissions","hooks","restrictedMethodPermissionBuilders","specifications","methodHooks","selectHooks"],"mappings":";;;;;;;;;;;IA4BgBA,sBAAsB;eAAtBA;;IAuBHC,gCAAgC;eAAhCA;;IAYAC,uCAAuC;eAAvCA;;;iCAvDN;uBAEqB;4BAKrB;AAaA,SAASF,uBACdG,kBAAmC;IAEnC,OAAOC,OAAOC,WAAW,CACvBD,OAAOE,OAAO,CAACH,oBAAoBI,GAAG,CAAC,CAAC,CAACC,mBAAmBC,MAAM;QAChE,IAAIC,IAAAA,kBAAW,EAACC,8BAAa,EAAEH,oBAAoB;YACjD,OAAO;gBAACA;gBAAmBG,8BAAa,CAACH,kBAAkB,CAACC;aAAO;QACrE,OAAO,IAAIC,IAAAA,kBAAW,EAACE,kCAAsB,EAAEJ,oBAAoB;YACjE,OAAO;gBACLA;gBACAI,kCAAsB,CAACJ,kBAAkB,CAACC;aAC3C;QACH;QAEA,yEAAyE;QACzE,OAAO;YACLD;YACAC;SACD;IACH;AAEJ;AAEO,MAAMR,mCAAmC,CAC9CY,qBAEAT,OAAOU,MAAM,CAACC,uCAA2B,EAAEC,MAAM,CAE/C,CAACC,mBAAmB,EAAEC,UAAU,EAAEC,oBAAoB,EAAE;QACxD,IAAI,CAACN,mBAAmBO,QAAQ,CAACF,aAAa;YAC5CD,iBAAiB,CAACC,WAAW,GAAGC,qBAAqB,CAAC;QACxD;QACA,OAAOF;IACT,GAAG,CAAC;AAEC,MAAMf,0CAA0C,CACrDmB,qBACAC,QAEAlB,OAAOU,MAAM,CAACS,mDAAkC,EAAEP,MAAM,CAEtD,CAACQ,gBAAgB,EAAEN,UAAU,EAAEC,oBAAoB,EAAEM,WAAW,EAAE;QAClE,IAAI,CAACJ,oBAAoBD,QAAQ,CAACF,aAAa;YAC7CM,cAAc,CAACN,WAAW,GAAGC,qBAAqB;gBAChD,iDAAiD;gBACjDM,aAAaC,IAAAA,4BAAW,EACtBJ,OACAG;YAEJ;QACF;QACA,OAAOD;IACT,GAAG,CAAC"}
@@ -1,99 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { rpcErrors } from '@metamask/rpc-errors';
3
- import { SnapCaveatType, isCronjobSpecificationArray } from '@metamask/snaps-utils';
4
- import { assert, hasProperty, isPlainObject } from '@metamask/utils';
5
- import { SnapEndowments } from './enum';
6
- const permissionName = SnapEndowments.Cronjob;
7
- /**
8
- * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.
9
- *
10
- * @param _builderOptions - Optional specification builder options.
11
- * @returns The specification for the cronjob endowment.
12
- */ const specificationBuilder = (_builderOptions)=>{
13
- return {
14
- permissionType: PermissionType.Endowment,
15
- targetName: permissionName,
16
- allowedCaveats: [
17
- SnapCaveatType.SnapCronjob
18
- ],
19
- endowmentGetter: (_getterOptions)=>undefined,
20
- subjectTypes: [
21
- SubjectType.Snap
22
- ]
23
- };
24
- };
25
- export const cronjobEndowmentBuilder = Object.freeze({
26
- targetName: permissionName,
27
- specificationBuilder
28
- });
29
- /**
30
- * Map a raw value from the `initialPermissions` to a caveat specification.
31
- * Note that this function does not do any validation, that's handled by the
32
- * PermissionsController when the permission is requested.
33
- *
34
- * @param value - The raw value from the `initialPermissions`.
35
- * @returns The caveat specification.
36
- */ export function getCronjobCaveatMapper(value) {
37
- return {
38
- caveats: [
39
- {
40
- type: SnapCaveatType.SnapCronjob,
41
- value
42
- }
43
- ]
44
- };
45
- }
46
- /**
47
- * Getter function to get the cronjobs from a permission.
48
- *
49
- * This does basic validation of the caveat, but does not validate the type or
50
- * value of the namespaces object itself, as this is handled by the
51
- * `PermissionsController` when the permission is requested.
52
- *
53
- * @param permission - The permission to get the keyring namespaces from.
54
- * @returns The cronjobs, or `null` if the permission does not have a
55
- * cronjob caveat.
56
- */ export function getCronjobCaveatJobs(permission) {
57
- if (!permission?.caveats) {
58
- return null;
59
- }
60
- assert(permission.caveats.length === 1);
61
- assert(permission.caveats[0].type === SnapCaveatType.SnapCronjob);
62
- const caveat = permission.caveats[0];
63
- return (caveat.value?.jobs) ?? null;
64
- }
65
- /**
66
- * Validate the cronjob specification values associated with a caveat.
67
- * This validates that the value is a non-empty array with valid
68
- * cronjob expression and request object.
69
- *
70
- * @param caveat - The caveat to validate.
71
- * @throws If the value is invalid.
72
- */ export function validateCronjobCaveat(caveat) {
73
- if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
74
- throw rpcErrors.invalidParams({
75
- message: 'Expected a plain object.'
76
- });
77
- }
78
- const { value } = caveat;
79
- if (!hasProperty(value, 'jobs') || !isPlainObject(value)) {
80
- throw rpcErrors.invalidParams({
81
- message: 'Expected a plain object.'
82
- });
83
- }
84
- if (!isCronjobSpecificationArray(value.jobs)) {
85
- throw rpcErrors.invalidParams({
86
- message: 'Expected a valid cronjob specification array.'
87
- });
88
- }
89
- }
90
- /**
91
- * Caveat specification for the Cronjob.
92
- */ export const cronjobCaveatSpecifications = {
93
- [SnapCaveatType.SnapCronjob]: Object.freeze({
94
- type: SnapCaveatType.SnapCronjob,
95
- validator: (caveat)=>validateCronjobCaveat(caveat)
96
- })
97
- };
98
-
99
- //# sourceMappingURL=cronjob.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../../src/snaps/endowments/cronjob.ts"],"sourcesContent":["import type {\n PermissionSpecificationBuilder,\n EndowmentGetterParams,\n ValidPermissionSpecification,\n PermissionConstraint,\n Caveat,\n CaveatSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { CronjobSpecification } from '@metamask/snaps-utils';\nimport {\n SnapCaveatType,\n isCronjobSpecificationArray,\n} 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.Cronjob;\n\ntype CronjobEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof permissionName;\n endowmentGetter: (_options?: any) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the cronjob endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n CronjobEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: [SnapCaveatType.SnapCronjob],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const cronjobEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\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 getCronjobCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n return {\n caveats: [\n {\n type: SnapCaveatType.SnapCronjob,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the cronjobs 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 keyring namespaces from.\n * @returns The cronjobs, or `null` if the permission does not have a\n * cronjob caveat.\n */\nexport function getCronjobCaveatJobs(\n permission?: PermissionConstraint,\n): CronjobSpecification[] | null {\n if (!permission?.caveats) {\n return null;\n }\n\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.SnapCronjob);\n\n const caveat = permission.caveats[0] as Caveat<string, { jobs: Json[] }>;\n\n return (caveat.value?.jobs as CronjobSpecification[]) ?? null;\n}\n\n/**\n * Validate the cronjob specification values associated with a caveat.\n * This validates that the value is a non-empty array with valid\n * cronjob expression and request object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the value is invalid.\n */\nexport function validateCronjobCaveat(caveat: Caveat<string, any>) {\n if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n throw rpcErrors.invalidParams({\n message: 'Expected a plain object.',\n });\n }\n\n const { value } = caveat;\n\n if (!hasProperty(value, 'jobs') || !isPlainObject(value)) {\n throw rpcErrors.invalidParams({\n message: 'Expected a plain object.',\n });\n }\n\n if (!isCronjobSpecificationArray(value.jobs)) {\n throw rpcErrors.invalidParams({\n message: 'Expected a valid cronjob specification array.',\n });\n }\n}\n\n/**\n * Caveat specification for the Cronjob.\n */\nexport const cronjobCaveatSpecifications: Record<\n SnapCaveatType.SnapCronjob,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.SnapCronjob]: Object.freeze({\n type: SnapCaveatType.SnapCronjob,\n validator: (caveat) => validateCronjobCaveat(caveat),\n }),\n};\n"],"names":["PermissionType","SubjectType","rpcErrors","SnapCaveatType","isCronjobSpecificationArray","assert","hasProperty","isPlainObject","SnapEndowments","permissionName","Cronjob","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","SnapCronjob","endowmentGetter","_getterOptions","undefined","subjectTypes","Snap","cronjobEndowmentBuilder","Object","freeze","getCronjobCaveatMapper","value","caveats","type","getCronjobCaveatJobs","permission","length","caveat","jobs","validateCronjobCaveat","invalidParams","message","cronjobCaveatSpecifications","validator"],"mappings":"AAQA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AAEjD,SACEC,cAAc,EACdC,2BAA2B,QACtB,wBAAwB;AAE/B,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,OAAO;AAS7C;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACb,eAAec,WAAW;SAAC;QAC5CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACpB,YAAYqB,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,0BAA0BC,OAAOC,MAAM,CAAC;IACnDV,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;;;CAOC,GACD,OAAO,SAASe,uBACdC,KAAW;IAEX,OAAO;QACLC,SAAS;YACP;gBACEC,MAAM1B,eAAec,WAAW;gBAChCU;YACF;SACD;IACH;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASG,qBACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYH,SAAS;QACxB,OAAO;IACT;IAEAvB,OAAO0B,WAAWH,OAAO,CAACI,MAAM,KAAK;IACrC3B,OAAO0B,WAAWH,OAAO,CAAC,EAAE,CAACC,IAAI,KAAK1B,eAAec,WAAW;IAEhE,MAAMgB,SAASF,WAAWH,OAAO,CAAC,EAAE;IAEpC,OAAO,CAACK,OAAON,KAAK,EAAEO,IAA8B,KAAK;AAC3D;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,sBAAsBF,MAA2B;IAC/D,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,OAAON,KAAK,GAAG;QACjE,MAAMzB,UAAUkC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEV,KAAK,EAAE,GAAGM;IAElB,IAAI,CAAC3B,YAAYqB,OAAO,WAAW,CAACpB,cAAcoB,QAAQ;QACxD,MAAMzB,UAAUkC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,IAAI,CAACjC,4BAA4BuB,MAAMO,IAAI,GAAG;QAC5C,MAAMhC,UAAUkC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAMC,8BAGT;IACF,CAACnC,eAAec,WAAW,CAAC,EAAEO,OAAOC,MAAM,CAAC;QAC1CI,MAAM1B,eAAec,WAAW;QAChCsB,WAAW,CAACN,SAAWE,sBAAsBF;IAC/C;AACF,EAAE"}
@@ -1,15 +0,0 @@
1
- export var SnapEndowments;
2
- (function(SnapEndowments) {
3
- SnapEndowments["NetworkAccess"] = 'endowment:network-access';
4
- SnapEndowments["TransactionInsight"] = 'endowment:transaction-insight';
5
- SnapEndowments["Cronjob"] = 'endowment:cronjob';
6
- SnapEndowments["EthereumProvider"] = 'endowment:ethereum-provider';
7
- SnapEndowments["Rpc"] = 'endowment:rpc';
8
- SnapEndowments["WebAssemblyAccess"] = 'endowment:webassembly';
9
- SnapEndowments["NameLookup"] = 'endowment:name-lookup';
10
- SnapEndowments["LifecycleHooks"] = 'endowment:lifecycle-hooks';
11
- SnapEndowments["Keyring"] = 'endowment:keyring';
12
- SnapEndowments["HomePage"] = 'endowment:page-home';
13
- })(SnapEndowments || (SnapEndowments = {}));
14
-
15
- //# sourceMappingURL=enum.js.map
@@ -1 +0,0 @@
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"}
@@ -1,33 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { SnapEndowments } from './enum';
3
- const permissionName = SnapEndowments.EthereumProvider;
4
- /**
5
- * `endowment:ethereum-provider` returns the name of the ethereum global browser API.
6
- * This is intended to populate the endowments of the
7
- * SES Compartment in which a Snap executes.
8
- *
9
- * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.
10
- *
11
- * @param _builderOptions - Optional specification builder options.
12
- * @returns The specification for the network endowment.
13
- */ const specificationBuilder = (_builderOptions)=>{
14
- return {
15
- permissionType: PermissionType.Endowment,
16
- targetName: permissionName,
17
- allowedCaveats: null,
18
- endowmentGetter: (_getterOptions)=>{
19
- return [
20
- 'ethereum'
21
- ];
22
- },
23
- subjectTypes: [
24
- SubjectType.Snap
25
- ]
26
- };
27
- };
28
- export const ethereumProviderEndowmentBuilder = Object.freeze({
29
- targetName: permissionName,
30
- specificationBuilder
31
- });
32
-
33
- //# sourceMappingURL=ethereum-provider.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../../src/snaps/endowments/ethereum-provider.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.EthereumProvider;\n\ntype EthereumProviderEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof permissionName;\n endowmentGetter: (_options?: any) => ['ethereum'];\n allowedCaveats: null;\n}>;\n\n/**\n * `endowment:ethereum-provider` returns the name of the ethereum global browser API.\n * This is intended to populate the endowments of the\n * SES Compartment in which a Snap executes.\n *\n * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.\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 EthereumProviderEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: null,\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n return ['ethereum'];\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const ethereumProviderEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\n"],"names":["PermissionType","SubjectType","SnapEndowments","permissionName","EthereumProvider","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","Snap","ethereumProviderEndowmentBuilder","Object","freeze"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAE9E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,gBAAgB;AAStD;;;;;;;;;CASC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;aAAW;QACrB;QACAC,cAAc;YAACZ,YAAYa,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,mCAAmCC,OAAOC,MAAM,CAAC;IAC5DR,YAAYN;IACZE;AACF,GAAY"}
@@ -1,27 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { SnapEndowments } from './enum';
3
- const permissionName = SnapEndowments.HomePage;
4
- /**
5
- * `endowment:page-home` returns nothing; it is intended to be used as a
6
- * flag by the snap controller to detect whether the snap has the capability to
7
- * use the snap home page feature.
8
- *
9
- * @param _builderOptions - Optional specification builder options.
10
- * @returns The specification for the `snap-pages` endowment.
11
- */ const specificationBuilder = (_builderOptions)=>{
12
- return {
13
- permissionType: PermissionType.Endowment,
14
- targetName: permissionName,
15
- allowedCaveats: null,
16
- endowmentGetter: (_getterOptions)=>undefined,
17
- subjectTypes: [
18
- SubjectType.Snap
19
- ]
20
- };
21
- };
22
- export const homePageEndowmentBuilder = Object.freeze({
23
- targetName: permissionName,
24
- specificationBuilder
25
- });
26
-
27
- //# sourceMappingURL=home-page.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../../src/snaps/endowments/home-page.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.HomePage;\n\ntype HomePageEndowmentSpecification = 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:page-home` 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 the snap home page feature.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the `snap-pages` endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n HomePageEndowmentSpecification\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 homePageEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\n"],"names":["PermissionType","SubjectType","SnapEndowments","permissionName","HomePage","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","Snap","homePageEndowmentBuilder","Object","freeze"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAG9E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,QAAQ;AAS9C;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACb,YAAYc,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,2BAA2BC,OAAOC,MAAM,CAAC;IACpDT,YAAYN;IACZE;AACF,GAAY"}
@@ -1,54 +0,0 @@
1
- import { HandlerType } from '@metamask/snaps-utils';
2
- import { cronjobCaveatSpecifications, cronjobEndowmentBuilder, getCronjobCaveatMapper } from './cronjob';
3
- import { ethereumProviderEndowmentBuilder } from './ethereum-provider';
4
- import { homePageEndowmentBuilder } from './home-page';
5
- import { getKeyringCaveatMapper, keyringCaveatSpecifications, keyringEndowmentBuilder } from './keyring';
6
- import { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';
7
- import { getNameLookupCaveatMapper, nameLookupCaveatSpecifications, nameLookupEndowmentBuilder } from './name-lookup';
8
- import { networkAccessEndowmentBuilder } from './network-access';
9
- import { getRpcCaveatMapper, rpcCaveatSpecifications, rpcEndowmentBuilder } from './rpc';
10
- import { getTransactionInsightCaveatMapper, transactionInsightCaveatSpecifications, transactionInsightEndowmentBuilder } from './transaction-insight';
11
- import { webAssemblyEndowmentBuilder } from './web-assembly';
12
- export const endowmentPermissionBuilders = {
13
- [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,
14
- [transactionInsightEndowmentBuilder.targetName]: transactionInsightEndowmentBuilder,
15
- [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,
16
- [ethereumProviderEndowmentBuilder.targetName]: ethereumProviderEndowmentBuilder,
17
- [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,
18
- [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,
19
- [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,
20
- [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,
21
- [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder,
22
- [homePageEndowmentBuilder.targetName]: homePageEndowmentBuilder
23
- };
24
- export const endowmentCaveatSpecifications = {
25
- ...cronjobCaveatSpecifications,
26
- ...transactionInsightCaveatSpecifications,
27
- ...rpcCaveatSpecifications,
28
- ...nameLookupCaveatSpecifications,
29
- ...keyringCaveatSpecifications
30
- };
31
- export const endowmentCaveatMappers = {
32
- [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,
33
- [transactionInsightEndowmentBuilder.targetName]: getTransactionInsightCaveatMapper,
34
- [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,
35
- [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,
36
- [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper
37
- };
38
- export const handlerEndowments = {
39
- [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,
40
- [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,
41
- [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,
42
- [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,
43
- [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,
44
- [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,
45
- [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName,
46
- [HandlerType.OnHomePage]: homePageEndowmentBuilder.targetName
47
- };
48
- export * from './enum';
49
- export { getRpcCaveatOrigins } from './rpc';
50
- export { getTransactionOriginCaveat } from './transaction-insight';
51
- export { getChainIdsCaveat } from './name-lookup';
52
- export { getKeyringCaveatOrigins } from './keyring';
53
-
54
- //# sourceMappingURL=index.js.map
@@ -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":["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"}
@@ -1,91 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { rpcErrors } from '@metamask/rpc-errors';
3
- import { assertIsKeyringOrigins, SnapCaveatType } from '@metamask/snaps-utils';
4
- import { assert, hasProperty, isPlainObject } from '@metamask/utils';
5
- import { SnapEndowments } from './enum';
6
- const permissionName = SnapEndowments.Keyring;
7
- /**
8
- * `endowment:keyring` returns nothing; it is intended to be used as a flag
9
- * by the client to detect whether the snap has keyring capabilities.
10
- *
11
- * @param _builderOptions - Optional specification builder options.
12
- * @returns The specification for the keyring endowment.
13
- */ const specificationBuilder = (_builderOptions)=>{
14
- return {
15
- permissionType: PermissionType.Endowment,
16
- targetName: permissionName,
17
- allowedCaveats: [
18
- SnapCaveatType.KeyringOrigin
19
- ],
20
- endowmentGetter: (_getterOptions)=>undefined,
21
- validator: ({ caveats })=>{
22
- if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.KeyringOrigin) {
23
- throw rpcErrors.invalidParams({
24
- message: `Expected a single "${SnapCaveatType.KeyringOrigin}" caveat.`
25
- });
26
- }
27
- },
28
- subjectTypes: [
29
- SubjectType.Snap
30
- ]
31
- };
32
- };
33
- export const keyringEndowmentBuilder = Object.freeze({
34
- targetName: permissionName,
35
- specificationBuilder
36
- });
37
- /**
38
- * Validate the value of a caveat. This does not validate the type of the
39
- * caveat itself, only the value of the caveat.
40
- *
41
- * @param caveat - The caveat to validate.
42
- * @throws If the caveat value is invalid.
43
- */ function validateCaveatOrigins(caveat) {
44
- if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
45
- throw rpcErrors.invalidParams({
46
- message: 'Invalid keyring origins: Expected a plain object.'
47
- });
48
- }
49
- const { value } = caveat;
50
- assertIsKeyringOrigins(value, rpcErrors.invalidParams);
51
- }
52
- /**
53
- * Map a raw value from the `initialPermissions` to a caveat specification.
54
- * Note that this function does not do any validation, that's handled by the
55
- * PermissionsController when the permission is requested.
56
- *
57
- * @param value - The raw value from the `initialPermissions`.
58
- * @returns The caveat specification.
59
- */ export function getKeyringCaveatMapper(value) {
60
- return {
61
- caveats: [
62
- {
63
- type: SnapCaveatType.KeyringOrigin,
64
- value
65
- }
66
- ]
67
- };
68
- }
69
- /**
70
- * Getter function to get the {@link KeyringOrigins} caveat value from a
71
- * permission.
72
- *
73
- * @param permission - The permission to get the caveat value from.
74
- * @returns The caveat value.
75
- * @throws If the permission does not have a valid {@link KeyringOrigins}
76
- * caveat.
77
- */ export function getKeyringCaveatOrigins(permission) {
78
- assert(permission?.caveats);
79
- assert(permission.caveats.length === 1);
80
- assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);
81
- const caveat = permission.caveats[0];
82
- return caveat.value;
83
- }
84
- export const keyringCaveatSpecifications = {
85
- [SnapCaveatType.KeyringOrigin]: Object.freeze({
86
- type: SnapCaveatType.KeyringOrigin,
87
- validator: (caveat)=>validateCaveatOrigins(caveat)
88
- })
89
- };
90
-
91
- //# 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":["PermissionType","SubjectType","rpcErrors","assertIsKeyringOrigins","SnapCaveatType","assert","hasProperty","isPlainObject","SnapEndowments","permissionName","Keyring","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","KeyringOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","keyringEndowmentBuilder","Object","freeze","validateCaveatOrigins","caveat","value","getKeyringCaveatMapper","getKeyringCaveatOrigins","permission","keyringCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AAEjD,SAASC,sBAAsB,EAAEC,cAAc,QAAQ,wBAAwB;AAE/E,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,OAAO;AAW7C;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACZ,eAAea,aAAa;SAAC;QAC9CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKpB,eAAea,aAAa,EAChD;gBACA,MAAMf,UAAUuB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEtB,eAAea,aAAa,CAAC,SAAS,CAAC;gBACxE;YACF;QACF;QACAU,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,0BAA0BC,OAAOC,MAAM,CAAC;IACnDhB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;;CAMC,GACD,SAASqB,sBAAsBC,MAA2B;IACxD,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,OAAOC,KAAK,GAAG;QACjE,MAAMhC,UAAUuB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAClB9B,uBAAuB+B,OAAOhC,UAAUuB,aAAa;AACvD;AAEA;;;;;;;CAOC,GACD,OAAO,SAASU,uBACdD,KAAW;IAEX,OAAO;QACLZ,SAAS;YACP;gBACEE,MAAMpB,eAAea,aAAa;gBAClCiB;YACF;SACD;IACH;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASE,wBACdC,UAAiC;IAEjChC,OAAOgC,YAAYf;IACnBjB,OAAOgC,WAAWf,OAAO,CAACC,MAAM,KAAK;IACrClB,OAAOgC,WAAWf,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKpB,eAAea,aAAa;IAElE,MAAMgB,SAASI,WAAWf,OAAO,CAAC,EAAE;IACpC,OAAOW,OAAOC,KAAK;AACrB;AAEA,OAAO,MAAMI,8BAGT;IACF,CAAClC,eAAea,aAAa,CAAC,EAAEa,OAAOC,MAAM,CAAC;QAC5CP,MAAMpB,eAAea,aAAa;QAClCI,WAAW,CAACY,SAAgCD,sBAAsBC;IACpE;AACF,EAAE"}
@@ -1,27 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { SnapEndowments } from './enum';
3
- const permissionName = SnapEndowments.LifecycleHooks;
4
- /**
5
- * `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a
6
- * flag by the snap controller to detect whether the snap has the capability to
7
- * use lifecycle hooks.
8
- *
9
- * @param _builderOptions - Optional specification builder options.
10
- * @returns The specification for the `lifecycle-hooks` endowment.
11
- */ const specificationBuilder = (_builderOptions)=>{
12
- return {
13
- permissionType: PermissionType.Endowment,
14
- targetName: permissionName,
15
- allowedCaveats: null,
16
- endowmentGetter: (_getterOptions)=>undefined,
17
- subjectTypes: [
18
- SubjectType.Snap
19
- ]
20
- };
21
- };
22
- export const lifecycleHooksEndowmentBuilder = Object.freeze({
23
- targetName: permissionName,
24
- specificationBuilder
25
- });
26
-
27
- //# 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":["PermissionType","SubjectType","SnapEndowments","permissionName","LifecycleHooks","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","Snap","lifecycleHooksEndowmentBuilder","Object","freeze"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAG9E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,cAAc;AASpD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACb,YAAYc,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,iCAAiCC,OAAOC,MAAM,CAAC;IAC1DT,YAAYN;IACZE;AACF,GAAY"}
@@ -1,98 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { rpcErrors } from '@metamask/rpc-errors';
3
- import { SnapCaveatType, isChainId } from '@metamask/snaps-utils';
4
- import { assert, hasProperty, isPlainObject } from '@metamask/utils';
5
- import { SnapEndowments } from './enum';
6
- const permissionName = SnapEndowments.NameLookup;
7
- /**
8
- * `endowment:name-lookup` returns nothing; it is intended to be used as a flag
9
- * by the extension to detect whether the snap has the capability to resolve a domain/address.
10
- *
11
- * @param _builderOptions - Optional specification builder options.
12
- * @returns The specification for the name-lookup endowment.
13
- */ const specificationBuilder = (_builderOptions)=>{
14
- return {
15
- permissionType: PermissionType.Endowment,
16
- targetName: permissionName,
17
- allowedCaveats: [
18
- SnapCaveatType.ChainIds
19
- ],
20
- endowmentGetter: (_getterOptions)=>undefined,
21
- validator: ({ caveats })=>{
22
- if (!caveats || caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== SnapCaveatType.ChainIds) {
23
- throw rpcErrors.invalidParams({
24
- message: `Expected a single "${SnapCaveatType.ChainIds}" caveat.`
25
- });
26
- }
27
- },
28
- subjectTypes: [
29
- SubjectType.Snap
30
- ]
31
- };
32
- };
33
- export const nameLookupEndowmentBuilder = Object.freeze({
34
- targetName: permissionName,
35
- specificationBuilder
36
- });
37
- /**
38
- * Validates the type of the caveat value.
39
- *
40
- * @param caveat - The caveat to validate.
41
- * @throws If the caveat value is invalid.
42
- */ function validateCaveat(caveat) {
43
- if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {
44
- throw rpcErrors.invalidParams({
45
- message: 'Expected a plain object.'
46
- });
47
- }
48
- const { value } = caveat;
49
- assert(Array.isArray(value) && value.every((val)=>isChainId(val)), 'Expected caveat value to have type "string array"');
50
- }
51
- /**
52
- * Map a raw value from the `initialPermissions` to a caveat specification.
53
- * Note that this function does not do any validation, that's handled by the
54
- * PermissionsController when the permission is requested.
55
- *
56
- * @param value - The raw value from the `initialPermissions`.
57
- * @returns The caveat specification.
58
- */ export function getNameLookupCaveatMapper(value) {
59
- if (!value || !Array.isArray(value) || Array.isArray(value) && value.length === 0) {
60
- return {
61
- caveats: null
62
- };
63
- }
64
- return {
65
- caveats: [
66
- {
67
- type: SnapCaveatType.ChainIds,
68
- value
69
- }
70
- ]
71
- };
72
- }
73
- /**
74
- * Getter function to get the chainIds caveat from a permission.
75
- *
76
- * This does basic validation of the caveat, but does not validate the type or
77
- * value of the namespaces object itself, as this is handled by the
78
- * `PermissionsController` when the permission is requested.
79
- *
80
- * @param permission - The permission to get the `chainIds` caveat from.
81
- * @returns An array of `chainIds` that the snap supports.
82
- */ export function getChainIdsCaveat(permission) {
83
- if (!permission?.caveats) {
84
- return null;
85
- }
86
- assert(permission.caveats.length === 1);
87
- assert(permission.caveats[0].type === SnapCaveatType.ChainIds);
88
- const caveat = permission.caveats[0];
89
- return caveat.value ?? null;
90
- }
91
- export const nameLookupCaveatSpecifications = {
92
- [SnapCaveatType.ChainIds]: Object.freeze({
93
- type: SnapCaveatType.ChainIds,
94
- validator: (caveat)=>validateCaveat(caveat)
95
- })
96
- };
97
-
98
- //# 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":["PermissionType","SubjectType","rpcErrors","SnapCaveatType","isChainId","assert","hasProperty","isPlainObject","SnapEndowments","permissionName","NameLookup","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","ChainIds","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","nameLookupEndowmentBuilder","Object","freeze","validateCaveat","caveat","value","Array","isArray","every","val","getNameLookupCaveatMapper","getChainIdsCaveat","permission","nameLookupCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,cAAc,EAAEC,SAAS,QAAQ,wBAAwB;AAElE,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,UAAU;AAUhD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACb,eAAec,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,KAAKrB,eAAec,QAAQ,EACrE;gBACA,MAAMf,UAAUuB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEvB,eAAec,QAAQ,CAAC,SAAS,CAAC;gBACnE;YACF;QACF;QACAU,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,6BAA6BC,OAAOC,MAAM,CAAC;IACtDhB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;CAKC,GACD,SAASqB,eAAeC,MAA2B;IACjD,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,SAAS;QAC3D,MAAM/B,UAAUuB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAElB5B,OACE8B,MAAMC,OAAO,CAACF,UAAUA,MAAMG,KAAK,CAAC,CAACC,MAAQlC,UAAUkC,OACvD;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,0BACdL,KAAW;IAEX,IACE,CAACA,SACD,CAACC,MAAMC,OAAO,CAACF,UACdC,MAAMC,OAAO,CAACF,UAAUA,MAAMX,MAAM,KAAK,GAC1C;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMrB,eAAec,QAAQ;gBAC7BiB;YACF;SACD;IACH;AACF;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASM,kBACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYnB,SAAS;QACxB,OAAO;IACT;IAEAjB,OAAOoC,WAAWnB,OAAO,CAACC,MAAM,KAAK;IACrClB,OAAOoC,WAAWnB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKrB,eAAec,QAAQ;IAE7D,MAAMgB,SAASQ,WAAWnB,OAAO,CAAC,EAAE;IAEpC,OAAOW,OAAOC,KAAK,IAAI;AACzB;AAEA,OAAO,MAAMQ,iCAGT;IACF,CAACvC,eAAec,QAAQ,CAAC,EAAEa,OAAOC,MAAM,CAAC;QACvCP,MAAMrB,eAAec,QAAQ;QAC7BI,WAAW,CAACY,SAAgCD,eAAeC;IAC7D;AACF,EAAE"}