From 70bd65f209a2738ec94671726668777bb56a4a7a Mon Sep 17 00:00:00 2001 From: jiexi Date: Mon, 21 Oct 2024 11:57:48 -0700 Subject: [PATCH] feat: create initial `@metamask/multichain` package (#4812) ## Explanation Creates the initial (empty) `@metamask/multichain` package to make downstream additions to this package easier to review. ## References Upstream: https://github.com/MetaMask/core/pull/4811 Downstream: https://github.com/MetaMask/core/pull/4784 ## Changelog ### `@metamask/multichain` - **ADDED**: Initial skeleton package for `@metamask/multichain` ## Checklist - [X] I've updated the test suite for new or updated code as appropriate - [X] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [X] I've highlighted breaking changes using the "BREAKING" category above as appropriate - [X] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes --------- Co-authored-by: Mark Stacey Co-authored-by: Alex --- README.md | 27 +++++----- packages/multichain/CHANGELOG.md | 10 ++++ packages/multichain/LICENSE | 20 ++++++++ packages/multichain/README.md | 15 ++++++ packages/multichain/jest.config.js | 26 ++++++++++ packages/multichain/package.json | 66 +++++++++++++++++++++++++ packages/multichain/src/index.test.ts | 9 ++++ packages/multichain/src/index.ts | 9 ++++ packages/multichain/tsconfig.build.json | 10 ++++ packages/multichain/tsconfig.json | 8 +++ packages/multichain/typedoc.json | 7 +++ tsconfig.build.json | 1 + tsconfig.json | 1 + yarn.lock | 15 ++++++ 14 files changed, 213 insertions(+), 11 deletions(-) create mode 100644 packages/multichain/CHANGELOG.md create mode 100644 packages/multichain/LICENSE create mode 100644 packages/multichain/README.md create mode 100644 packages/multichain/jest.config.js create mode 100644 packages/multichain/package.json create mode 100644 packages/multichain/src/index.test.ts create mode 100644 packages/multichain/src/index.ts create mode 100644 packages/multichain/tsconfig.build.json create mode 100644 packages/multichain/tsconfig.json create mode 100644 packages/multichain/typedoc.json diff --git a/README.md b/README.md index e5961edab2..91009bca92 100644 --- a/README.md +++ b/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,25 @@ 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 --> 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; ``` diff --git a/packages/multichain/CHANGELOG.md b/packages/multichain/CHANGELOG.md new file mode 100644 index 0000000000..b518709c7b --- /dev/null +++ b/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/ diff --git a/packages/multichain/LICENSE b/packages/multichain/LICENSE new file mode 100644 index 0000000000..6f8bff03fc --- /dev/null +++ b/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 diff --git a/packages/multichain/README.md b/packages/multichain/README.md new file mode 100644 index 0000000000..dc89e0fade --- /dev/null +++ b/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). diff --git a/packages/multichain/jest.config.js b/packages/multichain/jest.config.js new file mode 100644 index 0000000000..ca08413339 --- /dev/null +++ b/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: 100, + functions: 100, + lines: 100, + statements: 100, + }, + }, +}); diff --git a/packages/multichain/package.json b/packages/multichain/package.json new file mode 100644 index 0000000000..4fa4f7ccfc --- /dev/null +++ b/packages/multichain/package.json @@ -0,0 +1,66 @@ +{ + "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" + }, + "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": "~5.2.2" + }, + "engines": { + "node": "^18.18 || >=20" + }, + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org/" + } +} diff --git a/packages/multichain/src/index.test.ts b/packages/multichain/src/index.test.ts new file mode 100644 index 0000000000..bc062d3694 --- /dev/null +++ b/packages/multichain/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/multichain/src/index.ts b/packages/multichain/src/index.ts new file mode 100644 index 0000000000..6972c11729 --- /dev/null +++ b/packages/multichain/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/multichain/tsconfig.build.json b/packages/multichain/tsconfig.build.json new file mode 100644 index 0000000000..02a0eea03f --- /dev/null +++ b/packages/multichain/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/multichain/tsconfig.json b/packages/multichain/tsconfig.json new file mode 100644 index 0000000000..025ba2ef7f --- /dev/null +++ b/packages/multichain/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../tsconfig.packages.json", + "compilerOptions": { + "baseUrl": "./" + }, + "references": [], + "include": ["../../types", "./src"] +} diff --git a/packages/multichain/typedoc.json b/packages/multichain/typedoc.json new file mode 100644 index 0000000000..c9da015dbf --- /dev/null +++ b/packages/multichain/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 4e485ea189..6102878c56 100644 --- a/tsconfig.build.json +++ b/tsconfig.build.json @@ -18,6 +18,7 @@ { "path": "./packages/keyring-controller/tsconfig.build.json" }, { "path": "./packages/logging-controller/tsconfig.build.json" }, { "path": "./packages/message-manager/tsconfig.build.json" }, + { "path": "./packages/multichain/tsconfig.build.json" }, { "path": "./packages/name-controller/tsconfig.build.json" }, { "path": "./packages/network-controller/tsconfig.build.json" }, { "path": "./packages/notification-controller/tsconfig.build.json" }, diff --git a/tsconfig.json b/tsconfig.json index f886671a63..127a643b9d 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -18,6 +18,7 @@ { "path": "./packages/json-rpc-middleware-stream" }, { "path": "./packages/keyring-controller" }, { "path": "./packages/message-manager" }, + { "path": "./packages/multichain" }, { "path": "./packages/name-controller" }, { "path": "./packages/network-controller" }, { "path": "./packages/notification-controller" }, diff --git a/yarn.lock b/yarn.lock index 2eb7ea4f1a..0a7675ca55 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2998,6 +2998,21 @@ __metadata: languageName: node linkType: hard +"@metamask/multichain@workspace:packages/multichain": + version: 0.0.0-use.local + resolution: "@metamask/multichain@workspace:packages/multichain" + dependencies: + "@metamask/auto-changelog": "npm:^3.4.4" + "@types/jest": "npm:^27.4.1" + deepmerge: "npm:^4.2.2" + jest: "npm:^27.5.1" + ts-jest: "npm:^27.1.4" + typedoc: "npm:^0.24.8" + typedoc-plugin-missing-exports: "npm:^2.0.0" + typescript: "npm:~5.2.2" + languageName: unknown + linkType: soft + "@metamask/name-controller@workspace:packages/name-controller": version: 0.0.0-use.local resolution: "@metamask/name-controller@workspace:packages/name-controller"