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: add multichain support to bridge-controller #5486

Merged
merged 53 commits into from
Mar 21, 2025

Conversation

micaelae
Copy link
Member

@micaelae micaelae commented Mar 14, 2025

Explanation

The BridgeController currently only works with EVM networks and addresses. In order to support Solana integration into mobile, this PR adds the multichain compatibility updates implemented in extension.

Specific changes

  • Add support for solana in fetchBridgeTokens util
  • CAIP address and chainId support
  • Solana constants, quote fetching+validation and fee calculation logic
  • Replaces account used with multichain account
  • Tenderly quote override for e2e testing (this enables submitting bridge txs to a forked network so no real funds are spent)

Notes for upgrading mobile to this version

  • Controller's allowed actions need to be updated (see AllowedActions type update)
  • There should be no functional differences until Solana is enabled
  • When Solana is enabled, quote fetching should ✨ just work ✨

References

Changelog

@metamask/bridge-controller 8.0.0

ADDED

  • fetching Solana tokens and bridge/swap quotes, including tx validation and calculating Solana fees
  • chainId and address formatting utilities to make client side data compatible with the bridge-api's expected formats

CHANGED

  • Updated BridgeController's constructor so the fetchFn can propagate parameters to the underlying fetch function
  • Set intervals for polling quotes based on a feature flag
  • Change bridgeFeatureFlags.chains keys from Hex to CAIP-formatted chainIds

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@micaelae micaelae requested review from a team as code owners March 14, 2025 22:51
@micaelae micaelae marked this pull request as draft March 14, 2025 22:51
@micaelae micaelae force-pushed the mms2100-bridge-multichain-support branch from 9817317 to 1a23d2d Compare March 17, 2025 19:16
@micaelae micaelae force-pushed the mms2100-bridge-multichain-support branch from 1a23d2d to 42b9e6c Compare March 18, 2025 18:12
@micaelae micaelae marked this pull request as ready for review March 19, 2025 00:35
Copy link

socket-security bot commented Mar 20, 2025

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@metamask/[email protected] None +12 3.56 MB metamaskbot

View full report↗︎

@micaelae
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "27.0.0-preview-8c783cb1",
  "@metamask-previews/address-book-controller": "6.0.3-preview-8c783cb1",
  "@metamask-previews/announcement-controller": "7.0.3-preview-8c783cb1",
  "@metamask-previews/approval-controller": "7.1.3-preview-8c783cb1",
  "@metamask-previews/assets-controllers": "55.0.1-preview-8c783cb1",
  "@metamask-previews/base-controller": "8.0.0-preview-8c783cb1",
  "@metamask-previews/bridge-controller": "9.0.0-preview-8c783cb1",
  "@metamask-previews/bridge-status-controller": "9.0.0-preview-8c783cb1",
  "@metamask-previews/build-utils": "3.0.3-preview-8c783cb1",
  "@metamask-previews/chain-agnostic-permission": "0.1.0-preview-8c783cb1",
  "@metamask-previews/composable-controller": "11.0.0-preview-8c783cb1",
  "@metamask-previews/controller-utils": "11.6.0-preview-8c783cb1",
  "@metamask-previews/earn-controller": "0.9.0-preview-8c783cb1",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-8c783cb1",
  "@metamask-previews/ens-controller": "16.0.0-preview-8c783cb1",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-8c783cb1",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-8c783cb1",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-8c783cb1",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-8c783cb1",
  "@metamask-previews/keyring-controller": "21.0.0-preview-8c783cb1",
  "@metamask-previews/logging-controller": "6.0.4-preview-8c783cb1",
  "@metamask-previews/message-manager": "12.0.1-preview-8c783cb1",
  "@metamask-previews/multichain": "4.0.0-preview-8c783cb1",
  "@metamask-previews/multichain-api-middleware": "0.1.0-preview-8c783cb1",
  "@metamask-previews/multichain-network-controller": "0.3.0-preview-8c783cb1",
  "@metamask-previews/multichain-transactions-controller": "0.8.0-preview-8c783cb1",
  "@metamask-previews/name-controller": "8.0.3-preview-8c783cb1",
  "@metamask-previews/network-controller": "23.0.0-preview-8c783cb1",
  "@metamask-previews/notification-services-controller": "5.0.0-preview-8c783cb1",
  "@metamask-previews/permission-controller": "11.0.6-preview-8c783cb1",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-8c783cb1",
  "@metamask-previews/phishing-controller": "12.4.1-preview-8c783cb1",
  "@metamask-previews/polling-controller": "13.0.0-preview-8c783cb1",
  "@metamask-previews/preferences-controller": "17.0.0-preview-8c783cb1",
  "@metamask-previews/profile-sync-controller": "11.0.0-preview-8c783cb1",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-8c783cb1",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-8c783cb1",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-8c783cb1",
  "@metamask-previews/sample-controllers": "0.0.0-preview-8c783cb1",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-8c783cb1",
  "@metamask-previews/signature-controller": "27.0.0-preview-8c783cb1",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-8c783cb1",
  "@metamask-previews/transaction-controller": "51.0.0-preview-8c783cb1",
  "@metamask-previews/user-operation-controller": "30.0.0-preview-8c783cb1"
}

