Wallet framework prototype [WIP]

README.md

@@ -42,6 +42,7 @@ This repository contains the following packages [^fn1]:
 - [`@metamask/signature-controller`](packages/signature-controller)
 - [`@metamask/transaction-controller`](packages/transaction-controller)
 - [`@metamask/user-operation-controller`](packages/user-operation-controller)
+- [`@metamask/wallet-framework`](packages/wallet-framework)
 
 <!-- end package list -->
 
@@ -87,6 +88,7 @@ linkStyle default opacity:0.5
   signature_controller(["@metamask/signature-controller"]);
   transaction_controller(["@metamask/transaction-controller"]);
   user_operation_controller(["@metamask/user-operation-controller"]);
+  wallet_framework(["@metamask/wallet-framework"]);
   accounts_controller --> base_controller;
   accounts_controller --> keyring_controller;
   address_book_controller --> base_controller;
@@ -161,11 +163,13 @@ linkStyle default opacity:0.5
   signature_controller --> keyring_controller;
   signature_controller --> logging_controller;
   signature_controller --> message_manager;
+  transaction_controller --> accounts_controller;
   transaction_controller --> approval_controller;
   transaction_controller --> base_controller;
   transaction_controller --> controller_utils;
   transaction_controller --> gas_fee_controller;
   transaction_controller --> network_controller;
+  transaction_controller --> eth_json_rpc_provider;
   user_operation_controller --> approval_controller;
   user_operation_controller --> base_controller;
   user_operation_controller --> controller_utils;
@@ -174,6 +178,12 @@ linkStyle default opacity:0.5
   user_operation_controller --> network_controller;
   user_operation_controller --> polling_controller;
   user_operation_controller --> transaction_controller;
+  wallet_framework --> approval_controller;
+  wallet_framework --> base_controller;
+  wallet_framework --> controller_utils;
+  wallet_framework --> json_rpc_engine;
+  wallet_framework --> keyring_controller;
+  wallet_framework --> permission_controller;
 ```
 
 <!-- end dependency graph -->

constraints.pro

@@ -374,6 +374,7 @@ gen_enforced_dependency(WorkspaceCwd, DependencyIdent, null, 'devDependencies')
 gen_enforced_dependency(WorkspaceCwd, DependencyIdent, CorrectPeerDependencyRange, 'peerDependencies') :-
   workspace_has_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, 'dependencies'),
   \+ workspace_has_dependency(WorkspaceCwd, DependencyIdent, _, 'peerDependencies'),
+  WorkspaceCwd \= 'packages/wallet-framework',
   is_controller(DependencyIdent),
   DependencyIdent \= '@metamask/base-controller',
   DependencyIdent \= '@metamask/eth-keyring-controller',
@@ -385,6 +386,7 @@ gen_enforced_dependency(WorkspaceCwd, DependencyIdent, CorrectPeerDependencyRang
   atom_concat('^', CorrectPeerDependencyVersion, CorrectPeerDependencyRange).
 gen_enforced_dependency(WorkspaceCwd, DependencyIdent, CorrectPeerDependencyRange, 'peerDependencies') :-
   workspace_has_dependency(WorkspaceCwd, DependencyIdent, SpecifiedPeerDependencyRange, 'peerDependencies'),
+  WorkspaceCwd \= 'packages/wallet-framework',
   is_controller(DependencyIdent),
   DependencyIdent \= '@metamask/base-controller',
   DependencyIdent \= '@metamask/eth-keyring-controller',

packages/permission-controller/src/PermissionController.ts

@@ -339,6 +339,18 @@ export type ClearPermissions = {
   handler: () => void;
 };
 
+/**
+ * Execute a restricted method.
+ *
+ * @deprecated The permission middleware is intended to be the only place this is called. This was
+ * exposed as an action so that it could be used in a single legacy middleware function that needs
+ * to come before the permission middleware. Do not call this anywhere else.
+ */
+export type ExecuteRestructedMethod = {
+  type: `${typeof controllerName}:executeRestrictedMethod`;
+  handler: GenericPermissionController['executeRestrictedMethod'];
+};
+
 /**
  * Gets the endowments for the given subject and permission.
  */
@@ -352,6 +364,7 @@ export type GetEndowments = {
  */
 export type PermissionControllerActions =
   | ClearPermissions
+  | ExecuteRestructedMethod
   | GetEndowments
   | GetPermissionControllerState
   | GetSubjects
@@ -815,6 +828,12 @@ export class PermissionController<
       () => this.clearState(),
     );
 
+    this.messagingSystem.registerActionHandler(
+      `${controllerName}:executeRestrictedMethod` as const,
+      (...args: Parameters<typeof this.executeRestrictedMethod>) =>
+        this.executeRestrictedMethod(...args),
+    );
+
     this.messagingSystem.registerActionHandler(
       `${controllerName}:getEndowments` as const,
       (origin: string, targetName: string, requestData?: unknown) =>

packages/wallet-framework/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/

packages/wallet-framework/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 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

packages/wallet-framework/README.md

@@ -0,0 +1,15 @@
+# `@metamask/wallet-framework`
+
+A framework for building MetaMask wallets.
+
+## Installation
+
+`yarn add @metamask/wallet-framework`
+
+or
+
+`npm install @metamask/wallet-framework`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

packages/wallet-framework/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,
+    },
+  },
+});

packages/wallet-framework/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@metamask/wallet-framework",
+  "version": "0.0.0",
+  "description": "A framework for building MetaMask wallets",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/wallet-framework#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": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsup --config ../../tsup.config.ts --tsconfig ./tsconfig.build.json --clean",
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/wallet-framework",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest --reporters=jest-silent-reporter",
+    "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask/approval-controller": "^7.0.0",
+    "@metamask/base-controller": "^6.0.0",
+    "@metamask/controller-utils": "^11.0.0",
+    "@metamask/eth-json-rpc-middleware": "^12.1.1",
+    "@metamask/json-rpc-engine": "^9.0.0",
+    "@metamask/keyring-controller": "^17.1.0",
+    "@metamask/permission-controller": "^10.0.0",
+    "@metamask/rpc-errors": "^6.2.1",
+    "@metamask/utils": "^8.3.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~4.9.5"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}