@metamask/snaps-rpc-methods 4.0.2 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -1
- package/dist/cjs/permitted/getAllSnaps.js +44 -0
- package/dist/cjs/permitted/getAllSnaps.js.map +1 -0
- package/dist/cjs/permitted/handlers.js +2 -0
- package/dist/cjs/permitted/handlers.js.map +1 -1
- package/dist/cjs/permitted/index.js.map +1 -1
- package/dist/cjs/permitted/middleware.js +1 -1
- package/dist/cjs/permitted/middleware.js.map +1 -1
- package/dist/cjs/permitted/requestSnaps.js +5 -4
- package/dist/cjs/permitted/requestSnaps.js.map +1 -1
- package/dist/esm/permitted/getAllSnaps.js +37 -0
- package/dist/esm/permitted/getAllSnaps.js.map +1 -0
- package/dist/esm/permitted/handlers.js +2 -0
- package/dist/esm/permitted/handlers.js.map +1 -1
- package/dist/esm/permitted/index.js.map +1 -1
- package/dist/esm/permitted/middleware.js +1 -1
- package/dist/esm/permitted/middleware.js.map +1 -1
- package/dist/esm/permitted/requestSnaps.js +5 -4
- package/dist/esm/permitted/requestSnaps.js.map +1 -1
- package/dist/types/permitted/getAllSnaps.d.ts +14 -0
- package/dist/types/permitted/handlers.d.ts +2 -1
- package/dist/types/permitted/index.d.ts +2 -1
- package/dist/types/permitted/requestSnaps.d.ts +1 -2
- package/package.json +6 -6
- package/dist/cjs/permitted/common/snapInstallation.js +0 -33
- package/dist/cjs/permitted/common/snapInstallation.js.map +0 -1
- package/dist/esm/permitted/common/snapInstallation.js +0 -33
- package/dist/esm/permitted/common/snapInstallation.js.map +0 -1
- package/dist/types/permitted/common/snapInstallation.d.ts +0 -14
package/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
|
|
9
|
+
## [4.1.0]
|
|
10
|
+
### Added
|
|
11
|
+
- Add `wallet_getAllSnaps` method to get all installed Snaps ([#2047](https://github.com/MetaMask/snaps/pull/2047))
|
|
12
|
+
|
|
13
|
+
### Changed
|
|
14
|
+
- Bump several MetaMask dependencies ([#2064](https://github.com/MetaMask/snaps/pull/2064), [#2065](https://github.com/MetaMask/snaps/pull/2065))
|
|
15
|
+
|
|
16
|
+
## [4.0.3]
|
|
17
|
+
### Changed
|
|
18
|
+
- Use prototype `startsWith` for RPC method middleware ([#2035](https://github.com/MetaMask/snaps/pull/2035))
|
|
19
|
+
|
|
9
20
|
## [4.0.2]
|
|
10
21
|
### Changed
|
|
11
22
|
- Bump several MetaMask dependencies ([#1989](https://github.com/MetaMask/snaps/pull/1989))
|
|
@@ -80,7 +91,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
80
91
|
- The version of the package no longer needs to match the version of all other
|
|
81
92
|
MetaMask Snaps packages.
|
|
82
93
|
|
|
83
|
-
[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@4.0
|
|
94
|
+
[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@4.1.0...HEAD
|
|
95
|
+
[4.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@4.0.3...@metamask/snaps-rpc-methods@4.1.0
|
|
96
|
+
[4.0.3]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@4.0.2...@metamask/snaps-rpc-methods@4.0.3
|
|
84
97
|
[4.0.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@4.0.1...@metamask/snaps-rpc-methods@4.0.2
|
|
85
98
|
[4.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@4.0.0...@metamask/snaps-rpc-methods@4.0.1
|
|
86
99
|
[4.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-rpc-methods@3.3.0...@metamask/snaps-rpc-methods@4.0.0
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", {
|
|
3
|
+
value: true
|
|
4
|
+
});
|
|
5
|
+
Object.defineProperty(exports, "getAllSnapsHandler", {
|
|
6
|
+
enumerable: true,
|
|
7
|
+
get: function() {
|
|
8
|
+
return getAllSnapsHandler;
|
|
9
|
+
}
|
|
10
|
+
});
|
|
11
|
+
const _rpcerrors = require("@metamask/rpc-errors");
|
|
12
|
+
const hookNames = {
|
|
13
|
+
getAllSnaps: true
|
|
14
|
+
};
|
|
15
|
+
const getAllSnapsHandler = {
|
|
16
|
+
methodNames: [
|
|
17
|
+
'wallet_getAllSnaps'
|
|
18
|
+
],
|
|
19
|
+
implementation: getAllSnapsImplementation,
|
|
20
|
+
hookNames
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* The `wallet_getAllSnaps` method implementation.
|
|
24
|
+
* Fetches all installed snaps and adds them to the JSON-RPC response.
|
|
25
|
+
*
|
|
26
|
+
* @param request - The JSON-RPC request object.
|
|
27
|
+
* @param response - The JSON-RPC response object.
|
|
28
|
+
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
|
|
29
|
+
* function.
|
|
30
|
+
* @param end - The `json-rpc-engine` "end" callback.
|
|
31
|
+
* @param hooks - The RPC method hooks.
|
|
32
|
+
* @param hooks.getAllSnaps - A function that returns all installed snaps.
|
|
33
|
+
* @returns Nothing.
|
|
34
|
+
*/ async function getAllSnapsImplementation(request, response, _next, end, { getAllSnaps }) {
|
|
35
|
+
// The origin is added by the MetaMask middleware stack.
|
|
36
|
+
const { origin } = request;
|
|
37
|
+
if (origin !== 'https://snaps.metamask.io') {
|
|
38
|
+
return end(_rpcerrors.rpcErrors.methodNotFound());
|
|
39
|
+
}
|
|
40
|
+
response.result = await getAllSnaps();
|
|
41
|
+
return end();
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
//# sourceMappingURL=getAllSnaps.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/getAllSnaps.ts"],"sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetSnapsResult } from '@metamask/snaps-sdk';\nimport type {\n JsonRpcParams,\n JsonRpcRequest,\n PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetAllSnapsHooks> = {\n getAllSnaps: true,\n};\n\n/**\n * `wallet_getAllSnaps` gets all installed Snaps. Currently, this can only be\n * called from `https://snaps.metamask.io`.\n */\nexport const getAllSnapsHandler: PermittedHandlerExport<\n GetAllSnapsHooks,\n JsonRpcParams,\n GetSnapsResult\n> = {\n methodNames: ['wallet_getAllSnaps'],\n implementation: getAllSnapsImplementation,\n hookNames,\n};\n\nexport type GetAllSnapsHooks = {\n /**\n * @returns All installed Snaps.\n */\n getAllSnaps: () => Promise<GetSnapsResult>;\n};\n\n/**\n * The `wallet_getAllSnaps` method implementation.\n * Fetches all installed snaps and adds them to the JSON-RPC response.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getAllSnaps - A function that returns all installed snaps.\n * @returns Nothing.\n */\nasync function getAllSnapsImplementation(\n request: JsonRpcRequest,\n response: PendingJsonRpcResponse<GetSnapsResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { getAllSnaps }: GetAllSnapsHooks,\n): Promise<void> {\n // The origin is added by the MetaMask middleware stack.\n const { origin } = request as JsonRpcRequest & { origin: string };\n\n if (origin !== 'https://snaps.metamask.io') {\n return end(rpcErrors.methodNotFound());\n }\n\n response.result = await getAllSnaps();\n return end();\n}\n"],"names":["getAllSnapsHandler","hookNames","getAllSnaps","methodNames","implementation","getAllSnapsImplementation","request","response","_next","end","origin","rpcErrors","methodNotFound","result"],"mappings":";;;;+BAoBaA;;;eAAAA;;;2BAlBa;AAU1B,MAAMC,YAAiD;IACrDC,aAAa;AACf;AAMO,MAAMF,qBAIT;IACFG,aAAa;QAAC;KAAqB;IACnCC,gBAAgBC;IAChBJ;AACF;AASA;;;;;;;;;;;;CAYC,GACD,eAAeI,0BACbC,OAAuB,EACvBC,QAAgD,EAChDC,KAAc,EACdC,GAA6B,EAC7B,EAAEP,WAAW,EAAoB;IAEjC,wDAAwD;IACxD,MAAM,EAAEQ,MAAM,EAAE,GAAGJ;IAEnB,IAAII,WAAW,6BAA6B;QAC1C,OAAOD,IAAIE,oBAAS,CAACC,cAAc;IACrC;IAEAL,SAASM,MAAM,GAAG,MAAMX;IACxB,OAAOO;AACT"}
|
|
@@ -16,12 +16,14 @@ _export(exports, {
|
|
|
16
16
|
return handlers;
|
|
17
17
|
}
|
|
18
18
|
});
|
|
19
|
+
const _getAllSnaps = require("./getAllSnaps");
|
|
19
20
|
const _getFile = require("./getFile");
|
|
20
21
|
const _getSnaps = require("./getSnaps");
|
|
21
22
|
const _invokeKeyring = require("./invokeKeyring");
|
|
22
23
|
const _invokeSnapSugar = require("./invokeSnapSugar");
|
|
23
24
|
const _requestSnaps = require("./requestSnaps");
|
|
24
25
|
const methodHandlers = {
|
|
26
|
+
wallet_getAllSnaps: _getAllSnaps.getAllSnapsHandler,
|
|
25
27
|
wallet_getSnaps: _getSnaps.getSnapsHandler,
|
|
26
28
|
wallet_requestSnaps: _requestSnaps.requestSnapsHandler,
|
|
27
29
|
wallet_invokeSnap: _invokeSnapSugar.invokeSnapSugarHandler,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/handlers.ts"],"sourcesContent":["import { getFileHandler } from './getFile';\nimport { getSnapsHandler } from './getSnaps';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { requestSnapsHandler } from './requestSnaps';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n wallet_getSnaps: getSnapsHandler,\n wallet_requestSnaps: requestSnapsHandler,\n wallet_invokeSnap: invokeSnapSugarHandler,\n wallet_invokeKeyring: invokeKeyringHandler,\n snap_getFile: getFileHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"],"names":["methodHandlers","handlers","wallet_getSnaps","getSnapsHandler","wallet_requestSnaps","requestSnapsHandler","wallet_invokeSnap","invokeSnapSugarHandler","wallet_invokeKeyring","invokeKeyringHandler","snap_getFile","getFileHandler","Object","values"],"mappings":";;;;;;;;;;;
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/handlers.ts"],"sourcesContent":["import { getAllSnapsHandler } from './getAllSnaps';\nimport { getFileHandler } from './getFile';\nimport { getSnapsHandler } from './getSnaps';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { requestSnapsHandler } from './requestSnaps';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n wallet_getAllSnaps: getAllSnapsHandler,\n wallet_getSnaps: getSnapsHandler,\n wallet_requestSnaps: requestSnapsHandler,\n wallet_invokeSnap: invokeSnapSugarHandler,\n wallet_invokeKeyring: invokeKeyringHandler,\n snap_getFile: getFileHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"],"names":["methodHandlers","handlers","wallet_getAllSnaps","getAllSnapsHandler","wallet_getSnaps","getSnapsHandler","wallet_requestSnaps","requestSnapsHandler","wallet_invokeSnap","invokeSnapSugarHandler","wallet_invokeKeyring","invokeKeyringHandler","snap_getFile","getFileHandler","Object","values"],"mappings":";;;;;;;;;;;IAQaA,cAAc;eAAdA;;IAUAC,QAAQ;eAARA;;;6BAlBsB;yBACJ;0BACC;+BACK;iCACE;8BACH;AAG7B,MAAMD,iBAAiB;IAC5BE,oBAAoBC,+BAAkB;IACtCC,iBAAiBC,yBAAe;IAChCC,qBAAqBC,iCAAmB;IACxCC,mBAAmBC,uCAAsB;IACzCC,sBAAsBC,mCAAoB;IAC1CC,cAAcC,uBAAc;AAC9B;AAGO,MAAMZ,WAAWa,OAAOC,MAAM,CAACf"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/index.ts"],"sourcesContent":["import type { GetSnapsHooks } from './getSnaps';\nimport type { RequestSnapsHooks } from './requestSnaps';\n\nexport type PermittedRpcMethodHooks = GetSnapsHooks
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/index.ts"],"sourcesContent":["import type { GetAllSnapsHooks } from './getAllSnaps';\nimport type { GetSnapsHooks } from './getSnaps';\nimport type { RequestSnapsHooks } from './requestSnaps';\n\nexport type PermittedRpcMethodHooks = GetAllSnapsHooks &\n GetSnapsHooks &\n RequestSnapsHooks;\n\nexport * from './handlers';\nexport * from './middleware';\n"],"names":[],"mappings":";;;;qBAQc;qBACA"}
|
|
@@ -18,7 +18,7 @@ function createSnapsMethodMiddleware(isSnap, hooks) {
|
|
|
18
18
|
return async function methodMiddleware(request, response, next, end) {
|
|
19
19
|
const handler = _handlers.methodHandlers[request.method];
|
|
20
20
|
if (handler) {
|
|
21
|
-
if (
|
|
21
|
+
if (String.prototype.startsWith.call(request.method, 'snap_') && !isSnap) {
|
|
22
22
|
return end(_rpcerrors.rpcErrors.methodNotFound());
|
|
23
23
|
}
|
|
24
24
|
// TODO: Once json-rpc-engine types are up to date, we should type this correctly
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/middleware.ts"],"sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport { selectHooks } from '../utils';\nimport { methodHandlers } from './handlers';\n\n/**\n * Creates a middleware that handles permitted snap RPC methods.\n *\n * @param isSnap - A flag that should indicate whether the requesting origin is a snap or not.\n * @param hooks - An object containing the hooks made available to the permitted RPC methods.\n * @returns The middleware.\n */\nexport function createSnapsMethodMiddleware(\n isSnap: boolean,\n hooks: Record<string, unknown>,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n // This is not actually a misused promise, the type is just wrong\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n return async function methodMiddleware(request, response, next, end) {\n const handler =\n methodHandlers[request.method as keyof typeof methodHandlers];\n if (handler) {\n if (
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/middleware.ts"],"sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport { selectHooks } from '../utils';\nimport { methodHandlers } from './handlers';\n\n/**\n * Creates a middleware that handles permitted snap RPC methods.\n *\n * @param isSnap - A flag that should indicate whether the requesting origin is a snap or not.\n * @param hooks - An object containing the hooks made available to the permitted RPC methods.\n * @returns The middleware.\n */\nexport function createSnapsMethodMiddleware(\n isSnap: boolean,\n hooks: Record<string, unknown>,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n // This is not actually a misused promise, the type is just wrong\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n return async function methodMiddleware(request, response, next, end) {\n const handler =\n methodHandlers[request.method as keyof typeof methodHandlers];\n if (handler) {\n if (\n String.prototype.startsWith.call(request.method, 'snap_') &&\n !isSnap\n ) {\n return end(rpcErrors.methodNotFound());\n }\n\n // TODO: Once json-rpc-engine types are up to date, we should type this correctly\n const { implementation, hookNames } = handler as any;\n try {\n // Implementations may or may not be async, so we must await them.\n return await implementation(\n request,\n response,\n next,\n end,\n selectHooks(hooks, hookNames),\n );\n } catch (error) {\n logError(error);\n return end(error);\n }\n }\n\n return next();\n };\n}\n"],"names":["createSnapsMethodMiddleware","isSnap","hooks","methodMiddleware","request","response","next","end","handler","methodHandlers","method","String","prototype","startsWith","call","rpcErrors","methodNotFound","implementation","hookNames","selectHooks","error","logError"],"mappings":";;;;+BAegBA;;;eAAAA;;;2BAdU;4BACD;uBAGG;0BACG;AASxB,SAASA,4BACdC,MAAe,EACfC,KAA8B;IAE9B,iEAAiE;IACjE,kEAAkE;IAClE,OAAO,eAAeC,iBAAiBC,OAAO,EAAEC,QAAQ,EAAEC,IAAI,EAAEC,GAAG;QACjE,MAAMC,UACJC,wBAAc,CAACL,QAAQM,MAAM,CAAgC;QAC/D,IAAIF,SAAS;YACX,IACEG,OAAOC,SAAS,CAACC,UAAU,CAACC,IAAI,CAACV,QAAQM,MAAM,EAAE,YACjD,CAACT,QACD;gBACA,OAAOM,IAAIQ,oBAAS,CAACC,cAAc;YACrC;YAEA,iFAAiF;YACjF,MAAM,EAAEC,cAAc,EAAEC,SAAS,EAAE,GAAGV;YACtC,IAAI;gBACF,kEAAkE;gBAClE,OAAO,MAAMS,eACXb,SACAC,UACAC,MACAC,KACAY,IAAAA,kBAAW,EAACjB,OAAOgB;YAEvB,EAAE,OAAOE,OAAO;gBACdC,IAAAA,oBAAQ,EAACD;gBACT,OAAOb,IAAIa;YACb;QACF;QAEA,OAAOd;IACT;AACF"}
|
|
@@ -23,7 +23,6 @@ const _rpcerrors = require("@metamask/rpc-errors");
|
|
|
23
23
|
const _snapsutils = require("@metamask/snaps-utils");
|
|
24
24
|
const _utils = require("@metamask/utils");
|
|
25
25
|
const _invokeSnap = require("../restricted/invokeSnap");
|
|
26
|
-
const _snapInstallation = require("./common/snapInstallation");
|
|
27
26
|
const hookNames = {
|
|
28
27
|
installSnaps: true,
|
|
29
28
|
requestPermissions: true,
|
|
@@ -89,8 +88,10 @@ function getSnapPermissionsRequest(existingPermissions, requestedPermissions) {
|
|
|
89
88
|
}));
|
|
90
89
|
}
|
|
91
90
|
try {
|
|
92
|
-
if (
|
|
93
|
-
|
|
91
|
+
if (Object.keys(requestedSnaps).length === 0) {
|
|
92
|
+
return end(_rpcerrors.rpcErrors.invalidParams({
|
|
93
|
+
message: 'Request must have at least one requested snap.'
|
|
94
|
+
}));
|
|
94
95
|
}
|
|
95
96
|
const requestedPermissions = {
|
|
96
97
|
[_invokeSnap.WALLET_SNAP_PERMISSION_KEY]: {
|
|
@@ -107,7 +108,7 @@ function getSnapPermissionsRequest(existingPermissions, requestedPermissions) {
|
|
|
107
108
|
const [, metadata] = await requestPermissions(requestedPermissions);
|
|
108
109
|
res.result = metadata.data[_invokeSnap.WALLET_SNAP_PERMISSION_KEY];
|
|
109
110
|
} else if (hasRequestedSnaps(existingPermissions, requestedSnaps)) {
|
|
110
|
-
res.result = await (
|
|
111
|
+
res.result = await installSnaps(requestedSnaps);
|
|
111
112
|
} else {
|
|
112
113
|
const mergedPermissionsRequest = getSnapPermissionsRequest(existingPermissions, requestedPermissions);
|
|
113
114
|
const [, metadata] = await requestPermissions(mergedPermissionsRequest);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/requestSnaps.ts"],"sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type {\n PermissionConstraint,\n RequestedPermissions,\n Caveat,\n PermittedHandlerExport,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n RequestSnapsParams,\n RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport type { SnapsPermissionRequest } from '@metamask/snaps-utils';\nimport {\n SnapCaveatType,\n verifyRequestedSnapPermissions,\n} from '@metamask/snaps-utils';\nimport type {\n JsonRpcRequest,\n PendingJsonRpcResponse,\n Json,\n} from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { WALLET_SNAP_PERMISSION_KEY } from '../restricted/invokeSnap';\nimport type { MethodHooksObject } from '../utils';\nimport type { InstallSnapsHook } from './common/snapInstallation';\nimport { handleInstallSnaps } from './common/snapInstallation';\n\nconst hookNames: MethodHooksObject<RequestSnapsHooks> = {\n installSnaps: true,\n requestPermissions: true,\n getPermissions: true,\n};\n\n/**\n * `wallet_requestSnaps` installs the requested Snaps and requests permission to use them if necessary.\n */\nexport const requestSnapsHandler: PermittedHandlerExport<\n RequestSnapsHooks,\n RequestSnapsParams,\n RequestSnapsResult\n> = {\n methodNames: ['wallet_requestSnaps'],\n implementation: requestSnapsImplementation,\n hookNames,\n};\n\nexport type RequestSnapsHooks = {\n /**\n * Installs the requested snaps if they are permitted.\n */\n installSnaps: InstallSnapsHook;\n\n /**\n * Initiates a permission request for the requesting origin.\n *\n * @returns The result of the permissions request.\n */\n requestPermissions: (\n permissions: RequestedPermissions,\n ) => Promise<\n [\n Record<string, PermissionConstraint>,\n { data: Record<string, unknown>; id: string; origin: string },\n ]\n >;\n\n /**\n * Gets the current permissions for the requesting origin.\n *\n * @returns The current permissions of the requesting origin.\n */\n getPermissions: () => Promise<\n Record<string, PermissionConstraint> | undefined\n >;\n};\n\n/**\n * Checks whether an origin has existing `wallet_snap` permission and\n * whether or not it has the requested snapIds caveat.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedSnaps - The requested snaps.\n * @returns True if the existing permissions satisfy the requested snaps, otherwise false.\n */\nexport function hasRequestedSnaps(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedSnaps: Record<string, unknown>,\n): boolean {\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ]?.caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = snapIdCaveat?.value;\n if (isObject(permittedSnaps)) {\n return Object.keys(requestedSnaps).every((requestedSnap) =>\n hasProperty(permittedSnaps, requestedSnap),\n );\n }\n return false;\n}\n\n/**\n * Constructs a valid permission request with merged caveats based on existing permissions\n * and the requested snaps.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedPermissions - The permission request passed into `requestPermissions`.\n * @returns `requestedPermissions`.\n */\nexport function getSnapPermissionsRequest(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedPermissions: unknown,\n): SnapsPermissionRequest {\n verifyRequestedSnapPermissions(requestedPermissions);\n\n if (!existingPermissions[WALLET_SNAP_PERMISSION_KEY]) {\n return requestedPermissions;\n }\n\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ].caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = (snapIdCaveat?.value as Record<string, Json>) ?? {};\n\n const requestedSnaps =\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value;\n\n const snapIdSet = new Set([\n ...Object.keys(permittedSnaps),\n ...Object.keys(requestedSnaps),\n ]);\n\n const mergedCaveatValue = [...snapIdSet].reduce<Record<string, Json>>(\n (request, snapId) => {\n request[snapId] = requestedSnaps[snapId] ?? permittedSnaps[snapId];\n return request;\n },\n {},\n );\n\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value =\n mergedCaveatValue;\n\n return requestedPermissions;\n}\n\n/**\n * The `wallet_requestSnaps` method implementation.\n * Tries to install the requested snaps and adds them to the JSON-RPC response.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.installSnaps - A function that tries to install a given snap, prompting the user if necessary.\n * @param hooks.requestPermissions - A function that requests permissions on\n * behalf of a subject.\n * @param hooks.getPermissions - A function that gets the current permissions.\n * @returns A promise that resolves once the JSON-RPC response has been modified.\n * @throws If the params are invalid.\n */\nasync function requestSnapsImplementation(\n req: JsonRpcRequest<RequestSnapsParams>,\n res: PendingJsonRpcResponse<RequestSnapsResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { installSnaps, requestPermissions, getPermissions }: RequestSnapsHooks,\n): Promise<void> {\n const requestedSnaps = req.params;\n if (!isObject(requestedSnaps)) {\n return end(\n rpcErrors.invalidParams({\n message: '\"params\" must be an object.',\n }),\n );\n }\n\n try {\n if (!Object.keys(requestedSnaps).length) {\n throw new Error('Request must have at least one requested snap.');\n }\n\n const requestedPermissions = {\n [WALLET_SNAP_PERMISSION_KEY]: {\n caveats: [{ type: SnapCaveatType.SnapIds, value: requestedSnaps }],\n },\n } as RequestedPermissions;\n const existingPermissions = await getPermissions();\n\n if (!existingPermissions) {\n const [, metadata] = await requestPermissions(requestedPermissions);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n } else if (hasRequestedSnaps(existingPermissions, requestedSnaps)) {\n res.result = await handleInstallSnaps(requestedSnaps, installSnaps);\n } else {\n const mergedPermissionsRequest = getSnapPermissionsRequest(\n existingPermissions,\n requestedPermissions,\n );\n\n const [, metadata] = await requestPermissions(mergedPermissionsRequest);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n }\n } catch (error) {\n res.error = error;\n }\n\n return end();\n}\n"],"names":["requestSnapsHandler","hasRequestedSnaps","getSnapPermissionsRequest","hookNames","installSnaps","requestPermissions","getPermissions","methodNames","implementation","requestSnapsImplementation","existingPermissions","requestedSnaps","snapIdCaveat","WALLET_SNAP_PERMISSION_KEY","caveats","find","caveat","type","SnapCaveatType","SnapIds","permittedSnaps","value","isObject","Object","keys","every","requestedSnap","hasProperty","requestedPermissions","verifyRequestedSnapPermissions","snapIdSet","Set","mergedCaveatValue","reduce","request","snapId","req","res","_next","end","params","rpcErrors","invalidParams","message","length","Error","metadata","result","data","handleInstallSnaps","mergedPermissionsRequest","error"],"mappings":";;;;;;;;;;;IAsCaA,mBAAmB;eAAnBA;;IAgDGC,iBAAiB;eAAjBA;;IA2BAC,yBAAyB;eAAzBA;;;2BA1GU;4BASnB;uBAM+B;4BAEK;kCAGR;AAEnC,MAAMC,YAAkD;IACtDC,cAAc;IACdC,oBAAoB;IACpBC,gBAAgB;AAClB;AAKO,MAAMN,sBAIT;IACFO,aAAa;QAAC;KAAsB;IACpCC,gBAAgBC;IAChBN;AACF;AAwCO,SAASF,kBACdS,mBAAyD,EACzDC,cAAuC;IAEvC,MAAMC,eAAeF,mBAAmB,CACtCG,sCAA0B,CAC3B,EAAEC,SAASC,KACV,CAACC,SAAiCA,OAAOC,IAAI,KAAKC,0BAAc,CAACC,OAAO;IAG1E,MAAMC,iBAAiBR,cAAcS;IACrC,IAAIC,IAAAA,eAAQ,EAACF,iBAAiB;QAC5B,OAAOG,OAAOC,IAAI,CAACb,gBAAgBc,KAAK,CAAC,CAACC,gBACxCC,IAAAA,kBAAW,EAACP,gBAAgBM;IAEhC;IACA,OAAO;AACT;AAUO,SAASxB,0BACdQ,mBAAyD,EACzDkB,oBAA6B;IAE7BC,IAAAA,0CAA8B,EAACD;IAE/B,IAAI,CAAClB,mBAAmB,CAACG,sCAA0B,CAAC,EAAE;QACpD,OAAOe;IACT;IAEA,MAAMhB,eAAeF,mBAAmB,CACtCG,sCAA0B,CAC3B,CAACC,OAAO,EAAEC,KACT,CAACC,SAAiCA,OAAOC,IAAI,KAAKC,0BAAc,CAACC,OAAO;IAG1E,MAAMC,iBAAiB,CAACR,cAAcS,KAA6B,KAAK,CAAC;IAEzE,MAAMV,iBACJiB,oBAAoB,CAACf,sCAA0B,CAAC,CAACC,OAAO,CAAC,EAAE,CAACO,KAAK;IAEnE,MAAMS,YAAY,IAAIC,IAAI;WACrBR,OAAOC,IAAI,CAACJ;WACZG,OAAOC,IAAI,CAACb;KAChB;IAED,MAAMqB,oBAAoB;WAAIF;KAAU,CAACG,MAAM,CAC7C,CAACC,SAASC;QACRD,OAAO,CAACC,OAAO,GAAGxB,cAAc,CAACwB,OAAO,IAAIf,cAAc,CAACe,OAAO;QAClE,OAAOD;IACT,GACA,CAAC;IAGHN,oBAAoB,CAACf,sCAA0B,CAAC,CAACC,OAAO,CAAC,EAAE,CAACO,KAAK,GAC/DW;IAEF,OAAOJ;AACT;AAEA;;;;;;;;;;;;;;;;CAgBC,GACD,eAAenB,2BACb2B,GAAuC,EACvCC,GAA+C,EAC/CC,KAAc,EACdC,GAA6B,EAC7B,EAAEnC,YAAY,EAAEC,kBAAkB,EAAEC,cAAc,EAAqB;IAEvE,MAAMK,iBAAiByB,IAAII,MAAM;IACjC,IAAI,CAAClB,IAAAA,eAAQ,EAACX,iBAAiB;QAC7B,OAAO4B,IACLE,oBAAS,CAACC,aAAa,CAAC;YACtBC,SAAS;QACX;IAEJ;IAEA,IAAI;QACF,IAAI,CAACpB,OAAOC,IAAI,CAACb,gBAAgBiC,MAAM,EAAE;YACvC,MAAM,IAAIC,MAAM;QAClB;QAEA,MAAMjB,uBAAuB;YAC3B,CAACf,sCAA0B,CAAC,EAAE;gBAC5BC,SAAS;oBAAC;wBAAEG,MAAMC,0BAAc,CAACC,OAAO;wBAAEE,OAAOV;oBAAe;iBAAE;YACpE;QACF;QACA,MAAMD,sBAAsB,MAAMJ;QAElC,IAAI,CAACI,qBAAqB;YACxB,MAAM,GAAGoC,SAAS,GAAG,MAAMzC,mBAAmBuB;YAC9CS,IAAIU,MAAM,GAAGD,SAASE,IAAI,CACxBnC,sCAA0B,CAC3B;QACH,OAAO,IAAIZ,kBAAkBS,qBAAqBC,iBAAiB;YACjE0B,IAAIU,MAAM,GAAG,MAAME,IAAAA,oCAAkB,EAACtC,gBAAgBP;QACxD,OAAO;YACL,MAAM8C,2BAA2BhD,0BAC/BQ,qBACAkB;YAGF,MAAM,GAAGkB,SAAS,GAAG,MAAMzC,mBAAmB6C;YAC9Cb,IAAIU,MAAM,GAAGD,SAASE,IAAI,CACxBnC,sCAA0B,CAC3B;QACH;IACF,EAAE,OAAOsC,OAAO;QACdd,IAAIc,KAAK,GAAGA;IACd;IAEA,OAAOZ;AACT"}
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/requestSnaps.ts"],"sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type {\n PermissionConstraint,\n RequestedPermissions,\n Caveat,\n PermittedHandlerExport,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n RequestSnapsParams,\n RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport type { SnapsPermissionRequest } from '@metamask/snaps-utils';\nimport {\n SnapCaveatType,\n verifyRequestedSnapPermissions,\n} from '@metamask/snaps-utils';\nimport type {\n JsonRpcRequest,\n PendingJsonRpcResponse,\n Json,\n} from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { WALLET_SNAP_PERMISSION_KEY } from '../restricted/invokeSnap';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<RequestSnapsHooks> = {\n installSnaps: true,\n requestPermissions: true,\n getPermissions: true,\n};\n\n/**\n * `wallet_requestSnaps` installs the requested Snaps and requests permission to use them if necessary.\n */\nexport const requestSnapsHandler: PermittedHandlerExport<\n RequestSnapsHooks,\n RequestSnapsParams,\n RequestSnapsResult\n> = {\n methodNames: ['wallet_requestSnaps'],\n implementation: requestSnapsImplementation,\n hookNames,\n};\n\nexport type RequestSnapsHooks = {\n /**\n * Installs the requested snaps if they are permitted.\n */\n installSnaps: (\n requestedSnaps: RequestSnapsParams,\n ) => Promise<RequestSnapsResult>;\n\n /**\n * Initiates a permission request for the requesting origin.\n *\n * @returns The result of the permissions request.\n */\n requestPermissions: (\n permissions: RequestedPermissions,\n ) => Promise<\n [\n Record<string, PermissionConstraint>,\n { data: Record<string, unknown>; id: string; origin: string },\n ]\n >;\n\n /**\n * Gets the current permissions for the requesting origin.\n *\n * @returns The current permissions of the requesting origin.\n */\n getPermissions: () => Promise<\n Record<string, PermissionConstraint> | undefined\n >;\n};\n\n/**\n * Checks whether an origin has existing `wallet_snap` permission and\n * whether or not it has the requested snapIds caveat.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedSnaps - The requested snaps.\n * @returns True if the existing permissions satisfy the requested snaps, otherwise false.\n */\nexport function hasRequestedSnaps(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedSnaps: Record<string, unknown>,\n): boolean {\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ]?.caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = snapIdCaveat?.value;\n if (isObject(permittedSnaps)) {\n return Object.keys(requestedSnaps).every((requestedSnap) =>\n hasProperty(permittedSnaps, requestedSnap),\n );\n }\n return false;\n}\n\n/**\n * Constructs a valid permission request with merged caveats based on existing permissions\n * and the requested snaps.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedPermissions - The permission request passed into `requestPermissions`.\n * @returns `requestedPermissions`.\n */\nexport function getSnapPermissionsRequest(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedPermissions: unknown,\n): SnapsPermissionRequest {\n verifyRequestedSnapPermissions(requestedPermissions);\n\n if (!existingPermissions[WALLET_SNAP_PERMISSION_KEY]) {\n return requestedPermissions;\n }\n\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ].caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = (snapIdCaveat?.value as Record<string, Json>) ?? {};\n\n const requestedSnaps =\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value;\n\n const snapIdSet = new Set([\n ...Object.keys(permittedSnaps),\n ...Object.keys(requestedSnaps),\n ]);\n\n const mergedCaveatValue = [...snapIdSet].reduce<Record<string, Json>>(\n (request, snapId) => {\n request[snapId] = requestedSnaps[snapId] ?? permittedSnaps[snapId];\n return request;\n },\n {},\n );\n\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value =\n mergedCaveatValue;\n\n return requestedPermissions;\n}\n\n/**\n * The `wallet_requestSnaps` method implementation.\n * Tries to install the requested snaps and adds them to the JSON-RPC response.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.installSnaps - A function that tries to install a given snap, prompting the user if necessary.\n * @param hooks.requestPermissions - A function that requests permissions on\n * behalf of a subject.\n * @param hooks.getPermissions - A function that gets the current permissions.\n * @returns A promise that resolves once the JSON-RPC response has been modified.\n * @throws If the params are invalid.\n */\nasync function requestSnapsImplementation(\n req: JsonRpcRequest<RequestSnapsParams>,\n res: PendingJsonRpcResponse<RequestSnapsResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { installSnaps, requestPermissions, getPermissions }: RequestSnapsHooks,\n): Promise<void> {\n const requestedSnaps = req.params;\n if (!isObject(requestedSnaps)) {\n return end(\n rpcErrors.invalidParams({\n message: '\"params\" must be an object.',\n }),\n );\n }\n\n try {\n if (Object.keys(requestedSnaps).length === 0) {\n return end(\n rpcErrors.invalidParams({\n message: 'Request must have at least one requested snap.',\n }),\n );\n }\n\n const requestedPermissions = {\n [WALLET_SNAP_PERMISSION_KEY]: {\n caveats: [{ type: SnapCaveatType.SnapIds, value: requestedSnaps }],\n },\n } as RequestedPermissions;\n const existingPermissions = await getPermissions();\n\n if (!existingPermissions) {\n const [, metadata] = await requestPermissions(requestedPermissions);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n } else if (hasRequestedSnaps(existingPermissions, requestedSnaps)) {\n res.result = await installSnaps(requestedSnaps);\n } else {\n const mergedPermissionsRequest = getSnapPermissionsRequest(\n existingPermissions,\n requestedPermissions,\n );\n\n const [, metadata] = await requestPermissions(mergedPermissionsRequest);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n }\n } catch (error) {\n res.error = error;\n }\n\n return end();\n}\n"],"names":["requestSnapsHandler","hasRequestedSnaps","getSnapPermissionsRequest","hookNames","installSnaps","requestPermissions","getPermissions","methodNames","implementation","requestSnapsImplementation","existingPermissions","requestedSnaps","snapIdCaveat","WALLET_SNAP_PERMISSION_KEY","caveats","find","caveat","type","SnapCaveatType","SnapIds","permittedSnaps","value","isObject","Object","keys","every","requestedSnap","hasProperty","requestedPermissions","verifyRequestedSnapPermissions","snapIdSet","Set","mergedCaveatValue","reduce","request","snapId","req","res","_next","end","params","rpcErrors","invalidParams","message","length","metadata","result","data","mergedPermissionsRequest","error"],"mappings":";;;;;;;;;;;IAoCaA,mBAAmB;eAAnBA;;IAkDGC,iBAAiB;eAAjBA;;IA2BAC,yBAAyB;eAAzBA;;;2BA1GU;4BASnB;uBAM+B;4BAEK;AAG3C,MAAMC,YAAkD;IACtDC,cAAc;IACdC,oBAAoB;IACpBC,gBAAgB;AAClB;AAKO,MAAMN,sBAIT;IACFO,aAAa;QAAC;KAAsB;IACpCC,gBAAgBC;IAChBN;AACF;AA0CO,SAASF,kBACdS,mBAAyD,EACzDC,cAAuC;IAEvC,MAAMC,eAAeF,mBAAmB,CACtCG,sCAA0B,CAC3B,EAAEC,SAASC,KACV,CAACC,SAAiCA,OAAOC,IAAI,KAAKC,0BAAc,CAACC,OAAO;IAG1E,MAAMC,iBAAiBR,cAAcS;IACrC,IAAIC,IAAAA,eAAQ,EAACF,iBAAiB;QAC5B,OAAOG,OAAOC,IAAI,CAACb,gBAAgBc,KAAK,CAAC,CAACC,gBACxCC,IAAAA,kBAAW,EAACP,gBAAgBM;IAEhC;IACA,OAAO;AACT;AAUO,SAASxB,0BACdQ,mBAAyD,EACzDkB,oBAA6B;IAE7BC,IAAAA,0CAA8B,EAACD;IAE/B,IAAI,CAAClB,mBAAmB,CAACG,sCAA0B,CAAC,EAAE;QACpD,OAAOe;IACT;IAEA,MAAMhB,eAAeF,mBAAmB,CACtCG,sCAA0B,CAC3B,CAACC,OAAO,EAAEC,KACT,CAACC,SAAiCA,OAAOC,IAAI,KAAKC,0BAAc,CAACC,OAAO;IAG1E,MAAMC,iBAAiB,CAACR,cAAcS,KAA6B,KAAK,CAAC;IAEzE,MAAMV,iBACJiB,oBAAoB,CAACf,sCAA0B,CAAC,CAACC,OAAO,CAAC,EAAE,CAACO,KAAK;IAEnE,MAAMS,YAAY,IAAIC,IAAI;WACrBR,OAAOC,IAAI,CAACJ;WACZG,OAAOC,IAAI,CAACb;KAChB;IAED,MAAMqB,oBAAoB;WAAIF;KAAU,CAACG,MAAM,CAC7C,CAACC,SAASC;QACRD,OAAO,CAACC,OAAO,GAAGxB,cAAc,CAACwB,OAAO,IAAIf,cAAc,CAACe,OAAO;QAClE,OAAOD;IACT,GACA,CAAC;IAGHN,oBAAoB,CAACf,sCAA0B,CAAC,CAACC,OAAO,CAAC,EAAE,CAACO,KAAK,GAC/DW;IAEF,OAAOJ;AACT;AAEA;;;;;;;;;;;;;;;;CAgBC,GACD,eAAenB,2BACb2B,GAAuC,EACvCC,GAA+C,EAC/CC,KAAc,EACdC,GAA6B,EAC7B,EAAEnC,YAAY,EAAEC,kBAAkB,EAAEC,cAAc,EAAqB;IAEvE,MAAMK,iBAAiByB,IAAII,MAAM;IACjC,IAAI,CAAClB,IAAAA,eAAQ,EAACX,iBAAiB;QAC7B,OAAO4B,IACLE,oBAAS,CAACC,aAAa,CAAC;YACtBC,SAAS;QACX;IAEJ;IAEA,IAAI;QACF,IAAIpB,OAAOC,IAAI,CAACb,gBAAgBiC,MAAM,KAAK,GAAG;YAC5C,OAAOL,IACLE,oBAAS,CAACC,aAAa,CAAC;gBACtBC,SAAS;YACX;QAEJ;QAEA,MAAMf,uBAAuB;YAC3B,CAACf,sCAA0B,CAAC,EAAE;gBAC5BC,SAAS;oBAAC;wBAAEG,MAAMC,0BAAc,CAACC,OAAO;wBAAEE,OAAOV;oBAAe;iBAAE;YACpE;QACF;QACA,MAAMD,sBAAsB,MAAMJ;QAElC,IAAI,CAACI,qBAAqB;YACxB,MAAM,GAAGmC,SAAS,GAAG,MAAMxC,mBAAmBuB;YAC9CS,IAAIS,MAAM,GAAGD,SAASE,IAAI,CACxBlC,sCAA0B,CAC3B;QACH,OAAO,IAAIZ,kBAAkBS,qBAAqBC,iBAAiB;YACjE0B,IAAIS,MAAM,GAAG,MAAM1C,aAAaO;QAClC,OAAO;YACL,MAAMqC,2BAA2B9C,0BAC/BQ,qBACAkB;YAGF,MAAM,GAAGiB,SAAS,GAAG,MAAMxC,mBAAmB2C;YAC9CX,IAAIS,MAAM,GAAGD,SAASE,IAAI,CACxBlC,sCAA0B,CAC3B;QACH;IACF,EAAE,OAAOoC,OAAO;QACdZ,IAAIY,KAAK,GAAGA;IACd;IAEA,OAAOV;AACT"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { rpcErrors } from '@metamask/rpc-errors';
|
|
2
|
+
const hookNames = {
|
|
3
|
+
getAllSnaps: true
|
|
4
|
+
};
|
|
5
|
+
/**
|
|
6
|
+
* `wallet_getAllSnaps` gets all installed Snaps. Currently, this can only be
|
|
7
|
+
* called from `https://snaps.metamask.io`.
|
|
8
|
+
*/ export const getAllSnapsHandler = {
|
|
9
|
+
methodNames: [
|
|
10
|
+
'wallet_getAllSnaps'
|
|
11
|
+
],
|
|
12
|
+
implementation: getAllSnapsImplementation,
|
|
13
|
+
hookNames
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* The `wallet_getAllSnaps` method implementation.
|
|
17
|
+
* Fetches all installed snaps and adds them to the JSON-RPC response.
|
|
18
|
+
*
|
|
19
|
+
* @param request - The JSON-RPC request object.
|
|
20
|
+
* @param response - The JSON-RPC response object.
|
|
21
|
+
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
|
|
22
|
+
* function.
|
|
23
|
+
* @param end - The `json-rpc-engine` "end" callback.
|
|
24
|
+
* @param hooks - The RPC method hooks.
|
|
25
|
+
* @param hooks.getAllSnaps - A function that returns all installed snaps.
|
|
26
|
+
* @returns Nothing.
|
|
27
|
+
*/ async function getAllSnapsImplementation(request, response, _next, end, { getAllSnaps }) {
|
|
28
|
+
// The origin is added by the MetaMask middleware stack.
|
|
29
|
+
const { origin } = request;
|
|
30
|
+
if (origin !== 'https://snaps.metamask.io') {
|
|
31
|
+
return end(rpcErrors.methodNotFound());
|
|
32
|
+
}
|
|
33
|
+
response.result = await getAllSnaps();
|
|
34
|
+
return end();
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
//# sourceMappingURL=getAllSnaps.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/getAllSnaps.ts"],"sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { GetSnapsResult } from '@metamask/snaps-sdk';\nimport type {\n JsonRpcParams,\n JsonRpcRequest,\n PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<GetAllSnapsHooks> = {\n getAllSnaps: true,\n};\n\n/**\n * `wallet_getAllSnaps` gets all installed Snaps. Currently, this can only be\n * called from `https://snaps.metamask.io`.\n */\nexport const getAllSnapsHandler: PermittedHandlerExport<\n GetAllSnapsHooks,\n JsonRpcParams,\n GetSnapsResult\n> = {\n methodNames: ['wallet_getAllSnaps'],\n implementation: getAllSnapsImplementation,\n hookNames,\n};\n\nexport type GetAllSnapsHooks = {\n /**\n * @returns All installed Snaps.\n */\n getAllSnaps: () => Promise<GetSnapsResult>;\n};\n\n/**\n * The `wallet_getAllSnaps` method implementation.\n * Fetches all installed snaps and adds them to the JSON-RPC response.\n *\n * @param request - The JSON-RPC request object.\n * @param response - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.getAllSnaps - A function that returns all installed snaps.\n * @returns Nothing.\n */\nasync function getAllSnapsImplementation(\n request: JsonRpcRequest,\n response: PendingJsonRpcResponse<GetSnapsResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { getAllSnaps }: GetAllSnapsHooks,\n): Promise<void> {\n // The origin is added by the MetaMask middleware stack.\n const { origin } = request as JsonRpcRequest & { origin: string };\n\n if (origin !== 'https://snaps.metamask.io') {\n return end(rpcErrors.methodNotFound());\n }\n\n response.result = await getAllSnaps();\n return end();\n}\n"],"names":["rpcErrors","hookNames","getAllSnaps","getAllSnapsHandler","methodNames","implementation","getAllSnapsImplementation","request","response","_next","end","origin","methodNotFound","result"],"mappings":"AAEA,SAASA,SAAS,QAAQ,uBAAuB;AAUjD,MAAMC,YAAiD;IACrDC,aAAa;AACf;AAEA;;;CAGC,GACD,OAAO,MAAMC,qBAIT;IACFC,aAAa;QAAC;KAAqB;IACnCC,gBAAgBC;IAChBL;AACF,EAAE;AASF;;;;;;;;;;;;CAYC,GACD,eAAeK,0BACbC,OAAuB,EACvBC,QAAgD,EAChDC,KAAc,EACdC,GAA6B,EAC7B,EAAER,WAAW,EAAoB;IAEjC,wDAAwD;IACxD,MAAM,EAAES,MAAM,EAAE,GAAGJ;IAEnB,IAAII,WAAW,6BAA6B;QAC1C,OAAOD,IAAIV,UAAUY,cAAc;IACrC;IAEAJ,SAASK,MAAM,GAAG,MAAMX;IACxB,OAAOQ;AACT"}
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import { getAllSnapsHandler } from './getAllSnaps';
|
|
1
2
|
import { getFileHandler } from './getFile';
|
|
2
3
|
import { getSnapsHandler } from './getSnaps';
|
|
3
4
|
import { invokeKeyringHandler } from './invokeKeyring';
|
|
4
5
|
import { invokeSnapSugarHandler } from './invokeSnapSugar';
|
|
5
6
|
import { requestSnapsHandler } from './requestSnaps';
|
|
6
7
|
/* eslint-disable @typescript-eslint/naming-convention */ export const methodHandlers = {
|
|
8
|
+
wallet_getAllSnaps: getAllSnapsHandler,
|
|
7
9
|
wallet_getSnaps: getSnapsHandler,
|
|
8
10
|
wallet_requestSnaps: requestSnapsHandler,
|
|
9
11
|
wallet_invokeSnap: invokeSnapSugarHandler,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/handlers.ts"],"sourcesContent":["import { getFileHandler } from './getFile';\nimport { getSnapsHandler } from './getSnaps';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { requestSnapsHandler } from './requestSnaps';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n wallet_getSnaps: getSnapsHandler,\n wallet_requestSnaps: requestSnapsHandler,\n wallet_invokeSnap: invokeSnapSugarHandler,\n wallet_invokeKeyring: invokeKeyringHandler,\n snap_getFile: getFileHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"],"names":["getFileHandler","getSnapsHandler","invokeKeyringHandler","invokeSnapSugarHandler","requestSnapsHandler","methodHandlers","wallet_getSnaps","wallet_requestSnaps","wallet_invokeSnap","wallet_invokeKeyring","snap_getFile","handlers","Object","values"],"mappings":"AAAA,SAASA,cAAc,QAAQ,YAAY;AAC3C,SAASC,eAAe,QAAQ,aAAa;AAC7C,SAASC,oBAAoB,QAAQ,kBAAkB;AACvD,SAASC,sBAAsB,QAAQ,oBAAoB;AAC3D,SAASC,mBAAmB,QAAQ,iBAAiB;AAErD,uDAAuD,GACvD,OAAO,MAAMC,iBAAiB;IAC5BC,
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/handlers.ts"],"sourcesContent":["import { getAllSnapsHandler } from './getAllSnaps';\nimport { getFileHandler } from './getFile';\nimport { getSnapsHandler } from './getSnaps';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { requestSnapsHandler } from './requestSnaps';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n wallet_getAllSnaps: getAllSnapsHandler,\n wallet_getSnaps: getSnapsHandler,\n wallet_requestSnaps: requestSnapsHandler,\n wallet_invokeSnap: invokeSnapSugarHandler,\n wallet_invokeKeyring: invokeKeyringHandler,\n snap_getFile: getFileHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"],"names":["getAllSnapsHandler","getFileHandler","getSnapsHandler","invokeKeyringHandler","invokeSnapSugarHandler","requestSnapsHandler","methodHandlers","wallet_getAllSnaps","wallet_getSnaps","wallet_requestSnaps","wallet_invokeSnap","wallet_invokeKeyring","snap_getFile","handlers","Object","values"],"mappings":"AAAA,SAASA,kBAAkB,QAAQ,gBAAgB;AACnD,SAASC,cAAc,QAAQ,YAAY;AAC3C,SAASC,eAAe,QAAQ,aAAa;AAC7C,SAASC,oBAAoB,QAAQ,kBAAkB;AACvD,SAASC,sBAAsB,QAAQ,oBAAoB;AAC3D,SAASC,mBAAmB,QAAQ,iBAAiB;AAErD,uDAAuD,GACvD,OAAO,MAAMC,iBAAiB;IAC5BC,oBAAoBP;IACpBQ,iBAAiBN;IACjBO,qBAAqBJ;IACrBK,mBAAmBN;IACnBO,sBAAsBR;IACtBS,cAAcX;AAChB,EAAE;AACF,sDAAsD,GAEtD,OAAO,MAAMY,WAAWC,OAAOC,MAAM,CAACT,gBAAgB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/index.ts"],"sourcesContent":["import type { GetSnapsHooks } from './getSnaps';\nimport type { RequestSnapsHooks } from './requestSnaps';\n\nexport type PermittedRpcMethodHooks = GetSnapsHooks
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/index.ts"],"sourcesContent":["import type { GetAllSnapsHooks } from './getAllSnaps';\nimport type { GetSnapsHooks } from './getSnaps';\nimport type { RequestSnapsHooks } from './requestSnaps';\n\nexport type PermittedRpcMethodHooks = GetAllSnapsHooks &\n GetSnapsHooks &\n RequestSnapsHooks;\n\nexport * from './handlers';\nexport * from './middleware';\n"],"names":[],"mappings":"AAQA,cAAc,aAAa;AAC3B,cAAc,eAAe"}
|
|
@@ -14,7 +14,7 @@ import { methodHandlers } from './handlers';
|
|
|
14
14
|
return async function methodMiddleware(request, response, next, end) {
|
|
15
15
|
const handler = methodHandlers[request.method];
|
|
16
16
|
if (handler) {
|
|
17
|
-
if (
|
|
17
|
+
if (String.prototype.startsWith.call(request.method, 'snap_') && !isSnap) {
|
|
18
18
|
return end(rpcErrors.methodNotFound());
|
|
19
19
|
}
|
|
20
20
|
// TODO: Once json-rpc-engine types are up to date, we should type this correctly
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/middleware.ts"],"sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport { selectHooks } from '../utils';\nimport { methodHandlers } from './handlers';\n\n/**\n * Creates a middleware that handles permitted snap RPC methods.\n *\n * @param isSnap - A flag that should indicate whether the requesting origin is a snap or not.\n * @param hooks - An object containing the hooks made available to the permitted RPC methods.\n * @returns The middleware.\n */\nexport function createSnapsMethodMiddleware(\n isSnap: boolean,\n hooks: Record<string, unknown>,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n // This is not actually a misused promise, the type is just wrong\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n return async function methodMiddleware(request, response, next, end) {\n const handler =\n methodHandlers[request.method as keyof typeof methodHandlers];\n if (handler) {\n if (
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/middleware.ts"],"sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport { selectHooks } from '../utils';\nimport { methodHandlers } from './handlers';\n\n/**\n * Creates a middleware that handles permitted snap RPC methods.\n *\n * @param isSnap - A flag that should indicate whether the requesting origin is a snap or not.\n * @param hooks - An object containing the hooks made available to the permitted RPC methods.\n * @returns The middleware.\n */\nexport function createSnapsMethodMiddleware(\n isSnap: boolean,\n hooks: Record<string, unknown>,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n // This is not actually a misused promise, the type is just wrong\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n return async function methodMiddleware(request, response, next, end) {\n const handler =\n methodHandlers[request.method as keyof typeof methodHandlers];\n if (handler) {\n if (\n String.prototype.startsWith.call(request.method, 'snap_') &&\n !isSnap\n ) {\n return end(rpcErrors.methodNotFound());\n }\n\n // TODO: Once json-rpc-engine types are up to date, we should type this correctly\n const { implementation, hookNames } = handler as any;\n try {\n // Implementations may or may not be async, so we must await them.\n return await implementation(\n request,\n response,\n next,\n end,\n selectHooks(hooks, hookNames),\n );\n } catch (error) {\n logError(error);\n return end(error);\n }\n }\n\n return next();\n };\n}\n"],"names":["rpcErrors","logError","selectHooks","methodHandlers","createSnapsMethodMiddleware","isSnap","hooks","methodMiddleware","request","response","next","end","handler","method","String","prototype","startsWith","call","methodNotFound","implementation","hookNames","error"],"mappings":"AACA,SAASA,SAAS,QAAQ,uBAAuB;AACjD,SAASC,QAAQ,QAAQ,wBAAwB;AAGjD,SAASC,WAAW,QAAQ,WAAW;AACvC,SAASC,cAAc,QAAQ,aAAa;AAE5C;;;;;;CAMC,GACD,OAAO,SAASC,4BACdC,MAAe,EACfC,KAA8B;IAE9B,iEAAiE;IACjE,kEAAkE;IAClE,OAAO,eAAeC,iBAAiBC,OAAO,EAAEC,QAAQ,EAAEC,IAAI,EAAEC,GAAG;QACjE,MAAMC,UACJT,cAAc,CAACK,QAAQK,MAAM,CAAgC;QAC/D,IAAID,SAAS;YACX,IACEE,OAAOC,SAAS,CAACC,UAAU,CAACC,IAAI,CAACT,QAAQK,MAAM,EAAE,YACjD,CAACR,QACD;gBACA,OAAOM,IAAIX,UAAUkB,cAAc;YACrC;YAEA,iFAAiF;YACjF,MAAM,EAAEC,cAAc,EAAEC,SAAS,EAAE,GAAGR;YACtC,IAAI;gBACF,kEAAkE;gBAClE,OAAO,MAAMO,eACXX,SACAC,UACAC,MACAC,KACAT,YAAYI,OAAOc;YAEvB,EAAE,OAAOC,OAAO;gBACdpB,SAASoB;gBACT,OAAOV,IAAIU;YACb;QACF;QAEA,OAAOX;IACT;AACF"}
|
|
@@ -2,7 +2,6 @@ import { rpcErrors } from '@metamask/rpc-errors';
|
|
|
2
2
|
import { SnapCaveatType, verifyRequestedSnapPermissions } from '@metamask/snaps-utils';
|
|
3
3
|
import { hasProperty, isObject } from '@metamask/utils';
|
|
4
4
|
import { WALLET_SNAP_PERMISSION_KEY } from '../restricted/invokeSnap';
|
|
5
|
-
import { handleInstallSnaps } from './common/snapInstallation';
|
|
6
5
|
const hookNames = {
|
|
7
6
|
installSnaps: true,
|
|
8
7
|
requestPermissions: true,
|
|
@@ -84,8 +83,10 @@ const hookNames = {
|
|
|
84
83
|
}));
|
|
85
84
|
}
|
|
86
85
|
try {
|
|
87
|
-
if (
|
|
88
|
-
|
|
86
|
+
if (Object.keys(requestedSnaps).length === 0) {
|
|
87
|
+
return end(rpcErrors.invalidParams({
|
|
88
|
+
message: 'Request must have at least one requested snap.'
|
|
89
|
+
}));
|
|
89
90
|
}
|
|
90
91
|
const requestedPermissions = {
|
|
91
92
|
[WALLET_SNAP_PERMISSION_KEY]: {
|
|
@@ -102,7 +103,7 @@ const hookNames = {
|
|
|
102
103
|
const [, metadata] = await requestPermissions(requestedPermissions);
|
|
103
104
|
res.result = metadata.data[WALLET_SNAP_PERMISSION_KEY];
|
|
104
105
|
} else if (hasRequestedSnaps(existingPermissions, requestedSnaps)) {
|
|
105
|
-
res.result = await
|
|
106
|
+
res.result = await installSnaps(requestedSnaps);
|
|
106
107
|
} else {
|
|
107
108
|
const mergedPermissionsRequest = getSnapPermissionsRequest(existingPermissions, requestedPermissions);
|
|
108
109
|
const [, metadata] = await requestPermissions(mergedPermissionsRequest);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/permitted/requestSnaps.ts"],"sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type {\n PermissionConstraint,\n RequestedPermissions,\n Caveat,\n PermittedHandlerExport,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n RequestSnapsParams,\n RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport type { SnapsPermissionRequest } from '@metamask/snaps-utils';\nimport {\n SnapCaveatType,\n verifyRequestedSnapPermissions,\n} from '@metamask/snaps-utils';\nimport type {\n JsonRpcRequest,\n PendingJsonRpcResponse,\n Json,\n} from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { WALLET_SNAP_PERMISSION_KEY } from '../restricted/invokeSnap';\nimport type { MethodHooksObject } from '../utils';\nimport type { InstallSnapsHook } from './common/snapInstallation';\nimport { handleInstallSnaps } from './common/snapInstallation';\n\nconst hookNames: MethodHooksObject<RequestSnapsHooks> = {\n installSnaps: true,\n requestPermissions: true,\n getPermissions: true,\n};\n\n/**\n * `wallet_requestSnaps` installs the requested Snaps and requests permission to use them if necessary.\n */\nexport const requestSnapsHandler: PermittedHandlerExport<\n RequestSnapsHooks,\n RequestSnapsParams,\n RequestSnapsResult\n> = {\n methodNames: ['wallet_requestSnaps'],\n implementation: requestSnapsImplementation,\n hookNames,\n};\n\nexport type RequestSnapsHooks = {\n /**\n * Installs the requested snaps if they are permitted.\n */\n installSnaps: InstallSnapsHook;\n\n /**\n * Initiates a permission request for the requesting origin.\n *\n * @returns The result of the permissions request.\n */\n requestPermissions: (\n permissions: RequestedPermissions,\n ) => Promise<\n [\n Record<string, PermissionConstraint>,\n { data: Record<string, unknown>; id: string; origin: string },\n ]\n >;\n\n /**\n * Gets the current permissions for the requesting origin.\n *\n * @returns The current permissions of the requesting origin.\n */\n getPermissions: () => Promise<\n Record<string, PermissionConstraint> | undefined\n >;\n};\n\n/**\n * Checks whether an origin has existing `wallet_snap` permission and\n * whether or not it has the requested snapIds caveat.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedSnaps - The requested snaps.\n * @returns True if the existing permissions satisfy the requested snaps, otherwise false.\n */\nexport function hasRequestedSnaps(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedSnaps: Record<string, unknown>,\n): boolean {\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ]?.caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = snapIdCaveat?.value;\n if (isObject(permittedSnaps)) {\n return Object.keys(requestedSnaps).every((requestedSnap) =>\n hasProperty(permittedSnaps, requestedSnap),\n );\n }\n return false;\n}\n\n/**\n * Constructs a valid permission request with merged caveats based on existing permissions\n * and the requested snaps.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedPermissions - The permission request passed into `requestPermissions`.\n * @returns `requestedPermissions`.\n */\nexport function getSnapPermissionsRequest(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedPermissions: unknown,\n): SnapsPermissionRequest {\n verifyRequestedSnapPermissions(requestedPermissions);\n\n if (!existingPermissions[WALLET_SNAP_PERMISSION_KEY]) {\n return requestedPermissions;\n }\n\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ].caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = (snapIdCaveat?.value as Record<string, Json>) ?? {};\n\n const requestedSnaps =\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value;\n\n const snapIdSet = new Set([\n ...Object.keys(permittedSnaps),\n ...Object.keys(requestedSnaps),\n ]);\n\n const mergedCaveatValue = [...snapIdSet].reduce<Record<string, Json>>(\n (request, snapId) => {\n request[snapId] = requestedSnaps[snapId] ?? permittedSnaps[snapId];\n return request;\n },\n {},\n );\n\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value =\n mergedCaveatValue;\n\n return requestedPermissions;\n}\n\n/**\n * The `wallet_requestSnaps` method implementation.\n * Tries to install the requested snaps and adds them to the JSON-RPC response.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.installSnaps - A function that tries to install a given snap, prompting the user if necessary.\n * @param hooks.requestPermissions - A function that requests permissions on\n * behalf of a subject.\n * @param hooks.getPermissions - A function that gets the current permissions.\n * @returns A promise that resolves once the JSON-RPC response has been modified.\n * @throws If the params are invalid.\n */\nasync function requestSnapsImplementation(\n req: JsonRpcRequest<RequestSnapsParams>,\n res: PendingJsonRpcResponse<RequestSnapsResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { installSnaps, requestPermissions, getPermissions }: RequestSnapsHooks,\n): Promise<void> {\n const requestedSnaps = req.params;\n if (!isObject(requestedSnaps)) {\n return end(\n rpcErrors.invalidParams({\n message: '\"params\" must be an object.',\n }),\n );\n }\n\n try {\n if (!Object.keys(requestedSnaps).length) {\n throw new Error('Request must have at least one requested snap.');\n }\n\n const requestedPermissions = {\n [WALLET_SNAP_PERMISSION_KEY]: {\n caveats: [{ type: SnapCaveatType.SnapIds, value: requestedSnaps }],\n },\n } as RequestedPermissions;\n const existingPermissions = await getPermissions();\n\n if (!existingPermissions) {\n const [, metadata] = await requestPermissions(requestedPermissions);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n } else if (hasRequestedSnaps(existingPermissions, requestedSnaps)) {\n res.result = await handleInstallSnaps(requestedSnaps, installSnaps);\n } else {\n const mergedPermissionsRequest = getSnapPermissionsRequest(\n existingPermissions,\n requestedPermissions,\n );\n\n const [, metadata] = await requestPermissions(mergedPermissionsRequest);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n }\n } catch (error) {\n res.error = error;\n }\n\n return end();\n}\n"],"names":["rpcErrors","SnapCaveatType","verifyRequestedSnapPermissions","hasProperty","isObject","WALLET_SNAP_PERMISSION_KEY","handleInstallSnaps","hookNames","installSnaps","requestPermissions","getPermissions","requestSnapsHandler","methodNames","implementation","requestSnapsImplementation","hasRequestedSnaps","existingPermissions","requestedSnaps","snapIdCaveat","caveats","find","caveat","type","SnapIds","permittedSnaps","value","Object","keys","every","requestedSnap","getSnapPermissionsRequest","requestedPermissions","snapIdSet","Set","mergedCaveatValue","reduce","request","snapId","req","res","_next","end","params","invalidParams","message","length","Error","metadata","result","data","mergedPermissionsRequest","error"],"mappings":"AAOA,SAASA,SAAS,QAAQ,uBAAuB;AAMjD,SACEC,cAAc,EACdC,8BAA8B,QACzB,wBAAwB;AAM/B,SAASC,WAAW,EAAEC,QAAQ,QAAQ,kBAAkB;AAExD,SAASC,0BAA0B,QAAQ,2BAA2B;AAGtE,SAASC,kBAAkB,QAAQ,4BAA4B;AAE/D,MAAMC,YAAkD;IACtDC,cAAc;IACdC,oBAAoB;IACpBC,gBAAgB;AAClB;AAEA;;CAEC,GACD,OAAO,MAAMC,sBAIT;IACFC,aAAa;QAAC;KAAsB;IACpCC,gBAAgBC;IAChBP;AACF,EAAE;AAgCF;;;;;;;CAOC,GACD,OAAO,SAASQ,kBACdC,mBAAyD,EACzDC,cAAuC;IAEvC,MAAMC,eAAeF,mBAAmB,CACtCX,2BACD,EAAEc,SAASC,KACV,CAACC,SAAiCA,OAAOC,IAAI,KAAKrB,eAAesB,OAAO;IAG1E,MAAMC,iBAAiBN,cAAcO;IACrC,IAAIrB,SAASoB,iBAAiB;QAC5B,OAAOE,OAAOC,IAAI,CAACV,gBAAgBW,KAAK,CAAC,CAACC,gBACxC1B,YAAYqB,gBAAgBK;IAEhC;IACA,OAAO;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,0BACdd,mBAAyD,EACzDe,oBAA6B;IAE7B7B,+BAA+B6B;IAE/B,IAAI,CAACf,mBAAmB,CAACX,2BAA2B,EAAE;QACpD,OAAO0B;IACT;IAEA,MAAMb,eAAeF,mBAAmB,CACtCX,2BACD,CAACc,OAAO,EAAEC,KACT,CAACC,SAAiCA,OAAOC,IAAI,KAAKrB,eAAesB,OAAO;IAG1E,MAAMC,iBAAiB,CAACN,cAAcO,KAA6B,KAAK,CAAC;IAEzE,MAAMR,iBACJc,oBAAoB,CAAC1B,2BAA2B,CAACc,OAAO,CAAC,EAAE,CAACM,KAAK;IAEnE,MAAMO,YAAY,IAAIC,IAAI;WACrBP,OAAOC,IAAI,CAACH;WACZE,OAAOC,IAAI,CAACV;KAChB;IAED,MAAMiB,oBAAoB;WAAIF;KAAU,CAACG,MAAM,CAC7C,CAACC,SAASC;QACRD,OAAO,CAACC,OAAO,GAAGpB,cAAc,CAACoB,OAAO,IAAIb,cAAc,CAACa,OAAO;QAClE,OAAOD;IACT,GACA,CAAC;IAGHL,oBAAoB,CAAC1B,2BAA2B,CAACc,OAAO,CAAC,EAAE,CAACM,KAAK,GAC/DS;IAEF,OAAOH;AACT;AAEA;;;;;;;;;;;;;;;;CAgBC,GACD,eAAejB,2BACbwB,GAAuC,EACvCC,GAA+C,EAC/CC,KAAc,EACdC,GAA6B,EAC7B,EAAEjC,YAAY,EAAEC,kBAAkB,EAAEC,cAAc,EAAqB;IAEvE,MAAMO,iBAAiBqB,IAAII,MAAM;IACjC,IAAI,CAACtC,SAASa,iBAAiB;QAC7B,OAAOwB,IACLzC,UAAU2C,aAAa,CAAC;YACtBC,SAAS;QACX;IAEJ;IAEA,IAAI;QACF,IAAI,CAAClB,OAAOC,IAAI,CAACV,gBAAgB4B,MAAM,EAAE;YACvC,MAAM,IAAIC,MAAM;QAClB;QAEA,MAAMf,uBAAuB;YAC3B,CAAC1B,2BAA2B,EAAE;gBAC5Bc,SAAS;oBAAC;wBAAEG,MAAMrB,eAAesB,OAAO;wBAAEE,OAAOR;oBAAe;iBAAE;YACpE;QACF;QACA,MAAMD,sBAAsB,MAAMN;QAElC,IAAI,CAACM,qBAAqB;YACxB,MAAM,GAAG+B,SAAS,GAAG,MAAMtC,mBAAmBsB;YAC9CQ,IAAIS,MAAM,GAAGD,SAASE,IAAI,CACxB5C,2BACD;QACH,OAAO,IAAIU,kBAAkBC,qBAAqBC,iBAAiB;YACjEsB,IAAIS,MAAM,GAAG,MAAM1C,mBAAmBW,gBAAgBT;QACxD,OAAO;YACL,MAAM0C,2BAA2BpB,0BAC/Bd,qBACAe;YAGF,MAAM,GAAGgB,SAAS,GAAG,MAAMtC,mBAAmByC;YAC9CX,IAAIS,MAAM,GAAGD,SAASE,IAAI,CACxB5C,2BACD;QACH;IACF,EAAE,OAAO8C,OAAO;QACdZ,IAAIY,KAAK,GAAGA;IACd;IAEA,OAAOV;AACT"}
|
|
1
|
+
{"version":3,"sources":["../../../src/permitted/requestSnaps.ts"],"sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type {\n PermissionConstraint,\n RequestedPermissions,\n Caveat,\n PermittedHandlerExport,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n RequestSnapsParams,\n RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport type { SnapsPermissionRequest } from '@metamask/snaps-utils';\nimport {\n SnapCaveatType,\n verifyRequestedSnapPermissions,\n} from '@metamask/snaps-utils';\nimport type {\n JsonRpcRequest,\n PendingJsonRpcResponse,\n Json,\n} from '@metamask/utils';\nimport { hasProperty, isObject } from '@metamask/utils';\n\nimport { WALLET_SNAP_PERMISSION_KEY } from '../restricted/invokeSnap';\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<RequestSnapsHooks> = {\n installSnaps: true,\n requestPermissions: true,\n getPermissions: true,\n};\n\n/**\n * `wallet_requestSnaps` installs the requested Snaps and requests permission to use them if necessary.\n */\nexport const requestSnapsHandler: PermittedHandlerExport<\n RequestSnapsHooks,\n RequestSnapsParams,\n RequestSnapsResult\n> = {\n methodNames: ['wallet_requestSnaps'],\n implementation: requestSnapsImplementation,\n hookNames,\n};\n\nexport type RequestSnapsHooks = {\n /**\n * Installs the requested snaps if they are permitted.\n */\n installSnaps: (\n requestedSnaps: RequestSnapsParams,\n ) => Promise<RequestSnapsResult>;\n\n /**\n * Initiates a permission request for the requesting origin.\n *\n * @returns The result of the permissions request.\n */\n requestPermissions: (\n permissions: RequestedPermissions,\n ) => Promise<\n [\n Record<string, PermissionConstraint>,\n { data: Record<string, unknown>; id: string; origin: string },\n ]\n >;\n\n /**\n * Gets the current permissions for the requesting origin.\n *\n * @returns The current permissions of the requesting origin.\n */\n getPermissions: () => Promise<\n Record<string, PermissionConstraint> | undefined\n >;\n};\n\n/**\n * Checks whether an origin has existing `wallet_snap` permission and\n * whether or not it has the requested snapIds caveat.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedSnaps - The requested snaps.\n * @returns True if the existing permissions satisfy the requested snaps, otherwise false.\n */\nexport function hasRequestedSnaps(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedSnaps: Record<string, unknown>,\n): boolean {\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ]?.caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = snapIdCaveat?.value;\n if (isObject(permittedSnaps)) {\n return Object.keys(requestedSnaps).every((requestedSnap) =>\n hasProperty(permittedSnaps, requestedSnap),\n );\n }\n return false;\n}\n\n/**\n * Constructs a valid permission request with merged caveats based on existing permissions\n * and the requested snaps.\n *\n * @param existingPermissions - The existing permissions for the origin.\n * @param requestedPermissions - The permission request passed into `requestPermissions`.\n * @returns `requestedPermissions`.\n */\nexport function getSnapPermissionsRequest(\n existingPermissions: Record<string, PermissionConstraint>,\n requestedPermissions: unknown,\n): SnapsPermissionRequest {\n verifyRequestedSnapPermissions(requestedPermissions);\n\n if (!existingPermissions[WALLET_SNAP_PERMISSION_KEY]) {\n return requestedPermissions;\n }\n\n const snapIdCaveat = existingPermissions[\n WALLET_SNAP_PERMISSION_KEY\n ].caveats?.find(\n (caveat: Caveat<string, Json>) => caveat.type === SnapCaveatType.SnapIds,\n );\n\n const permittedSnaps = (snapIdCaveat?.value as Record<string, Json>) ?? {};\n\n const requestedSnaps =\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value;\n\n const snapIdSet = new Set([\n ...Object.keys(permittedSnaps),\n ...Object.keys(requestedSnaps),\n ]);\n\n const mergedCaveatValue = [...snapIdSet].reduce<Record<string, Json>>(\n (request, snapId) => {\n request[snapId] = requestedSnaps[snapId] ?? permittedSnaps[snapId];\n return request;\n },\n {},\n );\n\n requestedPermissions[WALLET_SNAP_PERMISSION_KEY].caveats[0].value =\n mergedCaveatValue;\n\n return requestedPermissions;\n}\n\n/**\n * The `wallet_requestSnaps` method implementation.\n * Tries to install the requested snaps and adds them to the JSON-RPC response.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.installSnaps - A function that tries to install a given snap, prompting the user if necessary.\n * @param hooks.requestPermissions - A function that requests permissions on\n * behalf of a subject.\n * @param hooks.getPermissions - A function that gets the current permissions.\n * @returns A promise that resolves once the JSON-RPC response has been modified.\n * @throws If the params are invalid.\n */\nasync function requestSnapsImplementation(\n req: JsonRpcRequest<RequestSnapsParams>,\n res: PendingJsonRpcResponse<RequestSnapsResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { installSnaps, requestPermissions, getPermissions }: RequestSnapsHooks,\n): Promise<void> {\n const requestedSnaps = req.params;\n if (!isObject(requestedSnaps)) {\n return end(\n rpcErrors.invalidParams({\n message: '\"params\" must be an object.',\n }),\n );\n }\n\n try {\n if (Object.keys(requestedSnaps).length === 0) {\n return end(\n rpcErrors.invalidParams({\n message: 'Request must have at least one requested snap.',\n }),\n );\n }\n\n const requestedPermissions = {\n [WALLET_SNAP_PERMISSION_KEY]: {\n caveats: [{ type: SnapCaveatType.SnapIds, value: requestedSnaps }],\n },\n } as RequestedPermissions;\n const existingPermissions = await getPermissions();\n\n if (!existingPermissions) {\n const [, metadata] = await requestPermissions(requestedPermissions);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n } else if (hasRequestedSnaps(existingPermissions, requestedSnaps)) {\n res.result = await installSnaps(requestedSnaps);\n } else {\n const mergedPermissionsRequest = getSnapPermissionsRequest(\n existingPermissions,\n requestedPermissions,\n );\n\n const [, metadata] = await requestPermissions(mergedPermissionsRequest);\n res.result = metadata.data[\n WALLET_SNAP_PERMISSION_KEY\n ] as RequestSnapsResult;\n }\n } catch (error) {\n res.error = error;\n }\n\n return end();\n}\n"],"names":["rpcErrors","SnapCaveatType","verifyRequestedSnapPermissions","hasProperty","isObject","WALLET_SNAP_PERMISSION_KEY","hookNames","installSnaps","requestPermissions","getPermissions","requestSnapsHandler","methodNames","implementation","requestSnapsImplementation","hasRequestedSnaps","existingPermissions","requestedSnaps","snapIdCaveat","caveats","find","caveat","type","SnapIds","permittedSnaps","value","Object","keys","every","requestedSnap","getSnapPermissionsRequest","requestedPermissions","snapIdSet","Set","mergedCaveatValue","reduce","request","snapId","req","res","_next","end","params","invalidParams","message","length","metadata","result","data","mergedPermissionsRequest","error"],"mappings":"AAOA,SAASA,SAAS,QAAQ,uBAAuB;AAMjD,SACEC,cAAc,EACdC,8BAA8B,QACzB,wBAAwB;AAM/B,SAASC,WAAW,EAAEC,QAAQ,QAAQ,kBAAkB;AAExD,SAASC,0BAA0B,QAAQ,2BAA2B;AAGtE,MAAMC,YAAkD;IACtDC,cAAc;IACdC,oBAAoB;IACpBC,gBAAgB;AAClB;AAEA;;CAEC,GACD,OAAO,MAAMC,sBAIT;IACFC,aAAa;QAAC;KAAsB;IACpCC,gBAAgBC;IAChBP;AACF,EAAE;AAkCF;;;;;;;CAOC,GACD,OAAO,SAASQ,kBACdC,mBAAyD,EACzDC,cAAuC;IAEvC,MAAMC,eAAeF,mBAAmB,CACtCV,2BACD,EAAEa,SAASC,KACV,CAACC,SAAiCA,OAAOC,IAAI,KAAKpB,eAAeqB,OAAO;IAG1E,MAAMC,iBAAiBN,cAAcO;IACrC,IAAIpB,SAASmB,iBAAiB;QAC5B,OAAOE,OAAOC,IAAI,CAACV,gBAAgBW,KAAK,CAAC,CAACC,gBACxCzB,YAAYoB,gBAAgBK;IAEhC;IACA,OAAO;AACT;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,0BACdd,mBAAyD,EACzDe,oBAA6B;IAE7B5B,+BAA+B4B;IAE/B,IAAI,CAACf,mBAAmB,CAACV,2BAA2B,EAAE;QACpD,OAAOyB;IACT;IAEA,MAAMb,eAAeF,mBAAmB,CACtCV,2BACD,CAACa,OAAO,EAAEC,KACT,CAACC,SAAiCA,OAAOC,IAAI,KAAKpB,eAAeqB,OAAO;IAG1E,MAAMC,iBAAiB,CAACN,cAAcO,KAA6B,KAAK,CAAC;IAEzE,MAAMR,iBACJc,oBAAoB,CAACzB,2BAA2B,CAACa,OAAO,CAAC,EAAE,CAACM,KAAK;IAEnE,MAAMO,YAAY,IAAIC,IAAI;WACrBP,OAAOC,IAAI,CAACH;WACZE,OAAOC,IAAI,CAACV;KAChB;IAED,MAAMiB,oBAAoB;WAAIF;KAAU,CAACG,MAAM,CAC7C,CAACC,SAASC;QACRD,OAAO,CAACC,OAAO,GAAGpB,cAAc,CAACoB,OAAO,IAAIb,cAAc,CAACa,OAAO;QAClE,OAAOD;IACT,GACA,CAAC;IAGHL,oBAAoB,CAACzB,2BAA2B,CAACa,OAAO,CAAC,EAAE,CAACM,KAAK,GAC/DS;IAEF,OAAOH;AACT;AAEA;;;;;;;;;;;;;;;;CAgBC,GACD,eAAejB,2BACbwB,GAAuC,EACvCC,GAA+C,EAC/CC,KAAc,EACdC,GAA6B,EAC7B,EAAEjC,YAAY,EAAEC,kBAAkB,EAAEC,cAAc,EAAqB;IAEvE,MAAMO,iBAAiBqB,IAAII,MAAM;IACjC,IAAI,CAACrC,SAASY,iBAAiB;QAC7B,OAAOwB,IACLxC,UAAU0C,aAAa,CAAC;YACtBC,SAAS;QACX;IAEJ;IAEA,IAAI;QACF,IAAIlB,OAAOC,IAAI,CAACV,gBAAgB4B,MAAM,KAAK,GAAG;YAC5C,OAAOJ,IACLxC,UAAU0C,aAAa,CAAC;gBACtBC,SAAS;YACX;QAEJ;QAEA,MAAMb,uBAAuB;YAC3B,CAACzB,2BAA2B,EAAE;gBAC5Ba,SAAS;oBAAC;wBAAEG,MAAMpB,eAAeqB,OAAO;wBAAEE,OAAOR;oBAAe;iBAAE;YACpE;QACF;QACA,MAAMD,sBAAsB,MAAMN;QAElC,IAAI,CAACM,qBAAqB;YACxB,MAAM,GAAG8B,SAAS,GAAG,MAAMrC,mBAAmBsB;YAC9CQ,IAAIQ,MAAM,GAAGD,SAASE,IAAI,CACxB1C,2BACD;QACH,OAAO,IAAIS,kBAAkBC,qBAAqBC,iBAAiB;YACjEsB,IAAIQ,MAAM,GAAG,MAAMvC,aAAaS;QAClC,OAAO;YACL,MAAMgC,2BAA2BnB,0BAC/Bd,qBACAe;YAGF,MAAM,GAAGe,SAAS,GAAG,MAAMrC,mBAAmBwC;YAC9CV,IAAIQ,MAAM,GAAGD,SAASE,IAAI,CACxB1C,2BACD;QACH;IACF,EAAE,OAAO4C,OAAO;QACdX,IAAIW,KAAK,GAAGA;IACd;IAEA,OAAOT;AACT"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { PermittedHandlerExport } from '@metamask/permission-controller';
|
|
2
|
+
import type { GetSnapsResult } from '@metamask/snaps-sdk';
|
|
3
|
+
import type { JsonRpcParams } from '@metamask/utils';
|
|
4
|
+
/**
|
|
5
|
+
* `wallet_getAllSnaps` gets all installed Snaps. Currently, this can only be
|
|
6
|
+
* called from `https://snaps.metamask.io`.
|
|
7
|
+
*/
|
|
8
|
+
export declare const getAllSnapsHandler: PermittedHandlerExport<GetAllSnapsHooks, JsonRpcParams, GetSnapsResult>;
|
|
9
|
+
export declare type GetAllSnapsHooks = {
|
|
10
|
+
/**
|
|
11
|
+
* @returns All installed Snaps.
|
|
12
|
+
*/
|
|
13
|
+
getAllSnaps: () => Promise<GetSnapsResult>;
|
|
14
|
+
};
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
export declare const methodHandlers: {
|
|
2
|
+
wallet_getAllSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./getAllSnaps").GetAllSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult>;
|
|
2
3
|
wallet_getSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult>;
|
|
3
4
|
wallet_requestSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult>;
|
|
4
5
|
wallet_invokeSnap: import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
|
|
5
6
|
wallet_invokeKeyring: import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
|
|
6
7
|
snap_getFile: import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string>;
|
|
7
8
|
};
|
|
8
|
-
export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>)[];
|
|
9
|
+
export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./getAllSnaps").GetAllSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>)[];
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import type { GetAllSnapsHooks } from './getAllSnaps';
|
|
1
2
|
import type { GetSnapsHooks } from './getSnaps';
|
|
2
3
|
import type { RequestSnapsHooks } from './requestSnaps';
|
|
3
|
-
export declare type PermittedRpcMethodHooks = GetSnapsHooks & RequestSnapsHooks;
|
|
4
|
+
export declare type PermittedRpcMethodHooks = GetAllSnapsHooks & GetSnapsHooks & RequestSnapsHooks;
|
|
4
5
|
export * from './handlers';
|
|
5
6
|
export * from './middleware';
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import type { PermissionConstraint, RequestedPermissions, PermittedHandlerExport } from '@metamask/permission-controller';
|
|
2
2
|
import type { RequestSnapsParams, RequestSnapsResult } from '@metamask/snaps-sdk';
|
|
3
3
|
import type { SnapsPermissionRequest } from '@metamask/snaps-utils';
|
|
4
|
-
import type { InstallSnapsHook } from './common/snapInstallation';
|
|
5
4
|
/**
|
|
6
5
|
* `wallet_requestSnaps` installs the requested Snaps and requests permission to use them if necessary.
|
|
7
6
|
*/
|
|
@@ -10,7 +9,7 @@ export declare type RequestSnapsHooks = {
|
|
|
10
9
|
/**
|
|
11
10
|
* Installs the requested snaps if they are permitted.
|
|
12
11
|
*/
|
|
13
|
-
installSnaps:
|
|
12
|
+
installSnaps: (requestedSnaps: RequestSnapsParams) => Promise<RequestSnapsResult>;
|
|
14
13
|
/**
|
|
15
14
|
* Initiates a permission request for the requesting origin.
|
|
16
15
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask/snaps-rpc-methods",
|
|
3
|
-
"version": "4.0
|
|
3
|
+
"version": "4.1.0",
|
|
4
4
|
"description": "MetaMask Snaps JSON-RPC method implementations.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -37,10 +37,10 @@
|
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
39
|
"@metamask/key-tree": "^9.0.0",
|
|
40
|
-
"@metamask/permission-controller": "^
|
|
40
|
+
"@metamask/permission-controller": "^7.0.0",
|
|
41
41
|
"@metamask/rpc-errors": "^6.1.0",
|
|
42
|
-
"@metamask/snaps-sdk": "^1.3.
|
|
43
|
-
"@metamask/snaps-utils": "^5.
|
|
42
|
+
"@metamask/snaps-sdk": "^1.3.1",
|
|
43
|
+
"@metamask/snaps-utils": "^5.1.1",
|
|
44
44
|
"@metamask/utils": "^8.2.1",
|
|
45
45
|
"@noble/hashes": "^1.3.1",
|
|
46
46
|
"superstruct": "^1.0.3"
|
|
@@ -48,12 +48,12 @@
|
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@lavamoat/allow-scripts": "^2.5.1",
|
|
50
50
|
"@metamask/auto-changelog": "^3.4.3",
|
|
51
|
-
"@metamask/browser-passworder": "^4.
|
|
51
|
+
"@metamask/browser-passworder": "^4.3.0",
|
|
52
52
|
"@metamask/eslint-config": "^12.1.0",
|
|
53
53
|
"@metamask/eslint-config-jest": "^12.1.0",
|
|
54
54
|
"@metamask/eslint-config-nodejs": "^12.1.0",
|
|
55
55
|
"@metamask/eslint-config-typescript": "^12.1.0",
|
|
56
|
-
"@metamask/json-rpc-engine": "^7.3.
|
|
56
|
+
"@metamask/json-rpc-engine": "^7.3.1",
|
|
57
57
|
"@swc/cli": "^0.1.62",
|
|
58
58
|
"@swc/core": "1.3.78",
|
|
59
59
|
"@swc/jest": "^0.2.26",
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", {
|
|
3
|
-
value: true
|
|
4
|
-
});
|
|
5
|
-
Object.defineProperty(exports, "handleInstallSnaps", {
|
|
6
|
-
enumerable: true,
|
|
7
|
-
get: function() {
|
|
8
|
-
return handleInstallSnaps;
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
const _rpcerrors = require("@metamask/rpc-errors");
|
|
12
|
-
const _utils = require("@metamask/utils");
|
|
13
|
-
async function handleInstallSnaps(requestedSnaps, installSnaps) {
|
|
14
|
-
if (!(0, _utils.isObject)(requestedSnaps)) {
|
|
15
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
16
|
-
message: `Invalid snap installation params.`,
|
|
17
|
-
data: {
|
|
18
|
-
requestedSnaps
|
|
19
|
-
}
|
|
20
|
-
});
|
|
21
|
-
} else if (Object.keys(requestedSnaps).length === 0) {
|
|
22
|
-
throw _rpcerrors.rpcErrors.invalidParams({
|
|
23
|
-
message: `Must specify at least one snap to install.`,
|
|
24
|
-
data: {
|
|
25
|
-
requestedSnaps
|
|
26
|
-
}
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
|
-
// installSnaps is bound to the origin
|
|
30
|
-
return await installSnaps(requestedSnaps);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
//# sourceMappingURL=snapInstallation.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/permitted/common/snapInstallation.ts"],"sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n RequestSnapsParams,\n RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport { isObject } from '@metamask/utils';\n\nexport type InstallSnapsHook = (\n requestedSnaps: RequestSnapsParams,\n) => Promise<RequestSnapsResult>;\n\n/**\n * Typechecks the requested snaps and passes them to the permissions\n * controller for installation.\n *\n * @param requestedSnaps - An object containing the requested snaps to be installed. The key of the\n * object is the snap id and the value is potential extra data, i.e. version.\n * @param installSnaps - A function that tries to install a given snap, prompting the user if\n * necessary.\n * @returns An object containing the installed snaps.\n * @throws If the params are invalid or the snap installation fails.\n */\nexport async function handleInstallSnaps(\n requestedSnaps: RequestSnapsParams,\n installSnaps: InstallSnapsHook,\n): Promise<RequestSnapsResult> {\n if (!isObject(requestedSnaps)) {\n throw rpcErrors.invalidParams({\n message: `Invalid snap installation params.`,\n data: { requestedSnaps },\n });\n } else if (Object.keys(requestedSnaps).length === 0) {\n throw rpcErrors.invalidParams({\n message: `Must specify at least one snap to install.`,\n data: { requestedSnaps },\n });\n }\n\n // installSnaps is bound to the origin\n return await installSnaps(requestedSnaps);\n}\n"],"names":["handleInstallSnaps","requestedSnaps","installSnaps","isObject","rpcErrors","invalidParams","message","data","Object","keys","length"],"mappings":";;;;+BAsBsBA;;;eAAAA;;;2BAtBI;uBAKD;AAiBlB,eAAeA,mBACpBC,cAAkC,EAClCC,YAA8B;IAE9B,IAAI,CAACC,IAAAA,eAAQ,EAACF,iBAAiB;QAC7B,MAAMG,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS,CAAC,iCAAiC,CAAC;YAC5CC,MAAM;gBAAEN;YAAe;QACzB;IACF,OAAO,IAAIO,OAAOC,IAAI,CAACR,gBAAgBS,MAAM,KAAK,GAAG;QACnD,MAAMN,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS,CAAC,0CAA0C,CAAC;YACrDC,MAAM;gBAAEN;YAAe;QACzB;IACF;IAEA,sCAAsC;IACtC,OAAO,MAAMC,aAAaD;AAC5B"}
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
import { rpcErrors } from '@metamask/rpc-errors';
|
|
2
|
-
import { isObject } from '@metamask/utils';
|
|
3
|
-
/**
|
|
4
|
-
* Typechecks the requested snaps and passes them to the permissions
|
|
5
|
-
* controller for installation.
|
|
6
|
-
*
|
|
7
|
-
* @param requestedSnaps - An object containing the requested snaps to be installed. The key of the
|
|
8
|
-
* object is the snap id and the value is potential extra data, i.e. version.
|
|
9
|
-
* @param installSnaps - A function that tries to install a given snap, prompting the user if
|
|
10
|
-
* necessary.
|
|
11
|
-
* @returns An object containing the installed snaps.
|
|
12
|
-
* @throws If the params are invalid or the snap installation fails.
|
|
13
|
-
*/ export async function handleInstallSnaps(requestedSnaps, installSnaps) {
|
|
14
|
-
if (!isObject(requestedSnaps)) {
|
|
15
|
-
throw rpcErrors.invalidParams({
|
|
16
|
-
message: `Invalid snap installation params.`,
|
|
17
|
-
data: {
|
|
18
|
-
requestedSnaps
|
|
19
|
-
}
|
|
20
|
-
});
|
|
21
|
-
} else if (Object.keys(requestedSnaps).length === 0) {
|
|
22
|
-
throw rpcErrors.invalidParams({
|
|
23
|
-
message: `Must specify at least one snap to install.`,
|
|
24
|
-
data: {
|
|
25
|
-
requestedSnaps
|
|
26
|
-
}
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
|
-
// installSnaps is bound to the origin
|
|
30
|
-
return await installSnaps(requestedSnaps);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
//# sourceMappingURL=snapInstallation.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../src/permitted/common/snapInstallation.ts"],"sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n RequestSnapsParams,\n RequestSnapsResult,\n} from '@metamask/snaps-sdk';\nimport { isObject } from '@metamask/utils';\n\nexport type InstallSnapsHook = (\n requestedSnaps: RequestSnapsParams,\n) => Promise<RequestSnapsResult>;\n\n/**\n * Typechecks the requested snaps and passes them to the permissions\n * controller for installation.\n *\n * @param requestedSnaps - An object containing the requested snaps to be installed. The key of the\n * object is the snap id and the value is potential extra data, i.e. version.\n * @param installSnaps - A function that tries to install a given snap, prompting the user if\n * necessary.\n * @returns An object containing the installed snaps.\n * @throws If the params are invalid or the snap installation fails.\n */\nexport async function handleInstallSnaps(\n requestedSnaps: RequestSnapsParams,\n installSnaps: InstallSnapsHook,\n): Promise<RequestSnapsResult> {\n if (!isObject(requestedSnaps)) {\n throw rpcErrors.invalidParams({\n message: `Invalid snap installation params.`,\n data: { requestedSnaps },\n });\n } else if (Object.keys(requestedSnaps).length === 0) {\n throw rpcErrors.invalidParams({\n message: `Must specify at least one snap to install.`,\n data: { requestedSnaps },\n });\n }\n\n // installSnaps is bound to the origin\n return await installSnaps(requestedSnaps);\n}\n"],"names":["rpcErrors","isObject","handleInstallSnaps","requestedSnaps","installSnaps","invalidParams","message","data","Object","keys","length"],"mappings":"AAAA,SAASA,SAAS,QAAQ,uBAAuB;AAKjD,SAASC,QAAQ,QAAQ,kBAAkB;AAM3C;;;;;;;;;;CAUC,GACD,OAAO,eAAeC,mBACpBC,cAAkC,EAClCC,YAA8B;IAE9B,IAAI,CAACH,SAASE,iBAAiB;QAC7B,MAAMH,UAAUK,aAAa,CAAC;YAC5BC,SAAS,CAAC,iCAAiC,CAAC;YAC5CC,MAAM;gBAAEJ;YAAe;QACzB;IACF,OAAO,IAAIK,OAAOC,IAAI,CAACN,gBAAgBO,MAAM,KAAK,GAAG;QACnD,MAAMV,UAAUK,aAAa,CAAC;YAC5BC,SAAS,CAAC,0CAA0C,CAAC;YACrDC,MAAM;gBAAEJ;YAAe;QACzB;IACF;IAEA,sCAAsC;IACtC,OAAO,MAAMC,aAAaD;AAC5B"}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import type { RequestSnapsParams, RequestSnapsResult } from '@metamask/snaps-sdk';
|
|
2
|
-
export declare type InstallSnapsHook = (requestedSnaps: RequestSnapsParams) => Promise<RequestSnapsResult>;
|
|
3
|
-
/**
|
|
4
|
-
* Typechecks the requested snaps and passes them to the permissions
|
|
5
|
-
* controller for installation.
|
|
6
|
-
*
|
|
7
|
-
* @param requestedSnaps - An object containing the requested snaps to be installed. The key of the
|
|
8
|
-
* object is the snap id and the value is potential extra data, i.e. version.
|
|
9
|
-
* @param installSnaps - A function that tries to install a given snap, prompting the user if
|
|
10
|
-
* necessary.
|
|
11
|
-
* @returns An object containing the installed snaps.
|
|
12
|
-
* @throws If the params are invalid or the snap installation fails.
|
|
13
|
-
*/
|
|
14
|
-
export declare function handleInstallSnaps(requestedSnaps: RequestSnapsParams, installSnaps: InstallSnapsHook): Promise<RequestSnapsResult>;
|