Skip to content

[BREAKING] Move endowments from Controllers to RPC methods #2155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
8 changes: 4 additions & 4 deletions packages/snaps-controllers/coverage.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"branches": 91.4,
"functions": 96.93,
"lines": 98.01,
"statements": 97.73
"branches": 91.12,
"functions": 96.81,
"lines": 97.86,
"statements": 97.51
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { SnapEndowments } from '@metamask/snaps-rpc-methods';
import type { TruncatedSnap } from '@metamask/snaps-utils';
import { HandlerType } from '@metamask/snaps-utils';
import { MOCK_ORIGIN, MOCK_SNAP_ID } from '@metamask/snaps-utils/test-utils';
import type { SemVerVersion } from '@metamask/utils';
import { Duration, inMilliseconds } from '@metamask/utils';

import { SnapEndowments } from '../snaps';
import {
getRestrictedCronjobControllerMessenger,
getRootCronjobControllerMessenger,
Expand Down
7 changes: 5 additions & 2 deletions packages/snaps-controllers/src/cronjob/CronjobController.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import type { RestrictedControllerMessenger } from '@metamask/base-controller';
import { BaseController } from '@metamask/base-controller';
import type { GetPermissions } from '@metamask/permission-controller';
import {
getCronjobCaveatJobs,
SnapEndowments,
} from '@metamask/snaps-rpc-methods';
import type { SnapId } from '@metamask/snaps-sdk';
import type {
TruncatedSnap,
Expand All @@ -22,8 +26,7 @@ import type {
SnapUninstalled,
SnapUpdated,
} from '..';
import { getRunnableSnaps, SnapEndowments } from '..';
import { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';
import { getRunnableSnaps } from '..';
import { Timer } from '../snaps/Timer';

export type CronjobControllerActions =
Expand Down
7 changes: 5 additions & 2 deletions packages/snaps-controllers/src/snaps/SnapController.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ import {
type ValidPermission,
} from '@metamask/permission-controller';
import { providerErrors, rpcErrors } from '@metamask/rpc-errors';
import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
import {
WALLET_SNAP_PERMISSION_KEY,
handlerEndowments,
SnapEndowments,
} from '@metamask/snaps-rpc-methods';
import type { SnapId } from '@metamask/snaps-sdk';
import { AuxiliaryFileEncoding, text } from '@metamask/snaps-sdk';
import type { SnapPermissions, RpcOrigins } from '@metamask/snaps-utils';
Expand Down Expand Up @@ -87,7 +91,6 @@ import {
sleep,
} from '../test-utils';
import { delay } from '../utils';
import { handlerEndowments, SnapEndowments } from './endowments';
import { SnapsRegistryStatus } from './registry';
import type { SnapControllerState } from './SnapController';
import {
Expand Down
18 changes: 9 additions & 9 deletions packages/snaps-controllers/src/snaps/SnapController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,15 @@ import type {
import { SubjectType } from '@metamask/permission-controller';
import { rpcErrors } from '@metamask/rpc-errors';
import type { BlockReason } from '@metamask/snaps-registry';
import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
import {
WALLET_SNAP_PERMISSION_KEY,
getMaxRequestTimeCaveat,
handlerEndowments,
SnapEndowments,
getKeyringCaveatOrigins,
getRpcCaveatOrigins,
processSnapPermissions,
} from '@metamask/snaps-rpc-methods';
import type {
RequestSnapsParams,
RequestSnapsResult,
Expand Down Expand Up @@ -105,16 +113,8 @@ import type {
} from '../services';
import { fetchSnap, hasTimedOut, setDiff, withTimeout } from '../utils';
import { ALLOWED_PERMISSIONS } from './constants';
import {
getMaxRequestTimeCaveat,
handlerEndowments,
SnapEndowments,
} from './endowments';
import { getKeyringCaveatOrigins } from './endowments/keyring';
import { getRpcCaveatOrigins } from './endowments/rpc';
import type { SnapLocation } from './location';
import { detectSnapLocation } from './location';
import { processSnapPermissions } from './permissions';
import type {
GetMetadata,
GetResult,
Expand Down
2 changes: 1 addition & 1 deletion packages/snaps-controllers/src/snaps/constants.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { SnapEndowments } from './endowments';
import { SnapEndowments } from '@metamask/snaps-rpc-methods';

// These permissions are allowed without being on the allowlist.
export const ALLOWED_PERMISSIONS = Object.freeze([
Expand Down
2 changes: 0 additions & 2 deletions packages/snaps-controllers/src/snaps/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
export * from './location';
export * from './SnapController';
export * from './endowments';
export * from './selectors';
export * from './registry';
export * from './permissions';
7 changes: 5 additions & 2 deletions packages/snaps-controllers/src/test-utils/controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ import type {
} from '@metamask/permission-controller';
import { SubjectType } from '@metamask/permission-controller';
import { providerErrors } from '@metamask/rpc-errors';
import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
import {
SnapEndowments,
WALLET_SNAP_PERMISSION_KEY,
} from '@metamask/snaps-rpc-methods';
import { text, type SnapId } from '@metamask/snaps-sdk';
import { SnapCaveatType } from '@metamask/snaps-utils';
import {
Expand Down Expand Up @@ -39,7 +42,7 @@ import type {
SnapsRegistryActions,
SnapsRegistryEvents,
} from '../snaps';
import { SnapController, SnapEndowments } from '../snaps';
import { SnapController } from '../snaps';
import { MOCK_CRONJOB_PERMISSION } from './cronjob';
import { getNodeEES, getNodeEESMessenger } from './execution-environment';
import { MockSnapsRegistry } from './registry';
Expand Down
3 changes: 1 addition & 2 deletions packages/snaps-controllers/src/test-utils/cronjob.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import type { PermissionConstraint } from '@metamask/permission-controller';
import { SnapEndowments } from '@metamask/snaps-rpc-methods';
import { SnapCaveatType } from '@metamask/snaps-utils';
import { MOCK_ORIGIN } from '@metamask/snaps-utils/test-utils';

import { SnapEndowments } from '../snaps/endowments';

export const MOCK_CRONJOB_PERMISSION: PermissionConstraint = {
caveats: [
{
Expand Down
4 changes: 2 additions & 2 deletions packages/snaps-jest/src/internals/simulation/controllers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import {
SubjectType,
} from '@metamask/permission-controller';
import {
caveatSpecifications as snapsCaveatsSpecifications,
endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,
processSnapPermissions,
} from '@metamask/snaps-controllers';
import { caveatSpecifications as snapsCaveatsSpecifications } from '@metamask/snaps-rpc-methods';
} from '@metamask/snaps-rpc-methods';
import type { SnapManifest } from '@metamask/snaps-utils';
import { getSafeJson } from '@metamask/utils';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import type { GenericPermissionController } from '@metamask/permission-controller';
import {
endowmentPermissionBuilders,
buildSnapEndowmentSpecifications,
buildSnapRestrictedMethodSpecifications,
endowmentPermissionBuilders,
} from '@metamask/snaps-controllers';
} from '@metamask/snaps-rpc-methods';
import { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';

import type { SimulationOptions } from '../options';
Expand Down
8 changes: 4 additions & 4 deletions packages/snaps-rpc-methods/jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ module.exports = deepmerge(baseConfig, {
],
coverageThreshold: {
global: {
branches: 93.07,
functions: 100,
lines: 99.2,
statements: 97.77,
branches: 91.54,
functions: 97,
lines: 97.53,
statements: 97,
},
},
});
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,4 @@ export { getTransactionOriginCaveat } from './transaction-insight';
export { getChainIdsCaveat, getLookupMatchersCaveat } from './name-lookup';
export { getKeyringCaveatOrigins } from './keyring';
export { getMaxRequestTimeCaveat } from './caveats';
export { getCronjobCaveatJobs } from './cronjob';
2 changes: 2 additions & 0 deletions packages/snaps-rpc-methods/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ export {
export * from './restricted';
export { SnapCaveatType } from '@metamask/snaps-utils';
export { selectHooks } from './utils';
export * from './endowments';
export * from './permissions';
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@ import type {
PermissionConstraint,
PermissionSpecificationConstraint,
} from '@metamask/permission-controller';
import {
caveatMappers,
restrictedMethodPermissionBuilders,
selectHooks,
} from '@metamask/snaps-rpc-methods';
import type { SnapPermissions } from '@metamask/snaps-utils';
import { hasProperty } from '@metamask/utils';

import {
endowmentCaveatMappers,
endowmentPermissionBuilders,
} from './endowments';
import {
caveatMappers,
restrictedMethodPermissionBuilders,
} from './restricted';
import { selectHooks } from './utils';

/**
* Map initial permissions as defined in a Snap manifest to something that can
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { GenericPermissionController } from '@metamask/permission-controller';
import { processSnapPermissions } from '@metamask/snaps-controllers';
import { processSnapPermissions } from '@metamask/snaps-rpc-methods';
import { SnapError } from '@metamask/snaps-sdk';
import {
DEFAULT_ENDOWMENTS,
Expand Down
8 changes: 4 additions & 4 deletions packages/snaps-simulator/src/features/simulation/sagas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ import {
import {
IframeExecutionService,
setupMultiplex,
endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,
processSnapPermissions,
buildSnapEndowmentSpecifications,
buildSnapRestrictedMethodSpecifications,
} from '@metamask/snaps-controllers';
import packageJson from '@metamask/snaps-execution-environments/package.json';
import {
createSnapsMethodMiddleware,
caveatSpecifications as snapsCaveatsSpecifications,
endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications,
processSnapPermissions,
buildSnapEndowmentSpecifications,
buildSnapRestrictedMethodSpecifications,
} from '@metamask/snaps-rpc-methods';
import type {
SnapManifest,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { GenericPermissionController } from '@metamask/permission-controller';
import { endowmentPermissionBuilders } from '@metamask/snaps-controllers';
import { endowmentPermissionBuilders } from '@metamask/snaps-rpc-methods';
import { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';

export const ExcludedSnapEndowments = Object.freeze([]);
Expand Down