@micaelae
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "27.0.0-preview-330335c1",
  "@metamask-previews/address-book-controller": "6.0.3-preview-330335c1",
  "@metamask-previews/announcement-controller": "7.0.3-preview-330335c1",
  "@metamask-previews/approval-controller": "7.1.3-preview-330335c1",
  "@metamask-previews/assets-controllers": "55.0.1-preview-330335c1",
  "@metamask-previews/base-controller": "8.0.0-preview-330335c1",
  "@metamask-previews/bridge-controller": "9.0.0-preview-330335c1",
  "@metamask-previews/bridge-status-controller": "9.0.0-preview-330335c1",
  "@metamask-previews/build-utils": "3.0.3-preview-330335c1",
  "@metamask-previews/chain-agnostic-permission": "0.1.0-preview-330335c1",
  "@metamask-previews/composable-controller": "11.0.0-preview-330335c1",
  "@metamask-previews/controller-utils": "11.6.0-preview-330335c1",
  "@metamask-previews/earn-controller": "0.9.0-preview-330335c1",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-330335c1",
  "@metamask-previews/ens-controller": "16.0.0-preview-330335c1",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-330335c1",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-330335c1",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-330335c1",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-330335c1",
  "@metamask-previews/keyring-controller": "21.0.0-preview-330335c1",
  "@metamask-previews/logging-controller": "6.0.4-preview-330335c1",
  "@metamask-previews/message-manager": "12.0.1-preview-330335c1",
  "@metamask-previews/multichain": "4.0.0-preview-330335c1",
  "@metamask-previews/multichain-api-middleware": "0.1.0-preview-330335c1",
  "@metamask-previews/multichain-network-controller": "0.3.0-preview-330335c1",
  "@metamask-previews/multichain-transactions-controller": "0.8.0-preview-330335c1",
  "@metamask-previews/name-controller": "8.0.3-preview-330335c1",
  "@metamask-previews/network-controller": "23.0.0-preview-330335c1",
  "@metamask-previews/notification-services-controller": "5.0.0-preview-330335c1",
  "@metamask-previews/permission-controller": "11.0.6-preview-330335c1",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-330335c1",
  "@metamask-previews/phishing-controller": "12.4.1-preview-330335c1",
  "@metamask-previews/polling-controller": "13.0.0-preview-330335c1",
  "@metamask-previews/preferences-controller": "17.0.0-preview-330335c1",
  "@metamask-previews/profile-sync-controller": "11.0.0-preview-330335c1",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-330335c1",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-330335c1",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-330335c1",
  "@metamask-previews/sample-controllers": "0.0.0-preview-330335c1",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-330335c1",
  "@metamask-previews/signature-controller": "27.0.0-preview-330335c1",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-330335c1",
  "@metamask-previews/transaction-controller": "51.0.0-preview-330335c1",
  "@metamask-previews/user-operation-controller": "30.0.0-preview-330335c1"
}

Copy link

@ghgoodreau ghgoodreau left a comment

Choose a reason for hiding this comment

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

lgtm great work

@infiniteflower infiniteflower self-requested a review March 21, 2025 18:43
Copy link
Contributor

@infiniteflower infiniteflower left a comment

Choose a reason for hiding this comment

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

LGTM! Great work!

@micaelae micaelae merged commit 73969e1 into main Mar 21, 2025
194 checks passed
@micaelae micaelae deleted the mms2100-bridge-multichain-support branch March 21, 2025 20:26
@micaelae micaelae restored the mms2100-bridge-multichain-support branch March 21, 2025 21:01
@micaelae
Copy link
Member Author

@metamaskbot publish-preview

