Skip to content
Draft
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
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
/packages/account-tree-controller @MetaMask/accounts-engineers
/packages/profile-sync-controller @MetaMask/accounts-engineers
/packages/money-account-controller @MetaMask/accounts-engineers
/packages/snap-account-service @MetaMask/accounts-engineers

## Assets Team
/packages/assets-controllers @MetaMask/metamask-assets
Expand Down Expand Up @@ -226,3 +227,5 @@
/packages/social-controllers/CHANGELOG.md @MetaMask/social-ai @MetaMask/core-platform
/packages/money-account-controller/package.json @MetaMask/accounts-engineers @MetaMask/core-platform
/packages/money-account-controller/CHANGELOG.md @MetaMask/accounts-engineers @MetaMask/core-platform
/packages/snap-account-service/package.json @MetaMask/accounts-engineers @MetaMask/core-platform
/packages/snap-account-service/CHANGELOG.md @MetaMask/accounts-engineers @MetaMask/core-platform
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ Each package in this repository has its own README where you can find installati
- [`@metamask/selected-network-controller`](packages/selected-network-controller)
- [`@metamask/shield-controller`](packages/shield-controller)
- [`@metamask/signature-controller`](packages/signature-controller)
- [`@metamask/snap-account-service`](packages/snap-account-service)
- [`@metamask/social-controllers`](packages/social-controllers)
- [`@metamask/storage-service`](packages/storage-service)
- [`@metamask/subscription-controller`](packages/subscription-controller)
Expand Down Expand Up @@ -177,6 +178,7 @@ linkStyle default opacity:0.5
selected_network_controller(["@metamask/selected-network-controller"]);
shield_controller(["@metamask/shield-controller"]);
signature_controller(["@metamask/signature-controller"]);
snap_account_service(["@metamask/snap-account-service"]);
social_controllers(["@metamask/social-controllers"]);
storage_service(["@metamask/storage-service"]);
subscription_controller(["@metamask/subscription-controller"]);
Expand Down Expand Up @@ -475,6 +477,7 @@ linkStyle default opacity:0.5
signature_controller --> logging_controller;
signature_controller --> messenger;
signature_controller --> network_controller;
snap_account_service --> messenger;
social_controllers --> base_controller;
social_controllers --> base_data_service;
social_controllers --> controller_utils;
Expand Down
14 changes: 14 additions & 0 deletions packages/snap-account-service/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- Add `SnapAccountService` ([#8414](https://github.com/MetaMask/core/pull/8414)), ([#8418](https://github.com/MetaMask/core/pull/8418))

[Unreleased]: https://github.com/MetaMask/core/
20 changes: 20 additions & 0 deletions packages/snap-account-service/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
MIT License

Copyright (c) 2026 MetaMask

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
15 changes: 15 additions & 0 deletions packages/snap-account-service/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# `@metamask/snap-account-service`

Service for Account Management Snaps

## Installation

`yarn add @metamask/snap-account-service`

or

`npm install @metamask/snap-account-service`

## Contributing

This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).
26 changes: 26 additions & 0 deletions packages/snap-account-service/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
* For a detailed explanation regarding each configuration property and type check, visit:
* https://jestjs.io/docs/configuration
*/

const merge = require('deepmerge');
const path = require('path');

const baseConfig = require('../../jest.config.packages');

const displayName = path.basename(__dirname);

module.exports = merge(baseConfig, {
// The display name when running multiple projects
displayName,

// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
branches: 100,
functions: 100,
lines: 100,
statements: 100,
},
},
});
76 changes: 76 additions & 0 deletions packages/snap-account-service/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
"name": "@metamask/snap-account-service",
"version": "0.0.0",
"description": "Service for Account Management Snaps",
"keywords": [
"MetaMask",
"Ethereum"
],
"homepage": "https://github.com/MetaMask/core/tree/main/packages/snap-account-service#readme",
"bugs": {
"url": "https://github.com/MetaMask/core/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/MetaMask/core.git"
},
"license": "MIT",
"sideEffects": false,
"exports": {
".": {
"import": {
"types": "./dist/index.d.mts",
"default": "./dist/index.mjs"
},
"require": {
"types": "./dist/index.d.cts",
"default": "./dist/index.cjs"
}
},
"./package.json": "./package.json"
},
"main": "./dist/index.cjs",
"types": "./dist/index.d.cts",
"files": [
"dist/"
],
"scripts": {
"build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
"build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
"build:docs": "typedoc",
"changelog:update": "../../scripts/update-changelog.sh @metamask/snap-account-service",
"changelog:validate": "../../scripts/validate-changelog.sh @metamask/snap-account-service",
"messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check",
"messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate",
"since-latest-release": "../../scripts/since-latest-release.sh",
"test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
"test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
"test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
"test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
},
"dependencies": {
"@metamask/messenger": "^1.1.1",
"@metamask/snaps-controllers": "^19.0.0",
"@metamask/snaps-sdk": "^11.0.0",
"@metamask/utils": "^11.9.0"
},
"devDependencies": {
"@metamask/auto-changelog": "^3.4.4",
"@ts-bridge/cli": "^0.6.4",
"@types/jest": "^29.5.14",
"deepmerge": "^4.2.2",
"jest": "^29.7.0",
"ts-jest": "^29.2.5",
"tsx": "^4.20.5",
"typedoc": "^0.25.13",
"typedoc-plugin-missing-exports": "^2.0.0",
"typescript": "~5.3.3"
},
"engines": {
"node": "^18.18 || >=20"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/**
* This file is auto generated.
* Do not edit manually.
*/

import type { SnapAccountService } from './SnapAccountService';

/**
* Returns the Snap IDs of all account management Snaps.
*
* @returns Set of Snap IDs of all account management Snaps.
*/
export type SnapAccountServiceGetSnapsAction = {
type: `SnapAccountService:getSnaps`;
handler: SnapAccountService['getSnaps'];
};

/**
* Union of all SnapAccountService action types.
*/
export type SnapAccountServiceMethodActions = SnapAccountServiceGetSnapsAction;
144 changes: 144 additions & 0 deletions packages/snap-account-service/src/SnapAccountService.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
import { Messenger, MOCK_ANY_NAMESPACE } from '@metamask/messenger';
import type {
MockAnyNamespace,
MessengerActions,
MessengerEvents,
} from '@metamask/messenger';
import type { SnapId } from '@metamask/snaps-sdk';

import type { SnapAccountServiceMessenger } from './SnapAccountService';
import { SnapAccountService } from './SnapAccountService';

const MOCK_KEYRING_SNAP_ID = 'npm:@metamask/keyring-snap' as SnapId;
const MOCK_OTHER_SNAP_ID = 'npm:@metamask/other-snap' as SnapId;

/**
* The type of the messenger populated with all external actions and events
* required by the service under test.
*/
type RootMessenger = Messenger<
MockAnyNamespace,
MessengerActions<SnapAccountServiceMessenger>,
MessengerEvents<SnapAccountServiceMessenger>
>;

/**
* Builds a minimal snap object for use in tests.
*
* @param id - The snap ID.
* @param initialPermissions - The snap's initial permissions.
* @returns A minimal snap object.
*/
function buildSnap(
id: SnapId,
initialPermissions: Record<string, unknown>,
): {
id: SnapId;
initialPermissions: Record<string, unknown>;
version: string;
enabled: boolean;
blocked: boolean;
} {
return {
id,
initialPermissions,
version: '1.0.0',
enabled: true,
blocked: false,
};
}

/**
* Sets up the service under test with its required mocks.
*
* @param args - The setup arguments.
* @param args.snaps - The snaps that `SnapController:getRunnableSnaps` will return.
* @returns The service and its messengers.
*/
function setup({ snaps }: { snaps: ReturnType<typeof buildSnap>[] }): {
service: SnapAccountService;
rootMessenger: RootMessenger;
messenger: SnapAccountServiceMessenger;
} {
const rootMessenger: RootMessenger = new Messenger({
namespace: MOCK_ANY_NAMESPACE,
});
const messenger: SnapAccountServiceMessenger = new Messenger({
namespace: 'SnapAccountService',
parent: rootMessenger,
});

rootMessenger.delegate({
actions: ['SnapController:getRunnableSnaps'],
messenger,
});
rootMessenger.registerActionHandler(
'SnapController:getRunnableSnaps',
jest.fn().mockReturnValue(snaps),
);

const service = new SnapAccountService({ messenger });

return { service, rootMessenger, messenger };
}

describe('SnapAccountService', () => {
describe('init', () => {
it('resolves without throwing when there are no snaps', async () => {
const { service } = setup({ snaps: [] });

expect(await service.init()).toBeUndefined();
});

it('stores snap IDs that have the endowment:keyring permission', async () => {
const { service } = setup({
snaps: [buildSnap(MOCK_KEYRING_SNAP_ID, { 'endowment:keyring': {} })],
});

await service.init();

expect(service.getSnaps().has(MOCK_KEYRING_SNAP_ID)).toBe(true);
});

it('does not store snap IDs that lack the endowment:keyring permission', async () => {
const { service } = setup({
snaps: [buildSnap(MOCK_OTHER_SNAP_ID, {})],
});

await service.init();

expect(service.getSnaps().has(MOCK_OTHER_SNAP_ID)).toBe(false);
});

it('handles a mix of keyring and non-keyring snaps', async () => {
const { service } = setup({
snaps: [
buildSnap(MOCK_KEYRING_SNAP_ID, { 'endowment:keyring': {} }),
buildSnap(MOCK_OTHER_SNAP_ID, {}),
],
});

await service.init();

expect(service.getSnaps().has(MOCK_KEYRING_SNAP_ID)).toBe(true);
expect(service.getSnaps().has(MOCK_OTHER_SNAP_ID)).toBe(false);
expect(service.getSnaps().size).toBe(1);
});
});

describe('getSnaps', () => {
it('returns the set of account management snap IDs via the messenger action', async () => {
const { rootMessenger, service } = setup({
snaps: [buildSnap(MOCK_KEYRING_SNAP_ID, { 'endowment:keyring': {} })],
});

await service.init();

expect(
rootMessenger
.call('SnapAccountService:getSnaps')
.has(MOCK_KEYRING_SNAP_ID),
).toBe(true);
});
});
});
Loading
Loading