@metamask/snaps-controllers 0.24.1 → 0.26.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/dist/cronjob/CronjobController.d.ts +3 -2
- package/dist/cronjob/CronjobController.js +37 -23
- package/dist/cronjob/CronjobController.js.map +1 -1
- package/dist/fsm.js +1 -1
- package/dist/fsm.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js.map +1 -1
- package/dist/multichain/MultiChainController.d.ts +3 -1
- package/dist/multichain/MultiChainController.js +8 -8
- package/dist/multichain/MultiChainController.js.map +1 -1
- package/dist/multichain/middleware.d.ts +1 -1
- package/dist/multichain/middleware.js +2 -2
- package/dist/multichain/middleware.js.map +1 -1
- package/dist/services/AbstractExecutionService.d.ts +3 -3
- package/dist/services/AbstractExecutionService.js +13 -12
- package/dist/services/AbstractExecutionService.js.map +1 -1
- package/dist/services/ExecutionService.d.ts +1 -1
- package/dist/services/ExecutionService.js.map +1 -1
- package/dist/services/iframe/IframeExecutionService.js +1 -1
- package/dist/services/iframe/IframeExecutionService.js.map +1 -1
- package/dist/services/iframe/test/server.js +6 -6
- package/dist/services/iframe/test/server.js.map +1 -1
- package/dist/services/node/NodeProcessExecutionService.d.ts +1 -1
- package/dist/services/node/NodeProcessExecutionService.js +2 -2
- package/dist/services/node/NodeProcessExecutionService.js.map +1 -1
- package/dist/services/node/NodeThreadExecutionService.d.ts +2 -2
- package/dist/services/node/NodeThreadExecutionService.js +5 -4
- package/dist/services/node/NodeThreadExecutionService.js.map +1 -1
- package/dist/snaps/SnapController.d.ts +37 -47
- package/dist/snaps/SnapController.js +306 -228
- package/dist/snaps/SnapController.js.map +1 -1
- package/dist/snaps/endowments/cronjob.d.ts +2 -2
- package/dist/snaps/endowments/cronjob.js +3 -3
- package/dist/snaps/endowments/cronjob.js.map +1 -1
- package/dist/snaps/endowments/enum.d.ts +2 -1
- package/dist/snaps/endowments/enum.js +1 -0
- package/dist/snaps/endowments/enum.js.map +1 -1
- package/dist/snaps/endowments/ethereum-provider.d.ts +1 -1
- package/dist/snaps/endowments/ethereum-provider.js +2 -2
- package/dist/snaps/endowments/ethereum-provider.js.map +1 -1
- package/dist/snaps/endowments/index.d.ts +33 -19
- package/dist/snaps/endowments/index.js +16 -4
- package/dist/snaps/endowments/index.js.map +1 -1
- package/dist/snaps/endowments/keyring.d.ts +1 -1
- package/dist/snaps/endowments/keyring.js +2 -2
- package/dist/snaps/endowments/keyring.js.map +1 -1
- package/dist/snaps/endowments/long-running.d.ts +1 -1
- package/dist/snaps/endowments/long-running.js +2 -2
- package/dist/snaps/endowments/long-running.js.map +1 -1
- package/dist/snaps/endowments/network-access.d.ts +1 -1
- package/dist/snaps/endowments/network-access.js +2 -2
- package/dist/snaps/endowments/network-access.js.map +1 -1
- package/dist/snaps/endowments/rpc.d.ts +35 -0
- package/dist/snaps/endowments/rpc.js +91 -0
- package/dist/snaps/endowments/rpc.js.map +1 -0
- package/dist/snaps/endowments/transaction-insight.d.ts +3 -3
- package/dist/snaps/endowments/transaction-insight.js +3 -3
- package/dist/snaps/endowments/transaction-insight.js.map +1 -1
- package/dist/snaps/index.d.ts +0 -1
- package/dist/snaps/index.js +0 -1
- package/dist/snaps/index.js.map +1 -1
- package/dist/snaps/location/http.d.ts +21 -0
- package/dist/snaps/location/http.js +71 -0
- package/dist/snaps/location/http.js.map +1 -0
- package/dist/snaps/location/index.d.ts +4 -0
- package/dist/snaps/{utils → location}/index.js +3 -1
- package/dist/snaps/location/index.js.map +1 -0
- package/dist/snaps/location/local.d.ts +10 -0
- package/dist/snaps/location/local.js +51 -0
- package/dist/snaps/location/local.js.map +1 -0
- package/dist/snaps/location/location.d.ts +32 -0
- package/dist/snaps/location/location.js +33 -0
- package/dist/snaps/location/location.js.map +1 -0
- package/dist/snaps/location/npm.d.ts +33 -0
- package/dist/snaps/location/npm.js +232 -0
- package/dist/snaps/location/npm.js.map +1 -0
- package/dist/utils.d.ts +10 -3
- package/dist/utils.js +17 -1
- package/dist/utils.js.map +1 -1
- package/package.json +25 -20
- package/dist/snaps/utils/index.d.ts +0 -2
- package/dist/snaps/utils/index.js.map +0 -1
- package/dist/snaps/utils/npm.d.ts +0 -14
- package/dist/snaps/utils/npm.js +0 -81
- package/dist/snaps/utils/npm.js.map +0 -1
- package/dist/snaps/utils/stream.d.ts +0 -30
- package/dist/snaps/utils/stream.js +0 -124
- package/dist/snaps/utils/stream.js.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cronjob.js","sourceRoot":"","sources":["../../../src/snaps/endowments/cronjob.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"cronjob.js","sourceRoot":"","sources":["../../../src/snaps/endowments/cronjob.ts"],"names":[],"mappings":";;;AAAA,2EAQyC;AACzC,uDAI+B;AAC/B,2CAMyB;AACzB,mDAA2C;AAE3C,iCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,OAAO,CAAC;AAS9C;;;;;GAKG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAqB,EAAE,EAAE;IAC5B,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,SAAS,EAAE,cAAc;QACzB,cAAc,EAAE,CAAC,4BAAc,CAAC,WAAW,CAAC;QAC5C,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,SAAS;KACvE,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC;IACnD,SAAS,EAAE,cAAc;IACzB,oBAAoB;CACZ,CAAC,CAAC;AAEZ;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,4BAAc,CAAC,WAAW;gBAChC,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAXD,wDAWC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,oBAAoB,CAClC,UAAiC;;IAEjC,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAA,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IAED,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACxC,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,WAAW,CAAC,CAAC;IAElE,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAqC,CAAC;IAEzE,OAAO,MAAC,MAAA,MAAM,CAAC,KAAK,0CAAE,IAA+B,mCAAI,IAAI,CAAC;AAChE,CAAC;AAbD,oDAaC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CAAC,MAA2B;IAC/D,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE;QACjE,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;YAChC,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;KACJ;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAEzB,IAAI,CAAC,IAAA,mBAAW,EAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE;QACxD,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;YAChC,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;KACJ;IAED,IAAI,CAAC,IAAA,yCAA2B,EAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAC5C,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;YAChC,OAAO,EAAE,+CAA+C;SACzD,CAAC,CAAC;KACJ;AACH,CAAC;AApBD,sDAoBC;AAED;;GAEG;AACU,QAAA,2BAA2B,GAGpC;IACF,CAAC,4BAAc,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC1C,IAAI,EAAE,4BAAc,CAAC,WAAW;QAChC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC;KACrD,CAAC;CACH,CAAC","sourcesContent":["import {\n PermissionSpecificationBuilder,\n PermissionType,\n EndowmentGetterParams,\n ValidPermissionSpecification,\n PermissionConstraint,\n Caveat,\n CaveatSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport {\n SnapCaveatType,\n CronjobSpecification,\n isCronjobSpecificationArray,\n} from '@metamask/snaps-utils';\nimport {\n assert,\n hasProperty,\n isPlainObject,\n Json,\n NonEmptyArray,\n} from '@metamask/utils';\nimport { ethErrors } from 'eth-rpc-errors';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Cronjob;\n\ntype CronjobEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetKey: typeof permissionName;\n endowmentGetter: (_options?: any) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the cronjob endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n CronjobEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetKey: permissionName,\n allowedCaveats: [SnapCaveatType.SnapCronjob],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n };\n};\n\nexport const cronjobEndowmentBuilder = Object.freeze({\n targetKey: permissionName,\n specificationBuilder,\n} as const);\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getCronjobCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n return {\n caveats: [\n {\n type: SnapCaveatType.SnapCronjob,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the cronjobs from a permission.\n *\n * This does basic validation of the caveat, but does not validate the type or\n * value of the namespaces object itself, as this is handled by the\n * `PermissionsController` when the permission is requested.\n *\n * @param permission - The permission to get the keyring namespaces from.\n * @returns The cronjobs, or `null` if the permission does not have a\n * cronjob caveat.\n */\nexport function getCronjobCaveatJobs(\n permission?: PermissionConstraint,\n): CronjobSpecification[] | null {\n if (!permission?.caveats) {\n return null;\n }\n\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.SnapCronjob);\n\n const caveat = permission.caveats[0] as Caveat<string, { jobs: Json[] }>;\n\n return (caveat.value?.jobs as CronjobSpecification[]) ?? null;\n}\n\n/**\n * Validate the cronjob specification values associated with a caveat.\n * This validates that the value is a non-empty array with valid\n * cronjob expression and request object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the value is invalid.\n */\nexport function validateCronjobCaveat(caveat: Caveat<string, any>) {\n if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n throw ethErrors.rpc.invalidParams({\n message: 'Expected a plain object.',\n });\n }\n\n const { value } = caveat;\n\n if (!hasProperty(value, 'jobs') || !isPlainObject(value)) {\n throw ethErrors.rpc.invalidParams({\n message: 'Expected a plain object.',\n });\n }\n\n if (!isCronjobSpecificationArray(value.jobs)) {\n throw ethErrors.rpc.invalidParams({\n message: 'Expected a valid cronjob specification array.',\n });\n }\n}\n\n/**\n * Caveat specification for the Cronjob.\n */\nexport const cronjobCaveatSpecifications: Record<\n SnapCaveatType.SnapCronjob,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.SnapCronjob]: Object.freeze({\n type: SnapCaveatType.SnapCronjob,\n validator: (caveat) => validateCronjobCaveat(caveat),\n }),\n};\n"]}
|
|
@@ -4,5 +4,6 @@ export declare enum SnapEndowments {
|
|
|
4
4
|
TransactionInsight = "endowment:transaction-insight",
|
|
5
5
|
Keyring = "endowment:keyring",
|
|
6
6
|
Cronjob = "endowment:cronjob",
|
|
7
|
-
EthereumProvider = "endowment:ethereum-provider"
|
|
7
|
+
EthereumProvider = "endowment:ethereum-provider",
|
|
8
|
+
Rpc = "endowment:rpc"
|
|
8
9
|
}
|
|
@@ -9,5 +9,6 @@ var SnapEndowments;
|
|
|
9
9
|
SnapEndowments["Keyring"] = "endowment:keyring";
|
|
10
10
|
SnapEndowments["Cronjob"] = "endowment:cronjob";
|
|
11
11
|
SnapEndowments["EthereumProvider"] = "endowment:ethereum-provider";
|
|
12
|
+
SnapEndowments["Rpc"] = "endowment:rpc";
|
|
12
13
|
})(SnapEndowments = exports.SnapEndowments || (exports.SnapEndowments = {}));
|
|
13
14
|
//# sourceMappingURL=enum.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../src/snaps/endowments/enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,
|
|
1
|
+
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../src/snaps/endowments/enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,4DAA0C,CAAA;IAC1C,wDAAsC,CAAA;IACtC,sEAAoD,CAAA;IACpD,+CAA6B,CAAA;IAC7B,+CAA6B,CAAA;IAC7B,kEAAgD,CAAA;IAChD,uCAAqB,CAAA;AACvB,CAAC,EARW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAQzB","sourcesContent":["export enum SnapEndowments {\n NetworkAccess = 'endowment:network-access',\n LongRunning = 'endowment:long-running',\n TransactionInsight = 'endowment:transaction-insight',\n Keyring = 'endowment:keyring',\n Cronjob = 'endowment:cronjob',\n EthereumProvider = 'endowment:ethereum-provider',\n Rpc = 'endowment:rpc',\n}\n"]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { PermissionSpecificationBuilder, PermissionType } from '@metamask/
|
|
1
|
+
import { PermissionSpecificationBuilder, PermissionType } from '@metamask/permission-controller';
|
|
2
2
|
import { SnapEndowments } from './enum';
|
|
3
3
|
declare const permissionName = SnapEndowments.EthereumProvider;
|
|
4
4
|
export declare const ethereumProviderEndowmentBuilder: Readonly<{
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ethereumProviderEndowmentBuilder = void 0;
|
|
4
|
-
const
|
|
4
|
+
const permission_controller_1 = require("@metamask/permission-controller");
|
|
5
5
|
const enum_1 = require("./enum");
|
|
6
6
|
const permissionName = enum_1.SnapEndowments.EthereumProvider;
|
|
7
7
|
/**
|
|
@@ -16,7 +16,7 @@ const permissionName = enum_1.SnapEndowments.EthereumProvider;
|
|
|
16
16
|
*/
|
|
17
17
|
const specificationBuilder = (_builderOptions) => {
|
|
18
18
|
return {
|
|
19
|
-
permissionType:
|
|
19
|
+
permissionType: permission_controller_1.PermissionType.Endowment,
|
|
20
20
|
targetKey: permissionName,
|
|
21
21
|
allowedCaveats: null,
|
|
22
22
|
endowmentGetter: (_getterOptions) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ethereum-provider.js","sourceRoot":"","sources":["../../../src/snaps/endowments/ethereum-provider.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"ethereum-provider.js","sourceRoot":"","sources":["../../../src/snaps/endowments/ethereum-provider.ts"],"names":[],"mappings":";;;AAAA,2EAKyC;AAEzC,iCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,gBAAgB,CAAC;AASvD;;;;;;;;;GASG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAqB,EAAE,EAAE;IAC5B,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,SAAS,EAAE,cAAc;QACzB,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE;YAC1D,OAAO,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,gCAAgC,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5D,SAAS,EAAE,cAAc;IACzB,oBAAoB;CACZ,CAAC,CAAC","sourcesContent":["import {\n EndowmentGetterParams,\n PermissionSpecificationBuilder,\n PermissionType,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.EthereumProvider;\n\ntype EthereumProviderEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetKey: typeof permissionName;\n endowmentGetter: (_options?: any) => ['ethereum'];\n allowedCaveats: null;\n}>;\n\n/**\n * `endowment:ethereum-provider` returns the name of the ethereum global browser API.\n * This is intended to populate the endowments of the\n * SES Compartment in which a Snap executes.\n *\n * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the network endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n EthereumProviderEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetKey: permissionName,\n allowedCaveats: null,\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n return ['ethereum'];\n },\n };\n};\n\nexport const ethereumProviderEndowmentBuilder = Object.freeze({\n targetKey: permissionName,\n specificationBuilder,\n} as const);\n"]}
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import { PermissionConstraint } from '@metamask/
|
|
1
|
+
import { PermissionConstraint } from '@metamask/permission-controller';
|
|
2
|
+
import { HandlerType } from '@metamask/snaps-utils';
|
|
2
3
|
import { Json } from '@metamask/utils';
|
|
3
4
|
export declare const endowmentPermissionBuilders: {
|
|
4
5
|
readonly "endowment:network-access": Readonly<{
|
|
5
6
|
readonly targetKey: import("./enum").SnapEndowments.NetworkAccess;
|
|
6
|
-
readonly specificationBuilder: import("@metamask/
|
|
7
|
-
permissionType: import("@metamask/
|
|
7
|
+
readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
|
|
8
|
+
permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
|
|
8
9
|
targetKey: import("./enum").SnapEndowments.NetworkAccess;
|
|
9
10
|
endowmentGetter: (_options?: any) => ["fetch", "WebSocket", "Request", "Headers", "Response"];
|
|
10
11
|
allowedCaveats: null;
|
|
@@ -12,8 +13,8 @@ export declare const endowmentPermissionBuilders: {
|
|
|
12
13
|
}>;
|
|
13
14
|
readonly "endowment:long-running": Readonly<{
|
|
14
15
|
readonly targetKey: import("./enum").SnapEndowments.LongRunning;
|
|
15
|
-
readonly specificationBuilder: import("@metamask/
|
|
16
|
-
permissionType: import("@metamask/
|
|
16
|
+
readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
|
|
17
|
+
permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
|
|
17
18
|
targetKey: import("./enum").SnapEndowments.LongRunning;
|
|
18
19
|
endowmentGetter: (_options?: any) => undefined;
|
|
19
20
|
allowedCaveats: null;
|
|
@@ -21,28 +22,28 @@ export declare const endowmentPermissionBuilders: {
|
|
|
21
22
|
}>;
|
|
22
23
|
readonly "endowment:transaction-insight": Readonly<{
|
|
23
24
|
readonly targetKey: import("./enum").SnapEndowments.TransactionInsight;
|
|
24
|
-
readonly specificationBuilder: import("@metamask/
|
|
25
|
-
permissionType: import("@metamask/
|
|
25
|
+
readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
|
|
26
|
+
permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
|
|
26
27
|
targetKey: import("./enum").SnapEndowments.TransactionInsight;
|
|
27
|
-
endowmentGetter: (_options?: import("@metamask/
|
|
28
|
+
endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
|
|
28
29
|
allowedCaveats: readonly [string, ...string[]] | null;
|
|
29
|
-
validator: import("@metamask/
|
|
30
|
+
validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
|
|
30
31
|
}>;
|
|
31
32
|
}>;
|
|
32
33
|
readonly "endowment:keyring": Readonly<{
|
|
33
34
|
readonly targetKey: import("./enum").SnapEndowments.Keyring;
|
|
34
|
-
readonly specificationBuilder: import("@metamask/
|
|
35
|
-
permissionType: import("@metamask/
|
|
35
|
+
readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, {}, {
|
|
36
|
+
permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
|
|
36
37
|
targetKey: import("./enum").SnapEndowments.Keyring;
|
|
37
38
|
endowmentGetter: (_options?: any) => undefined;
|
|
38
39
|
allowedCaveats: readonly [string, ...string[]] | null;
|
|
39
|
-
validator: import("@metamask/
|
|
40
|
+
validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
|
|
40
41
|
}>;
|
|
41
42
|
}>;
|
|
42
43
|
readonly "endowment:cronjob": Readonly<{
|
|
43
44
|
readonly targetKey: import("./enum").SnapEndowments.Cronjob;
|
|
44
|
-
readonly specificationBuilder: import("@metamask/
|
|
45
|
-
permissionType: import("@metamask/
|
|
45
|
+
readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
|
|
46
|
+
permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
|
|
46
47
|
targetKey: import("./enum").SnapEndowments.Cronjob;
|
|
47
48
|
endowmentGetter: (_options?: any) => undefined;
|
|
48
49
|
allowedCaveats: readonly [string, ...string[]] | null;
|
|
@@ -50,18 +51,31 @@ export declare const endowmentPermissionBuilders: {
|
|
|
50
51
|
}>;
|
|
51
52
|
readonly "endowment:ethereum-provider": Readonly<{
|
|
52
53
|
readonly targetKey: import("./enum").SnapEndowments.EthereumProvider;
|
|
53
|
-
readonly specificationBuilder: import("@metamask/
|
|
54
|
-
permissionType: import("@metamask/
|
|
54
|
+
readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
|
|
55
|
+
permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
|
|
55
56
|
targetKey: import("./enum").SnapEndowments.EthereumProvider;
|
|
56
57
|
endowmentGetter: (_options?: any) => ["ethereum"];
|
|
57
58
|
allowedCaveats: null;
|
|
58
59
|
}>;
|
|
59
60
|
}>;
|
|
61
|
+
readonly "endowment:rpc": Readonly<{
|
|
62
|
+
readonly targetKey: import("./enum").SnapEndowments.Rpc;
|
|
63
|
+
readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, {}, {
|
|
64
|
+
permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
|
|
65
|
+
targetKey: import("./enum").SnapEndowments.Rpc;
|
|
66
|
+
endowmentGetter: (_options?: any) => undefined;
|
|
67
|
+
allowedCaveats: readonly [string, ...string[]] | null;
|
|
68
|
+
validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
|
|
69
|
+
}>;
|
|
70
|
+
}>;
|
|
60
71
|
};
|
|
61
72
|
export declare const endowmentCaveatSpecifications: {
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
73
|
+
rpcOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
|
|
74
|
+
transactionOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
|
|
75
|
+
snapCronjob: import("@metamask/permission-controller").CaveatSpecificationConstraint;
|
|
76
|
+
snapKeyring: import("@metamask/permission-controller").CaveatSpecificationConstraint;
|
|
65
77
|
};
|
|
66
78
|
export declare const endowmentCaveatMappers: Record<string, (value: Json) => Pick<PermissionConstraint, 'caveats'>>;
|
|
79
|
+
export declare const handlerEndowments: Record<HandlerType, string>;
|
|
67
80
|
export * from './enum';
|
|
81
|
+
export { getTransactionOriginCaveat } from './transaction-insight';
|
|
@@ -14,13 +14,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
exports.endowmentCaveatMappers = exports.endowmentCaveatSpecifications = exports.endowmentPermissionBuilders = void 0;
|
|
17
|
+
exports.getTransactionOriginCaveat = exports.handlerEndowments = exports.endowmentCaveatMappers = exports.endowmentCaveatSpecifications = exports.endowmentPermissionBuilders = void 0;
|
|
18
|
+
const snaps_utils_1 = require("@metamask/snaps-utils");
|
|
18
19
|
const cronjob_1 = require("./cronjob");
|
|
20
|
+
const ethereum_provider_1 = require("./ethereum-provider");
|
|
21
|
+
const keyring_1 = require("./keyring");
|
|
19
22
|
const long_running_1 = require("./long-running");
|
|
20
23
|
const network_access_1 = require("./network-access");
|
|
24
|
+
const rpc_1 = require("./rpc");
|
|
21
25
|
const transaction_insight_1 = require("./transaction-insight");
|
|
22
|
-
const keyring_1 = require("./keyring");
|
|
23
|
-
const ethereum_provider_1 = require("./ethereum-provider");
|
|
24
26
|
exports.endowmentPermissionBuilders = {
|
|
25
27
|
[network_access_1.networkAccessEndowmentBuilder.targetKey]: network_access_1.networkAccessEndowmentBuilder,
|
|
26
28
|
[long_running_1.longRunningEndowmentBuilder.targetKey]: long_running_1.longRunningEndowmentBuilder,
|
|
@@ -28,12 +30,22 @@ exports.endowmentPermissionBuilders = {
|
|
|
28
30
|
[keyring_1.keyringEndowmentBuilder.targetKey]: keyring_1.keyringEndowmentBuilder,
|
|
29
31
|
[cronjob_1.cronjobEndowmentBuilder.targetKey]: cronjob_1.cronjobEndowmentBuilder,
|
|
30
32
|
[ethereum_provider_1.ethereumProviderEndowmentBuilder.targetKey]: ethereum_provider_1.ethereumProviderEndowmentBuilder,
|
|
33
|
+
[rpc_1.rpcEndowmentBuilder.targetKey]: rpc_1.rpcEndowmentBuilder,
|
|
31
34
|
};
|
|
32
|
-
exports.endowmentCaveatSpecifications = Object.assign(Object.assign(Object.assign({}, keyring_1.keyringCaveatSpecifications), cronjob_1.cronjobCaveatSpecifications), transaction_insight_1.transactionInsightCaveatSpecifications);
|
|
35
|
+
exports.endowmentCaveatSpecifications = Object.assign(Object.assign(Object.assign(Object.assign({}, keyring_1.keyringCaveatSpecifications), cronjob_1.cronjobCaveatSpecifications), transaction_insight_1.transactionInsightCaveatSpecifications), rpc_1.rpcCaveatSpecifications);
|
|
33
36
|
exports.endowmentCaveatMappers = {
|
|
34
37
|
[keyring_1.keyringEndowmentBuilder.targetKey]: keyring_1.getKeyringCaveatMapper,
|
|
35
38
|
[cronjob_1.cronjobEndowmentBuilder.targetKey]: cronjob_1.getCronjobCaveatMapper,
|
|
36
39
|
[transaction_insight_1.transactionInsightEndowmentBuilder.targetKey]: transaction_insight_1.getTransactionInsightCaveatMapper,
|
|
40
|
+
[rpc_1.rpcEndowmentBuilder.targetKey]: rpc_1.getRpcCaveatMapper,
|
|
41
|
+
};
|
|
42
|
+
exports.handlerEndowments = {
|
|
43
|
+
[snaps_utils_1.HandlerType.OnRpcRequest]: rpc_1.rpcEndowmentBuilder.targetKey,
|
|
44
|
+
[snaps_utils_1.HandlerType.SnapKeyring]: keyring_1.keyringEndowmentBuilder.targetKey,
|
|
45
|
+
[snaps_utils_1.HandlerType.OnTransaction]: transaction_insight_1.transactionInsightEndowmentBuilder.targetKey,
|
|
46
|
+
[snaps_utils_1.HandlerType.OnCronjob]: cronjob_1.cronjobEndowmentBuilder.targetKey,
|
|
37
47
|
};
|
|
38
48
|
__exportStar(require("./enum"), exports);
|
|
49
|
+
var transaction_insight_2 = require("./transaction-insight");
|
|
50
|
+
Object.defineProperty(exports, "getTransactionOriginCaveat", { enumerable: true, get: function () { return transaction_insight_2.getTransactionOriginCaveat; } });
|
|
39
51
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/snaps/endowments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/snaps/endowments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,uDAAoD;AAGpD,uCAImB;AACnB,2DAAuE;AACvE,uCAImB;AACnB,iDAA6D;AAC7D,qDAAiE;AACjE,+BAIe;AACf,+DAI+B;AAElB,QAAA,2BAA2B,GAAG;IACzC,CAAC,8CAA6B,CAAC,SAAS,CAAC,EAAE,8CAA6B;IACxE,CAAC,0CAA2B,CAAC,SAAS,CAAC,EAAE,0CAA2B;IACpE,CAAC,wDAAkC,CAAC,SAAS,CAAC,EAC5C,wDAAkC;IACpC,CAAC,iCAAuB,CAAC,SAAS,CAAC,EAAE,iCAAuB;IAC5D,CAAC,iCAAuB,CAAC,SAAS,CAAC,EAAE,iCAAuB;IAC5D,CAAC,oDAAgC,CAAC,SAAS,CAAC,EAC1C,oDAAgC;IAClC,CAAC,yBAAmB,CAAC,SAAS,CAAC,EAAE,yBAAmB;CAC5C,CAAC;AAEE,QAAA,6BAA6B,+DACrC,qCAA2B,GAC3B,qCAA2B,GAC3B,4DAAsC,GACtC,6BAAuB,EAC1B;AAEW,QAAA,sBAAsB,GAG/B;IACF,CAAC,iCAAuB,CAAC,SAAS,CAAC,EAAE,gCAAsB;IAC3D,CAAC,iCAAuB,CAAC,SAAS,CAAC,EAAE,gCAAsB;IAC3D,CAAC,wDAAkC,CAAC,SAAS,CAAC,EAC5C,uDAAiC;IACnC,CAAC,yBAAmB,CAAC,SAAS,CAAC,EAAE,wBAAkB;CACpD,CAAC;AAEW,QAAA,iBAAiB,GAAgC;IAC5D,CAAC,yBAAW,CAAC,YAAY,CAAC,EAAE,yBAAmB,CAAC,SAAS;IACzD,CAAC,yBAAW,CAAC,WAAW,CAAC,EAAE,iCAAuB,CAAC,SAAS;IAC5D,CAAC,yBAAW,CAAC,aAAa,CAAC,EAAE,wDAAkC,CAAC,SAAS;IACzE,CAAC,yBAAW,CAAC,SAAS,CAAC,EAAE,iCAAuB,CAAC,SAAS;CAC3D,CAAC;AAEF,yCAAuB;AACvB,6DAAmE;AAA1D,iIAAA,0BAA0B,OAAA","sourcesContent":["import { PermissionConstraint } from '@metamask/permission-controller';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport { Json } from '@metamask/utils';\n\nimport {\n cronjobCaveatSpecifications,\n cronjobEndowmentBuilder,\n getCronjobCaveatMapper,\n} from './cronjob';\nimport { ethereumProviderEndowmentBuilder } from './ethereum-provider';\nimport {\n keyringEndowmentBuilder,\n keyringCaveatSpecifications,\n getKeyringCaveatMapper,\n} from './keyring';\nimport { longRunningEndowmentBuilder } from './long-running';\nimport { networkAccessEndowmentBuilder } from './network-access';\nimport {\n getRpcCaveatMapper,\n rpcCaveatSpecifications,\n rpcEndowmentBuilder,\n} from './rpc';\nimport {\n getTransactionInsightCaveatMapper,\n transactionInsightCaveatSpecifications,\n transactionInsightEndowmentBuilder,\n} from './transaction-insight';\n\nexport const endowmentPermissionBuilders = {\n [networkAccessEndowmentBuilder.targetKey]: networkAccessEndowmentBuilder,\n [longRunningEndowmentBuilder.targetKey]: longRunningEndowmentBuilder,\n [transactionInsightEndowmentBuilder.targetKey]:\n transactionInsightEndowmentBuilder,\n [keyringEndowmentBuilder.targetKey]: keyringEndowmentBuilder,\n [cronjobEndowmentBuilder.targetKey]: cronjobEndowmentBuilder,\n [ethereumProviderEndowmentBuilder.targetKey]:\n ethereumProviderEndowmentBuilder,\n [rpcEndowmentBuilder.targetKey]: rpcEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n ...keyringCaveatSpecifications,\n ...cronjobCaveatSpecifications,\n ...transactionInsightCaveatSpecifications,\n ...rpcCaveatSpecifications,\n};\n\nexport const endowmentCaveatMappers: Record<\n string,\n (value: Json) => Pick<PermissionConstraint, 'caveats'>\n> = {\n [keyringEndowmentBuilder.targetKey]: getKeyringCaveatMapper,\n [cronjobEndowmentBuilder.targetKey]: getCronjobCaveatMapper,\n [transactionInsightEndowmentBuilder.targetKey]:\n getTransactionInsightCaveatMapper,\n [rpcEndowmentBuilder.targetKey]: getRpcCaveatMapper,\n};\n\nexport const handlerEndowments: Record<HandlerType, string> = {\n [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetKey,\n [HandlerType.SnapKeyring]: keyringEndowmentBuilder.targetKey,\n [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetKey,\n [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetKey,\n};\n\nexport * from './enum';\nexport { getTransactionOriginCaveat } from './transaction-insight';\n"]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
+
import { CaveatSpecificationConstraint, PermissionConstraint, PermissionSpecificationBuilder, PermissionType, PermissionValidatorConstraint } from '@metamask/permission-controller';
|
|
1
2
|
import { Namespaces, SnapCaveatType } from '@metamask/snaps-utils';
|
|
2
|
-
import { CaveatSpecificationConstraint, PermissionConstraint, PermissionSpecificationBuilder, PermissionType, PermissionValidatorConstraint } from '@metamask/controllers';
|
|
3
3
|
import { Json, NonEmptyArray } from '@metamask/utils';
|
|
4
4
|
import { SnapEndowments } from './enum';
|
|
5
5
|
declare const targetKey = SnapEndowments.Keyring;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.keyringCaveatSpecifications = exports.getKeyringCaveatNamespaces = exports.getKeyringCaveatMapper = exports.keyringEndowmentBuilder = void 0;
|
|
4
|
+
const permission_controller_1 = require("@metamask/permission-controller");
|
|
4
5
|
const snaps_utils_1 = require("@metamask/snaps-utils");
|
|
5
|
-
const controllers_1 = require("@metamask/controllers");
|
|
6
6
|
const utils_1 = require("@metamask/utils");
|
|
7
7
|
const eth_rpc_errors_1 = require("eth-rpc-errors");
|
|
8
8
|
const enum_1 = require("./enum");
|
|
@@ -14,7 +14,7 @@ const targetKey = enum_1.SnapEndowments.Keyring;
|
|
|
14
14
|
*/
|
|
15
15
|
const specificationBuilder = () => {
|
|
16
16
|
return {
|
|
17
|
-
permissionType:
|
|
17
|
+
permissionType: permission_controller_1.PermissionType.Endowment,
|
|
18
18
|
targetKey,
|
|
19
19
|
allowedCaveats: [snaps_utils_1.SnapCaveatType.SnapKeyring],
|
|
20
20
|
endowmentGetter: (_getterOptions) => undefined,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keyring.js","sourceRoot":"","sources":["../../../src/snaps/endowments/keyring.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"keyring.js","sourceRoot":"","sources":["../../../src/snaps/endowments/keyring.ts"],"names":[],"mappings":";;;AAAA,2EASyC;AACzC,uDAI+B;AAC/B,2CAMyB;AACzB,mDAA2C;AAE3C,iCAAwC;AAExC,MAAM,SAAS,GAAG,qBAAc,CAAC,OAAO,CAAC;AAczC;;;;GAIG;AACH,MAAM,oBAAoB,GAItB,GAAyB,EAAE;IAC7B,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,SAAS;QACT,cAAc,EAAE,CAAC,4BAAc,CAAC,WAAW,CAAC;QAC5C,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,SAAS;QACtE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IACE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,MAAK,CAAC;gBACrB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,WAAW,EAC9C;gBACA,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;oBAChC,OAAO,EAAE,sBAAsB,4BAAc,CAAC,WAAW,WAAW;iBACrE,CAAC,CAAC;aACJ;QACH,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC;IACnD,SAAS;IACT,oBAAoB;CACZ,CAAC,CAAC;AAEZ;;;;;;GAMG;AACH,SAAS,uBAAuB,CAAC,MAA2B;IAC1D,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE;QACjE,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;YAChC,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;KACJ;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAEzB,IAAI,CAAC,IAAA,mBAAW,EAAC,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE;QAC9D,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;YAChC,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;KACJ;IAED,IAAA,sCAAwB,EAAC,KAAK,CAAC,UAAU,EAAE,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,4BAAc,CAAC,WAAW;gBAChC,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAXD,wDAWC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,0BAA0B,CACxC,UAAiC;;IAEjC,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAA,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IAED,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACxC,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,WAAW,CAAC,CAAC;IAElE,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAGlC,CAAC;IAEF,OAAO,MAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,UAAU,mCAAI,IAAI,CAAC;AAC1C,CAAC;AAhBD,gEAgBC;AAEY,QAAA,2BAA2B,GAGpC;IACF,CAAC,4BAAc,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC1C,IAAI,EAAE,4BAAc,CAAC,WAAW;QAChC,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,uBAAuB,CAAC,MAAM,CAAC;KAC5E,CAAC;CACH,CAAC","sourcesContent":["import {\n Caveat,\n CaveatSpecificationConstraint,\n EndowmentGetterParams,\n PermissionConstraint,\n PermissionSpecificationBuilder,\n PermissionType,\n PermissionValidatorConstraint,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport {\n assertIsNamespacesObject,\n Namespaces,\n SnapCaveatType,\n} from '@metamask/snaps-utils';\nimport {\n hasProperty,\n isPlainObject,\n Json,\n NonEmptyArray,\n assert,\n} from '@metamask/utils';\nimport { ethErrors } from 'eth-rpc-errors';\n\nimport { SnapEndowments } from './enum';\n\nconst targetKey = SnapEndowments.Keyring;\n\ntype KeyringSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetKey: typeof targetKey;\n endowmentGetter: (_options?: any) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n validator: PermissionValidatorConstraint;\n}>;\n\ntype KeyringSpecificationBuilderOptions = {\n // Empty for now.\n};\n\n/**\n * The specification builder for the keyring endowment permission.\n *\n * @returns The specification for the keyring endowment permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n KeyringSpecificationBuilderOptions,\n KeyringSpecification\n> = (): KeyringSpecification => {\n return {\n permissionType: PermissionType.Endowment,\n targetKey,\n allowedCaveats: [SnapCaveatType.SnapKeyring],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n validator: ({ caveats }) => {\n if (\n caveats?.length !== 1 ||\n caveats[0].type !== SnapCaveatType.SnapKeyring\n ) {\n throw ethErrors.rpc.invalidParams({\n message: `Expected a single \"${SnapCaveatType.SnapKeyring}\" caveat.`,\n });\n }\n },\n };\n};\n\nexport const keyringEndowmentBuilder = Object.freeze({\n targetKey,\n specificationBuilder,\n} as const);\n\n/**\n * Validate the namespaces value of a caveat. This does not validate the type or\n * value of the caveat itself, only the value of the namespaces object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatNamespace(caveat: Caveat<string, any>): void {\n if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n throw ethErrors.rpc.invalidParams({\n message: 'Expected a plain object.',\n });\n }\n\n const { value } = caveat;\n\n if (!hasProperty(value, 'namespaces') || !isPlainObject(value)) {\n throw ethErrors.rpc.invalidParams({\n message: 'Expected a plain object.',\n });\n }\n\n assertIsNamespacesObject(value.namespaces, ethErrors.rpc.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getKeyringCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n return {\n caveats: [\n {\n type: SnapCaveatType.SnapKeyring,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the keyring namespaces from a permission.\n *\n * This does basic validation of the caveat, but does not validate the type or\n * value of the namespaces object itself, as this is handled by the\n * `PermissionsController` when the permission is requested.\n *\n * @param permission - The permission to get the keyring namespaces from.\n * @returns The keyring namespaces, or `null` if the permission does not have a\n * keyring caveat.\n */\nexport function getKeyringCaveatNamespaces(\n permission?: PermissionConstraint,\n): Namespaces | null {\n if (!permission?.caveats) {\n return null;\n }\n\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.SnapKeyring);\n\n const caveat = permission.caveats[0] as Caveat<\n string,\n { namespaces: Namespaces }\n >;\n\n return caveat.value?.namespaces ?? null;\n}\n\nexport const keyringCaveatSpecifications: Record<\n SnapCaveatType.SnapKeyring,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.SnapKeyring]: Object.freeze({\n type: SnapCaveatType.SnapKeyring,\n validator: (caveat: Caveat<string, any>) => validateCaveatNamespace(caveat),\n }),\n};\n"]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { PermissionSpecificationBuilder, PermissionType } from '@metamask/
|
|
1
|
+
import { PermissionSpecificationBuilder, PermissionType } from '@metamask/permission-controller';
|
|
2
2
|
import { SnapEndowments } from './enum';
|
|
3
3
|
declare const permissionName = SnapEndowments.LongRunning;
|
|
4
4
|
export declare const longRunningEndowmentBuilder: Readonly<{
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.longRunningEndowmentBuilder = void 0;
|
|
4
|
-
const
|
|
4
|
+
const permission_controller_1 = require("@metamask/permission-controller");
|
|
5
5
|
const enum_1 = require("./enum");
|
|
6
6
|
const permissionName = enum_1.SnapEndowments.LongRunning;
|
|
7
7
|
/**
|
|
@@ -15,7 +15,7 @@ const permissionName = enum_1.SnapEndowments.LongRunning;
|
|
|
15
15
|
*/
|
|
16
16
|
const specificationBuilder = (_builderOptions) => {
|
|
17
17
|
return {
|
|
18
|
-
permissionType:
|
|
18
|
+
permissionType: permission_controller_1.PermissionType.Endowment,
|
|
19
19
|
targetKey: permissionName,
|
|
20
20
|
allowedCaveats: null,
|
|
21
21
|
endowmentGetter: (_getterOptions) => undefined,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"long-running.js","sourceRoot":"","sources":["../../../src/snaps/endowments/long-running.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"long-running.js","sourceRoot":"","sources":["../../../src/snaps/endowments/long-running.ts"],"names":[],"mappings":";;;AAAA,2EAKyC;AAEzC,iCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,WAAW,CAAC;AASlD;;;;;;;;GAQG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAqB,EAAE,EAAE;IAC5B,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,SAAS,EAAE,cAAc;QACzB,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,SAAS;KACvE,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,2BAA2B,GAAG,MAAM,CAAC,MAAM,CAAC;IACvD,SAAS,EAAE,cAAc;IACzB,oBAAoB;CACZ,CAAC,CAAC","sourcesContent":["import {\n PermissionSpecificationBuilder,\n PermissionType,\n EndowmentGetterParams,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.LongRunning;\n\ntype LongRunningEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetKey: typeof permissionName;\n endowmentGetter: (_options?: any) => undefined;\n allowedCaveats: null;\n}>;\n\n/**\n * `endowment:long-running` returns nothing; it is intended to be used as a flag\n * by the `SnapController` to make it ignore the request processing timeout\n * during snap lifecycle management. Essentially, it allows a snap to take an\n * infinite amount of time to process a request.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the long-running endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n LongRunningEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetKey: permissionName,\n allowedCaveats: null,\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n };\n};\n\nexport const longRunningEndowmentBuilder = Object.freeze({\n targetKey: permissionName,\n specificationBuilder,\n} as const);\n"]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { PermissionSpecificationBuilder, PermissionType } from '@metamask/
|
|
1
|
+
import { PermissionSpecificationBuilder, PermissionType } from '@metamask/permission-controller';
|
|
2
2
|
import { SnapEndowments } from './enum';
|
|
3
3
|
declare const permissionName = SnapEndowments.NetworkAccess;
|
|
4
4
|
export declare const networkAccessEndowmentBuilder: Readonly<{
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.networkAccessEndowmentBuilder = void 0;
|
|
4
|
-
const
|
|
4
|
+
const permission_controller_1 = require("@metamask/permission-controller");
|
|
5
5
|
const enum_1 = require("./enum");
|
|
6
6
|
const permissionName = enum_1.SnapEndowments.NetworkAccess;
|
|
7
7
|
/**
|
|
@@ -14,7 +14,7 @@ const permissionName = enum_1.SnapEndowments.NetworkAccess;
|
|
|
14
14
|
*/
|
|
15
15
|
const specificationBuilder = (_builderOptions) => {
|
|
16
16
|
return {
|
|
17
|
-
permissionType:
|
|
17
|
+
permissionType: permission_controller_1.PermissionType.Endowment,
|
|
18
18
|
targetKey: permissionName,
|
|
19
19
|
allowedCaveats: null,
|
|
20
20
|
endowmentGetter: (_getterOptions) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"network-access.js","sourceRoot":"","sources":["../../../src/snaps/endowments/network-access.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"network-access.js","sourceRoot":"","sources":["../../../src/snaps/endowments/network-access.ts"],"names":[],"mappings":";;;AAAA,2EAKyC;AAEzC,iCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,aAAa,CAAC;AAWpD;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAqB,EAAE,EAAE;IAC5B,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,SAAS,EAAE,cAAc;QACzB,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE;YAC1D,OAAO,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAClE,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,6BAA6B,GAAG,MAAM,CAAC,MAAM,CAAC;IACzD,SAAS,EAAE,cAAc;IACzB,oBAAoB;CACZ,CAAC,CAAC","sourcesContent":["import {\n EndowmentGetterParams,\n PermissionSpecificationBuilder,\n PermissionType,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.NetworkAccess;\n\ntype NetworkAccessEndowmentSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetKey: typeof permissionName;\n endowmentGetter: (\n _options?: any,\n ) => ['fetch', 'WebSocket', 'Request', 'Headers', 'Response'];\n allowedCaveats: null;\n}>;\n\n/**\n * `endowment:network-access` returns the name of global browser API(s) that\n * enable network access. This is intended to populate the endowments of the\n * SES Compartment in which a Snap executes.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the network endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n any,\n NetworkAccessEndowmentSpecification\n> = (_builderOptions?: any) => {\n return {\n permissionType: PermissionType.Endowment,\n targetKey: permissionName,\n allowedCaveats: null,\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n return ['fetch', 'WebSocket', 'Request', 'Headers', 'Response'];\n },\n };\n};\n\nexport const networkAccessEndowmentBuilder = Object.freeze({\n targetKey: permissionName,\n specificationBuilder,\n} as const);\n"]}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { CaveatSpecificationConstraint, PermissionConstraint, PermissionSpecificationBuilder, PermissionType, PermissionValidatorConstraint } from '@metamask/permission-controller';
|
|
2
|
+
import { RpcOrigins, SnapCaveatType } from '@metamask/snaps-utils';
|
|
3
|
+
import { Json, NonEmptyArray } from '@metamask/utils';
|
|
4
|
+
import { SnapEndowments } from './enum';
|
|
5
|
+
declare const targetKey = SnapEndowments.Rpc;
|
|
6
|
+
declare type RpcSpecificationBuilderOptions = {};
|
|
7
|
+
export declare const rpcEndowmentBuilder: Readonly<{
|
|
8
|
+
readonly targetKey: SnapEndowments.Rpc;
|
|
9
|
+
readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, RpcSpecificationBuilderOptions, {
|
|
10
|
+
permissionType: PermissionType.Endowment;
|
|
11
|
+
targetKey: typeof targetKey;
|
|
12
|
+
endowmentGetter: (_options?: any) => undefined;
|
|
13
|
+
allowedCaveats: Readonly<NonEmptyArray<string>> | null;
|
|
14
|
+
validator: PermissionValidatorConstraint;
|
|
15
|
+
}>;
|
|
16
|
+
}>;
|
|
17
|
+
/**
|
|
18
|
+
* Map a raw value from the `initialPermissions` to a caveat specification.
|
|
19
|
+
* Note that this function does not do any validation, that's handled by the
|
|
20
|
+
* PermissionsController when the permission is requested.
|
|
21
|
+
*
|
|
22
|
+
* @param value - The raw value from the `initialPermissions`.
|
|
23
|
+
* @returns The caveat specification.
|
|
24
|
+
*/
|
|
25
|
+
export declare function getRpcCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
|
|
26
|
+
/**
|
|
27
|
+
* Getter function to get the {@link RpcOrigins} caveat value from a permission.
|
|
28
|
+
*
|
|
29
|
+
* @param permission - The permission to get the caveat value from.
|
|
30
|
+
* @returns The caveat value.
|
|
31
|
+
* @throws If the permission does not have a valid {@link RpcOrigins} caveat.
|
|
32
|
+
*/
|
|
33
|
+
export declare function getRpcCaveatOrigins(permission?: PermissionConstraint): RpcOrigins | null;
|
|
34
|
+
export declare const rpcCaveatSpecifications: Record<SnapCaveatType.RpcOrigin, CaveatSpecificationConstraint>;
|
|
35
|
+
export {};
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.rpcCaveatSpecifications = exports.getRpcCaveatOrigins = exports.getRpcCaveatMapper = exports.rpcEndowmentBuilder = void 0;
|
|
4
|
+
const permission_controller_1 = require("@metamask/permission-controller");
|
|
5
|
+
const snaps_utils_1 = require("@metamask/snaps-utils");
|
|
6
|
+
const utils_1 = require("@metamask/utils");
|
|
7
|
+
const eth_rpc_errors_1 = require("eth-rpc-errors");
|
|
8
|
+
const enum_1 = require("./enum");
|
|
9
|
+
const targetKey = enum_1.SnapEndowments.Rpc;
|
|
10
|
+
/**
|
|
11
|
+
* The specification builder for the JSON-RPC endowment permission.
|
|
12
|
+
*
|
|
13
|
+
* @returns The specification for the JSON-RPC endowment permission.
|
|
14
|
+
*/
|
|
15
|
+
const specificationBuilder = () => {
|
|
16
|
+
return {
|
|
17
|
+
permissionType: permission_controller_1.PermissionType.Endowment,
|
|
18
|
+
targetKey,
|
|
19
|
+
allowedCaveats: [snaps_utils_1.SnapCaveatType.RpcOrigin],
|
|
20
|
+
endowmentGetter: (_getterOptions) => undefined,
|
|
21
|
+
validator: ({ caveats }) => {
|
|
22
|
+
if ((caveats === null || caveats === void 0 ? void 0 : caveats.length) !== 1 ||
|
|
23
|
+
caveats[0].type !== snaps_utils_1.SnapCaveatType.RpcOrigin) {
|
|
24
|
+
throw eth_rpc_errors_1.ethErrors.rpc.invalidParams({
|
|
25
|
+
message: `Expected a single "${snaps_utils_1.SnapCaveatType.RpcOrigin}" caveat.`,
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
exports.rpcEndowmentBuilder = Object.freeze({
|
|
32
|
+
targetKey,
|
|
33
|
+
specificationBuilder,
|
|
34
|
+
});
|
|
35
|
+
/**
|
|
36
|
+
* Validate the value of a caveat. This does not validate the type of the
|
|
37
|
+
* caveat itself, only the value of the caveat.
|
|
38
|
+
*
|
|
39
|
+
* @param caveat - The caveat to validate.
|
|
40
|
+
* @throws If the caveat value is invalid.
|
|
41
|
+
*/
|
|
42
|
+
function validateCaveatOrigins(caveat) {
|
|
43
|
+
if (!(0, utils_1.hasProperty)(caveat, 'value') || !(0, utils_1.isPlainObject)(caveat.value)) {
|
|
44
|
+
throw eth_rpc_errors_1.ethErrors.rpc.invalidParams({
|
|
45
|
+
message: 'Invalid JSON-RPC origins: Expected a plain object.',
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
const { value } = caveat;
|
|
49
|
+
(0, snaps_utils_1.assertIsRpcOrigins)(value, eth_rpc_errors_1.ethErrors.rpc.invalidParams);
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Map a raw value from the `initialPermissions` to a caveat specification.
|
|
53
|
+
* Note that this function does not do any validation, that's handled by the
|
|
54
|
+
* PermissionsController when the permission is requested.
|
|
55
|
+
*
|
|
56
|
+
* @param value - The raw value from the `initialPermissions`.
|
|
57
|
+
* @returns The caveat specification.
|
|
58
|
+
*/
|
|
59
|
+
function getRpcCaveatMapper(value) {
|
|
60
|
+
return {
|
|
61
|
+
caveats: [
|
|
62
|
+
{
|
|
63
|
+
type: snaps_utils_1.SnapCaveatType.RpcOrigin,
|
|
64
|
+
value,
|
|
65
|
+
},
|
|
66
|
+
],
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
exports.getRpcCaveatMapper = getRpcCaveatMapper;
|
|
70
|
+
/**
|
|
71
|
+
* Getter function to get the {@link RpcOrigins} caveat value from a permission.
|
|
72
|
+
*
|
|
73
|
+
* @param permission - The permission to get the caveat value from.
|
|
74
|
+
* @returns The caveat value.
|
|
75
|
+
* @throws If the permission does not have a valid {@link RpcOrigins} caveat.
|
|
76
|
+
*/
|
|
77
|
+
function getRpcCaveatOrigins(permission) {
|
|
78
|
+
(0, utils_1.assert)(permission === null || permission === void 0 ? void 0 : permission.caveats);
|
|
79
|
+
(0, utils_1.assert)(permission.caveats.length === 1);
|
|
80
|
+
(0, utils_1.assert)(permission.caveats[0].type === snaps_utils_1.SnapCaveatType.RpcOrigin);
|
|
81
|
+
const caveat = permission.caveats[0];
|
|
82
|
+
return caveat.value;
|
|
83
|
+
}
|
|
84
|
+
exports.getRpcCaveatOrigins = getRpcCaveatOrigins;
|
|
85
|
+
exports.rpcCaveatSpecifications = {
|
|
86
|
+
[snaps_utils_1.SnapCaveatType.RpcOrigin]: Object.freeze({
|
|
87
|
+
type: snaps_utils_1.SnapCaveatType.RpcOrigin,
|
|
88
|
+
validator: (caveat) => validateCaveatOrigins(caveat),
|
|
89
|
+
}),
|
|
90
|
+
};
|
|
91
|
+
//# sourceMappingURL=rpc.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rpc.js","sourceRoot":"","sources":["../../../src/snaps/endowments/rpc.ts"],"names":[],"mappings":";;;AAAA,2EASyC;AACzC,uDAI+B;AAC/B,2CAMyB;AACzB,mDAA2C;AAE3C,iCAAwC;AAExC,MAAM,SAAS,GAAG,qBAAc,CAAC,GAAG,CAAC;AAcrC;;;;GAIG;AACH,MAAM,oBAAoB,GAItB,GAAqB,EAAE;IACzB,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,SAAS;QACT,cAAc,EAAE,CAAC,4BAAc,CAAC,SAAS,CAAC;QAC1C,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,SAAS;QACtE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IACE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,MAAK,CAAC;gBACrB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,SAAS,EAC5C;gBACA,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;oBAChC,OAAO,EAAE,sBAAsB,4BAAc,CAAC,SAAS,WAAW;iBACnE,CAAC,CAAC;aACJ;QACH,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,SAAS;IACT,oBAAoB;CACZ,CAAC,CAAC;AAEZ;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,MAA2B;IACxD,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE;QACjE,MAAM,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC;YAChC,OAAO,EAAE,oDAAoD;SAC9D,CAAC,CAAC;KACJ;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,IAAA,gCAAkB,EAAC,KAAK,EAAE,0BAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,4BAAc,CAAC,SAAS;gBAC9B,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAXD,gDAWC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,UAAiC;IAEjC,IAAA,cAAM,EAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAC,CAAC;IAC5B,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACxC,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,SAAS,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAA+B,CAAC;IACnE,OAAO,MAAM,CAAC,KAAK,CAAC;AACtB,CAAC;AATD,kDASC;AAEY,QAAA,uBAAuB,GAGhC;IACF,CAAC,4BAAc,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACxC,IAAI,EAAE,4BAAc,CAAC,SAAS;QAC9B,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC;KAC1E,CAAC;CACH,CAAC","sourcesContent":["import {\n Caveat,\n CaveatSpecificationConstraint,\n EndowmentGetterParams,\n PermissionConstraint,\n PermissionSpecificationBuilder,\n PermissionType,\n PermissionValidatorConstraint,\n ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport {\n assertIsRpcOrigins,\n RpcOrigins,\n SnapCaveatType,\n} from '@metamask/snaps-utils';\nimport {\n hasProperty,\n isPlainObject,\n Json,\n NonEmptyArray,\n assert,\n} from '@metamask/utils';\nimport { ethErrors } from 'eth-rpc-errors';\n\nimport { SnapEndowments } from './enum';\n\nconst targetKey = SnapEndowments.Rpc;\n\ntype RpcSpecification = ValidPermissionSpecification<{\n permissionType: PermissionType.Endowment;\n targetKey: typeof targetKey;\n endowmentGetter: (_options?: any) => undefined;\n allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n validator: PermissionValidatorConstraint;\n}>;\n\ntype RpcSpecificationBuilderOptions = {\n // Empty for now.\n};\n\n/**\n * The specification builder for the JSON-RPC endowment permission.\n *\n * @returns The specification for the JSON-RPC endowment permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n PermissionType.Endowment,\n RpcSpecificationBuilderOptions,\n RpcSpecification\n> = (): RpcSpecification => {\n return {\n permissionType: PermissionType.Endowment,\n targetKey,\n allowedCaveats: [SnapCaveatType.RpcOrigin],\n endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n validator: ({ caveats }) => {\n if (\n caveats?.length !== 1 ||\n caveats[0].type !== SnapCaveatType.RpcOrigin\n ) {\n throw ethErrors.rpc.invalidParams({\n message: `Expected a single \"${SnapCaveatType.RpcOrigin}\" caveat.`,\n });\n }\n },\n };\n};\n\nexport const rpcEndowmentBuilder = Object.freeze({\n targetKey,\n specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n throw ethErrors.rpc.invalidParams({\n message: 'Invalid JSON-RPC origins: Expected a plain object.',\n });\n }\n\n const { value } = caveat;\n assertIsRpcOrigins(value, ethErrors.rpc.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getRpcCaveatMapper(\n value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n return {\n caveats: [\n {\n type: SnapCaveatType.RpcOrigin,\n value,\n },\n ],\n };\n}\n\n/**\n * Getter function to get the {@link RpcOrigins} caveat value from a permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link RpcOrigins} caveat.\n */\nexport function getRpcCaveatOrigins(\n permission?: PermissionConstraint,\n): RpcOrigins | null {\n assert(permission?.caveats);\n assert(permission.caveats.length === 1);\n assert(permission.caveats[0].type === SnapCaveatType.RpcOrigin);\n\n const caveat = permission.caveats[0] as Caveat<string, RpcOrigins>;\n return caveat.value;\n}\n\nexport const rpcCaveatSpecifications: Record<\n SnapCaveatType.RpcOrigin,\n CaveatSpecificationConstraint\n> = {\n [SnapCaveatType.RpcOrigin]: Object.freeze({\n type: SnapCaveatType.RpcOrigin,\n validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n }),\n};\n"]}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { PermissionSpecificationBuilder, PermissionType, EndowmentGetterParams, PermissionValidatorConstraint, PermissionConstraint, CaveatSpecificationConstraint } from '@metamask/
|
|
2
|
-
import { Json, NonEmptyArray } from '@metamask/utils';
|
|
1
|
+
import { PermissionSpecificationBuilder, PermissionType, EndowmentGetterParams, PermissionValidatorConstraint, PermissionConstraint, CaveatSpecificationConstraint } from '@metamask/permission-controller';
|
|
3
2
|
import { SnapCaveatType } from '@metamask/snaps-utils';
|
|
3
|
+
import { Json, NonEmptyArray } from '@metamask/utils';
|
|
4
4
|
import { SnapEndowments } from './enum';
|
|
5
5
|
declare const permissionName = SnapEndowments.TransactionInsight;
|
|
6
6
|
export declare const transactionInsightEndowmentBuilder: Readonly<{
|
|
@@ -8,7 +8,7 @@ export declare const transactionInsightEndowmentBuilder: Readonly<{
|
|
|
8
8
|
readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
|
|
9
9
|
permissionType: PermissionType.Endowment;
|
|
10
10
|
targetKey: typeof permissionName;
|
|
11
|
-
endowmentGetter: (_options?: EndowmentGetterParams
|
|
11
|
+
endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
|
|
12
12
|
allowedCaveats: Readonly<NonEmptyArray<string>> | null;
|
|
13
13
|
validator: PermissionValidatorConstraint;
|
|
14
14
|
}>;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.transactionInsightCaveatSpecifications = exports.getTransactionOriginCaveat = exports.getTransactionInsightCaveatMapper = exports.transactionInsightEndowmentBuilder = void 0;
|
|
4
|
-
const
|
|
5
|
-
const utils_1 = require("@metamask/utils");
|
|
4
|
+
const permission_controller_1 = require("@metamask/permission-controller");
|
|
6
5
|
const snaps_utils_1 = require("@metamask/snaps-utils");
|
|
6
|
+
const utils_1 = require("@metamask/utils");
|
|
7
7
|
const eth_rpc_errors_1 = require("eth-rpc-errors");
|
|
8
8
|
const enum_1 = require("./enum");
|
|
9
9
|
const permissionName = enum_1.SnapEndowments.TransactionInsight;
|
|
@@ -16,7 +16,7 @@ const permissionName = enum_1.SnapEndowments.TransactionInsight;
|
|
|
16
16
|
*/
|
|
17
17
|
const specificationBuilder = (_builderOptions) => {
|
|
18
18
|
return {
|
|
19
|
-
permissionType:
|
|
19
|
+
permissionType: permission_controller_1.PermissionType.Endowment,
|
|
20
20
|
targetKey: permissionName,
|
|
21
21
|
allowedCaveats: [snaps_utils_1.SnapCaveatType.TransactionOrigin],
|
|
22
22
|
endowmentGetter: (_getterOptions) => undefined,
|