@metamask/snaps-controllers 4.1.0 → 5.0.1

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 (145) hide show
  1. package/CHANGELOG.md +27 -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/browser.js +1 -0
  13. package/dist/cjs/services/browser.js.map +1 -1
  14. package/dist/cjs/services/index.js +1 -0
  15. package/dist/cjs/services/index.js.map +1 -1
  16. package/dist/cjs/services/webview/WebViewExecutionService.js +99 -0
  17. package/dist/cjs/services/webview/WebViewExecutionService.js.map +1 -0
  18. package/dist/cjs/services/webview/WebViewMessageStream.js +127 -0
  19. package/dist/cjs/services/webview/WebViewMessageStream.js.map +1 -0
  20. package/dist/cjs/services/webview/index.js +20 -0
  21. package/dist/cjs/services/webview/index.js.map +1 -0
  22. package/dist/cjs/snaps/SnapController.js +111 -51
  23. package/dist/cjs/snaps/SnapController.js.map +1 -1
  24. package/dist/cjs/snaps/constants.js +25 -0
  25. package/dist/cjs/snaps/constants.js.map +1 -0
  26. package/dist/cjs/snaps/index.js +0 -2
  27. package/dist/cjs/snaps/index.js.map +1 -1
  28. package/dist/cjs/snaps/location/npm.js +13 -2
  29. package/dist/cjs/snaps/location/npm.js.map +1 -1
  30. package/dist/cjs/snaps/registry/json.js +10 -5
  31. package/dist/cjs/snaps/registry/json.js.map +1 -1
  32. package/dist/esm/cronjob/CronjobController.js +2 -2
  33. package/dist/esm/cronjob/CronjobController.js.map +1 -1
  34. package/dist/esm/index.js +1 -0
  35. package/dist/esm/index.js.map +1 -1
  36. package/dist/esm/interface/SnapInterfaceController.js +158 -0
  37. package/dist/esm/interface/SnapInterfaceController.js.map +1 -0
  38. package/dist/esm/interface/index.js +3 -0
  39. package/dist/esm/interface/index.js.map +1 -0
  40. package/dist/esm/interface/utils.js +62 -0
  41. package/dist/esm/interface/utils.js.map +1 -0
  42. package/dist/esm/services/browser.js +1 -0
  43. package/dist/esm/services/browser.js.map +1 -1
  44. package/dist/esm/services/index.js +1 -0
  45. package/dist/esm/services/index.js.map +1 -1
  46. package/dist/esm/services/webview/WebViewExecutionService.js +89 -0
  47. package/dist/esm/services/webview/WebViewExecutionService.js.map +1 -0
  48. package/dist/esm/services/webview/WebViewMessageStream.js +119 -0
  49. package/dist/esm/services/webview/WebViewMessageStream.js.map +1 -0
  50. package/dist/esm/services/webview/index.js +3 -0
  51. package/dist/esm/services/webview/index.js.map +1 -0
  52. package/dist/esm/snaps/SnapController.js +105 -45
  53. package/dist/esm/snaps/SnapController.js.map +1 -1
  54. package/dist/esm/snaps/constants.js +16 -0
  55. package/dist/esm/snaps/constants.js.map +1 -0
  56. package/dist/esm/snaps/index.js +0 -2
  57. package/dist/esm/snaps/index.js.map +1 -1
  58. package/dist/esm/snaps/location/npm.js +13 -2
  59. package/dist/esm/snaps/location/npm.js.map +1 -1
  60. package/dist/esm/snaps/registry/json.js +10 -5
  61. package/dist/esm/snaps/registry/json.js.map +1 -1
  62. package/dist/types/index.d.ts +1 -0
  63. package/dist/types/interface/SnapInterfaceController.d.ts +85 -0
  64. package/dist/types/interface/index.d.ts +1 -0
  65. package/dist/types/interface/utils.d.ts +36 -0
  66. package/dist/types/services/browser.d.ts +1 -0
  67. package/dist/types/services/index.d.ts +1 -0
  68. package/dist/types/services/webview/WebViewExecutionService.d.ts +20 -0
  69. package/dist/types/services/webview/WebViewMessageStream.d.ts +32 -0
  70. package/dist/types/services/webview/index.d.ts +1 -0
  71. package/dist/types/snaps/SnapController.d.ts +7 -4
  72. package/dist/types/snaps/constants.d.ts +1 -0
  73. package/dist/types/snaps/index.d.ts +0 -2
  74. package/dist/types/utils.d.ts +33 -13
  75. package/package.json +12 -12
  76. package/dist/cjs/snaps/endowments/cronjob.js +0 -100
  77. package/dist/cjs/snaps/endowments/cronjob.js.map +0 -1
  78. package/dist/cjs/snaps/endowments/enum.js +0 -26
  79. package/dist/cjs/snaps/endowments/enum.js.map +0 -1
  80. package/dist/cjs/snaps/endowments/ethereum-provider.js +0 -43
  81. package/dist/cjs/snaps/endowments/ethereum-provider.js.map +0 -1
  82. package/dist/cjs/snaps/endowments/home-page.js +0 -37
  83. package/dist/cjs/snaps/endowments/home-page.js.map +0 -1
  84. package/dist/cjs/snaps/endowments/index.js +0 -107
  85. package/dist/cjs/snaps/endowments/index.js.map +0 -1
  86. package/dist/cjs/snaps/endowments/keyring.js +0 -100
  87. package/dist/cjs/snaps/endowments/keyring.js.map +0 -1
  88. package/dist/cjs/snaps/endowments/lifecycle-hooks.js +0 -37
  89. package/dist/cjs/snaps/endowments/lifecycle-hooks.js.map +0 -1
  90. package/dist/cjs/snaps/endowments/name-lookup.js +0 -106
  91. package/dist/cjs/snaps/endowments/name-lookup.js.map +0 -1
  92. package/dist/cjs/snaps/endowments/network-access.js +0 -44
  93. package/dist/cjs/snaps/endowments/network-access.js.map +0 -1
  94. package/dist/cjs/snaps/endowments/rpc.js +0 -99
  95. package/dist/cjs/snaps/endowments/rpc.js.map +0 -1
  96. package/dist/cjs/snaps/endowments/signature-insight.js +0 -106
  97. package/dist/cjs/snaps/endowments/signature-insight.js.map +0 -1
  98. package/dist/cjs/snaps/endowments/transaction-insight.js +0 -106
  99. package/dist/cjs/snaps/endowments/transaction-insight.js.map +0 -1
  100. package/dist/cjs/snaps/endowments/web-assembly.js +0 -42
  101. package/dist/cjs/snaps/endowments/web-assembly.js.map +0 -1
  102. package/dist/cjs/snaps/permissions.js +0 -61
  103. package/dist/cjs/snaps/permissions.js.map +0 -1
  104. package/dist/esm/snaps/endowments/cronjob.js +0 -99
  105. package/dist/esm/snaps/endowments/cronjob.js.map +0 -1
  106. package/dist/esm/snaps/endowments/enum.js +0 -16
  107. package/dist/esm/snaps/endowments/enum.js.map +0 -1
  108. package/dist/esm/snaps/endowments/ethereum-provider.js +0 -33
  109. package/dist/esm/snaps/endowments/ethereum-provider.js.map +0 -1
  110. package/dist/esm/snaps/endowments/home-page.js +0 -27
  111. package/dist/esm/snaps/endowments/home-page.js.map +0 -1
  112. package/dist/esm/snaps/endowments/index.js +0 -60
  113. package/dist/esm/snaps/endowments/index.js.map +0 -1
  114. package/dist/esm/snaps/endowments/keyring.js +0 -91
  115. package/dist/esm/snaps/endowments/keyring.js.map +0 -1
  116. package/dist/esm/snaps/endowments/lifecycle-hooks.js +0 -27
  117. package/dist/esm/snaps/endowments/lifecycle-hooks.js.map +0 -1
  118. package/dist/esm/snaps/endowments/name-lookup.js +0 -98
  119. package/dist/esm/snaps/endowments/name-lookup.js.map +0 -1
  120. package/dist/esm/snaps/endowments/network-access.js +0 -34
  121. package/dist/esm/snaps/endowments/network-access.js.map +0 -1
  122. package/dist/esm/snaps/endowments/rpc.js +0 -88
  123. package/dist/esm/snaps/endowments/rpc.js.map +0 -1
  124. package/dist/esm/snaps/endowments/signature-insight.js +0 -99
  125. package/dist/esm/snaps/endowments/signature-insight.js.map +0 -1
  126. package/dist/esm/snaps/endowments/transaction-insight.js +0 -99
  127. package/dist/esm/snaps/endowments/transaction-insight.js.map +0 -1
  128. package/dist/esm/snaps/endowments/web-assembly.js +0 -32
  129. package/dist/esm/snaps/endowments/web-assembly.js.map +0 -1
  130. package/dist/esm/snaps/permissions.js +0 -50
  131. package/dist/esm/snaps/permissions.js.map +0 -1
  132. package/dist/types/snaps/endowments/cronjob.d.ts +0 -51
  133. package/dist/types/snaps/endowments/enum.d.ts +0 -13
  134. package/dist/types/snaps/endowments/ethereum-provider.d.ts +0 -14
  135. package/dist/types/snaps/endowments/home-page.d.ts +0 -15
  136. package/dist/types/snaps/endowments/index.d.ts +0 -127
  137. package/dist/types/snaps/endowments/keyring.d.ts +0 -39
  138. package/dist/types/snaps/endowments/lifecycle-hooks.d.ts +0 -15
  139. package/dist/types/snaps/endowments/name-lookup.d.ts +0 -38
  140. package/dist/types/snaps/endowments/network-access.d.ts +0 -14
  141. package/dist/types/snaps/endowments/rpc.d.ts +0 -38
  142. package/dist/types/snaps/endowments/signature-insight.d.ts +0 -39
  143. package/dist/types/snaps/endowments/transaction-insight.d.ts +0 -39
  144. package/dist/types/snaps/endowments/web-assembly.d.ts +0 -14
  145. package/dist/types/snaps/permissions.d.ts +0 -16
@@ -183,15 +183,6 @@ export declare function fetchSnap(snapId: SnapId, location: SnapLocation): Promi
183
183
  wallet_snap?: Record<string, {
184
184
  version?: string | undefined;
185
185
  }> | undefined;
186
- 'endowment:ethereum-provider'?: {} | undefined;
187
- 'endowment:network-access'?: {} | undefined;
188
- 'endowment:webassembly'?: {} | undefined;
189
- 'endowment:signature-insight'?: {
190
- allowSignatureOrigin?: boolean | undefined;
191
- } | undefined;
192
- 'endowment:transaction-insight'?: {
193
- allowTransactionOrigin?: boolean | undefined;
194
- } | undefined;
195
186
  'endowment:cronjob'?: {
196
187
  jobs: {
197
188
  request: {
@@ -202,17 +193,46 @@ export declare function fetchSnap(snapId: SnapId, location: SnapLocation): Promi
202
193
  };
203
194
  expression: string;
204
195
  }[];
196
+ maxRequestTime?: number | undefined;
197
+ } | undefined;
198
+ 'endowment:ethereum-provider'?: {} | undefined;
199
+ 'endowment:keyring'?: {
200
+ allowedOrigins?: string[] | undefined;
201
+ maxRequestTime?: number | undefined;
202
+ } | undefined;
203
+ 'endowment:lifecycle-hooks'?: {
204
+ maxRequestTime?: number | undefined;
205
+ } | undefined;
206
+ 'endowment:name-lookup'?: {
207
+ chains?: `${string}:${string}`[] | undefined;
208
+ maxRequestTime?: number | undefined;
209
+ matchers?: {
210
+ tlds: string[];
211
+ } | {
212
+ schemes: string[];
213
+ } | {
214
+ tlds: string[];
215
+ schemes: string[];
216
+ } | undefined;
217
+ } | undefined;
218
+ 'endowment:network-access'?: {} | undefined;
219
+ 'endowment:page-home'?: {
220
+ maxRequestTime?: number | undefined;
205
221
  } | undefined;
206
222
  'endowment:rpc'?: {
207
223
  dapps?: boolean | undefined;
208
224
  snaps?: boolean | undefined;
209
225
  allowedOrigins?: string[] | undefined;
210
226
  } | undefined;
211
- 'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
212
- 'endowment:keyring'?: {
213
- allowedOrigins?: string[] | undefined;
227
+ 'endowment:signature-insight'?: {
228
+ maxRequestTime?: number | undefined;
229
+ allowSignatureOrigin?: boolean | undefined;
230
+ } | undefined;
231
+ 'endowment:transaction-insight'?: {
232
+ maxRequestTime?: number | undefined;
233
+ allowTransactionOrigin?: boolean | undefined;
214
234
  } | undefined;
215
- snap_confirm?: {} | undefined;
235
+ 'endowment:webassembly'?: {} | undefined;
216
236
  };
217
237
  manifestVersion: "0.1";
218
238
  repository?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/snaps-controllers",
3
- "version": "4.1.0",
3
+ "version": "5.0.1",
4
4
  "description": "Controllers for MetaMask Snaps.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -42,18 +42,18 @@
42
42
  "lint:dependencies": "depcheck"
43
43
  },
44
44
  "dependencies": {
45
- "@metamask/approval-controller": "^5.1.1",
45
+ "@metamask/approval-controller": "^5.1.2",
46
46
  "@metamask/base-controller": "^4.1.0",
47
- "@metamask/json-rpc-engine": "^7.3.1",
47
+ "@metamask/json-rpc-engine": "^7.3.2",
48
48
  "@metamask/object-multiplex": "^2.0.0",
49
- "@metamask/permission-controller": "^7.1.0",
50
- "@metamask/phishing-controller": "^8.0.1",
51
- "@metamask/post-message-stream": "^7.0.0",
49
+ "@metamask/permission-controller": "^8.0.0",
50
+ "@metamask/phishing-controller": "^8.0.2",
51
+ "@metamask/post-message-stream": "^8.0.0",
52
52
  "@metamask/rpc-errors": "^6.1.0",
53
53
  "@metamask/snaps-registry": "^3.0.0",
54
- "@metamask/snaps-rpc-methods": "^5.0.0",
55
- "@metamask/snaps-sdk": "^1.4.0",
56
- "@metamask/snaps-utils": "^5.2.0",
54
+ "@metamask/snaps-rpc-methods": "^6.0.0",
55
+ "@metamask/snaps-sdk": "^2.1.0",
56
+ "@metamask/snaps-utils": "^6.1.0",
57
57
  "@metamask/utils": "^8.3.0",
58
58
  "@xstate/fsm": "^2.0.0",
59
59
  "browserify-zlib": "^0.2.0",
@@ -64,12 +64,12 @@
64
64
  "nanoid": "^3.1.31",
65
65
  "readable-stream": "^3.6.2",
66
66
  "readable-web-to-node-stream": "^3.0.2",
67
- "tar-stream": "^3.1.6"
67
+ "tar-stream": "^3.1.7"
68
68
  },
69
69
  "devDependencies": {
70
70
  "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
71
71
  "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
72
- "@lavamoat/allow-scripts": "^3.0.0",
72
+ "@lavamoat/allow-scripts": "^3.0.2",
73
73
  "@metamask/auto-changelog": "^3.4.4",
74
74
  "@metamask/eslint-config": "^12.1.0",
75
75
  "@metamask/eslint-config-jest": "^12.1.0",
@@ -125,7 +125,7 @@
125
125
  "webdriverio": "^8.19.0"
126
126
  },
127
127
  "peerDependencies": {
128
- "@metamask/snaps-execution-environments": "^3.5.0"
128
+ "@metamask/snaps-execution-environments": "^4.0.1"
129
129
  },