Copy link
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "27.0.0-preview-e7013a54",
  "@metamask-previews/address-book-controller": "6.0.3-preview-e7013a54",
  "@metamask-previews/announcement-controller": "7.0.3-preview-e7013a54",
  "@metamask-previews/approval-controller": "7.1.3-preview-e7013a54",
  "@metamask-previews/assets-controllers": "55.0.1-preview-e7013a54",
  "@metamask-previews/base-controller": "8.0.0-preview-e7013a54",
  "@metamask-previews/bridge-controller": "10.0.0-preview-e7013a54",
  "@metamask-previews/bridge-status-controller": "10.0.0-preview-e7013a54",
  "@metamask-previews/build-utils": "3.0.3-preview-e7013a54",
  "@metamask-previews/chain-agnostic-permission": "0.2.0-preview-e7013a54",
  "@metamask-previews/composable-controller": "11.0.0-preview-e7013a54",
  "@metamask-previews/controller-utils": "11.6.0-preview-e7013a54",
  "@metamask-previews/earn-controller": "0.9.0-preview-e7013a54",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-e7013a54",
  "@metamask-previews/ens-controller": "16.0.0-preview-e7013a54",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-e7013a54",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-e7013a54",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-e7013a54",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-e7013a54",
  "@metamask-previews/keyring-controller": "21.0.0-preview-e7013a54",
  "@metamask-previews/logging-controller": "6.0.4-preview-e7013a54",
  "@metamask-previews/message-manager": "12.0.1-preview-e7013a54",
  "@metamask-previews/multichain": "4.0.0-preview-e7013a54",
  "@metamask-previews/multichain-api-middleware": "0.1.1-preview-e7013a54",
  "@metamask-previews/multichain-network-controller": "0.3.0-preview-e7013a54",
  "@metamask-previews/multichain-transactions-controller": "0.8.0-preview-e7013a54",
  "@metamask-previews/name-controller": "8.0.3-preview-e7013a54",
  "@metamask-previews/network-controller": "23.1.0-preview-e7013a54",
  "@metamask-previews/notification-services-controller": "5.0.0-preview-e7013a54",
  "@metamask-previews/permission-controller": "11.0.6-preview-e7013a54",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-e7013a54",
  "@metamask-previews/phishing-controller": "12.4.1-preview-e7013a54",
  "@metamask-previews/polling-controller": "13.0.0-preview-e7013a54",
  "@metamask-previews/preferences-controller": "17.0.0-preview-e7013a54",
  "@metamask-previews/profile-sync-controller": "11.0.0-preview-e7013a54",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-e7013a54",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-e7013a54",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-e7013a54",
  "@metamask-previews/sample-controllers": "0.0.0-preview-e7013a54",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-e7013a54",
  "@metamask-previews/signature-controller": "27.0.0-preview-e7013a54",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-e7013a54",
  "@metamask-previews/transaction-controller": "52.0.0-preview-e7013a54",
  "@metamask-previews/user-operation-controller": "31.0.0-preview-e7013a54"
}

@micaelae micaelae mentioned this pull request Mar 21, 2025
micaelae added a commit that referenced this pull request Mar 21, 2025
## Explanation

Releasing @metamask/bridge-controller 11.0.0 to include multichain
network support implemented in
[5486](#5486)


<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/bridge-controller`

### Added

- BREAKING: Bump dependency @metamask/keyring-api to ^17.2.0
([#5486](#5486))
- BREAKING: Bump dependency @metamask/multichain-network-controller to
^0.3.0 ([#5486](#5486))
- BREAKING: Bump dependency @metamask/snaps-utils to ^8.10.0
([#5486](#5486))
- BREAKING: Bump peer dependency @metamask/snaps-controllers to ^9.19.0
([#5486](#5486))
- Solana constants, utils, quote and token support
([#5486](#5486))
- Utilities to convert chainIds between `ChainId`, `Hex`, `string` and
`CaipChainId` ([#5486](#5486))
- Add `refreshRate` feature flag to enable chain-specific quote refresh
intervals ([#5486](#5486))
- `isNativeAddress` and `isSolanaChainId` utilities that can be used by
both the controller and clients
([#5486](#5486))

### Changed

- Replace QuoteRequest usages with `GenericQuoteRequest` to support both
EVM and multichain input parameters
([#5486](#5486))
- Make `QuoteRequest.slippage` optional
([#5486](#5486))
- Deprecate `SwapsTokenObject` and replace usages with multichain
BridgeAsset ([#5486](#5486))
- Changed `bridgeFeatureFlags.extensionConfig.chains` to key configs by
CAIP chainIds ([#5486](#5486))

## Checklist

N/A
@micaelae micaelae deleted the mms2100-bridge-multichain-support branch March 21, 2025 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants