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.

Sign up for GitHub

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

Jump to bottom

Update TokenBalancesController to BaseControllerV2 #1808

Closed
mcmire opened this issue Oct 11, 2023 · 1 comment · Fixed by #3750
Closed

Update TokenBalancesController to BaseControllerV2 #1808

mcmire opened this issue Oct 11, 2023 · 1 comment · Fixed by #3750
Assignees
@cryptodev-2s
Labels
team-wallet-framework

Comments

@mcmire
Copy link
Contributor

mcmire commented Oct 11, 2023 •
edited
Loading

TokenBalancesController still inherits from BaseController (v1). In order to make all of our controllers consistent, we need to migrate this controller to BaseControllerV2.

Please use #1705 (PhishingController) as a recent reference for this type of migration.
@mcmire mcmire mentioned this issue Oct 11, 2023
Open
29 tasks
@mcmire mcmire changed the title (assets-controllers) TokenBalancesController Update TokenBalancesController to BaseControllerV2 Oct 11, 2023
@mcmire mcmire mentioned this issue Oct 11, 2023
Open
@desi
Copy link
Contributor

desi commented Dec 7, 2023

Hey team! Please add your planning poker estimate with Zenhub @cryptodev-2s @Gudahtt @MajorLift @mcmire @mikesposito

@cryptodev-2s cryptodev-2s self-assigned this Dec 14, 2023
@cryptodev-2s cryptodev-2s mentioned this issue Jan 9, 2024
Merged
3 tasks
cryptodev-2s added a commit that referenced this issue Jan 11, 2024
@cryptodev-2s
feat: migrate token balances controller to base controller v2 (#3750)
5b34a40 
## 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 hex and not as a BNs.
- Additional BN export has been removed as it was intended to be removed
in the next major release.

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cryptodev-2s cryptodev-2s

Labels
team-wallet-framework
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: migrate token balances controller to base controller v2 MetaMask/core
3 participants
@mcmire @desi @cryptodev-2s