feat(controller-utils): support bn.js v4 input to BN functions (re-introduces #4844)

[Gudahtt]

This PR re-introduces the changes that were originally merged as part of #4844. They were reverted due to an incompatibility with @metamask/create-release-branch v3, which was resolved with the update to v3.1.

References:

• Revert PR: #4858
• @metamask/create-release-branch support for npm: aliases: https://github.com/MetaMask/create-release-branch/pull/158
• @metamask/create-release-branch v3.1 release with backported alias support: https://github.com/MetaMask/create-release-branch/pull/160
• @metamask/create-release-branch bump to v3.1: #4884

Original description of #4844:

Explanation

• Extend types to indicate support for passing in bn.js v4 instances to BN.js utility functions
  • Affected functions:
  • BNToHex
  • fractionBN
  • fromHex
  • toHex
  • If input is v4 instance, return as v4. Otherwise use v5, as previously.
  • fractionBN now uses the original BN implementation when passed a v4 BN instance
• Use overload signatures to more specifically type BN-related util functions

References

• Context: https://github.com/MetaMask/metamask-mobile/pull/11972
  • Note that these functions are already used with v4 input but this was not caught due to the way bn.js is imported downstream. Making this support explicit facilitates resolving the type issue without requiring a prior full migration off bn.js v4 or resorting to peppering ts-expect-errors all over.

• 4827

• https://github.com/ethereumjs/ethereumjs-util/issues/250

Changelog

@metamask/controller-utils

• CHANGED: The following functions now accept input from bn.js v4 library:
  • BNToHex
  • fractionBN
  • fromHex
  • toHex
• FIXED: fractionToBN now returns output using the same bn.js library version that created the input

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
• [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

[socket-security[bot]]

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

Package	New capabilities	Transitives	Size	Publisher
npm/@types/bn.js@4.11.6	None	0	13.9 kB	types

View full report↗︎