Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/bridge status controller #5317

Merged
merged 51 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
8343c85
chore: update yarn lock
infiniteflower Feb 5, 2025
624bc83
chore: setup skeleton for bridge status controller
infiniteflower Feb 7, 2025
1d0daae
chore: update readme
infiniteflower Feb 7, 2025
dc655d0
chore: change version to 0.0.0 since it's not published
infiniteflower Feb 7, 2025
9582253
chore: update yarn lock
infiniteflower Feb 7, 2025
524192b
chore: add changelog
infiniteflower Feb 7, 2025
aba0200
chore: initial commit of code
infiniteflower Feb 7, 2025
c69bcdc
chore: update packages
infiniteflower Feb 12, 2025
d2ce2e6
chore: get all imports fixed
infiniteflower Feb 12, 2025
d5a1256
fix: broken tests
infiniteflower Feb 12, 2025
4b95d16
chore: remove mocks file to push test coverage up
infiniteflower Feb 12, 2025
00fd19c
feat: add fetchBridgeTxStatus test suite and export FeeType
infiniteflower Feb 13, 2025
c3556e2
test: add getStatusRequestDto tests and refactor utils test suite
infiniteflower Feb 13, 2025
e3d1a35
test: add test for polling with no source transaction hash
infiniteflower Feb 13, 2025
8ebffe5
test: enhance startPollingForBridgeTxStatus test cases for not pollin…
infiniteflower Feb 13, 2025
5ba5372
test: adjust coverage thresholds for bridge status controller
infiniteflower Feb 13, 2025
a038f08
test: update coverage thresholds for bridge status controller
infiniteflower Feb 13, 2025
1d5c5b7
test: add test cases for bridge transaction complete and failed events
infiniteflower Feb 13, 2025
cbde55a
test: add test case for updating srcTxHash during polling
infiniteflower Feb 13, 2025
454e222
refactor: simplify bridge status state updates
infiniteflower Feb 13, 2025
9a35a20
chore: increase coverage thresholds for bridge status controller
infiniteflower Feb 13, 2025
45c0e21
refactor: remove unused bridgeStatusState variable
infiniteflower Feb 13, 2025
0551f69
chore: commit snapshots
infiniteflower Feb 13, 2025
b85ed67
chore: fix lint error
infiniteflower Feb 13, 2025
e2b6bf4
chore: update CODEOWNERS
infiniteflower Feb 13, 2025
bc586c0
Update packages/bridge-status-controller/package.json
infiniteflower Feb 14, 2025
490595b
fix: move devDeps to deps for transaction controller
infiniteflower Feb 14, 2025
6c8d118
Revert "fix: move devDeps to deps for transaction controller"
infiniteflower Feb 14, 2025
81f3699
fix: move transaction controller devDeps to deps
infiniteflower Feb 14, 2025
b847950
chore: bump tx controller version
infiniteflower Feb 14, 2025
ce70967
chore: move utils into own folder
infiniteflower Feb 14, 2025
c3e61a5
chore: add index with export
infiniteflower Feb 14, 2025
052b425
fix: broken import
infiniteflower Feb 14, 2025
6882491
chore: align package version
infiniteflower Feb 14, 2025
e1a6ff2
fix: broken import
infiniteflower Feb 14, 2025
b8a2592
chore: update yarn lock
infiniteflower Feb 18, 2025
7cf0f59
chore: bump metamask/utils version to align with rest of codebase
infiniteflower Feb 18, 2025
df821b2
chore: remove unused dep
infiniteflower Feb 19, 2025
45fb6c8
chore: remove unneeded @metamask/json-rpc-engine dependency
infiniteflower Feb 19, 2025
fbe37fe
Update packages/bridge-status-controller/tsconfig.build.json
infiniteflower Feb 19, 2025
f407152
Update packages/bridge-status-controller/tsconfig.json
infiniteflower Feb 19, 2025
3e761e4
chore: remove unneeded @metamask/metamask-eth-abis dependency
infiniteflower Feb 19, 2025
4790868
Merge branch 'feat/bridge-status-controller' of github.com:MetaMask/c…
infiniteflower Feb 19, 2025
1817aab
chore: move transaction controller devDeps
infiniteflower Feb 19, 2025
0b09fa9
chore: update dependency graph
infiniteflower Feb 19, 2025
d35a619
chore: move transaction controller to devDeps for bridge controller
infiniteflower Feb 19, 2025
c440941
chore: add bridge-controller as a direct dependency of bridge-status-…
infiniteflower Feb 19, 2025
4053595
chore: add bridge-controller as a peer dependency for bridge-status-c…
infiniteflower Feb 19, 2025
8c7aec4
refactor: extract BridgeStatusControllerGetStateAction type
infiniteflower Feb 19, 2025
33dab2e
feat: add resetState action to BridgeStatusController and export all …
infiniteflower Feb 19, 2025
4b83c6d
Merge branch 'main' into feat/bridge-status-controller
infiniteflower Feb 20, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@

