feat: bridge controller

[infiniteflower]

Explanation

This PR adds a new controller: BridgeController.

This controller handles the quote fetching and polling from the Bridge API.

References

This is a port of the BridgeController from Extension: https://github.com/MetaMask/metamask-extension/tree/main/app/scripts/controllers/bridge

Some minor changes were needed to fill in the missing functions and variables from Extension.

This package will be consumed initially by the Metamask Mobile application first. Eventually, we wish to migrate the Extension to use this core/bridge-controller package.

Changelog

@metamask/bridge-controller

• : New BridgeController!

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

[socket-security]

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

[infiniteflower]

@SocketSecurity ignore npm/[email protected]

Was Introduced by @metamask/[email protected]

[mcmire]

Hi @infiniteflower! I've taken a good look at this PR. There are a number of items that would be great to fix to align with the rest of the controllers in this repo. However I recognize that the goal of this PR is probably just to port the controller from extension. So while I've made a lot of suggestions, I've marked the items I think we can could leave for another PR with ⏭️. Hope that helps.

[mcmire]

⏭️ We have multiple instances of chain IDs in this repo (name-controller, preferences-controller, transaction-controller, etc.) and it'd be great if we could consolidate these.

We've been using controller-utils as a shared location for constants like this. It has a ChainId enum that I think could be a good candidate for copying this information to.

[mcmire]

⏭️ controller-utils has a NetworkNickname enum, and I think these display names could be copied there.

[mcmire]

⏭️ Maybe these should not be SCREAMING_SNAKE_CASE, since they are not globals.

[mcmire]

It looks like this file is out of sync with dependencies:

Suggested change

	{ "path": "../base-controller" },
	{ "path": "../controller-utils" },
	{ "path": "../polling-controller" },
	{ "path": "../network-controller" },
	{ "path": "../transaction-controller" }
	{ "path": "../accounts-controller" },
	{ "path": "../base-controller" },
	{ "path": "../controller-utils" },
	{ "path": "../network-controller" },
	{ "path": "../polling-controller" },
	{ "path": "../transaction-controller" }

[mcmire]

It looks like this is out of date with the dependencies:

Suggested change

	{ "path": "../accounts-controller/tsconfig.build.json" },
	{ "path": "../approval-controller/tsconfig.build.json" },
	{ "path": "../base-controller/tsconfig.build.json" },
	{ "path": "../controller-utils/tsconfig.build.json" },
	{ "path": "../keyring-controller/tsconfig.build.json" },
	{ "path": "../network-controller/tsconfig.build.json" },
	{ "path": "../preferences-controller/tsconfig.build.json" },
	{ "path": "../polling-controller/tsconfig.build.json" }
	{ "path": "../accounts-controller/tsconfig.build.json" },
	{ "path": "../base-controller/tsconfig.build.json" },
	{ "path": "../controller-utils/tsconfig.build.json" },
	{ "path": "../network-controller/tsconfig.build.json" },
	{ "path": "../polling-controller/tsconfig.build.json" },
	{ "path": "../transaction-controller/tsconfig.build.json" }

[mcmire]

⏭️ We should strive to hit 100% test coverage. Otherwise, if we are on a branch and we get errors from Jest saying that coverage has not been met, it is painful to figure out which lines have been added in that branch that we need to test.