feat: Add CAIP-25 permission and adapters to @metamask/multichain

README.md

@@ -26,6 +26,7 @@ This repository contains the following packages [^fn1]:
 - [`@metamask/keyring-controller`](packages/keyring-controller)
 - [`@metamask/logging-controller`](packages/logging-controller)
 - [`@metamask/message-manager`](packages/message-manager)
+- [`@metamask/multichain`](packages/multichain)
 - [`@metamask/name-controller`](packages/name-controller)
 - [`@metamask/network-controller`](packages/network-controller)
 - [`@metamask/notification-controller`](packages/notification-controller)
@@ -71,6 +72,7 @@ linkStyle default opacity:0.5
   keyring_controller(["@metamask/keyring-controller"]);
   logging_controller(["@metamask/logging-controller"]);
   message_manager(["@metamask/message-manager"]);
+  multichain(["@metamask/multichain"]);
   name_controller(["@metamask/name-controller"]);
   network_controller(["@metamask/network-controller"]);
   notification_controller(["@metamask/notification-controller"]);
@@ -93,14 +95,15 @@ linkStyle default opacity:0.5
   address_book_controller --> controller_utils;
   announcement_controller --> base_controller;
   approval_controller --> base_controller;
-  assets_controllers --> accounts_controller;
-  assets_controllers --> approval_controller;
   assets_controllers --> base_controller;
   assets_controllers --> controller_utils;
+  assets_controllers --> polling_controller;
+  assets_controllers --> accounts_controller;
+  assets_controllers --> approval_controller;
   assets_controllers --> keyring_controller;
   assets_controllers --> network_controller;
-  assets_controllers --> polling_controller;
   assets_controllers --> preferences_controller;
+  base_controller --> json_rpc_engine;
   chain_controller --> base_controller;
   composable_controller --> base_controller;
   composable_controller --> json_rpc_engine;
@@ -110,8 +113,8 @@ linkStyle default opacity:0.5
   eth_json_rpc_provider --> json_rpc_engine;
   gas_fee_controller --> base_controller;
   gas_fee_controller --> controller_utils;
-  gas_fee_controller --> network_controller;
   gas_fee_controller --> polling_controller;
+  gas_fee_controller --> network_controller;
   json_rpc_middleware_stream --> json_rpc_engine;
   keyring_controller --> base_controller;
   keyring_controller --> message_manager;
@@ -145,6 +148,9 @@ linkStyle default opacity:0.5
   preferences_controller --> controller_utils;
   preferences_controller --> keyring_controller;
   profile_sync_controller --> base_controller;
+  profile_sync_controller --> keyring_controller;
+  profile_sync_controller --> accounts_controller;
+  profile_sync_controller --> network_controller;
   queued_request_controller --> base_controller;
   queued_request_controller --> controller_utils;
   queued_request_controller --> json_rpc_engine;
@@ -155,26 +161,26 @@ linkStyle default opacity:0.5
   selected_network_controller --> json_rpc_engine;
   selected_network_controller --> network_controller;
   selected_network_controller --> permission_controller;
-  signature_controller --> approval_controller;
   signature_controller --> base_controller;
   signature_controller --> controller_utils;
+  signature_controller --> message_manager;
+  signature_controller --> approval_controller;
   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 --> accounts_controller;
+  transaction_controller --> approval_controller;
+  transaction_controller --> eth_json_rpc_provider;
   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;
+  user_operation_controller --> polling_controller;
+  user_operation_controller --> approval_controller;
   user_operation_controller --> gas_fee_controller;
   user_operation_controller --> keyring_controller;
   user_operation_controller --> network_controller;