## Swaps-Bridge Team
/packages/bridge-controller @MetaMask/swaps-engineers
/packages/bridge-status-controller @MetaMask/swaps-engineers

## Portfolio Team
/packages/token-search-discovery-controller @MetaMask/portfolio
Expand Down Expand Up @@ -124,3 +125,5 @@
/packages/bridge-controller/CHANGELOG.md @MetaMask/swaps-engineers @MetaMask/wallet-framework-engineers
/packages/remote-feature-flag-controller/package.json @MetaMask/extension-platform @MetaMask/mobile-platform @MetaMask/wallet-framework-engineers
/packages/remote-feature-flag-controller/CHANGELOG.md @MetaMask/extension-platform @MetaMask/mobile-platform @MetaMask/wallet-framework-engineers
/packages/bridge-status-controller/package.json @MetaMask/swaps-engineers @MetaMask/wallet-framework-engineers
/packages/bridge-status-controller/CHANGELOG.md @MetaMask/swaps-engineers @MetaMask/wallet-framework-engineers
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Each package in this repository has its own README where you can find installati
- [`@metamask/assets-controllers`](packages/assets-controllers)
- [`@metamask/base-controller`](packages/base-controller)
- [`@metamask/bridge-controller`](packages/bridge-controller)
- [`@metamask/bridge-status-controller`](packages/bridge-status-controller)
- [`@metamask/build-utils`](packages/build-utils)
- [`@metamask/composable-controller`](packages/composable-controller)
- [`@metamask/controller-utils`](packages/controller-utils)
Expand Down Expand Up @@ -74,6 +75,8 @@ linkStyle default opacity:0.5
approval_controller(["@metamask/approval-controller"]);
assets_controllers(["@metamask/assets-controllers"]);
base_controller(["@metamask/base-controller"]);
bridge_controller(["@metamask/bridge-controller"]);
bridge_status_controller(["@metamask/bridge-status-controller"]);
build_utils(["@metamask/build-utils"]);
composable_controller(["@metamask/composable-controller"]);
controller_utils(["@metamask/controller-utils"]);
Expand Down Expand Up @@ -107,8 +110,8 @@ linkStyle default opacity:0.5
transaction_controller(["@metamask/transaction-controller"]);
user_operation_controller(["@metamask/user-operation-controller"]);
accounts_controller --> base_controller;
accounts_controller --> keyring_controller;
accounts_controller --> network_controller;
accounts_controller --> keyring_controller;
address_book_controller --> base_controller;
address_book_controller --> controller_utils;
announcement_controller --> base_controller;
Expand All @@ -123,6 +126,20 @@ linkStyle default opacity:0.5
assets_controllers --> permission_controller;
assets_controllers --> preferences_controller;
base_controller --> json_rpc_engine;
bridge_controller --> base_controller;
bridge_controller --> controller_utils;
bridge_controller --> polling_controller;
bridge_controller --> transaction_controller;
bridge_controller --> accounts_controller;
bridge_controller --> eth_json_rpc_provider;
bridge_controller --> network_controller;
bridge_status_controller --> base_controller;
bridge_status_controller --> controller_utils;
bridge_status_controller --> polling_controller;
bridge_status_controller --> accounts_controller;
bridge_status_controller --> bridge_controller;
bridge_status_controller --> network_controller;
bridge_status_controller --> transaction_controller;
composable_controller --> base_controller;
composable_controller --> json_rpc_engine;
earn_controller --> base_controller;
Expand All @@ -139,7 +156,6 @@ linkStyle default opacity:0.5
gas_fee_controller --> network_controller;
json_rpc_middleware_stream --> json_rpc_engine;
keyring_controller --> base_controller;
keyring_controller --> message_manager;
logging_controller --> base_controller;
logging_controller --> controller_utils;
message_manager --> base_controller;
Expand All @@ -150,6 +166,7 @@ linkStyle default opacity:0.5
multichain --> permission_controller;
multichain_network_controller --> base_controller;
multichain_network_controller --> keyring_controller;
multichain_network_controller --> network_controller;
multichain_transactions_controller --> base_controller;
multichain_transactions_controller --> polling_controller;
multichain_transactions_controller --> accounts_controller;
Expand Down Expand Up @@ -203,6 +220,7 @@ linkStyle default opacity:0.5
token_search_discovery_controller --> base_controller;
transaction_controller --> base_controller;
transaction_controller --> controller_utils;
transaction_controller --> remote_feature_flag_controller;
transaction_controller --> accounts_controller;
transaction_controller --> approval_controller;
transaction_controller --> eth_json_rpc_provider;
Expand Down
1 change: 0 additions & 1 deletion packages/bridge-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@
"@metamask/accounts-controller": "^24.0.0",
"@metamask/auto-changelog": "^3.4.4",
"@metamask/eth-json-rpc-provider": "^4.1.8",
"@metamask/json-rpc-engine": "^10.0.3",
"@metamask/network-controller": "^22.2.1",
"@metamask/transaction-controller": "^46.0.0",
"@types/jest": "^27.4.1",
Expand Down
3 changes: 2 additions & 1 deletion packages/bridge-controller/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ export type {
Quote,
QuoteResponse,
ChainId,
FeeType,
FeeData,
TxData,
BridgeFeatureFlagsKey,
Expand All @@ -34,6 +33,8 @@ export type {
BridgeControllerMessenger,
} from './types';

export { FeeType } from './types';

export {
ALLOWED_BRIDGE_CHAIN_IDS,
BridgeClientId,
Expand Down
14 changes: 14 additions & 0 deletions packages/bridge-status-controller/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 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]

### Added

- Initial release

[Unreleased]: https://github.com/MetaMask/core/
20 changes: 20 additions & 0 deletions packages/bridge-status-controller/LICENSE
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
15 changes: 15 additions & 0 deletions packages/bridge-status-controller/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# `@metamask/bridge-status-controller`

Manages bridge-related status fetching functionality for MetaMask.

## Installation

`yarn add @metamask/bridge-status-controller`

or

`npm install @metamask/bridge-status-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).
26 changes: 26 additions & 0 deletions packages/bridge-status-controller/jest.config.js
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: 94,
functions: 100,
lines: 100,
statements: 100,
},
},
});
85 changes: 85 additions & 0 deletions packages/bridge-status-controller/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
{
"name": "@metamask/bridge-status-controller",
"version": "0.0.0",
"description": "Manages bridge-related status fetching functionality for MetaMask",
"keywords": [
"MetaMask",
"Ethereum"
],
"homepage": "https://github.com/MetaMask/core/tree/main/packages/bridge-status-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:update": "../../scripts/update-changelog.sh @metamask/bridge-status-controller",
"changelog:validate": "../../scripts/validate-changelog.sh @metamask/bridge-status-controller",
"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/base-controller": "^8.0.0",
"@metamask/bridge-controller": "^0.0.0",
"@metamask/controller-utils": "^11.5.0",
"@metamask/polling-controller": "^12.0.3",
"@metamask/utils": "^11.2.0"
},
"devDependencies": {
"@metamask/accounts-controller": "^24.0.0",
"@metamask/auto-changelog": "^3.4.4",
"@metamask/network-controller": "^22.2.1",
"@metamask/transaction-controller": "^46.0.0",
"@types/jest": "^27.4.1",
"deepmerge": "^4.2.2",
"jest": "^27.5.1",
"jest-environment-jsdom": "^27.5.1",
"lodash": "^4.17.21",
"nock": "^13.3.1",
"ts-jest": "^27.1.4",
"typedoc": "^0.24.8",
"typedoc-plugin-missing-exports": "^2.0.0",
"typescript": "~5.2.2"
},
"peerDependencies": {
"@metamask/accounts-controller": "^24.0.0",
mcmire marked this conversation as resolved.
Show resolved Hide resolved
"@metamask/bridge-controller": "^0.0.0",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For future reviewers: there seems to be a bug in the Yarn constraints which forces any controller packages added as dependencies to also be added as peer dependencies. We should fix this.

"@metamask/network-controller": "^22.0.0",
"@metamask/transaction-controller": "^46.0.0"
},
"engines": {
"node": "^18.18 || >=20"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
}
}
Loading
Loading