From 61b6916cc36fb52dca1237ecc8bddce7e20b51e5 Mon Sep 17 00:00:00 2001 From: Bigshmow Date: Thu, 26 Mar 2026 19:00:26 -0600 Subject: [PATCH 1/3] feat: introduces the new home for the social controllers --- .github/CODEOWNERS | 3 + README.md | 22 +++++- packages/social-controllers/CHANGELOG.md | 10 +++ packages/social-controllers/LICENSE | 20 ++++++ packages/social-controllers/README.md | 15 +++++ packages/social-controllers/jest.config.js | 26 +++++++ packages/social-controllers/package.json | 67 +++++++++++++++++++ packages/social-controllers/src/index.test.ts | 9 +++ packages/social-controllers/src/index.ts | 9 +++ .../social-controllers/tsconfig.build.json | 10 +++ packages/social-controllers/tsconfig.json | 8 +++ packages/social-controllers/typedoc.json | 7 ++ tsconfig.build.json | 3 + tsconfig.json | 3 + yarn.lock | 16 +++++ 15 files changed, 225 insertions(+), 3 deletions(-) create mode 100644 packages/social-controllers/CHANGELOG.md create mode 100644 packages/social-controllers/LICENSE create mode 100644 packages/social-controllers/README.md create mode 100644 packages/social-controllers/jest.config.js create mode 100644 packages/social-controllers/package.json create mode 100644 packages/social-controllers/src/index.test.ts create mode 100644 packages/social-controllers/src/index.ts create mode 100644 packages/social-controllers/tsconfig.build.json create mode 100644 packages/social-controllers/tsconfig.json create mode 100644 packages/social-controllers/typedoc.json diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 331f1487491..6b64f4042f0 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -41,6 +41,7 @@ ## Social AI Team /packages/ai-controllers @MetaMask/social-ai +/packages/social-controllers @MetaMask/social-ai ## Ramp Team /packages/ramps-controller @MetaMask/ramp @@ -220,3 +221,5 @@ /packages/ai-controllers/CHANGELOG.md @MetaMask/social-ai @MetaMask/core-platform /packages/client-controller/package.json @MetaMask/core-platform @MetaMask/extension-platform @MetaMask/mobile-platform /packages/client-controller/CHANGELOG.md @MetaMask/core-platform @MetaMask/extension-platform @MetaMask/mobile-platform +/packages/social-controllers/package.json @MetaMask/social-ai @MetaMask/core-platform +/packages/social-controllers/CHANGELOG.md @MetaMask/social-ai @MetaMask/core-platform diff --git a/README.md b/README.md index 80c0514440c..d4999756ed7 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,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/social-controllers`](packages/social-controllers) - [`@metamask/storage-service`](packages/storage-service) - [`@metamask/subscription-controller`](packages/subscription-controller) - [`@metamask/transaction-controller`](packages/transaction-controller) @@ -174,6 +175,7 @@ linkStyle default opacity:0.5 selected_network_controller(["@metamask/selected-network-controller"]); shield_controller(["@metamask/shield-controller"]); signature_controller(["@metamask/signature-controller"]); + social_controllers(["@metamask/social-controllers"]); storage_service(["@metamask/storage-service"]); subscription_controller(["@metamask/subscription-controller"]); transaction_controller(["@metamask/transaction-controller"]); @@ -240,7 +242,10 @@ linkStyle default opacity:0.5 assets_controllers --> transaction_controller; base_controller --> messenger; base_controller --> json_rpc_engine; + base_data_service --> controller_utils; + base_data_service --> messenger; bridge_controller --> accounts_controller; + bridge_controller --> assets_controller; bridge_controller --> assets_controllers; bridge_controller --> base_controller; bridge_controller --> controller_utils; @@ -258,6 +263,7 @@ linkStyle default opacity:0.5 bridge_status_controller --> bridge_controller; bridge_status_controller --> controller_utils; bridge_status_controller --> gas_fee_controller; + bridge_status_controller --> keyring_controller; bridge_status_controller --> network_controller; bridge_status_controller --> polling_controller; bridge_status_controller --> profile_sync_controller; @@ -266,8 +272,8 @@ linkStyle default opacity:0.5 chain_agnostic_permission --> permission_controller; claims_controller --> base_controller; claims_controller --> controller_utils; - claims_controller --> messenger; claims_controller --> keyring_controller; + claims_controller --> messenger; claims_controller --> profile_sync_controller; client_controller --> base_controller; client_controller --> messenger; @@ -331,6 +337,7 @@ linkStyle default opacity:0.5 gator_permissions_controller --> messenger; gator_permissions_controller --> transaction_controller; geolocation_controller --> base_controller; + geolocation_controller --> controller_utils; geolocation_controller --> messenger; json_rpc_middleware_stream --> json_rpc_engine; keyring_controller --> base_controller; @@ -345,6 +352,7 @@ linkStyle default opacity:0.5 multichain_account_service --> base_controller; multichain_account_service --> keyring_controller; multichain_account_service --> messenger; + multichain_account_service --> controller_utils; multichain_api_middleware --> chain_agnostic_permission; multichain_api_middleware --> controller_utils; multichain_api_middleware --> json_rpc_engine; @@ -395,6 +403,13 @@ linkStyle default opacity:0.5 perps_controller --> base_controller; perps_controller --> controller_utils; perps_controller --> messenger; + perps_controller --> account_tree_controller; + perps_controller --> geolocation_controller; + perps_controller --> keyring_controller; + perps_controller --> network_controller; + perps_controller --> profile_sync_controller; + perps_controller --> remote_feature_flag_controller; + perps_controller --> transaction_controller; phishing_controller --> base_controller; phishing_controller --> controller_utils; phishing_controller --> messenger; @@ -403,8 +418,6 @@ linkStyle default opacity:0.5 polling_controller --> controller_utils; polling_controller --> network_controller; preferences_controller --> base_controller; - preferences_controller --> controller_utils; - preferences_controller --> keyring_controller; preferences_controller --> messenger; profile_metrics_controller --> accounts_controller; profile_metrics_controller --> base_controller; @@ -423,6 +436,7 @@ linkStyle default opacity:0.5 ramps_controller --> messenger; rate_limit_controller --> base_controller; rate_limit_controller --> messenger; + react_data_query --> base_data_service; remote_feature_flag_controller --> base_controller; remote_feature_flag_controller --> controller_utils; remote_feature_flag_controller --> messenger; @@ -470,6 +484,7 @@ linkStyle default opacity:0.5 transaction_controller --> remote_feature_flag_controller; transaction_controller --> eth_block_tracker; transaction_controller --> eth_json_rpc_provider; + transaction_pay_controller --> assets_controller; transaction_pay_controller --> assets_controllers; transaction_pay_controller --> base_controller; transaction_pay_controller --> bridge_controller; @@ -478,6 +493,7 @@ linkStyle default opacity:0.5 transaction_pay_controller --> gas_fee_controller; transaction_pay_controller --> messenger; transaction_pay_controller --> network_controller; + transaction_pay_controller --> ramps_controller; transaction_pay_controller --> remote_feature_flag_controller; transaction_pay_controller --> transaction_controller; user_operation_controller --> approval_controller; diff --git a/packages/social-controllers/CHANGELOG.md b/packages/social-controllers/CHANGELOG.md new file mode 100644 index 00000000000..b518709c7b8 --- /dev/null +++ b/packages/social-controllers/CHANGELOG.md @@ -0,0 +1,10 @@ +# 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] + +[Unreleased]: https://github.com/MetaMask/core/ diff --git a/packages/social-controllers/LICENSE b/packages/social-controllers/LICENSE new file mode 100644 index 00000000000..c8a0ff6be3a --- /dev/null +++ b/packages/social-controllers/LICENSE @@ -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 diff --git a/packages/social-controllers/README.md b/packages/social-controllers/README.md new file mode 100644 index 00000000000..cc761885b70 --- /dev/null +++ b/packages/social-controllers/README.md @@ -0,0 +1,15 @@ +# `@metamask/social-controllers` + +A collection of social related controllers + +## Installation + +`yarn add @metamask/social-controllers` + +or + +`npm install @metamask/social-controllers` + +## Contributing + +This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme). diff --git a/packages/social-controllers/jest.config.js b/packages/social-controllers/jest.config.js new file mode 100644 index 00000000000..ca084133399 --- /dev/null +++ b/packages/social-controllers/jest.config.js @@ -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, + }, + }, +}); diff --git a/packages/social-controllers/package.json b/packages/social-controllers/package.json new file mode 100644 index 00000000000..ffc78893b2b --- /dev/null +++ b/packages/social-controllers/package.json @@ -0,0 +1,67 @@ +{ + "name": "@metamask/social-controllers", + "version": "0.0.0", + "description": "A collection of social related controllers", + "keywords": [ + "MetaMask", + "Ethereum" + ], + "homepage": "https://github.com/MetaMask/core/tree/main/packages/social-controllers#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/social-controllers", + "changelog:validate": "../../scripts/validate-changelog.sh @metamask/social-controllers", + "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" + }, + "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", + "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/" + } +} diff --git a/packages/social-controllers/src/index.test.ts b/packages/social-controllers/src/index.test.ts new file mode 100644 index 00000000000..bc062d3694a --- /dev/null +++ b/packages/social-controllers/src/index.test.ts @@ -0,0 +1,9 @@ +import greeter from '.'; + +describe('Test', () => { + it('greets', () => { + const name = 'Huey'; + const result = greeter(name); + expect(result).toBe('Hello, Huey!'); + }); +}); diff --git a/packages/social-controllers/src/index.ts b/packages/social-controllers/src/index.ts new file mode 100644 index 00000000000..6972c117292 --- /dev/null +++ b/packages/social-controllers/src/index.ts @@ -0,0 +1,9 @@ +/** + * Example function that returns a greeting for the given name. + * + * @param name - The name to greet. + * @returns The greeting. + */ +export default function greeter(name: string): string { + return `Hello, ${name}!`; +} diff --git a/packages/social-controllers/tsconfig.build.json b/packages/social-controllers/tsconfig.build.json new file mode 100644 index 00000000000..02a0eea03fe --- /dev/null +++ b/packages/social-controllers/tsconfig.build.json @@ -0,0 +1,10 @@ +{ + "extends": "../../tsconfig.packages.build.json", + "compilerOptions": { + "baseUrl": "./", + "outDir": "./dist", + "rootDir": "./src" + }, + "references": [], + "include": ["../../types", "./src"] +} diff --git a/packages/social-controllers/tsconfig.json b/packages/social-controllers/tsconfig.json new file mode 100644 index 00000000000..025ba2ef7f4 --- /dev/null +++ b/packages/social-controllers/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../tsconfig.packages.json", + "compilerOptions": { + "baseUrl": "./" + }, + "references": [], + "include": ["../../types", "./src"] +} diff --git a/packages/social-controllers/typedoc.json b/packages/social-controllers/typedoc.json new file mode 100644 index 00000000000..c9da015dbf8 --- /dev/null +++ b/packages/social-controllers/typedoc.json @@ -0,0 +1,7 @@ +{ + "entryPoints": ["./src/index.ts"], + "excludePrivate": true, + "hideGenerator": true, + "out": "docs", + "tsconfig": "./tsconfig.build.json" +} diff --git a/tsconfig.build.json b/tsconfig.build.json index 0b4716238fb..c6304267b69 100644 --- a/tsconfig.build.json +++ b/tsconfig.build.json @@ -217,6 +217,9 @@ { "path": "./packages/signature-controller/tsconfig.build.json" }, + { + "path": "./packages/social-controllers/tsconfig.build.json" + }, { "path": "./packages/storage-service/tsconfig.build.json" }, diff --git a/tsconfig.json b/tsconfig.json index a177726dfba..15696c872d8 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -209,6 +209,9 @@ { "path": "./packages/signature-controller" }, + { + "path": "./packages/social-controllers" + }, { "path": "./packages/subscription-controller" }, diff --git a/yarn.lock b/yarn.lock index 540f525e9ca..bc702b75335 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5361,6 +5361,22 @@ __metadata: languageName: node linkType: hard +"@metamask/social-controllers@workspace:packages/social-controllers": + version: 0.0.0-use.local + resolution: "@metamask/social-controllers@workspace:packages/social-controllers" + dependencies: + "@metamask/auto-changelog": "npm:^3.4.4" + "@ts-bridge/cli": "npm:^0.6.4" + "@types/jest": "npm:^29.5.14" + deepmerge: "npm:^4.2.2" + jest: "npm:^29.7.0" + ts-jest: "npm:^29.2.5" + typedoc: "npm:^0.25.13" + typedoc-plugin-missing-exports: "npm:^2.0.0" + typescript: "npm:~5.3.3" + languageName: unknown + linkType: soft + "@metamask/stake-sdk@npm:^3.2.1": version: 3.2.1 resolution: "@metamask/stake-sdk@npm:3.2.1" From ebf31ed63fe642e9d589938e28b74e6a0b152661 Mon Sep 17 00:00:00 2001 From: Bigshmow Date: Thu, 26 Mar 2026 19:06:10 -0600 Subject: [PATCH 2/3] feat: update teams json --- teams.json | 1 + 1 file changed, 1 insertion(+) diff --git a/teams.json b/teams.json index 4a3f6902d14..5cf44ee75e3 100644 --- a/teams.json +++ b/teams.json @@ -1,6 +1,7 @@ { "metamask/accounts-controller": "team-accounts-framework", "metamask/ai-controllers": "team-social-ai", + "metamask/social-controllers": "team-social-ai", "metamask/multichain-transactions-controller": "team-confirmations", "metamask/multichain-account-service": "team-accounts-framework", "metamask/account-tree-controller": "team-accounts-framework", From 7a0921a3b4df138ef015edda05e1aef309c64de5 Mon Sep 17 00:00:00 2001 From: Bigshmow Date: Thu, 26 Mar 2026 19:15:39 -0600 Subject: [PATCH 3/3] chore: update changelog --- packages/social-controllers/CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/social-controllers/CHANGELOG.md b/packages/social-controllers/CHANGELOG.md index b518709c7b8..d128d74e8e8 100644 --- a/packages/social-controllers/CHANGELOG.md +++ b/packages/social-controllers/CHANGELOG.md @@ -7,4 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- Initial release ([#8321](https://github.com/MetaMask/core/pull/8321)) + [Unreleased]: https://github.com/MetaMask/core/