@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,34 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { SnapEndowments } from './enum';
3
- const permissionName = SnapEndowments.NetworkAccess;
4
- /**
5
- * `endowment:network-access` returns the name of global browser API(s) that
6
- * enable network access. This is intended to populate the endowments of the
7
- * SES Compartment in which a Snap executes.
8
- *
9
- * @param _builderOptions - Optional specification builder options.
10
- * @returns The specification for the network endowment.
11
- */ const specificationBuilder = (_builderOptions)=>{
12
- return {
13
- permissionType: PermissionType.Endowment,
14
- targetName: permissionName,
15
- allowedCaveats: null,
16
- endowmentGetter: (_getterOptions)=>{
17
- return [
18
- 'fetch',
19
- 'Request',
20
- 'Headers',
21
- 'Response'
22
- ];
23
- },
24
- subjectTypes: [
25
- SubjectType.Snap
26
- ]
27
- };
28
- };
29
- export const networkAccessEndowmentBuilder = Object.freeze({
30
- targetName: permissionName,
31
- specificationBuilder
32
- });
33
-
34
- //# 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":["PermissionType","SubjectType","SnapEndowments","permissionName","NetworkAccess","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","Snap","networkAccessEndowmentBuilder","Object","freeze"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAE9E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,aAAa;AAWnD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;gBAAS;gBAAW;gBAAW;aAAW;QACpD;QACAC,cAAc;YAACZ,YAAYa,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,gCAAgCC,OAAOC,MAAM,CAAC;IACzDR,YAAYN;IACZE;AACF,GAAY"}
@@ -1,88 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { rpcErrors } from '@metamask/rpc-errors';
3
- import { assertIsRpcOrigins, SnapCaveatType } from '@metamask/snaps-utils';
4
- import { hasProperty, isPlainObject, assert } from '@metamask/utils';
5
- import { SnapEndowments } from './enum';
6
- const targetName = SnapEndowments.Rpc;
7
- /**
8
- * The specification builder for the JSON-RPC endowment permission.
9
- *
10
- * @param _builderOptions - Optional specification builder options.
11
- * @returns The specification for the JSON-RPC endowment permission.
12
- */ const specificationBuilder = (_builderOptions)=>{
13
- return {
14
- permissionType: PermissionType.Endowment,
15
- targetName,
16
- allowedCaveats: [
17
- SnapCaveatType.RpcOrigin
18
- ],
19
- endowmentGetter: (_getterOptions)=>undefined,
20
- validator: ({ caveats })=>{
21
- if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.RpcOrigin) {
22
- throw rpcErrors.invalidParams({
23
- message: `Expected a single "${SnapCaveatType.RpcOrigin}" caveat.`
24
- });
25
- }
26
- },
27
- subjectTypes: [
28
- SubjectType.Snap
29
- ]
30
- };
31
- };
32
- export const rpcEndowmentBuilder = Object.freeze({
33
- targetName,
34
- specificationBuilder
35
- });
36
- /**
37
- * Validate the value of a caveat. This does not validate the type of the
38
- * caveat itself, only the value of the caveat.
39
- *
40
- * @param caveat - The caveat to validate.
41
- * @throws If the caveat value is invalid.
42
- */ function validateCaveatOrigins(caveat) {
43
- if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
44
- throw rpcErrors.invalidParams({
45
- message: 'Invalid JSON-RPC origins: Expected a plain object.'
46
- });
47
- }
48
- const { value } = caveat;
49
- assertIsRpcOrigins(value, rpcErrors.invalidParams);
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 getRpcCaveatMapper(value) {
59
- return {
60
- caveats: [
61
- {
62
- type: SnapCaveatType.RpcOrigin,
63
- value
64
- }
65
- ]
66
- };
67
- }
68
- /**
69
- * Getter function to get the {@link RpcOrigins} caveat value from a permission.
70
- *
71
- * @param permission - The permission to get the caveat value from.
72
- * @returns The caveat value.
73
- * @throws If the permission does not have a valid {@link RpcOrigins} caveat.
74
- */ export function getRpcCaveatOrigins(permission) {
75
- assert(permission?.caveats);
76
- assert(permission.caveats.length === 1);
77
- assert(permission.caveats[0].type === SnapCaveatType.RpcOrigin);
78
- const caveat = permission.caveats[0];
79
- return caveat.value;
80
- }
81
- export const rpcCaveatSpecifications = {
82
- [SnapCaveatType.RpcOrigin]: Object.freeze({
83
- type: SnapCaveatType.RpcOrigin,
84
- validator: (caveat)=>validateCaveatOrigins(caveat)
85
- })
86
- };
87
-
88
- //# 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":["PermissionType","SubjectType","rpcErrors","assertIsRpcOrigins","SnapCaveatType","hasProperty","isPlainObject","assert","SnapEndowments","targetName","Rpc","specificationBuilder","_builderOptions","permissionType","Endowment","allowedCaveats","RpcOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","rpcEndowmentBuilder","Object","freeze","validateCaveatOrigins","caveat","value","getRpcCaveatMapper","getRpcCaveatOrigins","permission","rpcCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AAEjD,SAASC,kBAAkB,EAAEC,cAAc,QAAQ,wBAAwB;AAE3E,SAASC,WAAW,EAAEC,aAAa,EAAEC,MAAM,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,aAAaD,eAAeE,GAAG;AAerC;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCL;QACAM,gBAAgB;YAACX,eAAeY,SAAS;SAAC;QAC1CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKnB,eAAeY,SAAS,EAC5C;gBACA,MAAMd,UAAUsB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAErB,eAAeY,SAAS,CAAC,SAAS,CAAC;gBACpE;YACF;QACF;QACAU,cAAc;YAACzB,YAAY0B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,sBAAsBC,OAAOC,MAAM,CAAC;IAC/CrB;IACAE;AACF,GAAY;AAEZ;;;;;;CAMC,GACD,SAASoB,sBAAsBC,MAA2B;IACxD,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,OAAOC,KAAK,GAAG;QACjE,MAAM/B,UAAUsB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAClB7B,mBAAmB8B,OAAO/B,UAAUsB,aAAa;AACnD;AAEA;;;;;;;CAOC,GACD,OAAO,SAASU,mBACdD,KAAW;IAEX,OAAO;QACLZ,SAAS;YACP;gBACEE,MAAMnB,eAAeY,SAAS;gBAC9BiB;YACF;SACD;IACH;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,oBACdC,UAAiC;IAEjC7B,OAAO6B,YAAYf;IACnBd,OAAO6B,WAAWf,OAAO,CAACC,MAAM,KAAK;IACrCf,OAAO6B,WAAWf,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKnB,eAAeY,SAAS;IAE9D,MAAMgB,SAASI,WAAWf,OAAO,CAAC,EAAE;IACpC,OAAOW,OAAOC,KAAK;AACrB;AAEA,OAAO,MAAMI,0BAGT;IACF,CAACjC,eAAeY,SAAS,CAAC,EAAEa,OAAOC,MAAM,CAAC;QACxCP,MAAMnB,eAAeY,SAAS;QAC9BI,WAAW,CAACY,SAAgCD,sBAAsBC;IACpE;AACF,EAAE"}
@@ -1,99 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { rpcErrors } from '@metamask/rpc-errors';
3
- import { SnapCaveatType } from '@metamask/snaps-utils';
4
- import { assert, hasProperty, isObject, isPlainObject } from '@metamask/utils';
5
- import { SnapEndowments } from './enum';
6
- const permissionName = SnapEndowments.TransactionInsight;
7
- /**
8
- * `endowment:transaction-insight` returns nothing; it is intended to be used as a flag
9
- * by the extension to detect whether the snap has the capability to show information on the transaction confirmation screen.
10
- *
11
- * @param _builderOptions - Optional specification builder options.
12
- * @returns The specification for the transaction-insight endowment.
13
- */ const specificationBuilder = (_builderOptions)=>{
14
- return {
15
- permissionType: PermissionType.Endowment,
16
- targetName: permissionName,
17
- allowedCaveats: [
18
- SnapCaveatType.TransactionOrigin
19
- ],
20
- endowmentGetter: (_getterOptions)=>undefined,
21
- validator: ({ caveats })=>{
22
- if (caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== SnapCaveatType.TransactionOrigin) {
23
- throw rpcErrors.invalidParams({
24
- message: `Expected a single "${SnapCaveatType.TransactionOrigin}" caveat.`
25
- });
26
- }
27
- },
28
- subjectTypes: [
29
- SubjectType.Snap
30
- ]
31
- };
32
- };
33
- export const transactionInsightEndowmentBuilder = 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(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
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 getTransactionInsightCaveatMapper(value) {
59
- if (!value || !isObject(value) || isObject(value) && Object.keys(value).length === 0) {
60
- return {
61
- caveats: null
62
- };
63
- }
64
- return {
65
- caveats: [
66
- {
67
- type: SnapCaveatType.TransactionOrigin,
68
- value: hasProperty(value, 'allowTransactionOrigin') && value.allowTransactionOrigin
69
- }
70
- ]
71
- };
72
- }
73
- /**
74
- * Getter function to get the transaction origin 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 transaction origin caveat from.
81
- * @returns The transaction origin, or `null` if the permission does not have a
82
- * transaction origin caveat.
83
- */ export function getTransactionOriginCaveat(permission) {
84
- if (!permission?.caveats) {
85
- return null;
86
- }
87
- assert(permission.caveats.length === 1);
88
- assert(permission.caveats[0].type === SnapCaveatType.TransactionOrigin);
89
- const caveat = permission.caveats[0];
90
- return caveat.value ?? null;
91
- }
92
- export const transactionInsightCaveatSpecifications = {
93
- [SnapCaveatType.TransactionOrigin]: Object.freeze({
94
- type: SnapCaveatType.TransactionOrigin,
95
- validator: (caveat)=>validateCaveat(caveat)
96
- })
97
- };
98
-
99
- //# 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":["PermissionType","SubjectType","rpcErrors","SnapCaveatType","assert","hasProperty","isObject","isPlainObject","SnapEndowments","permissionName","TransactionInsight","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","TransactionOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","transactionInsightEndowmentBuilder","Object","freeze","validateCaveat","caveat","value","getTransactionInsightCaveatMapper","keys","allowTransactionOrigin","getTransactionOriginCaveat","permission","transactionInsightCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,cAAc,QAAQ,wBAAwB;AAEvD,SAASC,MAAM,EAAEC,WAAW,EAAEC,QAAQ,EAAEC,aAAa,QAAQ,kBAAkB;AAE/E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,kBAAkB;AAUxD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACb,eAAec,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,KAAKrB,eAAec,iBAAiB,EACtD;gBACA,MAAMf,UAAUuB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEvB,eAAec,iBAAiB,CAAC,SAAS,CAAC;gBAC5E;YACF;QACF;QACAU,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,qCAAqCC,OAAOC,MAAM,CAAC;IAC9DhB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;CAKC,GACD,SAASqB,eAAeC,MAA2B;IACjD,IAAI,CAAC5B,YAAY4B,QAAQ,YAAY,CAAC1B,cAAc0B,SAAS;QAC3D,MAAM/B,UAAUuB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAElB7B,OACE,OAAO8B,UAAU,WACjB;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,kCACdD,KAAW;IAEX,IACE,CAACA,SACD,CAAC5B,SAAS4B,UACT5B,SAAS4B,UAAUJ,OAAOM,IAAI,CAACF,OAAOX,MAAM,KAAK,GAClD;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMrB,eAAec,iBAAiB;gBACtCiB,OACE7B,YAAY6B,OAAO,6BAClBA,MAAMG,sBAAsB;YACjC;SACD;IACH;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,2BACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYjB,SAAS;QACxB,OAAO;IACT;IAEAlB,OAAOmC,WAAWjB,OAAO,CAACC,MAAM,KAAK;IACrCnB,OAAOmC,WAAWjB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKrB,eAAec,iBAAiB;IAEtE,MAAMgB,SAASM,WAAWjB,OAAO,CAAC,EAAE;IAEpC,OAAOW,OAAOC,KAAK,IAAI;AACzB;AAEA,OAAO,MAAMM,yCAGT;IACF,CAACrC,eAAec,iBAAiB,CAAC,EAAEa,OAAOC,MAAM,CAAC;QAChDP,MAAMrB,eAAec,iBAAiB;QACtCI,WAAW,CAACY,SAAgCD,eAAeC;IAC7D;AACF,EAAE"}
@@ -1,32 +0,0 @@
1
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
2
- import { SnapEndowments } from './enum';
3
- const permissionName = SnapEndowments.WebAssemblyAccess;
4
- /**
5
- * `endowment:webassembly` returns the name of global browser API(s) that
6
- * enable access to the WebAssembly API.
7
- * This is intended to populate the endowments of the SES Compartment
8
- * in which a Snap executes.
9
- *
10
- * @param _builderOptions - Optional specification builder options.
11
- * @returns The specification for the WebAssembly endowment.
12
- */ const specificationBuilder = (_builderOptions)=>{
13
- return {
14
- permissionType: PermissionType.Endowment,
15
- targetName: permissionName,
16
- allowedCaveats: null,
17
- endowmentGetter: (_getterOptions)=>{
18
- return [
19
- 'WebAssembly'
20
- ];
21
- },
22
- subjectTypes: [
23
- SubjectType.Snap
24
- ]
25
- };
26
- };
27
- export const webAssemblyEndowmentBuilder = Object.freeze({
28
- targetName: permissionName,
29
- specificationBuilder
30
- });
31
-
32
- //# 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":["PermissionType","SubjectType","SnapEndowments","permissionName","WebAssemblyAccess","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","Snap","webAssemblyEndowmentBuilder","Object","freeze"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAE9E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,iBAAiB;AASvD;;;;;;;;CAQC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;aAAc;QACxB;QACAC,cAAc;YAACZ,YAAYa,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,8BAA8BC,OAAOC,MAAM,CAAC;IACvDR,YAAYN;IACZE;AACF,GAAY"}
@@ -1,50 +0,0 @@
1
- import { caveatMappers, restrictedMethodPermissionBuilders, selectHooks } from '@metamask/snaps-rpc-methods';
2
- import { hasProperty } from '@metamask/utils';
3
- import { endowmentCaveatMappers, endowmentPermissionBuilders } from './endowments';
4
- /**
5
- * Map initial permissions as defined in a Snap manifest to something that can
6
- * be processed by the PermissionsController. Each caveat mapping function
7
- * should return a valid permission caveat value.
8
- *
9
- * This function does not validate the caveat values, since that is done by
10
- * the PermissionsController itself, upon requesting the permissions.
11
- *
12
- * @param initialPermissions - The initial permissions to process.
13
- * @returns The processed permissions.
14
- */ export function processSnapPermissions(initialPermissions) {
15
- return Object.fromEntries(Object.entries(initialPermissions).map(([initialPermission, value])=>{
16
- if (hasProperty(caveatMappers, initialPermission)) {
17
- return [
18
- initialPermission,
19
- caveatMappers[initialPermission](value)
20
- ];
21
- } else if (hasProperty(endowmentCaveatMappers, initialPermission)) {
22
- return [
23
- initialPermission,
24
- endowmentCaveatMappers[initialPermission](value)
25
- ];
26
- }
27
- // If we have no mapping, this may be a non-snap permission, return as-is
28
- return [
29
- initialPermission,
30
- value
31
- ];
32
- }));
33
- }
34
- export const buildSnapEndowmentSpecifications = (excludedEndowments)=>Object.values(endowmentPermissionBuilders).reduce((allSpecifications, { targetName, specificationBuilder })=>{
35
- if (!excludedEndowments.includes(targetName)) {
36
- allSpecifications[targetName] = specificationBuilder({});
37
- }
38
- return allSpecifications;
39
- }, {});
40
- export const buildSnapRestrictedMethodSpecifications = (excludedPermissions, hooks)=>Object.values(restrictedMethodPermissionBuilders).reduce((specifications, { targetName, specificationBuilder, methodHooks })=>{
41
- if (!excludedPermissions.includes(targetName)) {
42
- specifications[targetName] = specificationBuilder({
43
- // @ts-expect-error The selectHooks type is wonky
44
- methodHooks: selectHooks(hooks, methodHooks)
45
- });
46
- }
47
- return specifications;
48
- }, {});
49
-
50
- //# 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":["caveatMappers","restrictedMethodPermissionBuilders","selectHooks","hasProperty","endowmentCaveatMappers","endowmentPermissionBuilders","processSnapPermissions","initialPermissions","Object","fromEntries","entries","map","initialPermission","value","buildSnapEndowmentSpecifications","excludedEndowments","values","reduce","allSpecifications","targetName","specificationBuilder","includes","buildSnapRestrictedMethodSpecifications","excludedPermissions","hooks","specifications","methodHooks"],"mappings":"AAIA,SACEA,aAAa,EACbC,kCAAkC,EAClCC,WAAW,QACN,8BAA8B;AAErC,SAASC,WAAW,QAAQ,kBAAkB;AAE9C,SACEC,sBAAsB,EACtBC,2BAA2B,QACtB,eAAe;AAEtB;;;;;;;;;;CAUC,GACD,OAAO,SAASC,uBACdC,kBAAmC;IAEnC,OAAOC,OAAOC,WAAW,CACvBD,OAAOE,OAAO,CAACH,oBAAoBI,GAAG,CAAC,CAAC,CAACC,mBAAmBC,MAAM;QAChE,IAAIV,YAAYH,eAAeY,oBAAoB;YACjD,OAAO;gBAACA;gBAAmBZ,aAAa,CAACY,kBAAkB,CAACC;aAAO;QACrE,OAAO,IAAIV,YAAYC,wBAAwBQ,oBAAoB;YACjE,OAAO;gBACLA;gBACAR,sBAAsB,CAACQ,kBAAkB,CAACC;aAC3C;QACH;QAEA,yEAAyE;QACzE,OAAO;YACLD;YACAC;SACD;IACH;AAEJ;AAEA,OAAO,MAAMC,mCAAmC,CAC9CC,qBAEAP,OAAOQ,MAAM,CAACX,6BAA6BY,MAAM,CAE/C,CAACC,mBAAmB,EAAEC,UAAU,EAAEC,oBAAoB,EAAE;QACxD,IAAI,CAACL,mBAAmBM,QAAQ,CAACF,aAAa;YAC5CD,iBAAiB,CAACC,WAAW,GAAGC,qBAAqB,CAAC;QACxD;QACA,OAAOF;IACT,GAAG,CAAC,GAAG;AAET,OAAO,MAAMI,0CAA0C,CACrDC,qBACAC,QAEAhB,OAAOQ,MAAM,CAACf,oCAAoCgB,MAAM,CAEtD,CAACQ,gBAAgB,EAAEN,UAAU,EAAEC,oBAAoB,EAAEM,WAAW,EAAE;QAClE,IAAI,CAACH,oBAAoBF,QAAQ,CAACF,aAAa;YAC7CM,cAAc,CAACN,WAAW,GAAGC,qBAAqB;gBAChD,iDAAiD;gBACjDM,aAAaxB,YACXsB,OACAE;YAEJ;QACF;QACA,OAAOD;IACT,GAAG,CAAC,GAAG"}
@@ -1,51 +0,0 @@
1
- import type { PermissionSpecificationBuilder, PermissionConstraint, Caveat, CaveatSpecificationConstraint } from '@metamask/permission-controller';
2
- import { PermissionType } from '@metamask/permission-controller';
3
- import type { CronjobSpecification } from '@metamask/snaps-utils';
4
- import { SnapCaveatType } from '@metamask/snaps-utils';
5
- import type { Json, NonEmptyArray } from '@metamask/utils';
6
- import { SnapEndowments } from './enum';
7
- declare const permissionName = SnapEndowments.Cronjob;
8
- export declare const cronjobEndowmentBuilder: Readonly<{
9
- readonly targetName: SnapEndowments.Cronjob;
10
- readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
11
- permissionType: PermissionType.Endowment;
12
- targetName: typeof permissionName;
13
- endowmentGetter: (_options?: any) => undefined;
14
- allowedCaveats: Readonly<NonEmptyArray<string>> | null;
15
- }>;
16
- }>;
17
- /**
18
- * Map a raw value from the `initialPermissions` to a caveat specification.
19
- * Note that this function does not do any validation, that's handled by the
20
- * PermissionsController when the permission is requested.
21
- *
22
- * @param value - The raw value from the `initialPermissions`.
23
- * @returns The caveat specification.
24
- */
25
- export declare function getCronjobCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
26
- /**
27
- * Getter function to get the cronjobs from a permission.
28
- *
29
- * This does basic validation of the caveat, but does not validate the type or
30
- * value of the namespaces object itself, as this is handled by the
31
- * `PermissionsController` when the permission is requested.
32
- *
33
- * @param permission - The permission to get the keyring namespaces from.
34
- * @returns The cronjobs, or `null` if the permission does not have a
35
- * cronjob caveat.
36
- */
37
- export declare function getCronjobCaveatJobs(permission?: PermissionConstraint): CronjobSpecification[] | null;
38
- /**
39
- * Validate the cronjob specification values associated with a caveat.
40
- * This validates that the value is a non-empty array with valid
41
- * cronjob expression and request object.
42
- *
43
- * @param caveat - The caveat to validate.
44
- * @throws If the value is invalid.
45
- */
46
- export declare function validateCronjobCaveat(caveat: Caveat<string, any>): void;
47
- /**
48
- * Caveat specification for the Cronjob.
49
- */
50
- export declare const cronjobCaveatSpecifications: Record<SnapCaveatType.SnapCronjob, CaveatSpecificationConstraint>;
51
- export {};
@@ -1,12 +0,0 @@
1
- export declare enum SnapEndowments {
2
- NetworkAccess = "endowment:network-access",
3
- TransactionInsight = "endowment:transaction-insight",
4
- Cronjob = "endowment:cronjob",
5
- EthereumProvider = "endowment:ethereum-provider",
6
- Rpc = "endowment:rpc",
7
- WebAssemblyAccess = "endowment:webassembly",
8
- NameLookup = "endowment:name-lookup",
9
- LifecycleHooks = "endowment:lifecycle-hooks",
10
- Keyring = "endowment:keyring",
11
- HomePage = "endowment:page-home"
12
- }
@@ -1,14 +0,0 @@
1
- import type { PermissionSpecificationBuilder } from '@metamask/permission-controller';
2
- import { PermissionType } from '@metamask/permission-controller';
3
- import { SnapEndowments } from './enum';
4
- declare const permissionName = SnapEndowments.EthereumProvider;
5
- export declare const ethereumProviderEndowmentBuilder: Readonly<{
6
- readonly targetName: SnapEndowments.EthereumProvider;
7
- readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
8
- permissionType: PermissionType.Endowment;
9
- targetName: typeof permissionName;
10
- endowmentGetter: (_options?: any) => ['ethereum'];
11
- allowedCaveats: null;
12
- }>;
13
- }>;
14
- export {};
@@ -1,15 +0,0 @@
1
- import type { PermissionSpecificationBuilder, EndowmentGetterParams } from '@metamask/permission-controller';
2
- import { PermissionType } from '@metamask/permission-controller';
3
- import type { NonEmptyArray } from '@metamask/utils';
4
- import { SnapEndowments } from './enum';
5
- declare const permissionName = SnapEndowments.HomePage;
6
- export declare const homePageEndowmentBuilder: Readonly<{
7
- readonly targetName: SnapEndowments.HomePage;
8
- readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
9
- permissionType: PermissionType.Endowment;
10
- targetName: typeof permissionName;
11
- endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
12
- allowedCaveats: Readonly<NonEmptyArray<string>> | null;
13
- }>;
14
- }>;
15
- export {};
@@ -1,115 +0,0 @@
1
- import type { PermissionConstraint } from '@metamask/permission-controller';
2
- import { HandlerType } from '@metamask/snaps-utils';
3
- import type { Json } from '@metamask/utils';
4
- export declare const endowmentPermissionBuilders: {
5
- readonly "endowment:network-access": Readonly<{
6
- readonly targetName: import("./enum").SnapEndowments.NetworkAccess;
7
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
8
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
9
- targetName: import("./enum").SnapEndowments.NetworkAccess;
10
- endowmentGetter: (_options?: any) => ["fetch", "Request", "Headers", "Response"];
11
- allowedCaveats: null;
12
- }>;
13
- }>;
14
- readonly "endowment:transaction-insight": Readonly<{
15
- readonly targetName: import("./enum").SnapEndowments.TransactionInsight;
16
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
17
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
18
- targetName: import("./enum").SnapEndowments.TransactionInsight;
19
- endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
20
- allowedCaveats: readonly [string, ...string[]] | null;
21
- validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
22
- }>;
23
- }>;
24
- readonly "endowment:cronjob": Readonly<{
25
- readonly targetName: import("./enum").SnapEndowments.Cronjob;
26
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
27
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
28
- targetName: import("./enum").SnapEndowments.Cronjob;
29
- endowmentGetter: (_options?: any) => undefined;
30
- allowedCaveats: readonly [string, ...string[]] | null;
31
- }>;
32
- }>;
33
- readonly "endowment:ethereum-provider": Readonly<{
34
- readonly targetName: import("./enum").SnapEndowments.EthereumProvider;
35
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
36
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
37
- targetName: import("./enum").SnapEndowments.EthereumProvider;
38
- endowmentGetter: (_options?: any) => ["ethereum"];
39
- allowedCaveats: null;
40
- }>;
41
- }>;
42
- readonly "endowment:rpc": Readonly<{
43
- readonly targetName: import("./enum").SnapEndowments.Rpc;
44
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, {}, {
45
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
46
- targetName: import("./enum").SnapEndowments.Rpc;
47
- endowmentGetter: (_options?: any) => undefined;
48
- allowedCaveats: readonly [string, ...string[]] | null;
49
- validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
50
- subjectTypes: readonly import("@metamask/permission-controller").SubjectType[];
51
- }>;
52
- }>;
53
- readonly "endowment:webassembly": Readonly<{
54
- readonly targetName: import("./enum").SnapEndowments.WebAssemblyAccess;
55
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
56
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
57
- targetName: import("./enum").SnapEndowments.WebAssemblyAccess;
58
- endowmentGetter: (_options?: any) => ["WebAssembly"];
59
- allowedCaveats: null;
60
- }>;
61
- }>;
62
- readonly "endowment:name-lookup": Readonly<{
63
- readonly targetName: import("./enum").SnapEndowments.NameLookup;
64
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
65
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
66
- targetName: import("./enum").SnapEndowments.NameLookup;
67
- endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
68
- allowedCaveats: readonly [string, ...string[]] | null;
69
- validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
70
- }>;
71
- }>;
72
- readonly "endowment:lifecycle-hooks": Readonly<{
73
- readonly targetName: import("./enum").SnapEndowments.LifecycleHooks;
74
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
75
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
76
- targetName: import("./enum").SnapEndowments.LifecycleHooks;
77
- endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
78
- allowedCaveats: readonly [string, ...string[]] | null;
79
- }>;
80
- }>;
81
- readonly "endowment:keyring": Readonly<{
82
- readonly targetName: import("./enum").SnapEndowments.Keyring;
83
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
84
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
85
- targetName: import("./enum").SnapEndowments.Keyring;
86
- endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
87
- allowedCaveats: readonly [string, ...string[]] | null;
88
- validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
89
- subjectTypes: readonly import("@metamask/permission-controller").SubjectType[];
90
- }>;
91
- }>;
92
- readonly "endowment:page-home": Readonly<{
93
- readonly targetName: import("./enum").SnapEndowments.HomePage;
94
- readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
95
- permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
96
- targetName: import("./enum").SnapEndowments.HomePage;
97
- endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
98
- allowedCaveats: readonly [string, ...string[]] | null;
99
- }>;
100
- }>;
101
- };
102
- export declare const endowmentCaveatSpecifications: {
103
- keyringOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
104
- chainIds: import("@metamask/permission-controller").CaveatSpecificationConstraint;
105
- rpcOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
106
- transactionOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
107
- snapCronjob: import("@metamask/permission-controller").CaveatSpecificationConstraint;
108
- };
109
- export declare const endowmentCaveatMappers: Record<string, (value: Json) => Pick<PermissionConstraint, 'caveats'>>;
110
- export declare const handlerEndowments: Record<HandlerType, string>;
111
- export * from './enum';
112
- export { getRpcCaveatOrigins } from './rpc';
113
- export { getTransactionOriginCaveat } from './transaction-insight';
114
- export { getChainIdsCaveat } from './name-lookup';
115
- export { getKeyringCaveatOrigins } from './keyring';
@@ -1,39 +0,0 @@
1
- import type { CaveatSpecificationConstraint, EndowmentGetterParams, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from '@metamask/permission-controller';
2
- import { PermissionType, SubjectType } from '@metamask/permission-controller';
3
- import type { KeyringOrigins } from '@metamask/snaps-utils';
4
- import { SnapCaveatType } from '@metamask/snaps-utils';
5
- import type { Json, NonEmptyArray } from '@metamask/utils';
6
- import { SnapEndowments } from './enum';
7
- declare const permissionName = SnapEndowments.Keyring;
8
- export declare const keyringEndowmentBuilder: Readonly<{
9
- readonly targetName: SnapEndowments.Keyring;
10
- readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
11
- permissionType: PermissionType.Endowment;
12
- targetName: typeof permissionName;
13
- endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
14
- allowedCaveats: Readonly<NonEmptyArray<string>> | null;
15
- validator: PermissionValidatorConstraint;
16
- subjectTypes: readonly SubjectType[];
17
- }>;
18
- }>;
19
- /**
20
- * Map a raw value from the `initialPermissions` to a caveat specification.
21
- * Note that this function does not do any validation, that's handled by the
22
- * PermissionsController when the permission is requested.
23
- *
24
- * @param value - The raw value from the `initialPermissions`.
25
- * @returns The caveat specification.
26
- */
27
- export declare function getKeyringCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
28
- /**
29
- * Getter function to get the {@link KeyringOrigins} caveat value from a
30
- * permission.
31
- *
32
- * @param permission - The permission to get the caveat value from.
33
- * @returns The caveat value.
34
- * @throws If the permission does not have a valid {@link KeyringOrigins}
35
- * caveat.
36
- */
37
- export declare function getKeyringCaveatOrigins(permission?: PermissionConstraint): KeyringOrigins | null;
38
- export declare const keyringCaveatSpecifications: Record<SnapCaveatType.KeyringOrigin, CaveatSpecificationConstraint>;
39
- export {};
@@ -1,15 +0,0 @@
1
- import type { PermissionSpecificationBuilder, EndowmentGetterParams } from '@metamask/permission-controller';
2
- import { PermissionType } from '@metamask/permission-controller';
3
- import type { NonEmptyArray } from '@metamask/utils';
4
- import { SnapEndowments } from './enum';
5
- declare const permissionName = SnapEndowments.LifecycleHooks;
6
- export declare const lifecycleHooksEndowmentBuilder: Readonly<{
7
- readonly targetName: SnapEndowments.LifecycleHooks;
8
- readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
9
- permissionType: PermissionType.Endowment;
10
- targetName: typeof permissionName;
11
- endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
12
- allowedCaveats: Readonly<NonEmptyArray<string>> | null;
13
- }>;
14
- }>;
15
- export {};