feat: Add NetworkVisibilityController
#5939
+917
−5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2025 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # `@metamask/network-visibility-controller` | ||
|
|
||
| Handles user-facing network state for how networks are displayed and interacted with. | ||
|
|
||
| ## Installation | ||
|
|
||
| `yarn add @metamask/network-visibility-controller` | ||
|
|
||
| or | ||
|
|
||
| `npm install @metamask/network-visibility-controller` | ||
|
|
||
| ## Contributing | ||
|
|
||
| This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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, | ||
| }, | ||
| }, | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| { | ||
| "name": "@metamask/network-visibility-controller", | ||
| "version": "0.0.0", | ||
| "description": "Handles user-facing network state for how networks are displayed and interacted with", | ||
| "keywords": [ | ||
| "MetaMask", | ||
| "Ethereum" | ||
| ], | ||
| "homepage": "https://github.com/MetaMask/core/tree/main/packages/network-visibility-controller#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:validate": "../../scripts/validate-changelog.sh @metamask/network-visibility-controller", | ||
| "since-latest-release": "../../scripts/since-latest-release.sh", | ||
| "changelog:update": "../../scripts/update-changelog.sh @metamask/network-visibility-controller", | ||
| "publish:preview": "yarn npm publish --tag preview", | ||
| "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": { | ||
| "@lavamoat/allow-scripts": "^3.0.4", | ||
| "@metamask/auto-changelog": "^3.4.4", | ||
| "@metamask/error-reporting-service": "^1.0.0", | ||
| "@metamask/network-controller": "^23.6.0", | ||
| "@metamask/providers": "^22.1.0", | ||
| "@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/" | ||
| }, | ||
| "dependencies": { | ||
| "@metamask/base-controller": "^8.0.1", | ||
| "@metamask/keyring-api": "^18.0.0", | ||
| "@metamask/keyring-snap-client": "^5.0.0", | ||
| "@metamask/multichain-network-controller": "^0.8.0" | ||
| }, | ||
| "peerDependencies": { | ||
| "@metamask/error-reporting-service": "^1.0.0", | ||
|
There was a problem hiding this comment. Same here, searching for this, I don't see if in out src. |
||
| "@metamask/network-controller": "^23.0.0", | ||
| "@metamask/providers": "^22.0.0" | ||
|
There was a problem hiding this comment. Same here, I think we can remove it since it is not used. |
||
| }, | ||
| "lavamoat": { | ||
| "allowScripts": { | ||
| "@metamask/multichain-network-controller>@metamask/accounts-controller>@metamask/keyring-controller>ethereumjs-wallet>ethereum-cryptography>keccak": false, | ||
| "@metamask/multichain-network-controller>@metamask/accounts-controller>@metamask/keyring-controller>ethereumjs-wallet>ethereum-cryptography>secp256k1": false | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Unchanged files with check annotations Beta
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import { errorCodes, JsonRpcError } from '@metamask/rpc-errors'; | ||
| import { nanoid } from 'nanoid'; | ||
| import { flushPromises } from '../../../tests/helpers'; | ||
| import type { | ||
| AddApprovalOptions, | ||
| ApprovalControllerActions, | ||
| const id = Object.keys( | ||
| approvalController.state[PENDING_APPROVALS_STORE_KEY], | ||
| )[0]; | ||
| expect(id && typeof id === 'string').toBe(true); | ||
| }); | ||
| it('adds correctly specified entry with request data', () => { | ||
| ).not.toThrow(); | ||
| expect( | ||
| approvalController.has({ id: 'foo1' }) && | ||
| approvalController.has({ id: 'foo2' }), | ||
| ).toBe(true); | ||
| expect( | ||
| approvalController.has({ origin: ORIGIN }) && | ||
|
Check warning on line 412 in packages/approval-controller/src/ApprovalController.test.ts
|
||
| approvalController.has({ origin: ORIGIN, type: 'myType1' }) && | ||
| approvalController.has({ origin: ORIGIN, type: 'myType2' }), | ||
| ).toBe(true); | ||
| approvalController.accept('foo'); | ||
| expect( | ||
| !approvalController.has({ id: 'foo' }) && | ||
|
Check warning on line 949 in packages/approval-controller/src/ApprovalController.test.ts
|
||
| !approvalController.has({ type: 'type' }) && | ||
| !approvalController.has({ origin: 'bar.baz' }) && | ||
| !approvalController.state[PENDING_APPROVALS_STORE_KEY].foo, | ||
| approvalController.accept('fizz'); | ||
| expect( | ||
| !approvalController.has({ id: 'fizz' }) && | ||
| !approvalController.has({ origin: 'bar.baz', type: 'type2' }), | ||
| ).toBe(true); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import { SnapStatus } from '@metamask/snaps-utils'; | ||
| import type { CaipChainId } from '@metamask/utils'; | ||
| import type { V4Options } from 'uuid'; | ||
| import * as uuid from 'uuid'; | ||
| import type { | ||
| AccountsControllerActions, | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we use this dep, I don't see it when I search for it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are inheriting the
BaseControllerinNetworkVisibilityControllerso that we can extend from it. I saw this pattern elsewhere in the app. Did I miss something here?