feat: migrate token balances controller to base controller v2

[cryptodev-2s]

Explanation

The TokenBalancesController has been migrated to BaseControllerV2.

References

Closes #1808

Changelog

@metamask/token-balances-controller

Changed

• BREAKING: Convert to BaseControllerV2
  • The constructor parameters have changed; rather than accepting a "config" parameter for interval and tokens we now pass both values as controller options, and a "state" parameter, there is now just a single object for all constructor arguments. This object has a mandatory messenger and an optional state, tokens, interval properties a disabled property has also been added.
  • State now saves tokens balances as strings and not as a BNs.
  • Additional BN export has been removed as it was intended to be removed in the next major release.

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

[MajorLift]

BaseControllerV2 controllers now have a :getState action and :stateChange event by default, so we'll need to add TokenBalancesControllerGetStateAction and TokenBalancesControllerStateChangeEvent.

For reference (from #3707):

• Introduce TransactionControllerGetStateAction type
  • You can use the ControllerGetStateAction utility type to create this; see TokenDetectionController for an example
• Introduce TransactionControllerStateChangeEvent type
  • You can use the ControllerStateChangeEvent utility type to create the type; see TokenDetectionController for an example
• Introduce TransactionControllerControllerEvents type, set to TransactionControllerStateChangeEvent
• Introduce TransactionControllerControllerActions type, set to TransactionControllerGetStateAction
• Update TransactionControllerMessenger to allowlist the above events and actions

[MajorLift]

Also, it seems like this controller should extend from StaticIntervalPollingController, not BaseControllerV2. The .{g,s}etIntervalLength() methods could be used instead of this.#interval. Although maybe this could be done in a separate PR?

[cryptodev-2s]

BaseControllerV2 controllers now have a :getState action and :stateChange event by default, so we'll need to add TokenBalancesControllerGetStateAction and TokenBalancesControllerStateChangeEvent.

For reference (from #3707):

• Introduce TransactionControllerGetStateAction type

  • You can use the ControllerGetStateAction utility type to create this; see TokenDetectionController for an example

• Introduce TransactionControllerStateChangeEvent type

  • You can use the ControllerStateChangeEvent utility type to create the type; see TokenDetectionController for an example

• Introduce TransactionControllerControllerEvents type, set to TransactionControllerStateChangeEvent

• Introduce TransactionControllerControllerActions type, set to TransactionControllerGetStateAction

• Update TransactionControllerMessenger to allowlist the above events and actions

missing types added

[cryptodev-2s]

Also, it seems like this controller should extend from StaticIntervalPollingController, not BaseControllerV2. The .{g,s}etIntervalLength() methods could be used instead of this.#interval. Although maybe this could be done in a separate PR?

Currently TokenBalancesController is not tied to NetworkController and if I correctly understood StaticIntervalPollingController require having networkClientId

[mcmire]

Made a first pass on this. Nice work overall. I'll check back a bit later but this should cover most of it for now.

[mcmire]

@cryptodev-2s @MajorLift Re: inheriting from StaticIntervalPollingController, I believe the purpose of that superclass is to ensure that polling can be performed in a multichain-compatible way. I don't think this controller has been converted to be multichain-compatible yet — I think it's still on the DevEx team's board to do that. So perhaps we stick with BaseControllerV2 for now and then if they see the need to migrate this class to StaticIntervalPollingController, they can do that, or we can if we end up taking it over from them.

[mcmire]

Nice! Just a few more suggestions.

[mcmire]

Looks good!