Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
diff --git a/dist/types/restricted/getLocale.d.ts b/dist/types/restricted/getLocale.d.ts
index 2941d2733042664c341776c7bc840ba0813994ca..0188bbd4de0cd013159a36b736ad9baf94c18c92 100644
--- a/dist/types/restricted/getLocale.d.ts
+++ b/dist/types/restricted/getLocale.d.ts
@@ -1,6 +1,6 @@
import type { PermissionSpecificationBuilder, ValidPermissionSpecification, RestrictedMethodOptions } from '@metamask/permission-controller';
import { PermissionType } from '@metamask/permission-controller';
-import type { NonEmptyArray } from '@metamask/utils';
+import type { Json, NonEmptyArray } from '@metamask/utils';
import type { MethodHooksObject } from '../utils';
declare const methodName = "snap_getLocale";
export declare type GetLocaleMethodHooks = {
@@ -43,5 +43,5 @@ export declare const getLocaleBuilder: Readonly<{
* @param hooks.getLocale - A function that returns the user selected locale.
* @returns The user selected locale.
*/
-export declare function getImplementation({ getLocale }: GetLocaleMethodHooks): (_args: RestrictedMethodOptions<void>) => Promise<string>;
+export declare function getImplementation({ getLocale }: GetLocaleMethodHooks): (_args: RestrictedMethodOptions<Record<string, Json> | Json[]>) => Promise<string>;
export {};
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@
"simple-git-hooks": {
"pre-push": "yarn lint"
},
"resolutions": {
"@metamask/rpc-methods@^0.38.1-flask.1": "patch:@metamask/rpc-methods@npm%3A0.38.1-flask.1#./.yarn/patches/@metamask-rpc-methods-npm-0.38.1-flask.1-081e1eb5b3.patch",
"@metamask/rpc-methods@^1.0.1": "patch:@metamask/rpc-methods@npm%3A0.38.1-flask.1#./.yarn/patches/@metamask-rpc-methods-npm-0.38.1-flask.1-081e1eb5b3.patch"
},
"devDependencies": {
"@lavamoat/allow-scripts": "^2.3.1",
"@metamask/create-release-branch": "^1.1.0",
Expand All @@ -40,7 +44,7 @@
"@metamask/eslint-config-nodejs": "^12.0.0",
"@metamask/eslint-config-typescript": "^12.0.0",
"@metamask/eth-json-rpc-provider": "^1.0.0",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"@types/node": "^16.18.24",
"@typescript-eslint/eslint-plugin": "^5.30.7",
"@typescript-eslint/parser": "^5.30.7",
Expand Down
2 changes: 1 addition & 1 deletion packages/accounts-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@metamask/eth-snap-keyring": "^0.2.2",
"@metamask/keyring-api": "^0.2.5",
"@metamask/snaps-utils": "^1.0.1",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"deepmerge": "^4.2.2",
"eth-rpc-errors": "^4.0.2",
"ethereumjs-util": "^7.0.10",
Expand Down
2 changes: 1 addition & 1 deletion packages/address-book-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"dependencies": {
"@metamask/base-controller": "^3.2.1",
"@metamask/controller-utils": "^4.3.2",
"@metamask/utils": "^6.2.0"
"@metamask/utils": "^8.1.0"
},
"devDependencies": {
"@metamask/auto-changelog": "^3.1.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/approval-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"dependencies": {
"@metamask/base-controller": "^3.2.1",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"eth-rpc-errors": "^4.0.2",
"immer": "^9.0.6",
"nanoid": "^3.1.31"
Expand Down
2 changes: 1 addition & 1 deletion packages/assets-controllers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"@metamask/network-controller": "^12.2.0",
"@metamask/preferences-controller": "^4.4.0",
"@metamask/rpc-errors": "^5.1.1",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"@types/uuid": "^8.3.0",
"abort-controller": "^3.0.0",
"async-mutex": "^0.2.6",
Expand Down
2 changes: 1 addition & 1 deletion packages/base-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"test:watch": "jest --watch"
},
"dependencies": {
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"immer": "^9.0.6"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/controller-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"dependencies": {
"@metamask/eth-query": "^3.0.1",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"@spruceid/siwe-parser": "1.1.3",
"eth-ens-namehash": "^2.0.8",
"eth-rpc-errors": "^4.0.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/ens-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@metamask/base-controller": "^3.2.1",
"@metamask/controller-utils": "^4.3.2",
"@metamask/network-controller": "^12.2.0",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"ethereum-ens-network-map": "^1.0.2",
"punycode": "^2.1.1"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/gas-fee-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@metamask/controller-utils": "^4.3.2",
"@metamask/eth-query": "^3.0.1",
"@metamask/network-controller": "^12.2.0",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"@types/uuid": "^8.3.0",
"ethereumjs-util": "^7.0.10",
"ethjs-unit": "^0.1.6",
Expand Down
2 changes: 1 addition & 1 deletion packages/keyring-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"@metamask/eth-keyring-controller": "^13.0.1",
"@metamask/message-manager": "^7.3.2",
"@metamask/preferences-controller": "^4.4.0",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"async-mutex": "^0.2.6",
"ethereumjs-util": "^7.0.10",
"ethereumjs-wallet": "^1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/message-manager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"@metamask/base-controller": "^3.2.1",
"@metamask/controller-utils": "^4.3.2",
"@metamask/eth-sig-util": "^7.0.0",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"@types/uuid": "^8.3.0",
"ethereumjs-util": "^7.0.10",
"jsonschema": "^1.2.4",
Expand Down
2 changes: 1 addition & 1 deletion packages/network-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@metamask/eth-json-rpc-provider": "^1.0.0",
"@metamask/eth-query": "^3.0.1",
"@metamask/swappable-obj-proxy": "^2.1.0",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"async-mutex": "^0.2.6",
"eth-block-tracker": "^7.0.1",
"eth-rpc-errors": "^4.0.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/notification-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
"dependencies": {
"@metamask/base-controller": "^3.2.1",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"immer": "^9.0.6",
"nanoid": "^3.1.31"
},
Expand Down
4 changes: 2 additions & 2 deletions packages/permission-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@
"@metamask/approval-controller": "^3.5.1",
"@metamask/base-controller": "^3.2.1",
"@metamask/controller-utils": "^4.3.2",
"@metamask/utils": "^6.2.0",
"@metamask/json-rpc-engine": "^7.1.1",
"@metamask/utils": "^8.1.0",
"@types/deep-freeze-strict": "^1.1.0",
"deep-freeze-strict": "^1.1.1",
"eth-rpc-errors": "^4.0.2",
"immer": "^9.0.6",
"json-rpc-engine": "^6.1.0",
"nanoid": "^3.1.31"
},
"devDependencies": {
Expand Down
4 changes: 2 additions & 2 deletions packages/permission-controller/src/Permission.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type {
EventConstraint,
} from '@metamask/base-controller';
import type { NonEmptyArray } from '@metamask/controller-utils';
import type { Json } from '@metamask/utils';
import type { Json, JsonRpcParams } from '@metamask/utils';
import { nanoid } from 'nanoid';

// eslint-disable-next-line @typescript-eslint/no-unused-vars
Expand Down Expand Up @@ -210,7 +210,7 @@ type RestrictedMethodContext = Readonly<{
[key: string]: any;
}>;

export type RestrictedMethodParameters = Json[] | Record<string, Json> | void;
export type RestrictedMethodParameters = JsonRpcParams;

/**
* The arguments passed to a restricted method implementation.
Expand Down
29 changes: 16 additions & 13 deletions packages/permission-controller/src/PermissionController.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ import type {
} from '@metamask/approval-controller';
import { ControllerMessenger } from '@metamask/base-controller';
import { isPlainObject } from '@metamask/controller-utils';
import type { Json } from '@metamask/utils';
import { JsonRpcEngine } from '@metamask/json-rpc-engine';
import { hasProperty } from '@metamask/utils';
import type {
Json,
PendingJsonRpcResponse,
JsonRpcParams,
} from '@metamask/utils';
import assert from 'assert';
import { JsonRpcEngine } from 'json-rpc-engine';
import type { PendingJsonRpcResponse } from 'json-rpc-engine';

import type {
AsyncRestrictedMethod,
Expand Down Expand Up @@ -251,7 +254,7 @@ function getDefaultPermissionSpecifications() {
CaveatTypes.filterArrayResponse,
CaveatTypes.reverseArrayResponse,
],
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return ['a', 'b', 'c'];
},
},
Expand All @@ -262,7 +265,7 @@ function getDefaultPermissionSpecifications() {
CaveatTypes.filterObjectResponse,
CaveatTypes.noopCaveat,
],
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return { a: 'x', b: 'y', c: 'z' };
},
validator: (permission: PermissionConstraint) => {
Expand Down Expand Up @@ -292,15 +295,15 @@ function getDefaultPermissionSpecifications() {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.wallet_noop,
allowedCaveats: null,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
},
[PermissionKeys.wallet_noopWithPermittedAndFailureSideEffects]: {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.wallet_noopWithPermittedAndFailureSideEffects,
allowedCaveats: null,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
sideEffect: {
Expand All @@ -312,7 +315,7 @@ function getDefaultPermissionSpecifications() {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.wallet_noopWithPermittedAndFailureSideEffects2,
allowedCaveats: null,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
sideEffect: {
Expand All @@ -324,7 +327,7 @@ function getDefaultPermissionSpecifications() {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.wallet_noopWithPermittedSideEffects,
allowedCaveats: null,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
sideEffect: {
Expand All @@ -335,7 +338,7 @@ function getDefaultPermissionSpecifications() {
[PermissionKeys.wallet_noopWithValidator]: {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.wallet_noopWithValidator,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
allowedCaveats: [CaveatTypes.noopCaveat, CaveatTypes.filterArrayResponse],
Expand All @@ -352,7 +355,7 @@ function getDefaultPermissionSpecifications() {
[PermissionKeys.wallet_noopWithRequiredCaveat]: {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.wallet_noopWithRequiredCaveat,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
allowedCaveats: [CaveatTypes.noopCaveat],
Expand Down Expand Up @@ -388,7 +391,7 @@ function getDefaultPermissionSpecifications() {
[PermissionKeys.wallet_noopWithFactory]: {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.wallet_noopWithFactory,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
allowedCaveats: [CaveatTypes.filterArrayResponse],
Expand All @@ -415,7 +418,7 @@ function getDefaultPermissionSpecifications() {
permissionType: PermissionType.RestrictedMethod,
targetName: PermissionKeys.snap_foo,
allowedCaveats: null,
methodImplementation: (_args: RestrictedMethodOptions<void>) => {
methodImplementation: (_args: RestrictedMethodOptions<JsonRpcParams>) => {
return null;
},
subjectTypes: [SubjectType.Snap],
Expand Down
12 changes: 7 additions & 5 deletions packages/permission-controller/src/permission-middleware.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import type { Json } from '@metamask/utils';
import { createAsyncMiddleware } from 'json-rpc-engine';
import { createAsyncMiddleware } from '@metamask/json-rpc-engine';
import type {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
JsonRpcEngine,
JsonRpcMiddleware,
AsyncJsonRpcEngineNextCallback,
PendingJsonRpcResponse,
} from '@metamask/json-rpc-engine';
import type {
Json,
JsonRpcRequest,
} from 'json-rpc-engine';
PendingJsonRpcResponse,
} from '@metamask/utils';

import type {
GenericPermissionController,
Expand Down Expand Up @@ -60,7 +62,7 @@ export function getPermissionMiddlewareFactory({
}

const permissionsMiddleware = async (
req: JsonRpcRequest<RestrictedMethodParameters>,
req: JsonRpcRequest,
res: PendingJsonRpcResponse<Json>,
next: AsyncJsonRpcEngineNextCallback,
): Promise<void> => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { JsonRpcEngine } from 'json-rpc-engine';
import { JsonRpcEngine } from '@metamask/json-rpc-engine';

import { getPermissionsHandler } from './getPermissions';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { PendingJsonRpcResponse } from '@metamask/utils';
import type { JsonRpcEngineEndCallback } from 'json-rpc-engine';
import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';
import type { JsonRpcParams, PendingJsonRpcResponse } from '@metamask/utils';

import type { PermissionConstraint } from '../Permission';
import type { SubjectPermissions } from '../PermissionController';
Expand All @@ -8,7 +8,7 @@ import { MethodNames } from '../utils';

export const getPermissionsHandler: PermittedHandlerExport<
GetPermissionsHooks,
undefined,
JsonRpcParams,
PermissionConstraint[]
> = {
methodNames: [MethodNames.getPermissions],
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import {
JsonRpcEngine,
createAsyncMiddleware,
} from '@metamask/json-rpc-engine';
import { ethErrors, serializeError } from 'eth-rpc-errors';
import { JsonRpcEngine, createAsyncMiddleware } from 'json-rpc-engine';

import { requestPermissionsHandler } from './requestPermissions';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { isPlainObject } from '@metamask/controller-utils';
import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';
import type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';
import { ethErrors } from 'eth-rpc-errors';
import type { JsonRpcEngineEndCallback } from 'json-rpc-engine';

import { invalidParams } from '../errors';
import type { PermissionConstraint, RequestedPermissions } from '../Permission';
Expand Down
8 changes: 4 additions & 4 deletions packages/permission-controller/src/utils.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import type {
JsonRpcEngineEndCallback,
JsonRpcEngineNextCallback,
} from '@metamask/json-rpc-engine';
import type {
Json,
JsonRpcParams,
JsonRpcRequest,
PendingJsonRpcResponse,
} from '@metamask/utils';
import type {
JsonRpcEngineEndCallback,
JsonRpcEngineNextCallback,
} from 'json-rpc-engine';

import type {
CaveatSpecificationConstraint,
Expand Down
2 changes: 1 addition & 1 deletion packages/signature-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"@metamask/controller-utils": "^4.3.2",
"@metamask/logging-controller": "^1.0.1",
"@metamask/message-manager": "^7.3.2",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"eth-rpc-errors": "^4.0.2",
"ethereumjs-util": "^7.0.10",
"immer": "^9.0.6",
Expand Down
2 changes: 1 addition & 1 deletion packages/transaction-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"@metamask/eth-query": "^3.0.1",
"@metamask/metamask-eth-abis": "^3.0.0",
"@metamask/network-controller": "^12.2.0",
"@metamask/utils": "^6.2.0",
"@metamask/utils": "^8.1.0",
"async-mutex": "^0.2.6",
"eth-method-registry": "1.1.0",
"eth-rpc-errors": "^4.0.2",
Expand Down
Loading