130
130
  "peerDependenciesMeta": {
131
131
  "@metamask/snaps-execution-environments": {
@@ -1,100 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", {
3
- value: true
4
- });
5
- function _export(target, all) {
6
- for(var name in all)Object.defineProperty(target, name, {
7
- enumerable: true,
8
- get: all[name]
9
- });
10
- }
11
- _export(exports, {
12
- cronjobEndowmentBuilder: function() {
13
- return cronjobEndowmentBuilder;
14
- },
15
- getCronjobCaveatMapper: function() {
16
- return getCronjobCaveatMapper;
17
- },
18
- getCronjobCaveatJobs: function() {
19
- return getCronjobCaveatJobs;
20
- },
21
- validateCronjobCaveat: function() {
22
- return validateCronjobCaveat;
23
- },
24
- cronjobCaveatSpecifications: function() {
25
- return cronjobCaveatSpecifications;
26
- }
27
- });
28
- const _permissioncontroller = require("@metamask/permission-controller");
29
- const _rpcerrors = require("@metamask/rpc-errors");
30
- const _snapsutils = require("@metamask/snaps-utils");
31
- const _utils = require("@metamask/utils");
32
- const _enum = require("./enum");
33
- const permissionName = _enum.SnapEndowments.Cronjob;
34
- /**
35
- * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.
36
- *
37
- * @param _builderOptions - Optional specification builder options.
38
- * @returns The specification for the cronjob endowment.
39
- */ const specificationBuilder = (_builderOptions)=>{
40
- return {
41
- permissionType: _permissioncontroller.PermissionType.Endowment,
42
- targetName: permissionName,
43
- allowedCaveats: [
44
- _snapsutils.SnapCaveatType.SnapCronjob
45
- ],
46
- endowmentGetter: (_getterOptions)=>undefined,
47
- subjectTypes: [
48
- _permissioncontroller.SubjectType.Snap
49
- ]
50
- };
51
- };
52
- const cronjobEndowmentBuilder = Object.freeze({
53
- targetName: permissionName,
54
- specificationBuilder
55
- });
56
- function getCronjobCaveatMapper(value) {
57
- return {
58
- caveats: [
59
- {
60
- type: _snapsutils.SnapCaveatType.SnapCronjob,
61
- value
62
- }
63
- ]
64
- };
65
- }
66
- function getCronjobCaveatJobs(permission) {
67
- if (!permission?.caveats) {
68
- return null;
69
- }
70
- (0, _utils.assert)(permission.caveats.length === 1);
71
- (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.SnapCronjob);
72
- const caveat = permission.caveats[0];
73
- return (caveat.value?.jobs) ?? null;
74
- }
75
- function validateCronjobCaveat(caveat) {
76
- if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
77
- throw _rpcerrors.rpcErrors.invalidParams({
78
- message: 'Expected a plain object.'
79
- });
80
- }
81
- const { value } = caveat;
82
- if (!(0, _utils.hasProperty)(value, 'jobs') || !(0, _utils.isPlainObject)(value)) {
83
- throw _rpcerrors.rpcErrors.invalidParams({
84
- message: 'Expected a plain object.'
85
- });
86
- }
87
- if (!(0, _snapsutils.isCronjobSpecificationArray)(value.jobs)) {
88
- throw _rpcerrors.rpcErrors.invalidParams({
89
- message: 'Expected a valid cronjob specification array.'
90
- });
91
- }
92
- }
93
- const cronjobCaveatSpecifications = {
94
- [_snapsutils.SnapCaveatType.SnapCronjob]: Object.freeze({
95
- type: _snapsutils.SnapCaveatType.SnapCronjob,
96
- validator: (caveat)=>validateCronjobCaveat(caveat)
97
- })
98
- };
99
-
100
- //# 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":["cronjobEndowmentBuilder","getCronjobCaveatMapper","getCronjobCaveatJobs","validateCronjobCaveat","cronjobCaveatSpecifications","permissionName","SnapEndowments","Cronjob","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","SnapCronjob","endowmentGetter","_getterOptions","undefined","subjectTypes","SubjectType","Snap","Object","freeze","value","caveats","type","permission","assert","length","caveat","jobs","hasProperty","isPlainObject","rpcErrors","invalidParams","message","isCronjobSpecificationArray","validator"],"mappings":";;;;;;;;;;;IAiDaA,uBAAuB;eAAvBA;;IAaGC,sBAAsB;eAAtBA;;IAwBAC,oBAAoB;eAApBA;;IAuBAC,qBAAqB;eAArBA;;IAyBHC,2BAA2B;eAA3BA;;;sCA9H+B;2BAClB;4BAKnB;uBAE4C;sBAEpB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,OAAO;AAS7C;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,WAAW;SAAC;QAC5CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMtB,0BAA0BuB,OAAOC,MAAM,CAAC;IACnDX,YAAYR;IACZG;AACF;AAUO,SAASP,uBACdwB,KAAW;IAEX,OAAO;QACLC,SAAS;YACP;gBACEC,MAAMZ,0BAAc,CAACC,WAAW;gBAChCS;YACF;SACD;IACH;AACF;AAaO,SAASvB,qBACd0B,UAAiC;IAEjC,IAAI,CAACA,YAAYF,SAAS;QACxB,OAAO;IACT;IAEAG,IAAAA,aAAM,EAACD,WAAWF,OAAO,CAACI,MAAM,KAAK;IACrCD,IAAAA,aAAM,EAACD,WAAWF,OAAO,CAAC,EAAE,CAACC,IAAI,KAAKZ,0BAAc,CAACC,WAAW;IAEhE,MAAMe,SAASH,WAAWF,OAAO,CAAC,EAAE;IAEpC,OAAO,CAACK,OAAON,KAAK,EAAEO,IAA8B,KAAK;AAC3D;AAUO,SAAS7B,sBAAsB4B,MAA2B;IAC/D,IAAI,CAACE,IAAAA,kBAAW,EAACF,QAAQ,YAAY,CAACG,IAAAA,oBAAa,EAACH,OAAON,KAAK,GAAG;QACjE,MAAMU,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEZ,KAAK,EAAE,GAAGM;IAElB,IAAI,CAACE,IAAAA,kBAAW,EAACR,OAAO,WAAW,CAACS,IAAAA,oBAAa,EAACT,QAAQ;QACxD,MAAMU,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,IAAI,CAACC,IAAAA,uCAA2B,EAACb,MAAMO,IAAI,GAAG;QAC5C,MAAMG,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;AACF;AAKO,MAAMjC,8BAGT;IACF,CAACW,0BAAc,CAACC,WAAW,CAAC,EAAEO,OAAOC,MAAM,CAAC;QAC1CG,MAAMZ,0BAAc,CAACC,WAAW;QAChCuB,WAAW,CAACR,SAAW5B,sBAAsB4B;IAC/C;AACF"}
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", {
3
- value: true
4
- });
5
- Object.defineProperty(exports, "SnapEndowments", {
6
- enumerable: true,
7
- get: function() {
8
- return SnapEndowments;
9
- }
10
- });
11
- var SnapEndowments;
12
- (function(SnapEndowments) {
13
- SnapEndowments["NetworkAccess"] = 'endowment:network-access';
14
- SnapEndowments["SignatureInsight"] = 'endowment:signature-insight';
15
- SnapEndowments["TransactionInsight"] = 'endowment:transaction-insight';
16
- SnapEndowments["Cronjob"] = 'endowment:cronjob';
17
- SnapEndowments["EthereumProvider"] = 'endowment:ethereum-provider';
18
- SnapEndowments["Rpc"] = 'endowment:rpc';
19
- SnapEndowments["WebAssemblyAccess"] = 'endowment:webassembly';
20
- SnapEndowments["NameLookup"] = 'endowment:name-lookup';
21
- SnapEndowments["LifecycleHooks"] = 'endowment:lifecycle-hooks';
22
- SnapEndowments["Keyring"] = 'endowment:keyring';
23
- SnapEndowments["HomePage"] = 'endowment:page-home';
24
- })(SnapEndowments || (SnapEndowments = {}));
25
-
26
- //# 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 SignatureInsight = 'endowment:signature-insight',\n TransactionInsight = 'endowment:transaction-insight',\n Cronjob = 'endowment:cronjob',\n EthereumProvider = 'endowment:ethereum-provider',\n Rpc = 'endowment:rpc',\n WebAssemblyAccess = 'endowment:webassembly',\n NameLookup = 'endowment:name-lookup',\n LifecycleHooks = 'endowment:lifecycle-hooks',\n Keyring = 'endowment:keyring',\n HomePage = 'endowment:page-home',\n}\n"],"names":["SnapEndowments","NetworkAccess","SignatureInsight","TransactionInsight","Cronjob","EthereumProvider","Rpc","WebAssemblyAccess","NameLookup","LifecycleHooks","Keyring","HomePage"],"mappings":";;;;;;;;;;IAAO;UAAKA,cAAc;IAAdA,eACVC,mBAAgB;IADND,eAEVE,sBAAmB;IAFTF,eAGVG,wBAAqB;IAHXH,eAIVI,aAAU;IAJAJ,eAKVK,sBAAmB;IALTL,eAMVM,SAAM;IANIN,eAOVO,uBAAoB;IAPVP,eAQVQ,gBAAa;IARHR,eASVS,oBAAiB;IATPT,eAUVU,aAAU;IAVAV,eAWVW,cAAW;GAXDX,mBAAAA"}
@@ -1,43 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", {
3
- value: true
4
- });
5
- Object.defineProperty(exports, "ethereumProviderEndowmentBuilder", {
6
- enumerable: true,
7
- get: function() {
8
- return ethereumProviderEndowmentBuilder;
9
- }
10
- });
11
- const _permissioncontroller = require("@metamask/permission-controller");
12
- const _enum = require("./enum");
13
- const permissionName = _enum.SnapEndowments.EthereumProvider;
14
- /**
15
- * `endowment:ethereum-provider` returns the name of the ethereum global browser API.
16
- * This is intended to populate the endowments of the
17
- * SES Compartment in which a Snap executes.
18
- *
19
- * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.
20
- *
21
- * @param _builderOptions - Optional specification builder options.
22
- * @returns The specification for the network endowment.
23
- */ const specificationBuilder = (_builderOptions)=>{
24
- return {
25
- permissionType: _permissioncontroller.PermissionType.Endowment,
26
- targetName: permissionName,
27
- allowedCaveats: null,
28
- endowmentGetter: (_getterOptions)=>{
29
- return [
30
- 'ethereum'
31
- ];
32
- },
33
- subjectTypes: [
34
- _permissioncontroller.SubjectType.Snap
35
- ]
36
- };
37
- };
38
- const ethereumProviderEndowmentBuilder = Object.freeze({
39
- targetName: permissionName,
40
- specificationBuilder
41
- });
42
-
43
- //# 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":["ethereumProviderEndowmentBuilder","permissionName","SnapEndowments","EthereumProvider","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BA4CaA;;;eAAAA;;;sCAvC+B;sBAEb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,gBAAgB;AAStD;;;;;;;;;CASC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;aAAW;QACrB;QACAC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMf,mCAAmCgB,OAAOC,MAAM,CAAC;IAC5DR,YAAYR;IACZG;AACF"}
@@ -1,37 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", {
3
- value: true
4
- });
5
- Object.defineProperty(exports, "homePageEndowmentBuilder", {
6
- enumerable: true,
7
- get: function() {
8
- return homePageEndowmentBuilder;
9
- }
10
- });
11
- const _permissioncontroller = require("@metamask/permission-controller");
12
- const _enum = require("./enum");
13
- const permissionName = _enum.SnapEndowments.HomePage;
14
- /**
15
- * `endowment:page-home` returns nothing; it is intended to be used as a
16
- * flag by the snap controller to detect whether the snap has the capability to
17
- * use the snap home page feature.
18
- *
19
- * @param _builderOptions - Optional specification builder options.
20
- * @returns The specification for the `snap-pages` endowment.
21
- */ const specificationBuilder = (_builderOptions)=>{
22
- return {
23
- permissionType: _permissioncontroller.PermissionType.Endowment,
24
- targetName: permissionName,
25
- allowedCaveats: null,
26
- endowmentGetter: (_getterOptions)=>undefined,
27
- subjectTypes: [
28
- _permissioncontroller.SubjectType.Snap
29
- ]
30
- };
31
- };
32
- const homePageEndowmentBuilder = Object.freeze({
33
- targetName: permissionName,
34
- specificationBuilder
35
- });
36
-
37
- //# 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":["homePageEndowmentBuilder","permissionName","SnapEndowments","HomePage","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BAyCaA;;;eAAAA;;;sCApC+B;sBAGb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,QAAQ;AAS9C;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMhB,2BAA2BiB,OAAOC,MAAM,CAAC;IACpDT,YAAYR;IACZG;AACF"}
@@ -1,107 +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
- endowmentPermissionBuilders: function() {
13
- return endowmentPermissionBuilders;
14
- },
15
- endowmentCaveatSpecifications: function() {
16
- return endowmentCaveatSpecifications;
17
- },
18
- endowmentCaveatMappers: function() {
19
- return endowmentCaveatMappers;
20
- },
21
- handlerEndowments: function() {
22
- return handlerEndowments;
23
- },
24
- getRpcCaveatOrigins: function() {
25
- return _rpc.getRpcCaveatOrigins;
26
- },
27
- getSignatureOriginCaveat: function() {
28
- return _signatureinsight.getSignatureOriginCaveat;
29
- },
30
- getTransactionOriginCaveat: function() {
31
- return _transactioninsight.getTransactionOriginCaveat;
32
- },
33
- getChainIdsCaveat: function() {
34
- return _namelookup.getChainIdsCaveat;
35
- },
36
- getKeyringCaveatOrigins: function() {
37
- return _keyring.getKeyringCaveatOrigins;
38
- }
39
- });
40
- const _snapsutils = require("@metamask/snaps-utils");
41
- const _cronjob = require("./cronjob");
42
- const _ethereumprovider = require("./ethereum-provider");
43
- const _homepage = require("./home-page");
44
- const _keyring = require("./keyring");
45
- const _lifecyclehooks = require("./lifecycle-hooks");
46
- const _namelookup = require("./name-lookup");
47
- const _networkaccess = require("./network-access");
48
- const _rpc = require("./rpc");
49
- const _signatureinsight = require("./signature-insight");
50
- const _transactioninsight = require("./transaction-insight");
51
- const _webassembly = require("./web-assembly");
52
- _export_star(require("./enum"), exports);
53
- function _export_star(from, to) {
54
- Object.keys(from).forEach(function(k) {
55
- if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
56
- Object.defineProperty(to, k, {
57
- enumerable: true,
58
- get: function() {
59
- return from[k];
60
- }
61
- });
62
- }
63
- });
64
- return from;
65
- }
66
- const endowmentPermissionBuilders = {
67
- [_networkaccess.networkAccessEndowmentBuilder.targetName]: _networkaccess.networkAccessEndowmentBuilder,
68
- [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: _transactioninsight.transactionInsightEndowmentBuilder,
69
- [_cronjob.cronjobEndowmentBuilder.targetName]: _cronjob.cronjobEndowmentBuilder,
70
- [_ethereumprovider.ethereumProviderEndowmentBuilder.targetName]: _ethereumprovider.ethereumProviderEndowmentBuilder,
71
- [_rpc.rpcEndowmentBuilder.targetName]: _rpc.rpcEndowmentBuilder,
72
- [_webassembly.webAssemblyEndowmentBuilder.targetName]: _webassembly.webAssemblyEndowmentBuilder,
73
- [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.nameLookupEndowmentBuilder,
74
- [_lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName]: _lifecyclehooks.lifecycleHooksEndowmentBuilder,
75
- [_keyring.keyringEndowmentBuilder.targetName]: _keyring.keyringEndowmentBuilder,
76
- [_homepage.homePageEndowmentBuilder.targetName]: _homepage.homePageEndowmentBuilder,
77
- [_signatureinsight.signatureInsightEndowmentBuilder.targetName]: _signatureinsight.signatureInsightEndowmentBuilder
78
- };
79
- const endowmentCaveatSpecifications = {
80
- ..._cronjob.cronjobCaveatSpecifications,
81
- ..._transactioninsight.transactionInsightCaveatSpecifications,
82
- ..._rpc.rpcCaveatSpecifications,
83
- ..._namelookup.nameLookupCaveatSpecifications,
84
- ..._keyring.keyringCaveatSpecifications,
85
- ..._signatureinsight.signatureInsightCaveatSpecifications
86
- };
87
- const endowmentCaveatMappers = {
88
- [_cronjob.cronjobEndowmentBuilder.targetName]: _cronjob.getCronjobCaveatMapper,
89
- [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: _transactioninsight.getTransactionInsightCaveatMapper,
90
- [_rpc.rpcEndowmentBuilder.targetName]: _rpc.getRpcCaveatMapper,
91
- [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.getNameLookupCaveatMapper,
92
- [_keyring.keyringEndowmentBuilder.targetName]: _keyring.getKeyringCaveatMapper,
93
- [_signatureinsight.signatureInsightEndowmentBuilder.targetName]: _signatureinsight.getSignatureInsightCaveatMapper
94
- };
95
- const handlerEndowments = {
96
- [_snapsutils.HandlerType.OnRpcRequest]: _rpc.rpcEndowmentBuilder.targetName,
97
- [_snapsutils.HandlerType.OnTransaction]: _transactioninsight.transactionInsightEndowmentBuilder.targetName,
98
- [_snapsutils.HandlerType.OnCronjob]: _cronjob.cronjobEndowmentBuilder.targetName,
99
- [_snapsutils.HandlerType.OnNameLookup]: _namelookup.nameLookupEndowmentBuilder.targetName,
100
- [_snapsutils.HandlerType.OnInstall]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName,
101
- [_snapsutils.HandlerType.OnUpdate]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName,
102
- [_snapsutils.HandlerType.OnKeyringRequest]: _keyring.keyringEndowmentBuilder.targetName,
103
- [_snapsutils.HandlerType.OnHomePage]: _homepage.homePageEndowmentBuilder.targetName,
104
- [_snapsutils.HandlerType.OnSignature]: _signatureinsight.signatureInsightEndowmentBuilder.targetName
105
- };
106
-
107
- //# 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 getSignatureInsightCaveatMapper,\n signatureInsightCaveatSpecifications,\n signatureInsightEndowmentBuilder,\n} from './signature-insight';\nimport {\n getTransactionInsightCaveatMapper,\n transactionInsightCaveatSpecifications,\n transactionInsightEndowmentBuilder,\n} from './transaction-insight';\nimport { webAssemblyEndowmentBuilder } from './web-assembly';\n\nexport const endowmentPermissionBuilders = {\n [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,\n [transactionInsightEndowmentBuilder.targetName]:\n transactionInsightEndowmentBuilder,\n [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,\n [ethereumProviderEndowmentBuilder.targetName]:\n ethereumProviderEndowmentBuilder,\n [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,\n [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,\n [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,\n [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,\n [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder,\n [homePageEndowmentBuilder.targetName]: homePageEndowmentBuilder,\n [signatureInsightEndowmentBuilder.targetName]:\n signatureInsightEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n ...cronjobCaveatSpecifications,\n ...transactionInsightCaveatSpecifications,\n ...rpcCaveatSpecifications,\n ...nameLookupCaveatSpecifications,\n ...keyringCaveatSpecifications,\n ...signatureInsightCaveatSpecifications,\n};\n\nexport const endowmentCaveatMappers: Record<\n string,\n (value: Json) => Pick<PermissionConstraint, 'caveats'>\n> = {\n [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,\n [transactionInsightEndowmentBuilder.targetName]:\n getTransactionInsightCaveatMapper,\n [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,\n [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,\n [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper,\n [signatureInsightEndowmentBuilder.targetName]:\n getSignatureInsightCaveatMapper,\n};\n\nexport const handlerEndowments: Record<HandlerType, string> = {\n [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,\n [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,\n [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,\n [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,\n [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,\n [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,\n [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName,\n [HandlerType.OnHomePage]: homePageEndowmentBuilder.targetName,\n [HandlerType.OnSignature]: signatureInsightEndowmentBuilder.targetName,\n};\n\nexport * from './enum';\nexport { getRpcCaveatOrigins } from './rpc';\nexport { getSignatureOriginCaveat } from './signature-insight';\nexport { getTransactionOriginCaveat } from './transaction-insight';\nexport { getChainIdsCaveat } from './name-lookup';\nexport { getKeyringCaveatOrigins } from './keyring';\n"],"names":["endowmentPermissionBuilders","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","getRpcCaveatOrigins","getSignatureOriginCaveat","getTransactionOriginCaveat","getChainIdsCaveat","getKeyringCaveatOrigins","networkAccessEndowmentBuilder","targetName","transactionInsightEndowmentBuilder","cronjobEndowmentBuilder","ethereumProviderEndowmentBuilder","rpcEndowmentBuilder","webAssemblyEndowmentBuilder","nameLookupEndowmentBuilder","lifecycleHooksEndowmentBuilder","keyringEndowmentBuilder","homePageEndowmentBuilder","signatureInsightEndowmentBuilder","cronjobCaveatSpecifications","transactionInsightCaveatSpecifications","rpcCaveatSpecifications","nameLookupCaveatSpecifications","keyringCaveatSpecifications","signatureInsightCaveatSpecifications","getCronjobCaveatMapper","getTransactionInsightCaveatMapper","getRpcCaveatMapper","getNameLookupCaveatMapper","getKeyringCaveatMapper","getSignatureInsightCaveatMapper","HandlerType","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","OnSignature"],"mappings":";;;;;;;;;;;IAwCaA,2BAA2B;eAA3BA;;IAiBAC,6BAA6B;eAA7BA;;IASAC,sBAAsB;eAAtBA;;IAcAC,iBAAiB;eAAjBA;;IAaJC,mBAAmB;eAAnBA,wBAAmB;;IACnBC,wBAAwB;eAAxBA,0CAAwB;;IACxBC,0BAA0B;eAA1BA,8CAA0B;;IAC1BC,iBAAiB;eAAjBA,6BAAiB;;IACjBC,uBAAuB;eAAvBA,gCAAuB;;;4BAhGJ;yBAOrB;kCAC0C;0BACR;yBAKlC;gCACwC;4BAKxC;+BACuC;qBAKvC;kCAKA;oCAKA;6BACqC;qBAsD9B;;;;;;;;;;;;;;AApDP,MAAMR,8BAA8B;IACzC,CAACS,4CAA6B,CAACC,UAAU,CAAC,EAAED,4CAA6B;IACzE,CAACE,sDAAkC,CAACD,UAAU,CAAC,EAC7CC,sDAAkC;IACpC,CAACC,gCAAuB,CAACF,UAAU,CAAC,EAAEE,gCAAuB;IAC7D,CAACC,kDAAgC,CAACH,UAAU,CAAC,EAC3CG,kDAAgC;IAClC,CAACC,wBAAmB,CAACJ,UAAU,CAAC,EAAEI,wBAAmB;IACrD,CAACC,wCAA2B,CAACL,UAAU,CAAC,EAAEK,wCAA2B;IACrE,CAACC,sCAA0B,CAACN,UAAU,CAAC,EAAEM,sCAA0B;IACnE,CAACC,8CAA8B,CAACP,UAAU,CAAC,EAAEO,8CAA8B;IAC3E,CAACC,gCAAuB,CAACR,UAAU,CAAC,EAAEQ,gCAAuB;IAC7D,CAACC,kCAAwB,CAACT,UAAU,CAAC,EAAES,kCAAwB;IAC/D,CAACC,kDAAgC,CAACV,UAAU,CAAC,EAC3CU,kDAAgC;AACpC;AAEO,MAAMnB,gCAAgC;IAC3C,GAAGoB,oCAA2B;IAC9B,GAAGC,0DAAsC;IACzC,GAAGC,4BAAuB;IAC1B,GAAGC,0CAA8B;IACjC,GAAGC,oCAA2B;IAC9B,GAAGC,sDAAoC;AACzC;AAEO,MAAMxB,yBAGT;IACF,CAACU,gCAAuB,CAACF,UAAU,CAAC,EAAEiB,+BAAsB;IAC5D,CAAChB,sDAAkC,CAACD,UAAU,CAAC,EAC7CkB,qDAAiC;IACnC,CAACd,wBAAmB,CAACJ,UAAU,CAAC,EAAEmB,uBAAkB;IACpD,CAACb,sCAA0B,CAACN,UAAU,CAAC,EAAEoB,qCAAyB;IAClE,CAACZ,gCAAuB,CAACR,UAAU,CAAC,EAAEqB,+BAAsB;IAC5D,CAACX,kDAAgC,CAACV,UAAU,CAAC,EAC3CsB,iDAA+B;AACnC;AAEO,MAAM7B,oBAAiD;IAC5D,CAAC8B,uBAAW,CAACC,YAAY,CAAC,EAAEpB,wBAAmB,CAACJ,UAAU;IAC1D,CAACuB,uBAAW,CAACE,aAAa,CAAC,EAAExB,sDAAkC,CAACD,UAAU;IAC1E,CAACuB,uBAAW,CAACG,SAAS,CAAC,EAAExB,gCAAuB,CAACF,UAAU;IAC3D,CAACuB,uBAAW,CAACI,YAAY,CAAC,EAAErB,sCAA0B,CAACN,UAAU;IACjE,CAACuB,uBAAW,CAACK,SAAS,CAAC,EAAErB,8CAA8B,CAACP,UAAU;IAClE,CAACuB,uBAAW,CAACM,QAAQ,CAAC,EAAEtB,8CAA8B,CAACP,UAAU;IACjE,CAACuB,uBAAW,CAACO,gBAAgB,CAAC,EAAEtB,gCAAuB,CAACR,UAAU;IAClE,CAACuB,uBAAW,CAACQ,UAAU,CAAC,EAAEtB,kCAAwB,CAACT,UAAU;IAC7D,CAACuB,uBAAW,CAACS,WAAW,CAAC,EAAEtB,kDAAgC,CAACV,UAAU;AACxE"}
@@ -1,100 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", {
3
- value: true
4
- });
5
- function _export(target, all) {
6
- for(var name in all)Object.defineProperty(target, name, {
7
- enumerable: true,
8
- get: all[name]
9
- });
10
- }
11
- _export(exports, {
12
- keyringEndowmentBuilder: function() {
13
- return keyringEndowmentBuilder;
14
- },
15
- getKeyringCaveatMapper: function() {
16
- return getKeyringCaveatMapper;
17
- },
18
- getKeyringCaveatOrigins: function() {
19
- return getKeyringCaveatOrigins;
20
- },
21
- keyringCaveatSpecifications: function() {
22
- return keyringCaveatSpecifications;
23
- }
24
- });
25
- const _permissioncontroller = require("@metamask/permission-controller");
26
- const _rpcerrors = require("@metamask/rpc-errors");
27
- const _snapsutils = require("@metamask/snaps-utils");
28
- const _utils = require("@metamask/utils");
29
- const _enum = require("./enum");
30
- const permissionName = _enum.SnapEndowments.Keyring;
31
- /**
32
- * `endowment:keyring` returns nothing; it is intended to be used as a flag
33
- * by the client to detect whether the snap has keyring capabilities.
34
- *
35
- * @param _builderOptions - Optional specification builder options.
36
- * @returns The specification for the keyring endowment.
37
- */ const specificationBuilder = (_builderOptions)=>{
38
- return {
39
- permissionType: _permissioncontroller.PermissionType.Endowment,
40
- targetName: permissionName,
41
- allowedCaveats: [
42
- _snapsutils.SnapCaveatType.KeyringOrigin
43
- ],
44
- endowmentGetter: (_getterOptions)=>undefined,
45
- validator: ({ caveats })=>{
46
- if (caveats?.length !== 1 || caveats[0].type !== _snapsutils.SnapCaveatType.KeyringOrigin) {
47
- throw _rpcerrors.rpcErrors.invalidParams({
48
- message: `Expected a single "${_snapsutils.SnapCaveatType.KeyringOrigin}" caveat.`
49
- });
50
- }
51
- },
52
- subjectTypes: [
53
- _permissioncontroller.SubjectType.Snap
54
- ]
55
- };
56
- };
57
- const keyringEndowmentBuilder = Object.freeze({
58
- targetName: permissionName,
59
- specificationBuilder
60
- });
61
- /**
62
- * Validate the value of a caveat. This does not validate the type of the
63
- * caveat itself, only the value of the caveat.
64
- *
65
- * @param caveat - The caveat to validate.
66
- * @throws If the caveat value is invalid.
67
- */ function validateCaveatOrigins(caveat) {
68
- if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
69
- throw _rpcerrors.rpcErrors.invalidParams({
70
- message: 'Invalid keyring origins: Expected a plain object.'
71
- });
72
- }
73
- const { value } = caveat;
74
- (0, _snapsutils.assertIsKeyringOrigins)(value, _rpcerrors.rpcErrors.invalidParams);
75
- }
76
- function getKeyringCaveatMapper(value) {
77
- return {
78
- caveats: [
79
- {
80
- type: _snapsutils.SnapCaveatType.KeyringOrigin,
81
- value
82
- }
83
- ]
84
- };
85
- }
86
- function getKeyringCaveatOrigins(permission) {
87
- (0, _utils.assert)(permission?.caveats);
88
- (0, _utils.assert)(permission.caveats.length === 1);
89
- (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.KeyringOrigin);
90
- const caveat = permission.caveats[0];
91
- return caveat.value;
92
- }
93
- const keyringCaveatSpecifications = {
94
- [_snapsutils.SnapCaveatType.KeyringOrigin]: Object.freeze({
95
- type: _snapsutils.SnapCaveatType.KeyringOrigin,
96
- validator: (caveat)=>validateCaveatOrigins(caveat)
97
- })
98
- };
99
-
100
- //# sourceMappingURL=keyring.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../../src/snaps/endowments/keyring.ts"],"sourcesContent":["import type {\n Caveat,\n CaveatSpecificationConstraint,\n EndowmentGetterParams,\n PermissionConstraint,\n PermissionSpecificationBuilder,\n PermissionValidatorConstraint,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { KeyringOrigins } from '@metamask/snaps-utils';\nimport { assertIsKeyringOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Keyring;\n\ntype KeyringEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetName: typeof permissionName;\n endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n validator: PermissionValidatorConstraint;\n subjectTypes: readonly SubjectType[];\n}>;\n\n/**\n * `endowment:keyring` returns nothing; it is intended to be used as a flag\n * by the client to detect whether the snap has keyring capabilities.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the keyring endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n KeyringEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n return {\n permissionType: PermissionType.Endowment,\n targetName: permissionName,\n allowedCaveats: [SnapCaveatType.KeyringOrigin],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n validator: ({ caveats }) => {\n if (\n caveats?.length !== 1 ||\n caveats[0].type !== SnapCaveatType.KeyringOrigin\n ) {\n throw rpcErrors.invalidParams({\n message: `Expected a single \"${SnapCaveatType.KeyringOrigin}\" caveat.`,\n });\n }\n },\n subjectTypes: [SubjectType.Snap],\n };\n};\n\nexport const keyringEndowmentBuilder = Object.freeze({\n targetName: permissionName,\n specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n throw rpcErrors.invalidParams({\n message: 'Invalid keyring origins: Expected a plain object.',\n });\n }\n\n const { value } = caveat;\n assertIsKeyringOrigins(value, rpcErrors.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getKeyringCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n return {\n caveats: [\n {\n type: SnapCaveatType.KeyringOrigin,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the {@link KeyringOrigins} caveat value from a\n * permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link KeyringOrigins}\n * caveat.\n */\nexport function getKeyringCaveatOrigins(\n permission?: PermissionConstraint,\n): KeyringOrigins | null {\n assert(permission?.caveats);\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);\n\n const caveat = permission.caveats[0] as Caveat<string, KeyringOrigins>;\n return caveat.value;\n}\n\nexport const keyringCaveatSpecifications: Record<\n SnapCaveatType.KeyringOrigin,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.KeyringOrigin]: Object.freeze({\n type: SnapCaveatType.KeyringOrigin,\n validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n }),\n};\n"],"names":["keyringEndowmentBuilder","getKeyringCaveatMapper","getKeyringCaveatOrigins","keyringCaveatSpecifications","permissionName","SnapEndowments","Keyring","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","KeyringOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpcErrors","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveatOrigins","caveat","hasProperty","isPlainObject","value","assertIsKeyringOrigins","permission","assert"],"mappings":";;;;;;;;;;;IA4DaA,uBAAuB;eAAvBA;;IA+BGC,sBAAsB;eAAtBA;;IAsBAC,uBAAuB;eAAvBA;;IAWHC,2BAA2B;eAA3BA;;;sCAnH+B;2BAClB;4BAE6B;uBAEJ;sBAEpB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,OAAO;AAW7C;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,aAAa;SAAC;QAC9CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,aAAa,EAChD;gBACA,MAAMQ,oBAAS,CAACC,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEX,0BAAc,CAACC,aAAa,CAAC,SAAS,CAAC;gBACxE;YACF;QACF;QACAW,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM5B,0BAA0B6B,OAAOC,MAAM,CAAC;IACnDlB,YAAYR;IACZG;AACF;AAEA;;;;;;CAMC,GACD,SAASwB,sBAAsBC,MAA2B;IACxD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,OAAOG,KAAK,GAAG;QACjE,MAAMZ,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEU,KAAK,EAAE,GAAGH;IAClBI,IAAAA,kCAAsB,EAACD,OAAOZ,oBAAS,CAACC,aAAa;AACvD;AAUO,SAASvB,uBACdkC,KAAW;IAEX,OAAO;QACLf,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,aAAa;gBAClCoB;YACF;SACD;IACH;AACF;AAWO,SAASjC,wBACdmC,UAAiC;IAEjCC,IAAAA,aAAM,EAACD,YAAYjB;IACnBkB,IAAAA,aAAM,EAACD,WAAWjB,OAAO,CAACC,MAAM,KAAK;IACrCiB,IAAAA,aAAM,EAACD,WAAWjB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,aAAa;IAElE,MAAMiB,SAASK,WAAWjB,OAAO,CAAC,EAAE;IACpC,OAAOY,OAAOG,KAAK;AACrB;AAEO,MAAMhC,8BAGT;IACF,CAACW,0BAAc,CAACC,aAAa,CAAC,EAAEc,OAAOC,MAAM,CAAC;QAC5CR,MAAMR,0BAAc,CAACC,aAAa;QAClCI,WAAW,CAACa,SAAgCD,sBAAsBC;IACpE;AACF"}
@@ -1,37 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", {
3
- value: true
4
- });
5
- Object.defineProperty(exports, "lifecycleHooksEndowmentBuilder", {
6
- enumerable: true,
7
- get: function() {
8
- return lifecycleHooksEndowmentBuilder;
9
- }
10
- });
11
- const _permissioncontroller = require("@metamask/permission-controller");
12
- const _enum = require("./enum");
13
- const permissionName = _enum.SnapEndowments.LifecycleHooks;
14
- /**
15
- * `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a
16
- * flag by the snap controller to detect whether the snap has the capability to
17
- * use lifecycle hooks.
18
- *
19
- * @param _builderOptions - Optional specification builder options.
20
- * @returns The specification for the `lifecycle-hooks` endowment.
21
- */ const specificationBuilder = (_builderOptions)=>{
22
- return {
23
- permissionType: _permissioncontroller.PermissionType.Endowment,
24
- targetName: permissionName,
25
- allowedCaveats: null,
26
- endowmentGetter: (_getterOptions)=>undefined,
27
- subjectTypes: [
28
- _permissioncontroller.SubjectType.Snap
29
- ]
30
- };
31
- };
32
- const lifecycleHooksEndowmentBuilder = Object.freeze({
33
- targetName: permissionName,
34
- specificationBuilder
35
- });
36
-
37
- //# sourceMappingURL=lifecycle-hooks.js.map