-  user_operation_controller --> polling_controller;
   user_operation_controller --> transaction_controller;
 ```
 

packages/assets-controllers/src/TokenDetectionController.ts

@@ -9,7 +9,11 @@ import type {
   ControllerStateChangeEvent,
 } from '@metamask/base-controller';
 import contractMap from '@metamask/contract-metadata';
-import { ChainId, safelyExecute } from '@metamask/controller-utils';
+import {
+  ChainId,
+  safelyExecute,
+  isEqualCaseInsensitive,
+} from '@metamask/controller-utils';
 import type {
   KeyringControllerGetStateAction,
   KeyringControllerLockEvent,
@@ -44,26 +48,6 @@ import type {
 
 const DEFAULT_INTERVAL = 180000;
 
-/**
- * Compare 2 given strings and return boolean
- * eg: "foo" and "FOO" => true
- * eg: "foo" and "bar" => false
- * eg: "foo" and 123 => false
- *
- * @param value1 - first string to compare
- * @param value2 - first string to compare
- * @returns true if 2 strings are identical when they are lowercase
- */
-export function isEqualCaseInsensitive(
-  value1: string,
-  value2: string,
-): boolean {
-  if (typeof value1 !== 'string' || typeof value2 !== 'string') {
-    return false;
-  }
-  return value1.toLowerCase() === value2.toLowerCase();
-}
-
 type LegacyToken = {
   name: string;
   logo: `${string}.svg`;

packages/controller-utils/src/index.ts

@@ -27,6 +27,7 @@ export {
   toChecksumHexAddress,
   toHex,
   weiHexToGweiDec,
+  isEqualCaseInsensitive,
 } from './util';
 export * from './types';
 export * from './siwe';

packages/controller-utils/src/util.test.ts

@@ -611,3 +611,29 @@ describe('util', () => {
     });
   });
 });
+
+describe('isEqualCaseInsensitive', () => {
+  it('returns false for non-string values', () => {
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive(null, 'test')).toBe(false);
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive('test', null)).toBe(false);
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive(5, 'test')).toBe(false);
+    // @ts-expect-error Invalid type for testing purposes
+    expect(util.isEqualCaseInsensitive('test', 5)).toBe(false);
+  });
+
+  it('returns false for strings that are not equal', () => {
+    expect(util.isEqualCaseInsensitive('test', 'test1')).toBe(false);
+    expect(util.isEqualCaseInsensitive('test1', 'test')).toBe(false);
+  });
+
+  it('returns true for strings that are equal', () => {
+    expect(util.isEqualCaseInsensitive('test', 'TEST')).toBe(true);
+    expect(util.isEqualCaseInsensitive('test', 'test')).toBe(true);
+    expect(util.isEqualCaseInsensitive('TEST', 'TEST')).toBe(true);
+    expect(util.isEqualCaseInsensitive('test', 'Test')).toBe(true);
+    expect(util.isEqualCaseInsensitive('Test', 'test')).toBe(true);
+  });
+});

packages/controller-utils/src/util.ts

@@ -619,3 +619,20 @@ function logOrRethrowError(error: unknown, codesToCatch: number[] = []) {
     throw error;
   }
 }
+
+/**
+ * Checks if two strings are equal, ignoring case.
+ *
+ * @param value1 - The first string to compare.
+ * @param value2 - The second string to compare.
+ * @returns `true` if the strings are equal, ignoring case; otherwise, `false`.
+ */
+export function isEqualCaseInsensitive(
+  value1: string,
+  value2: string,
+): boolean {
+  if (typeof value1 !== 'string' || typeof value2 !== 'string') {
+    return false;
+  }
+  return value1.toLowerCase() === value2.toLowerCase();
+}

packages/multichain/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/multichain/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/multichain/README.md

@@ -0,0 +1,15 @@
+# `@metamask/multichain`
+
+Provides types, helpers, adapters, and wrappers for facilitating CAIP Multichain sessions
+
+## Installation
+
+`yarn add @metamask/multichain`
+
+or
+
+`npm install @metamask/multichain`
+
+## 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/multichain/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: 82.38,
+      functions: 87.37,
+      lines: 86.65,
+      statements: 87.09,
+    },
+  },
+});

packages/multichain/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@metamask/multichain",
+  "version": "0.0.0",
+  "description": "Provides types, helpers, adapters, and wrappers for facilitating CAIP Multichain sessions",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/multichain#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:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/multichain",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/multichain",
+    "publish:preview": "yarn npm publish --tag preview",
+    "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/api-specs": "^0.10.12",
+    "@metamask/controller-utils": "^11.3.0",
+    "@metamask/eth-json-rpc-filters": "^7.0.0",
+    "@metamask/rpc-errors": "^6.3.1",
+    "@metamask/safe-event-emitter": "^3.0.0",
+    "@metamask/utils": "^9.1.0",
+    "@open-rpc/schema-utils-js": "^2.0.5",
+    "jsonschema": "^1.2.4",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/json-rpc-engine": "^9.0.3",
+    "@metamask/network-controller": "^21.0.1",
+    "@metamask/permission-controller": "^11.0.2",
+    "@open-rpc/meta-schema": "^1.14.6",
+    "@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": "~5.2.2"
+  },
+  "peerDependencies": {
+    "@metamask/network-controller": "^21.0.0",
+    "@metamask/permission-controller": "^11.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}