@metamask/permission-controller 11.0.1 → 11.0.2
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 +20 -1
- package/dist/Caveat.cjs +48 -0
- package/dist/Caveat.cjs.map +1 -0
- package/dist/{types/Caveat.d.ts → Caveat.d.cts} +3 -3
- package/dist/Caveat.d.cts.map +1 -0
- package/dist/Caveat.d.mts +210 -0
- package/dist/Caveat.d.mts.map +1 -0
- package/dist/Caveat.mjs +42 -11
- package/dist/Caveat.mjs.map +1 -1
- package/dist/Permission.cjs +65 -0
- package/dist/Permission.cjs.map +1 -0
- package/dist/{types/Permission.d.ts → Permission.d.cts} +7 -7
- package/dist/Permission.d.cts.map +1 -0
- package/dist/Permission.d.mts +417 -0
- package/dist/Permission.d.mts.map +1 -0
- package/dist/Permission.mjs +58 -13
- package/dist/Permission.mjs.map +1 -1
- package/dist/PermissionController.cjs +1481 -0
- package/dist/{chunk-COGJLF22.mjs.map → PermissionController.cjs.map} +1 -1
- package/dist/{types/PermissionController.d.ts → PermissionController.d.cts} +10 -10
- package/dist/PermissionController.d.cts.map +1 -0
- package/dist/PermissionController.d.mts +986 -0
- package/dist/PermissionController.d.mts.map +1 -0
- package/dist/PermissionController.mjs +1479 -13
- package/dist/PermissionController.mjs.map +1 -1
- package/dist/SubjectMetadataController.cjs +152 -0
- package/dist/SubjectMetadataController.cjs.map +1 -0
- package/dist/{types/SubjectMetadataController.d.ts → SubjectMetadataController.d.cts} +5 -5
- package/dist/SubjectMetadataController.d.cts.map +1 -0
- package/dist/SubjectMetadataController.d.mts +107 -0
- package/dist/SubjectMetadataController.d.mts.map +1 -0
- package/dist/SubjectMetadataController.mjs +146 -8
- package/dist/SubjectMetadataController.mjs.map +1 -1
- package/dist/errors.cjs +217 -0
- package/dist/errors.cjs.map +1 -0
- package/dist/{types/errors.d.ts → errors.d.cts} +6 -6
- package/dist/errors.d.cts.map +1 -0
- package/dist/errors.d.mts +185 -0
- package/dist/errors.d.mts.map +1 -0
- package/dist/errors.mjs +187 -57
- package/dist/errors.mjs.map +1 -1
- package/dist/index.cjs +38 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +9 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +9 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +7 -97
- package/dist/index.mjs.map +1 -1
- package/dist/permission-middleware.cjs +55 -0
- package/dist/permission-middleware.cjs.map +1 -0
- package/dist/{types/permission-middleware.d.ts → permission-middleware.d.cts} +4 -4
- package/dist/permission-middleware.d.cts.map +1 -0
- package/dist/permission-middleware.d.mts +33 -0
- package/dist/permission-middleware.d.mts.map +1 -0
- package/dist/permission-middleware.mjs +50 -8
- package/dist/permission-middleware.mjs.map +1 -1
- package/dist/rpc-methods/getPermissions.cjs +27 -0
- package/dist/rpc-methods/getPermissions.cjs.map +1 -0
- package/dist/rpc-methods/getPermissions.d.cts +9 -0
- package/dist/rpc-methods/getPermissions.d.cts.map +1 -0
- package/dist/rpc-methods/getPermissions.d.mts +9 -0
- package/dist/rpc-methods/getPermissions.d.mts.map +1 -0
- package/dist/rpc-methods/getPermissions.mjs +22 -7
- package/dist/rpc-methods/getPermissions.mjs.map +1 -1
- package/dist/rpc-methods/index.cjs +12 -0
- package/dist/rpc-methods/index.cjs.map +1 -0
- package/dist/rpc-methods/index.d.cts +6 -0
- package/dist/rpc-methods/index.d.cts.map +1 -0
- package/dist/rpc-methods/index.d.mts +6 -0
- package/dist/rpc-methods/index.d.mts.map +1 -0
- package/dist/rpc-methods/index.mjs +8 -12
- package/dist/rpc-methods/index.mjs.map +1 -1
- package/dist/rpc-methods/requestPermissions.cjs +36 -0
- package/dist/rpc-methods/requestPermissions.cjs.map +1 -0
- package/dist/{types/rpc-methods/requestPermissions.d.ts → rpc-methods/requestPermissions.d.cts} +3 -3
- package/dist/rpc-methods/requestPermissions.d.cts.map +1 -0
- package/dist/rpc-methods/requestPermissions.d.mts +17 -0
- package/dist/rpc-methods/requestPermissions.d.mts.map +1 -0
- package/dist/rpc-methods/requestPermissions.mjs +31 -8
- package/dist/rpc-methods/requestPermissions.mjs.map +1 -1
- package/dist/rpc-methods/revokePermissions.cjs +41 -0
- package/dist/rpc-methods/revokePermissions.cjs.map +1 -0
- package/dist/{types/rpc-methods/revokePermissions.d.ts → rpc-methods/revokePermissions.d.cts} +4 -4
- package/dist/rpc-methods/revokePermissions.d.cts.map +1 -0
- package/dist/rpc-methods/revokePermissions.d.mts +11 -0
- package/dist/rpc-methods/revokePermissions.d.mts.map +1 -0
- package/dist/rpc-methods/revokePermissions.mjs +36 -8
- package/dist/rpc-methods/revokePermissions.mjs.map +1 -1
- package/dist/utils.cjs +44 -0
- package/dist/utils.cjs.map +1 -0
- package/dist/{types/utils.d.ts → utils.d.cts} +5 -5
- package/dist/utils.d.cts.map +1 -0
- package/dist/utils.d.mts +57 -0
- package/dist/utils.d.mts.map +1 -0
- package/dist/utils.mjs +39 -9
- package/dist/utils.mjs.map +1 -1
- package/package.json +16 -11
- package/dist/Caveat.js +0 -12
- package/dist/Caveat.js.map +0 -1
- package/dist/Permission.js +0 -14
- package/dist/Permission.js.map +0 -1
- package/dist/PermissionController.js +0 -15
- package/dist/PermissionController.js.map +0 -1
- package/dist/SubjectMetadataController.js +0 -10
- package/dist/SubjectMetadataController.js.map +0 -1
- package/dist/chunk-2L4QPE5A.mjs +0 -25
- package/dist/chunk-2L4QPE5A.mjs.map +0 -1
- package/dist/chunk-3WWJKO7P.mjs +0 -37
- package/dist/chunk-3WWJKO7P.mjs.map +0 -1
- package/dist/chunk-3YOPLPVY.js +0 -37
- package/dist/chunk-3YOPLPVY.js.map +0 -1
- package/dist/chunk-42QSJHWO.mjs +0 -155
- package/dist/chunk-42QSJHWO.mjs.map +0 -1
- package/dist/chunk-4FMYQC3Y.mjs +0 -29
- package/dist/chunk-4FMYQC3Y.mjs.map +0 -1
- package/dist/chunk-4NAVRO44.mjs +0 -35
- package/dist/chunk-4NAVRO44.mjs.map +0 -1
- package/dist/chunk-5RFW5THA.mjs +0 -17
- package/dist/chunk-5RFW5THA.mjs.map +0 -1
- package/dist/chunk-6PXDVUYM.js +0 -29
- package/dist/chunk-6PXDVUYM.js.map +0 -1
- package/dist/chunk-74H4CVH7.mjs +0 -34
- package/dist/chunk-74H4CVH7.mjs.map +0 -1
- package/dist/chunk-7A3VYLCK.js +0 -30
- package/dist/chunk-7A3VYLCK.js.map +0 -1
- package/dist/chunk-B6PDRQ7N.js +0 -1679
- package/dist/chunk-B6PDRQ7N.js.map +0 -1
- package/dist/chunk-COGJLF22.mjs +0 -1679
- package/dist/chunk-F5TBMVWC.js +0 -46
- package/dist/chunk-F5TBMVWC.js.map +0 -1
- package/dist/chunk-FYADAA2G.js +0 -220
- package/dist/chunk-FYADAA2G.js.map +0 -1
- package/dist/chunk-G4BWJ7EA.mjs +0 -220
- package/dist/chunk-G4BWJ7EA.mjs.map +0 -1
- package/dist/chunk-HYMS7IGB.mjs +0 -31
- package/dist/chunk-HYMS7IGB.mjs.map +0 -1
- package/dist/chunk-I62TTXZ6.mjs +0 -46
- package/dist/chunk-I62TTXZ6.mjs.map +0 -1
- package/dist/chunk-OCLNDUYO.mjs +0 -30
- package/dist/chunk-OCLNDUYO.mjs.map +0 -1
- package/dist/chunk-VBIZGGQL.js +0 -17
- package/dist/chunk-VBIZGGQL.js.map +0 -1
- package/dist/chunk-VQPP5PWS.js +0 -35
- package/dist/chunk-VQPP5PWS.js.map +0 -1
- package/dist/chunk-VSDHL2GQ.js +0 -155
- package/dist/chunk-VSDHL2GQ.js.map +0 -1
- package/dist/chunk-X4ZAW4QR.js +0 -34
- package/dist/chunk-X4ZAW4QR.js.map +0 -1
- package/dist/chunk-Z2XKIXLS.js +0 -25
- package/dist/chunk-Z2XKIXLS.js.map +0 -1
- package/dist/chunk-ZH4MLSXX.js +0 -31
- package/dist/chunk-ZH4MLSXX.js.map +0 -1
- package/dist/errors.js +0 -58
- package/dist/errors.js.map +0 -1
- package/dist/index.js +0 -98
- package/dist/index.js.map +0 -1
- package/dist/permission-middleware.js +0 -9
- package/dist/permission-middleware.js.map +0 -1
- package/dist/rpc-methods/getPermissions.js +0 -9
- package/dist/rpc-methods/getPermissions.js.map +0 -1
- package/dist/rpc-methods/index.js +0 -13
- package/dist/rpc-methods/index.js.map +0 -1
- package/dist/rpc-methods/requestPermissions.js +0 -10
- package/dist/rpc-methods/requestPermissions.js.map +0 -1
- package/dist/rpc-methods/revokePermissions.js +0 -10
- package/dist/rpc-methods/revokePermissions.js.map +0 -1
- package/dist/tsconfig.build.tsbuildinfo +0 -1
- package/dist/types/Caveat.d.ts.map +0 -1
- package/dist/types/Permission.d.ts.map +0 -1
- package/dist/types/PermissionController.d.ts.map +0 -1
- package/dist/types/SubjectMetadataController.d.ts.map +0 -1
- package/dist/types/errors.d.ts.map +0 -1
- package/dist/types/index.d.ts +0 -9
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/permission-middleware.d.ts.map +0 -1
- package/dist/types/rpc-methods/getPermissions.d.ts +0 -9
- package/dist/types/rpc-methods/getPermissions.d.ts.map +0 -1
- package/dist/types/rpc-methods/index.d.ts +0 -6
- package/dist/types/rpc-methods/index.d.ts.map +0 -1
- package/dist/types/rpc-methods/requestPermissions.d.ts.map +0 -1
- package/dist/types/rpc-methods/revokePermissions.d.ts.map +0 -1
- package/dist/types/utils.d.ts.map +0 -1
- package/dist/utils.js +0 -10
- package/dist/utils.js.map +0 -1
|
@@ -1,9 +1,51 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
import { createAsyncMiddleware } from "@metamask/json-rpc-engine";
|
|
2
|
+
import { internalError } from "./errors.mjs";
|
|
3
|
+
/**
|
|
4
|
+
* Creates a permission middleware function factory. Intended for internal use
|
|
5
|
+
* in the {@link PermissionController}. Like any {@link JsonRpcEngine}
|
|
6
|
+
* middleware, each middleware will only receive requests from a particular
|
|
7
|
+
* subject / origin. However, each middleware also requires access to some
|
|
8
|
+
* `PermissionController` internals, which is why this "factory factory" exists.
|
|
9
|
+
*
|
|
10
|
+
* The middlewares returned by the factory will pass through requests for
|
|
11
|
+
* unrestricted methods, and attempt to execute restricted methods. If a method
|
|
12
|
+
* is neither restricted nor unrestricted, a "method not found" error will be
|
|
13
|
+
* returned.
|
|
14
|
+
* If a method is restricted, the middleware will first attempt to retrieve the
|
|
15
|
+
* subject's permission for that method. If the permission is found, the method
|
|
16
|
+
* will be executed. Otherwise, an "unauthorized" error will be returned.
|
|
17
|
+
*
|
|
18
|
+
* @param options - Options bag.
|
|
19
|
+
* @param options.executeRestrictedMethod - {@link PermissionController._executeRestrictedMethod}.
|
|
20
|
+
* @param options.getRestrictedMethod - {@link PermissionController.getRestrictedMethod}.
|
|
21
|
+
* @param options.isUnrestrictedMethod - A function that checks whether a
|
|
22
|
+
* particular method is unrestricted.
|
|
23
|
+
* @returns A permission middleware factory function.
|
|
24
|
+
*/
|
|
25
|
+
export function getPermissionMiddlewareFactory({ executeRestrictedMethod, getRestrictedMethod, isUnrestrictedMethod, }) {
|
|
26
|
+
return function createPermissionMiddleware(subject) {
|
|
27
|
+
const { origin } = subject;
|
|
28
|
+
if (typeof origin !== 'string' || !origin) {
|
|
29
|
+
throw new Error('The subject "origin" must be a non-empty string.');
|
|
30
|
+
}
|
|
31
|
+
const permissionsMiddleware = async (req, res, next) => {
|
|
32
|
+
const { method, params } = req;
|
|
33
|
+
// Skip registered unrestricted methods.
|
|
34
|
+
if (isUnrestrictedMethod(method)) {
|
|
35
|
+
return next();
|
|
36
|
+
}
|
|
37
|
+
// This will throw if no restricted method implementation is found.
|
|
38
|
+
const methodImplementation = getRestrictedMethod(method, origin);
|
|
39
|
+
// This will throw if the permission does not exist.
|
|
40
|
+
const result = await executeRestrictedMethod(methodImplementation, subject, method, params);
|
|
41
|
+
if (result === undefined) {
|
|
42
|
+
res.error = internalError(`Request for method "${req.method}" returned undefined result.`, { request: req });
|
|
43
|
+
return undefined;
|
|
44
|
+
}
|
|
45
|
+
res.result = result;
|
|
46
|
+
return undefined;
|
|
47
|
+
};
|
|
48
|
+
return createAsyncMiddleware(permissionsMiddleware);
|
|
49
|
+
};
|
|
50
|
+
}
|
|
9
51
|
//# sourceMappingURL=permission-middleware.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[],"
|
|
1
|
+
{"version":3,"file":"permission-middleware.mjs","sourceRoot":"","sources":["../src/permission-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,kCAAkC;AAkBlE,OAAO,EAAE,aAAa,EAAE,qBAAiB;AAUzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,8BAA8B,CAAC,EAC7C,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,GACe;IACnC,OAAO,SAAS,0BAA0B,CACxC,OAAkC;QAElC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC3B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACrE;QAED,MAAM,qBAAqB,GAAG,KAAK,EACjC,GAA+C,EAC/C,GAAiC,EACjC,IAAoC,EACrB,EAAE;YACjB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;YAE/B,wCAAwC;YACxC,IAAI,oBAAoB,CAAC,MAAM,CAAC,EAAE;gBAChC,OAAO,IAAI,EAAE,CAAC;aACf;YAED,mEAAmE;YACnE,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAEjE,oDAAoD;YACpD,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAC1C,oBAAoB,EACpB,OAAO,EACP,MAAM,EACN,MAAM,CACP,CAAC;YAEF,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,GAAG,CAAC,KAAK,GAAG,aAAa,CACvB,uBAAuB,GAAG,CAAC,MAAM,8BAA8B,EAC/D,EAAE,OAAO,EAAE,GAAG,EAAE,CACjB,CAAC;gBACF,OAAO,SAAS,CAAC;aAClB;YAED,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QAEF,OAAO,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;IACtD,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import { createAsyncMiddleware } from '@metamask/json-rpc-engine';\nimport type {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n JsonRpcEngine,\n JsonRpcMiddleware,\n AsyncJsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport type {\n Json,\n PendingJsonRpcResponse,\n JsonRpcRequest,\n} from '@metamask/utils';\n\nimport type {\n GenericPermissionController,\n PermissionSubjectMetadata,\n RestrictedMethodParameters,\n} from '.';\nimport { internalError } from './errors';\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nimport type { PermissionController } from './PermissionController';\n\ntype PermissionMiddlewareFactoryOptions = {\n executeRestrictedMethod: GenericPermissionController['_executeRestrictedMethod'];\n getRestrictedMethod: GenericPermissionController['getRestrictedMethod'];\n isUnrestrictedMethod: (method: string) => boolean;\n};\n\n/**\n * Creates a permission middleware function factory. Intended for internal use\n * in the {@link PermissionController}. Like any {@link JsonRpcEngine}\n * middleware, each middleware will only receive requests from a particular\n * subject / origin. However, each middleware also requires access to some\n * `PermissionController` internals, which is why this \"factory factory\" exists.\n *\n * The middlewares returned by the factory will pass through requests for\n * unrestricted methods, and attempt to execute restricted methods. If a method\n * is neither restricted nor unrestricted, a \"method not found\" error will be\n * returned.\n * If a method is restricted, the middleware will first attempt to retrieve the\n * subject's permission for that method. If the permission is found, the method\n * will be executed. Otherwise, an \"unauthorized\" error will be returned.\n *\n * @param options - Options bag.\n * @param options.executeRestrictedMethod - {@link PermissionController._executeRestrictedMethod}.\n * @param options.getRestrictedMethod - {@link PermissionController.getRestrictedMethod}.\n * @param options.isUnrestrictedMethod - A function that checks whether a\n * particular method is unrestricted.\n * @returns A permission middleware factory function.\n */\nexport function getPermissionMiddlewareFactory({\n executeRestrictedMethod,\n getRestrictedMethod,\n isUnrestrictedMethod,\n}: PermissionMiddlewareFactoryOptions) {\n return function createPermissionMiddleware(\n subject: PermissionSubjectMetadata,\n ): JsonRpcMiddleware<RestrictedMethodParameters, Json> {\n const { origin } = subject;\n if (typeof origin !== 'string' || !origin) {\n throw new Error('The subject \"origin\" must be a non-empty string.');\n }\n\n const permissionsMiddleware = async (\n req: JsonRpcRequest<RestrictedMethodParameters>,\n res: PendingJsonRpcResponse<Json>,\n next: AsyncJsonRpcEngineNextCallback,\n ): Promise<void> => {\n const { method, params } = req;\n\n // Skip registered unrestricted methods.\n if (isUnrestrictedMethod(method)) {\n return next();\n }\n\n // This will throw if no restricted method implementation is found.\n const methodImplementation = getRestrictedMethod(method, origin);\n\n // This will throw if the permission does not exist.\n const result = await executeRestrictedMethod(\n methodImplementation,\n subject,\n method,\n params,\n );\n\n if (result === undefined) {\n res.error = internalError(\n `Request for method \"${req.method}\" returned undefined result.`,\n { request: req },\n );\n return undefined;\n }\n\n res.result = result;\n return undefined;\n };\n\n return createAsyncMiddleware(permissionsMiddleware);\n };\n}\n"]}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getPermissionsHandler = void 0;
|
|
4
|
+
const utils_1 = require("../utils.cjs");
|
|
5
|
+
exports.getPermissionsHandler = {
|
|
6
|
+
methodNames: [utils_1.MethodNames.GetPermissions],
|
|
7
|
+
implementation: getPermissionsImplementation,
|
|
8
|
+
hookNames: {
|
|
9
|
+
getPermissionsForOrigin: true,
|
|
10
|
+
},
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Get Permissions implementation to be used in JsonRpcEngine middleware.
|
|
14
|
+
*
|
|
15
|
+
* @param _req - The JsonRpcEngine request - unused
|
|
16
|
+
* @param res - The JsonRpcEngine result object
|
|
17
|
+
* @param _next - JsonRpcEngine next() callback - unused
|
|
18
|
+
* @param end - JsonRpcEngine end() callback
|
|
19
|
+
* @param options - Method hooks passed to the method implementation
|
|
20
|
+
* @param options.getPermissionsForOrigin - The specific method hook needed for this method implementation
|
|
21
|
+
* @returns A promise that resolves to nothing
|
|
22
|
+
*/
|
|
23
|
+
async function getPermissionsImplementation(_req, res, _next, end, { getPermissionsForOrigin }) {
|
|
24
|
+
res.result = Object.values(getPermissionsForOrigin() || {});
|
|
25
|
+
return end();
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=getPermissions.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getPermissions.cjs","sourceRoot":"","sources":["../../src/rpc-methods/getPermissions.ts"],"names":[],"mappings":";;;AAMA,wCAAuC;AAE1B,QAAA,qBAAqB,GAI9B;IACF,WAAW,EAAE,CAAC,mBAAW,CAAC,cAAc,CAAC;IACzC,cAAc,EAAE,4BAA4B;IAC5C,SAAS,EAAE;QACT,uBAAuB,EAAE,IAAI;KAC9B;CACF,CAAC;AAOF;;;;;;;;;;GAUG;AACH,KAAK,UAAU,4BAA4B,CACzC,IAAa,EACb,GAAmD,EACnD,KAAc,EACd,GAA6B,EAC7B,EAAE,uBAAuB,EAAuB;IAEhD,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { PermissionConstraint } from '../Permission';\nimport type { SubjectPermissions } from '../PermissionController';\nimport type { PermittedHandlerExport } from '../utils';\nimport { MethodNames } from '../utils';\n\nexport const getPermissionsHandler: PermittedHandlerExport<\n GetPermissionsHooks,\n [],\n PermissionConstraint[]\n> = {\n methodNames: [MethodNames.GetPermissions],\n implementation: getPermissionsImplementation,\n hookNames: {\n getPermissionsForOrigin: true,\n },\n};\n\nexport type GetPermissionsHooks = {\n // This must be bound to the requesting origin.\n getPermissionsForOrigin: () => SubjectPermissions<PermissionConstraint>;\n};\n\n/**\n * Get Permissions implementation to be used in JsonRpcEngine middleware.\n *\n * @param _req - The JsonRpcEngine request - unused\n * @param res - The JsonRpcEngine result object\n * @param _next - JsonRpcEngine next() callback - unused\n * @param end - JsonRpcEngine end() callback\n * @param options - Method hooks passed to the method implementation\n * @param options.getPermissionsForOrigin - The specific method hook needed for this method implementation\n * @returns A promise that resolves to nothing\n */\nasync function getPermissionsImplementation(\n _req: unknown,\n res: PendingJsonRpcResponse<PermissionConstraint[]>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { getPermissionsForOrigin }: GetPermissionsHooks,\n): Promise<void> {\n res.result = Object.values(getPermissionsForOrigin() || {});\n return end();\n}\n"]}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { PermissionConstraint } from "../Permission.cjs";
|
|
2
|
+
import type { SubjectPermissions } from "../PermissionController.cjs";
|
|
3
|
+
import type { PermittedHandlerExport } from "../utils.cjs";
|
|
4
|
+
export declare const getPermissionsHandler: PermittedHandlerExport<GetPermissionsHooks, [
|
|
5
|
+
], PermissionConstraint[]>;
|
|
6
|
+
export type GetPermissionsHooks = {
|
|
7
|
+
getPermissionsForOrigin: () => SubjectPermissions<PermissionConstraint>;
|
|
8
|
+
};
|
|
9
|
+
//# sourceMappingURL=getPermissions.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getPermissions.d.cts","sourceRoot":"","sources":["../../src/rpc-methods/getPermissions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAAsB;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,oCAAgC;AAClE,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAGvD,eAAO,MAAM,qBAAqB,EAAE,sBAAsB,CACxD,mBAAmB,EACnB;CAAE,EACF,oBAAoB,EAAE,CAOvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAEhC,uBAAuB,EAAE,MAAM,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;CACzE,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { PermissionConstraint } from "../Permission.mjs";
|
|
2
|
+
import type { SubjectPermissions } from "../PermissionController.mjs";
|
|
3
|
+
import type { PermittedHandlerExport } from "../utils.mjs";
|
|
4
|
+
export declare const getPermissionsHandler: PermittedHandlerExport<GetPermissionsHooks, [
|
|
5
|
+
], PermissionConstraint[]>;
|
|
6
|
+
export type GetPermissionsHooks = {
|
|
7
|
+
getPermissionsForOrigin: () => SubjectPermissions<PermissionConstraint>;
|
|
8
|
+
};
|
|
9
|
+
//# sourceMappingURL=getPermissions.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getPermissions.d.mts","sourceRoot":"","sources":["../../src/rpc-methods/getPermissions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAAsB;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,oCAAgC;AAClE,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAGvD,eAAO,MAAM,qBAAqB,EAAE,sBAAsB,CACxD,mBAAmB,EACnB;CAAE,EACF,oBAAoB,EAAE,CAOvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAEhC,uBAAuB,EAAE,MAAM,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;CACzE,CAAC"}
|
|
@@ -1,9 +1,24 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
import { MethodNames } from "../utils.mjs";
|
|
2
|
+
export const getPermissionsHandler = {
|
|
3
|
+
methodNames: [MethodNames.GetPermissions],
|
|
4
|
+
implementation: getPermissionsImplementation,
|
|
5
|
+
hookNames: {
|
|
6
|
+
getPermissionsForOrigin: true,
|
|
7
|
+
},
|
|
8
8
|
};
|
|
9
|
+
/**
|
|
10
|
+
* Get Permissions implementation to be used in JsonRpcEngine middleware.
|
|
11
|
+
*
|
|
12
|
+
* @param _req - The JsonRpcEngine request - unused
|
|
13
|
+
* @param res - The JsonRpcEngine result object
|
|
14
|
+
* @param _next - JsonRpcEngine next() callback - unused
|
|
15
|
+
* @param end - JsonRpcEngine end() callback
|
|
16
|
+
* @param options - Method hooks passed to the method implementation
|
|
17
|
+
* @param options.getPermissionsForOrigin - The specific method hook needed for this method implementation
|
|
18
|
+
* @returns A promise that resolves to nothing
|
|
19
|
+
*/
|
|
20
|
+
async function getPermissionsImplementation(_req, res, _next, end, { getPermissionsForOrigin }) {
|
|
21
|
+
res.result = Object.values(getPermissionsForOrigin() || {});
|
|
22
|
+
return end();
|
|
23
|
+
}
|
|
9
24
|
//# sourceMappingURL=getPermissions.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[],"
|
|
1
|
+
{"version":3,"file":"getPermissions.mjs","sourceRoot":"","sources":["../../src/rpc-methods/getPermissions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,qBAAiB;AAEvC,MAAM,CAAC,MAAM,qBAAqB,GAI9B;IACF,WAAW,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC;IACzC,cAAc,EAAE,4BAA4B;IAC5C,SAAS,EAAE;QACT,uBAAuB,EAAE,IAAI;KAC9B;CACF,CAAC;AAOF;;;;;;;;;;GAUG;AACH,KAAK,UAAU,4BAA4B,CACzC,IAAa,EACb,GAAmD,EACnD,KAAc,EACd,GAA6B,EAC7B,EAAE,uBAAuB,EAAuB;IAEhD,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { PermissionConstraint } from '../Permission';\nimport type { SubjectPermissions } from '../PermissionController';\nimport type { PermittedHandlerExport } from '../utils';\nimport { MethodNames } from '../utils';\n\nexport const getPermissionsHandler: PermittedHandlerExport<\n GetPermissionsHooks,\n [],\n PermissionConstraint[]\n> = {\n methodNames: [MethodNames.GetPermissions],\n implementation: getPermissionsImplementation,\n hookNames: {\n getPermissionsForOrigin: true,\n },\n};\n\nexport type GetPermissionsHooks = {\n // This must be bound to the requesting origin.\n getPermissionsForOrigin: () => SubjectPermissions<PermissionConstraint>;\n};\n\n/**\n * Get Permissions implementation to be used in JsonRpcEngine middleware.\n *\n * @param _req - The JsonRpcEngine request - unused\n * @param res - The JsonRpcEngine result object\n * @param _next - JsonRpcEngine next() callback - unused\n * @param end - JsonRpcEngine end() callback\n * @param options - Method hooks passed to the method implementation\n * @param options.getPermissionsForOrigin - The specific method hook needed for this method implementation\n * @returns A promise that resolves to nothing\n */\nasync function getPermissionsImplementation(\n _req: unknown,\n res: PendingJsonRpcResponse<PermissionConstraint[]>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { getPermissionsForOrigin }: GetPermissionsHooks,\n): Promise<void> {\n res.result = Object.values(getPermissionsForOrigin() || {});\n return end();\n}\n"]}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.handlers = void 0;
|
|
4
|
+
const getPermissions_1 = require("./getPermissions.cjs");
|
|
5
|
+
const requestPermissions_1 = require("./requestPermissions.cjs");
|
|
6
|
+
const revokePermissions_1 = require("./revokePermissions.cjs");
|
|
7
|
+
exports.handlers = [
|
|
8
|
+
requestPermissions_1.requestPermissionsHandler,
|
|
9
|
+
getPermissions_1.getPermissionsHandler,
|
|
10
|
+
revokePermissions_1.revokePermissionsHandler,
|
|
11
|
+
];
|
|
12
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/rpc-methods/index.ts"],"names":[],"mappings":";;;AACA,yDAAyD;AAEzD,iEAAiE;AAEjE,+DAA+D;AAMlD,QAAA,QAAQ,GAAG;IACtB,8CAAyB;IACzB,sCAAqB;IACrB,4CAAwB;CAChB,CAAC","sourcesContent":["import type { GetPermissionsHooks } from './getPermissions';\nimport { getPermissionsHandler } from './getPermissions';\nimport type { RequestPermissionsHooks } from './requestPermissions';\nimport { requestPermissionsHandler } from './requestPermissions';\nimport type { RevokePermissionsHooks } from './revokePermissions';\nimport { revokePermissionsHandler } from './revokePermissions';\n\nexport type PermittedRpcMethodHooks = RequestPermissionsHooks &\n GetPermissionsHooks &\n RevokePermissionsHooks;\n\nexport const handlers = [\n requestPermissionsHandler,\n getPermissionsHandler,\n revokePermissionsHandler,\n] as const;\n"]}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { GetPermissionsHooks } from "./getPermissions.cjs";
|
|
2
|
+
import type { RequestPermissionsHooks } from "./requestPermissions.cjs";
|
|
3
|
+
import type { RevokePermissionsHooks } from "./revokePermissions.cjs";
|
|
4
|
+
export type PermittedRpcMethodHooks = RequestPermissionsHooks & GetPermissionsHooks & RevokePermissionsHooks;
|
|
5
|
+
export declare const handlers: readonly [import("../index.cjs").PermittedHandlerExport<RequestPermissionsHooks, [import("../index.cjs").RequestedPermissions], import("../index.cjs").PermissionConstraint[]>, import("../index.cjs").PermittedHandlerExport<GetPermissionsHooks, [], import("../index.cjs").PermissionConstraint[]>, import("../index.cjs").PermittedHandlerExport<RevokePermissionsHooks, import("./revokePermissions.cjs").RevokePermissionArgs, null>];
|
|
6
|
+
//# sourceMappingURL=index.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/rpc-methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,6BAAyB;AAE5D,OAAO,KAAK,EAAE,uBAAuB,EAAE,iCAA6B;AAEpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,gCAA4B;AAGlE,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,GAC3D,mBAAmB,GACnB,sBAAsB,CAAC;AAEzB,eAAO,MAAM,QAAQ,6WAIX,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { GetPermissionsHooks } from "./getPermissions.mjs";
|
|
2
|
+
import type { RequestPermissionsHooks } from "./requestPermissions.mjs";
|
|
3
|
+
import type { RevokePermissionsHooks } from "./revokePermissions.mjs";
|
|
4
|
+
export type PermittedRpcMethodHooks = RequestPermissionsHooks & GetPermissionsHooks & RevokePermissionsHooks;
|
|
5
|
+
export declare const handlers: readonly [import("../index.mjs").PermittedHandlerExport<RequestPermissionsHooks, [import("../index.mjs").RequestedPermissions], import("../index.mjs").PermissionConstraint[]>, import("../index.mjs").PermittedHandlerExport<GetPermissionsHooks, [], import("../index.mjs").PermissionConstraint[]>, import("../index.mjs").PermittedHandlerExport<RevokePermissionsHooks, import("./revokePermissions.mjs").RevokePermissionArgs, null>];
|
|
6
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/rpc-methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,6BAAyB;AAE5D,OAAO,KAAK,EAAE,uBAAuB,EAAE,iCAA6B;AAEpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,gCAA4B;AAGlE,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,GAC3D,mBAAmB,GACnB,sBAAsB,CAAC;AAEzB,eAAO,MAAM,QAAQ,6WAIX,CAAC"}
|
|
@@ -1,13 +1,9 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
} from "
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
import "../chunk-2L4QPE5A.mjs";
|
|
10
|
-
export {
|
|
11
|
-
handlers
|
|
12
|
-
};
|
|
1
|
+
import { getPermissionsHandler } from "./getPermissions.mjs";
|
|
2
|
+
import { requestPermissionsHandler } from "./requestPermissions.mjs";
|
|
3
|
+
import { revokePermissionsHandler } from "./revokePermissions.mjs";
|
|
4
|
+
export const handlers = [
|
|
5
|
+
requestPermissionsHandler,
|
|
6
|
+
getPermissionsHandler,
|
|
7
|
+
revokePermissionsHandler,
|
|
8
|
+
];
|
|
13
9
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[],"
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/rpc-methods/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,6BAAyB;AAEzD,OAAO,EAAE,yBAAyB,EAAE,iCAA6B;AAEjE,OAAO,EAAE,wBAAwB,EAAE,gCAA4B;AAM/D,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,yBAAyB;IACzB,qBAAqB;IACrB,wBAAwB;CAChB,CAAC","sourcesContent":["import type { GetPermissionsHooks } from './getPermissions';\nimport { getPermissionsHandler } from './getPermissions';\nimport type { RequestPermissionsHooks } from './requestPermissions';\nimport { requestPermissionsHandler } from './requestPermissions';\nimport type { RevokePermissionsHooks } from './revokePermissions';\nimport { revokePermissionsHandler } from './revokePermissions';\n\nexport type PermittedRpcMethodHooks = RequestPermissionsHooks &\n GetPermissionsHooks &\n RevokePermissionsHooks;\n\nexport const handlers = [\n requestPermissionsHandler,\n getPermissionsHandler,\n revokePermissionsHandler,\n] as const;\n"]}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.requestPermissionsHandler = void 0;
|
|
4
|
+
const controller_utils_1 = require("@metamask/controller-utils");
|
|
5
|
+
const errors_1 = require("../errors.cjs");
|
|
6
|
+
const utils_1 = require("../utils.cjs");
|
|
7
|
+
exports.requestPermissionsHandler = {
|
|
8
|
+
methodNames: [utils_1.MethodNames.RequestPermissions],
|
|
9
|
+
implementation: requestPermissionsImplementation,
|
|
10
|
+
hookNames: {
|
|
11
|
+
requestPermissionsForOrigin: true,
|
|
12
|
+
},
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Request Permissions implementation to be used in JsonRpcEngine middleware.
|
|
16
|
+
*
|
|
17
|
+
* @param req - The JsonRpcEngine request
|
|
18
|
+
* @param res - The JsonRpcEngine result object
|
|
19
|
+
* @param _next - JsonRpcEngine next() callback - unused
|
|
20
|
+
* @param end - JsonRpcEngine end() callback
|
|
21
|
+
* @param options - Method hooks passed to the method implementation
|
|
22
|
+
* @param options.requestPermissionsForOrigin - The specific method hook needed for this method implementation
|
|
23
|
+
* @returns A promise that resolves to nothing
|
|
24
|
+
*/
|
|
25
|
+
async function requestPermissionsImplementation(req, res, _next, end, { requestPermissionsForOrigin }) {
|
|
26
|
+
const { params } = req;
|
|
27
|
+
if (!Array.isArray(params) || !(0, controller_utils_1.isPlainObject)(params[0])) {
|
|
28
|
+
return end((0, errors_1.invalidParams)({ data: { request: req } }));
|
|
29
|
+
}
|
|
30
|
+
const [requestedPermissions] = params;
|
|
31
|
+
const [grantedPermissions] = await requestPermissionsForOrigin(requestedPermissions);
|
|
32
|
+
// `wallet_requestPermission` is specified to return an array.
|
|
33
|
+
res.result = Object.values(grantedPermissions);
|
|
34
|
+
return end();
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=requestPermissions.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"requestPermissions.cjs","sourceRoot":"","sources":["../../src/rpc-methods/requestPermissions.ts"],"names":[],"mappings":";;;AAAA,iEAA2D;AAI3D,0CAA0C;AAG1C,wCAAuC;AAE1B,QAAA,yBAAyB,GAIlC;IACF,WAAW,EAAE,CAAC,mBAAW,CAAC,kBAAkB,CAAC;IAC7C,cAAc,EAAE,gCAAgC;IAChD,SAAS,EAAE;QACT,2BAA2B,EAAE,IAAI;KAClC;CACF,CAAC;AAYF;;;;;;;;;;GAUG;AACH,KAAK,UAAU,gCAAgC,CAC7C,GAA2C,EAC3C,GAAmD,EACnD,KAAc,EACd,GAA6B,EAC7B,EAAE,2BAA2B,EAA2B;IAExD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAA,gCAAa,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;QACvD,OAAO,GAAG,CAAC,IAAA,sBAAa,EAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;KACvD;IAED,MAAM,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;IACtC,MAAM,CAAC,kBAAkB,CAAC,GAAG,MAAM,2BAA2B,CAC5D,oBAAoB,CACrB,CAAC;IAEF,8DAA8D;IAC9D,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC/C,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import { isPlainObject } from '@metamask/controller-utils';\nimport type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { invalidParams } from '../errors';\nimport type { PermissionConstraint, RequestedPermissions } from '../Permission';\nimport type { PermittedHandlerExport } from '../utils';\nimport { MethodNames } from '../utils';\n\nexport const requestPermissionsHandler: PermittedHandlerExport<\n RequestPermissionsHooks,\n [RequestedPermissions],\n PermissionConstraint[]\n> = {\n methodNames: [MethodNames.RequestPermissions],\n implementation: requestPermissionsImplementation,\n hookNames: {\n requestPermissionsForOrigin: true,\n },\n};\n\ntype RequestPermissions = (\n requestedPermissions: RequestedPermissions,\n) => Promise<\n [Record<string, PermissionConstraint>, { id: string; origin: string }]\n>;\n\nexport type RequestPermissionsHooks = {\n requestPermissionsForOrigin: RequestPermissions;\n};\n\n/**\n * Request Permissions implementation to be used in JsonRpcEngine middleware.\n *\n * @param req - The JsonRpcEngine request\n * @param res - The JsonRpcEngine result object\n * @param _next - JsonRpcEngine next() callback - unused\n * @param end - JsonRpcEngine end() callback\n * @param options - Method hooks passed to the method implementation\n * @param options.requestPermissionsForOrigin - The specific method hook needed for this method implementation\n * @returns A promise that resolves to nothing\n */\nasync function requestPermissionsImplementation(\n req: JsonRpcRequest<[RequestedPermissions]>,\n res: PendingJsonRpcResponse<PermissionConstraint[]>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { requestPermissionsForOrigin }: RequestPermissionsHooks,\n): Promise<void> {\n const { params } = req;\n\n if (!Array.isArray(params) || !isPlainObject(params[0])) {\n return end(invalidParams({ data: { request: req } }));\n }\n\n const [requestedPermissions] = params;\n const [grantedPermissions] = await requestPermissionsForOrigin(\n requestedPermissions,\n );\n\n // `wallet_requestPermission` is specified to return an array.\n res.result = Object.values(grantedPermissions);\n return end();\n}\n"]}
|
package/dist/{types/rpc-methods/requestPermissions.d.ts → rpc-methods/requestPermissions.d.cts}
RENAMED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { PermissionConstraint, RequestedPermissions } from
|
|
2
|
-
import type { PermittedHandlerExport } from
|
|
1
|
+
import type { PermissionConstraint, RequestedPermissions } from "../Permission.cjs";
|
|
2
|
+
import type { PermittedHandlerExport } from "../utils.cjs";
|
|
3
3
|
export declare const requestPermissionsHandler: PermittedHandlerExport<RequestPermissionsHooks, [
|
|
4
4
|
RequestedPermissions
|
|
5
5
|
], PermissionConstraint[]>;
|
|
@@ -14,4 +14,4 @@ export type RequestPermissionsHooks = {
|
|
|
14
14
|
requestPermissionsForOrigin: RequestPermissions;
|
|
15
15
|
};
|
|
16
16
|
export {};
|
|
17
|
-
//# sourceMappingURL=requestPermissions.d.
|
|
17
|
+
//# sourceMappingURL=requestPermissions.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"requestPermissions.d.cts","sourceRoot":"","sources":["../../src/rpc-methods/requestPermissions.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,0BAAsB;AAChF,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAGvD,eAAO,MAAM,yBAAyB,EAAE,sBAAsB,CAC5D,uBAAuB,EACvB;IAAC,oBAAoB;CAAC,EACtB,oBAAoB,EAAE,CAOvB,CAAC;AAEF,KAAK,kBAAkB,GAAG,CACxB,oBAAoB,EAAE,oBAAoB,KACvC,OAAO,CACV;IAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;CAAC,CACvE,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,2BAA2B,EAAE,kBAAkB,CAAC;CACjD,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { PermissionConstraint, RequestedPermissions } from "../Permission.mjs";
|
|
2
|
+
import type { PermittedHandlerExport } from "../utils.mjs";
|
|
3
|
+
export declare const requestPermissionsHandler: PermittedHandlerExport<RequestPermissionsHooks, [
|
|
4
|
+
RequestedPermissions
|
|
5
|
+
], PermissionConstraint[]>;
|
|
6
|
+
type RequestPermissions = (requestedPermissions: RequestedPermissions) => Promise<[
|
|
7
|
+
Record<string, PermissionConstraint>,
|
|
8
|
+
{
|
|
9
|
+
id: string;
|
|
10
|
+
origin: string;
|
|
11
|
+
}
|
|
12
|
+
]>;
|
|
13
|
+
export type RequestPermissionsHooks = {
|
|
14
|
+
requestPermissionsForOrigin: RequestPermissions;
|
|
15
|
+
};
|
|
16
|
+
export {};
|
|
17
|
+
//# sourceMappingURL=requestPermissions.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"requestPermissions.d.mts","sourceRoot":"","sources":["../../src/rpc-methods/requestPermissions.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,0BAAsB;AAChF,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAGvD,eAAO,MAAM,yBAAyB,EAAE,sBAAsB,CAC5D,uBAAuB,EACvB;IAAC,oBAAoB;CAAC,EACtB,oBAAoB,EAAE,CAOvB,CAAC;AAEF,KAAK,kBAAkB,GAAG,CACxB,oBAAoB,EAAE,oBAAoB,KACvC,OAAO,CACV;IAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;CAAC,CACvE,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,2BAA2B,EAAE,kBAAkB,CAAC;CACjD,CAAC"}
|
|
@@ -1,10 +1,33 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
} from "../
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
import { isPlainObject } from "@metamask/controller-utils";
|
|
2
|
+
import { invalidParams } from "../errors.mjs";
|
|
3
|
+
import { MethodNames } from "../utils.mjs";
|
|
4
|
+
export const requestPermissionsHandler = {
|
|
5
|
+
methodNames: [MethodNames.RequestPermissions],
|
|
6
|
+
implementation: requestPermissionsImplementation,
|
|
7
|
+
hookNames: {
|
|
8
|
+
requestPermissionsForOrigin: true,
|
|
9
|
+
},
|
|
9
10
|
};
|
|
11
|
+
/**
|
|
12
|
+
* Request Permissions implementation to be used in JsonRpcEngine middleware.
|
|
13
|
+
*
|
|
14
|
+
* @param req - The JsonRpcEngine request
|
|
15
|
+
* @param res - The JsonRpcEngine result object
|
|
16
|
+
* @param _next - JsonRpcEngine next() callback - unused
|
|
17
|
+
* @param end - JsonRpcEngine end() callback
|
|
18
|
+
* @param options - Method hooks passed to the method implementation
|
|
19
|
+
* @param options.requestPermissionsForOrigin - The specific method hook needed for this method implementation
|
|
20
|
+
* @returns A promise that resolves to nothing
|
|
21
|
+
*/
|
|
22
|
+
async function requestPermissionsImplementation(req, res, _next, end, { requestPermissionsForOrigin }) {
|
|
23
|
+
const { params } = req;
|
|
24
|
+
if (!Array.isArray(params) || !isPlainObject(params[0])) {
|
|
25
|
+
return end(invalidParams({ data: { request: req } }));
|
|
26
|
+
}
|
|
27
|
+
const [requestedPermissions] = params;
|
|
28
|
+
const [grantedPermissions] = await requestPermissionsForOrigin(requestedPermissions);
|
|
29
|
+
// `wallet_requestPermission` is specified to return an array.
|
|
30
|
+
res.result = Object.values(grantedPermissions);
|
|
31
|
+
return end();
|
|
32
|
+
}
|
|
10
33
|
//# sourceMappingURL=requestPermissions.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[],"
|
|
1
|
+
{"version":3,"file":"requestPermissions.mjs","sourceRoot":"","sources":["../../src/rpc-methods/requestPermissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,mCAAmC;AAI3D,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAG1C,OAAO,EAAE,WAAW,EAAE,qBAAiB;AAEvC,MAAM,CAAC,MAAM,yBAAyB,GAIlC;IACF,WAAW,EAAE,CAAC,WAAW,CAAC,kBAAkB,CAAC;IAC7C,cAAc,EAAE,gCAAgC;IAChD,SAAS,EAAE;QACT,2BAA2B,EAAE,IAAI;KAClC;CACF,CAAC;AAYF;;;;;;;;;;GAUG;AACH,KAAK,UAAU,gCAAgC,CAC7C,GAA2C,EAC3C,GAAmD,EACnD,KAAc,EACd,GAA6B,EAC7B,EAAE,2BAA2B,EAA2B;IAExD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;QACvD,OAAO,GAAG,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;KACvD;IAED,MAAM,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;IACtC,MAAM,CAAC,kBAAkB,CAAC,GAAG,MAAM,2BAA2B,CAC5D,oBAAoB,CACrB,CAAC;IAEF,8DAA8D;IAC9D,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC/C,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import { isPlainObject } from '@metamask/controller-utils';\nimport type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { invalidParams } from '../errors';\nimport type { PermissionConstraint, RequestedPermissions } from '../Permission';\nimport type { PermittedHandlerExport } from '../utils';\nimport { MethodNames } from '../utils';\n\nexport const requestPermissionsHandler: PermittedHandlerExport<\n RequestPermissionsHooks,\n [RequestedPermissions],\n PermissionConstraint[]\n> = {\n methodNames: [MethodNames.RequestPermissions],\n implementation: requestPermissionsImplementation,\n hookNames: {\n requestPermissionsForOrigin: true,\n },\n};\n\ntype RequestPermissions = (\n requestedPermissions: RequestedPermissions,\n) => Promise<\n [Record<string, PermissionConstraint>, { id: string; origin: string }]\n>;\n\nexport type RequestPermissionsHooks = {\n requestPermissionsForOrigin: RequestPermissions;\n};\n\n/**\n * Request Permissions implementation to be used in JsonRpcEngine middleware.\n *\n * @param req - The JsonRpcEngine request\n * @param res - The JsonRpcEngine result object\n * @param _next - JsonRpcEngine next() callback - unused\n * @param end - JsonRpcEngine end() callback\n * @param options - Method hooks passed to the method implementation\n * @param options.requestPermissionsForOrigin - The specific method hook needed for this method implementation\n * @returns A promise that resolves to nothing\n */\nasync function requestPermissionsImplementation(\n req: JsonRpcRequest<[RequestedPermissions]>,\n res: PendingJsonRpcResponse<PermissionConstraint[]>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { requestPermissionsForOrigin }: RequestPermissionsHooks,\n): Promise<void> {\n const { params } = req;\n\n if (!Array.isArray(params) || !isPlainObject(params[0])) {\n return end(invalidParams({ data: { request: req } }));\n }\n\n const [requestedPermissions] = params;\n const [grantedPermissions] = await requestPermissionsForOrigin(\n requestedPermissions,\n );\n\n // `wallet_requestPermission` is specified to return an array.\n res.result = Object.values(grantedPermissions);\n return end();\n}\n"]}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.revokePermissionsHandler = void 0;
|
|
4
|
+
const utils_1 = require("@metamask/utils");
|
|
5
|
+
const errors_1 = require("../errors.cjs");
|
|
6
|
+
const utils_2 = require("../utils.cjs");
|
|
7
|
+
exports.revokePermissionsHandler = {
|
|
8
|
+
methodNames: [utils_2.MethodNames.RevokePermissions],
|
|
9
|
+
implementation: revokePermissionsImplementation,
|
|
10
|
+
hookNames: {
|
|
11
|
+
revokePermissionsForOrigin: true,
|
|
12
|
+
},
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Revoke Permissions implementation to be used in JsonRpcEngine middleware.
|
|
16
|
+
*
|
|
17
|
+
* @param req - The JsonRpcEngine request
|
|
18
|
+
* @param res - The JsonRpcEngine result object
|
|
19
|
+
* @param _next - JsonRpcEngine next() callback - unused
|
|
20
|
+
* @param end - JsonRpcEngine end() callback
|
|
21
|
+
* @param options - Method hooks passed to the method implementation
|
|
22
|
+
* @param options.revokePermissionsForOrigin - A hook that revokes given permission keys for an origin
|
|
23
|
+
* @returns A promise that resolves to nothing
|
|
24
|
+
*/
|
|
25
|
+
async function revokePermissionsImplementation(req, res, _next, end, { revokePermissionsForOrigin }) {
|
|
26
|
+
const { params } = req;
|
|
27
|
+
const param = params?.[0];
|
|
28
|
+
if (!param) {
|
|
29
|
+
return end((0, errors_1.invalidParams)({ data: { request: req } }));
|
|
30
|
+
}
|
|
31
|
+
// For now, this API revokes the entire permission key
|
|
32
|
+
// even if caveats are specified.
|
|
33
|
+
const permissionKeys = Object.keys(param);
|
|
34
|
+
if (!(0, utils_1.isNonEmptyArray)(permissionKeys)) {
|
|
35
|
+
return end((0, errors_1.invalidParams)({ data: { request: req } }));
|
|
36
|
+
}
|
|
37
|
+
revokePermissionsForOrigin(permissionKeys);
|
|
38
|
+
res.result = null;
|
|
39
|
+
return end();
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=revokePermissions.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"revokePermissions.cjs","sourceRoot":"","sources":["../../src/rpc-methods/revokePermissions.ts"],"names":[],"mappings":";;;AACA,2CAMyB;AAEzB,0CAA0C;AAG1C,wCAAuC;AAE1B,QAAA,wBAAwB,GAIjC;IACF,WAAW,EAAE,CAAC,mBAAW,CAAC,iBAAiB,CAAC;IAC5C,cAAc,EAAE,+BAA+B;IAC/C,SAAS,EAAE;QACT,0BAA0B,EAAE,IAAI;KACjC;CACF,CAAC;AAeF;;;;;;;;;;GAUG;AACH,KAAK,UAAU,+BAA+B,CAC5C,GAAyC,EACzC,GAAiC,EACjC,KAAc,EACd,GAA6B,EAC7B,EAAE,0BAA0B,EAA0B;IAEtD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1B,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,GAAG,CAAC,IAAA,sBAAa,EAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;KACvD;IAED,sDAAsD;IACtD,iCAAiC;IACjC,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAE1C,IAAI,CAAC,IAAA,uBAAe,EAAC,cAAc,CAAC,EAAE;QACpC,OAAO,GAAG,CAAC,IAAA,sBAAa,EAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;KACvD;IAED,0BAA0B,CAAC,cAAc,CAAC,CAAC;IAE3C,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IAElB,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport {\n isNonEmptyArray,\n type Json,\n type JsonRpcRequest,\n type NonEmptyArray,\n type PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport { invalidParams } from '../errors';\nimport type { PermissionConstraint } from '../Permission';\nimport type { PermittedHandlerExport } from '../utils';\nimport { MethodNames } from '../utils';\n\nexport const revokePermissionsHandler: PermittedHandlerExport<\n RevokePermissionsHooks,\n RevokePermissionArgs,\n null\n> = {\n methodNames: [MethodNames.RevokePermissions],\n implementation: revokePermissionsImplementation,\n hookNames: {\n revokePermissionsForOrigin: true,\n },\n};\n\nexport type RevokePermissionArgs = Record<\n PermissionConstraint['parentCapability'],\n Json\n>;\n\ntype RevokePermissions = (\n permissions: NonEmptyArray<PermissionConstraint['parentCapability']>,\n) => void;\n\nexport type RevokePermissionsHooks = {\n revokePermissionsForOrigin: RevokePermissions;\n};\n\n/**\n * Revoke Permissions implementation to be used in JsonRpcEngine middleware.\n *\n * @param req - The JsonRpcEngine request\n * @param res - The JsonRpcEngine result object\n * @param _next - JsonRpcEngine next() callback - unused\n * @param end - JsonRpcEngine end() callback\n * @param options - Method hooks passed to the method implementation\n * @param options.revokePermissionsForOrigin - A hook that revokes given permission keys for an origin\n * @returns A promise that resolves to nothing\n */\nasync function revokePermissionsImplementation(\n req: JsonRpcRequest<RevokePermissionArgs>,\n res: PendingJsonRpcResponse<null>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { revokePermissionsForOrigin }: RevokePermissionsHooks,\n): Promise<void> {\n const { params } = req;\n\n const param = params?.[0];\n\n if (!param) {\n return end(invalidParams({ data: { request: req } }));\n }\n\n // For now, this API revokes the entire permission key\n // even if caveats are specified.\n const permissionKeys = Object.keys(param);\n\n if (!isNonEmptyArray(permissionKeys)) {\n return end(invalidParams({ data: { request: req } }));\n }\n\n revokePermissionsForOrigin(permissionKeys);\n\n res.result = null;\n\n return end();\n}\n"]}
|
package/dist/{types/rpc-methods/revokePermissions.d.ts → rpc-methods/revokePermissions.d.cts}
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { type Json, type NonEmptyArray } from
|
|
2
|
-
import type { PermissionConstraint } from
|
|
3
|
-
import type { PermittedHandlerExport } from
|
|
1
|
+
import { type Json, type NonEmptyArray } from "@metamask/utils";
|
|
2
|
+
import type { PermissionConstraint } from "../Permission.cjs";
|
|
3
|
+
import type { PermittedHandlerExport } from "../utils.cjs";
|
|
4
4
|
export declare const revokePermissionsHandler: PermittedHandlerExport<RevokePermissionsHooks, RevokePermissionArgs, null>;
|
|
5
5
|
export type RevokePermissionArgs = Record<PermissionConstraint['parentCapability'], Json>;
|
|
6
6
|
type RevokePermissions = (permissions: NonEmptyArray<PermissionConstraint['parentCapability']>) => void;
|
|
@@ -8,4 +8,4 @@ export type RevokePermissionsHooks = {
|
|
|
8
8
|
revokePermissionsForOrigin: RevokePermissions;
|
|
9
9
|
};
|
|
10
10
|
export {};
|
|
11
|
-
//# sourceMappingURL=revokePermissions.d.
|
|
11
|
+
//# sourceMappingURL=revokePermissions.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"revokePermissions.d.cts","sourceRoot":"","sources":["../../src/rpc-methods/revokePermissions.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,IAAI,EAET,KAAK,aAAa,EAEnB,wBAAwB;AAGzB,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAAsB;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAGvD,eAAO,MAAM,wBAAwB,EAAE,sBAAsB,CAC3D,sBAAsB,EACtB,oBAAoB,EACpB,IAAI,CAOL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,oBAAoB,CAAC,kBAAkB,CAAC,EACxC,IAAI,CACL,CAAC;AAEF,KAAK,iBAAiB,GAAG,CACvB,WAAW,EAAE,aAAa,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,KACjE,IAAI,CAAC;AAEV,MAAM,MAAM,sBAAsB,GAAG;IACnC,0BAA0B,EAAE,iBAAiB,CAAC;CAC/C,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { type Json, type NonEmptyArray } from "@metamask/utils";
|
|
2
|
+
import type { PermissionConstraint } from "../Permission.mjs";
|
|
3
|
+
import type { PermittedHandlerExport } from "../utils.mjs";
|
|
4
|
+
export declare const revokePermissionsHandler: PermittedHandlerExport<RevokePermissionsHooks, RevokePermissionArgs, null>;
|
|
5
|
+
export type RevokePermissionArgs = Record<PermissionConstraint['parentCapability'], Json>;
|
|
6
|
+
type RevokePermissions = (permissions: NonEmptyArray<PermissionConstraint['parentCapability']>) => void;
|
|
7
|
+
export type RevokePermissionsHooks = {
|
|
8
|
+
revokePermissionsForOrigin: RevokePermissions;
|
|
9
|
+
};
|
|
10
|
+
export {};
|
|
11
|
+
//# sourceMappingURL=revokePermissions.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"revokePermissions.d.mts","sourceRoot":"","sources":["../../src/rpc-methods/revokePermissions.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,IAAI,EAET,KAAK,aAAa,EAEnB,wBAAwB;AAGzB,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAAsB;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAiB;AAGvD,eAAO,MAAM,wBAAwB,EAAE,sBAAsB,CAC3D,sBAAsB,EACtB,oBAAoB,EACpB,IAAI,CAOL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,oBAAoB,CAAC,kBAAkB,CAAC,EACxC,IAAI,CACL,CAAC;AAEF,KAAK,iBAAiB,GAAG,CACvB,WAAW,EAAE,aAAa,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,KACjE,IAAI,CAAC;AAEV,MAAM,MAAM,sBAAsB,GAAG;IACnC,0BAA0B,EAAE,iBAAiB,CAAC;CAC/C,CAAC"}
|
|
@@ -1,10 +1,38 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
} from "../
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
import { isNonEmptyArray } from "@metamask/utils";
|
|
2
|
+
import { invalidParams } from "../errors.mjs";
|
|
3
|
+
import { MethodNames } from "../utils.mjs";
|
|
4
|
+
export const revokePermissionsHandler = {
|
|
5
|
+
methodNames: [MethodNames.RevokePermissions],
|
|
6
|
+
implementation: revokePermissionsImplementation,
|
|
7
|
+
hookNames: {
|
|
8
|
+
revokePermissionsForOrigin: true,
|
|
9
|
+
},
|
|
9
10
|
};
|
|
11
|
+
/**
|
|
12
|
+
* Revoke Permissions implementation to be used in JsonRpcEngine middleware.
|
|
13
|
+
*
|
|
14
|
+
* @param req - The JsonRpcEngine request
|
|
15
|
+
* @param res - The JsonRpcEngine result object
|
|
16
|
+
* @param _next - JsonRpcEngine next() callback - unused
|
|
17
|
+
* @param end - JsonRpcEngine end() callback
|
|
18
|
+
* @param options - Method hooks passed to the method implementation
|
|
19
|
+
* @param options.revokePermissionsForOrigin - A hook that revokes given permission keys for an origin
|
|
20
|
+
* @returns A promise that resolves to nothing
|
|
21
|
+
*/
|
|
22
|
+
async function revokePermissionsImplementation(req, res, _next, end, { revokePermissionsForOrigin }) {
|
|
23
|
+
const { params } = req;
|
|
24
|
+
const param = params?.[0];
|
|
25
|
+
if (!param) {
|
|
26
|
+
return end(invalidParams({ data: { request: req } }));
|
|
27
|
+
}
|
|
28
|
+
// For now, this API revokes the entire permission key
|
|
29
|
+
// even if caveats are specified.
|
|
30
|
+
const permissionKeys = Object.keys(param);
|
|
31
|
+
if (!isNonEmptyArray(permissionKeys)) {
|
|
32
|
+
return end(invalidParams({ data: { request: req } }));
|
|
33
|
+
}
|
|
34
|
+
revokePermissionsForOrigin(permissionKeys);
|
|
35
|
+
res.result = null;
|
|
36
|
+
return end();
|
|
37
|
+
}
|
|
10
38
|
//# sourceMappingURL=revokePermissions.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[],"
|
|
1
|
+
{"version":3,"file":"revokePermissions.mjs","sourceRoot":"","sources":["../../src/rpc-methods/revokePermissions.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EAKhB,wBAAwB;AAEzB,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAG1C,OAAO,EAAE,WAAW,EAAE,qBAAiB;AAEvC,MAAM,CAAC,MAAM,wBAAwB,GAIjC;IACF,WAAW,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC;IAC5C,cAAc,EAAE,+BAA+B;IAC/C,SAAS,EAAE;QACT,0BAA0B,EAAE,IAAI;KACjC;CACF,CAAC;AAeF;;;;;;;;;;GAUG;AACH,KAAK,UAAU,+BAA+B,CAC5C,GAAyC,EACzC,GAAiC,EACjC,KAAc,EACd,GAA6B,EAC7B,EAAE,0BAA0B,EAA0B;IAEtD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1B,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,GAAG,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;KACvD;IAED,sDAAsD;IACtD,iCAAiC;IACjC,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAE1C,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE;QACpC,OAAO,GAAG,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;KACvD;IAED,0BAA0B,CAAC,cAAc,CAAC,CAAC;IAE3C,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IAElB,OAAO,GAAG,EAAE,CAAC;AACf,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport {\n isNonEmptyArray,\n type Json,\n type JsonRpcRequest,\n type NonEmptyArray,\n type PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport { invalidParams } from '../errors';\nimport type { PermissionConstraint } from '../Permission';\nimport type { PermittedHandlerExport } from '../utils';\nimport { MethodNames } from '../utils';\n\nexport const revokePermissionsHandler: PermittedHandlerExport<\n RevokePermissionsHooks,\n RevokePermissionArgs,\n null\n> = {\n methodNames: [MethodNames.RevokePermissions],\n implementation: revokePermissionsImplementation,\n hookNames: {\n revokePermissionsForOrigin: true,\n },\n};\n\nexport type RevokePermissionArgs = Record<\n PermissionConstraint['parentCapability'],\n Json\n>;\n\ntype RevokePermissions = (\n permissions: NonEmptyArray<PermissionConstraint['parentCapability']>,\n) => void;\n\nexport type RevokePermissionsHooks = {\n revokePermissionsForOrigin: RevokePermissions;\n};\n\n/**\n * Revoke Permissions implementation to be used in JsonRpcEngine middleware.\n *\n * @param req - The JsonRpcEngine request\n * @param res - The JsonRpcEngine result object\n * @param _next - JsonRpcEngine next() callback - unused\n * @param end - JsonRpcEngine end() callback\n * @param options - Method hooks passed to the method implementation\n * @param options.revokePermissionsForOrigin - A hook that revokes given permission keys for an origin\n * @returns A promise that resolves to nothing\n */\nasync function revokePermissionsImplementation(\n req: JsonRpcRequest<RevokePermissionArgs>,\n res: PendingJsonRpcResponse<null>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n { revokePermissionsForOrigin }: RevokePermissionsHooks,\n): Promise<void> {\n const { params } = req;\n\n const param = params?.[0];\n\n if (!param) {\n return end(invalidParams({ data: { request: req } }));\n }\n\n // For now, this API revokes the entire permission key\n // even if caveats are specified.\n const permissionKeys = Object.keys(param);\n\n if (!isNonEmptyArray(permissionKeys)) {\n return end(invalidParams({ data: { request: req } }));\n }\n\n revokePermissionsForOrigin(permissionKeys);\n\n res.result = null;\n\n return end();\n}\n"]}
|
package/dist/utils.cjs
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.collectUniqueAndPairedCaveats = exports.MethodNames = void 0;
|
|
4
|
+
var MethodNames;
|
|
5
|
+
(function (MethodNames) {
|
|
6
|
+
MethodNames["RequestPermissions"] = "wallet_requestPermissions";
|
|
7
|
+
MethodNames["GetPermissions"] = "wallet_getPermissions";
|
|
8
|
+
MethodNames["RevokePermissions"] = "wallet_revokePermissions";
|
|
9
|
+
})(MethodNames || (exports.MethodNames = MethodNames = {}));
|
|
10
|
+
/**
|
|
11
|
+
* Given two permission objects, computes 3 sets:
|
|
12
|
+
* - The set of caveat pairs that are common to both permissions.
|
|
13
|
+
* - The set of caveats that are unique to the existing permission.
|
|
14
|
+
* - The set of caveats that are unique to the requested permission.
|
|
15
|
+
*
|
|
16
|
+
* Assumes that the caveat arrays of both permissions are valid.
|
|
17
|
+
*
|
|
18
|
+
* @param leftPermission - The left-hand permission.
|
|
19
|
+
* @param rightPermission - The right-hand permission.
|
|
20
|
+
* @returns The sets of caveat pairs and unique caveats.
|
|
21
|
+
*/
|
|
22
|
+
function collectUniqueAndPairedCaveats(leftPermission, rightPermission) {
|
|
23
|
+
const leftCaveats = leftPermission?.caveats?.slice() ?? [];
|
|
24
|
+
const rightCaveats = rightPermission.caveats?.slice() ?? [];
|
|
25
|
+
const leftUniqueCaveats = [];
|
|
26
|
+
const caveatPairs = [];
|
|
27
|
+
leftCaveats.forEach((leftCaveat) => {
|
|
28
|
+
const rightCaveatIndex = rightCaveats.findIndex((rightCaveat) => rightCaveat.type === leftCaveat.type);
|
|
29
|
+
if (rightCaveatIndex === -1) {
|
|
30
|
+
leftUniqueCaveats.push(leftCaveat);
|
|
31
|
+
}
|
|
32
|
+
else {
|
|
33
|
+
caveatPairs.push([leftCaveat, rightCaveats[rightCaveatIndex]]);
|
|
34
|
+
rightCaveats.splice(rightCaveatIndex, 1);
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
return {
|
|
38
|
+
caveatPairs,
|
|
39
|
+
leftUniqueCaveats,
|
|
40
|
+
rightUniqueCaveats: [...rightCaveats],
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
exports.collectUniqueAndPairedCaveats = collectUniqueAndPairedCaveats;
|
|
44
|
+
//# sourceMappingURL=utils.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAsBA,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,+DAAgD,CAAA;IAChD,uDAAwC,CAAA;IACxC,6DAA8C,CAAA;AAChD,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAsDD;;;;;;;;;;;GAWG;AACH,SAAgB,6BAA6B,CAC3C,cAAyD,EACzD,eAA8C;IAE9C,MAAM,WAAW,GAAG,cAAc,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3D,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC5D,MAAM,iBAAiB,GAAuB,EAAE,CAAC;IACjD,MAAM,WAAW,GAA2C,EAAE,CAAC;IAE/D,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACjC,MAAM,gBAAgB,GAAG,YAAY,CAAC,SAAS,CAC7C,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CACtD,CAAC;QAEF,IAAI,gBAAgB,KAAK,CAAC,CAAC,EAAE;YAC3B,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACpC;aAAM;YACL,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;YAC/D,YAAY,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;SAC1C;IACH,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,WAAW;QACX,iBAAiB;QACjB,kBAAkB,EAAE,CAAC,GAAG,YAAY,CAAC;KACtC,CAAC;AACJ,CAAC;AA3BD,sEA2BC","sourcesContent":["import type {\n JsonRpcEngineEndCallback,\n JsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport type {\n Json,\n JsonRpcParams,\n JsonRpcRequest,\n PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport type {\n CaveatConstraint,\n CaveatSpecificationConstraint,\n CaveatSpecificationMap,\n} from './Caveat';\nimport type {\n PermissionConstraint,\n PermissionSpecificationConstraint,\n PermissionSpecificationMap,\n} from './Permission';\n\nexport enum MethodNames {\n RequestPermissions = 'wallet_requestPermissions',\n GetPermissions = 'wallet_getPermissions',\n RevokePermissions = 'wallet_revokePermissions',\n}\n\n/**\n * Utility type for extracting a union of all individual caveat or permission\n * specification types from a {@link CaveatSpecificationMap} or\n * {@link PermissionSpecificationMap}.\n *\n * @template SpecificationsMap - The caveat or permission specifications map\n * whose specification type union to extract.\n */\nexport type ExtractSpecifications<\n SpecificationsMap extends\n | CaveatSpecificationMap<CaveatSpecificationConstraint>\n | PermissionSpecificationMap<PermissionSpecificationConstraint>,\n> = SpecificationsMap[keyof SpecificationsMap];\n\n/**\n * A middleware function for handling a permitted method.\n */\nexport type HandlerMiddlewareFunction<\n Hooks,\n Params extends JsonRpcParams,\n Result extends Json,\n> = (\n req: JsonRpcRequest<Params>,\n res: PendingJsonRpcResponse<Result>,\n next: JsonRpcEngineNextCallback,\n end: JsonRpcEngineEndCallback,\n hooks: Hooks,\n) => void | Promise<void>;\n\n/**\n * We use a mapped object type in order to create a type that requires the\n * presence of the names of all hooks for the given handler.\n * This can then be used to select only the necessary hooks whenever a method\n * is called for purposes of POLA.\n */\nexport type HookNames<HookMap> = {\n [Property in keyof HookMap]: true;\n};\n\n/**\n * A handler for a permitted method.\n */\nexport type PermittedHandlerExport<\n Hooks,\n Params extends JsonRpcParams,\n Result extends Json,\n> = {\n implementation: HandlerMiddlewareFunction<Hooks, Params, Result>;\n hookNames: HookNames<Hooks>;\n methodNames: string[];\n};\n\n/**\n * Given two permission objects, computes 3 sets:\n * - The set of caveat pairs that are common to both permissions.\n * - The set of caveats that are unique to the existing permission.\n * - The set of caveats that are unique to the requested permission.\n *\n * Assumes that the caveat arrays of both permissions are valid.\n *\n * @param leftPermission - The left-hand permission.\n * @param rightPermission - The right-hand permission.\n * @returns The sets of caveat pairs and unique caveats.\n */\nexport function collectUniqueAndPairedCaveats(\n leftPermission: Partial<PermissionConstraint> | undefined,\n rightPermission: Partial<PermissionConstraint>,\n) {\n const leftCaveats = leftPermission?.caveats?.slice() ?? [];\n const rightCaveats = rightPermission.caveats?.slice() ?? [];\n const leftUniqueCaveats: CaveatConstraint[] = [];\n const caveatPairs: [CaveatConstraint, CaveatConstraint][] = [];\n\n leftCaveats.forEach((leftCaveat) => {\n const rightCaveatIndex = rightCaveats.findIndex(\n (rightCaveat) => rightCaveat.type === leftCaveat.type,\n );\n\n if (rightCaveatIndex === -1) {\n leftUniqueCaveats.push(leftCaveat);\n } else {\n caveatPairs.push([leftCaveat, rightCaveats[rightCaveatIndex]]);\n rightCaveats.splice(rightCaveatIndex, 1);\n }\n });\n\n return {\n caveatPairs,\n leftUniqueCaveats,\n rightUniqueCaveats: [...rightCaveats],\n };\n}\n"]}
|