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

controller-utils: Replace use of any with proper types (non-test files only) #3717

Closed
Tracked by #3706
mcmire opened this issue Jan 4, 2024 · 3 comments · Fixed by #3975
Closed
Tracked by #3706

controller-utils: Replace use of any with proper types (non-test files only) #3717

mcmire opened this issue Jan 4, 2024 · 3 comments · Fixed by #3975
Assignees
@cryptodev-2s
Labels
team-wallet-framework

Comments

@mcmire
Copy link
Contributor

mcmire commented Jan 4, 2024 •
edited by desi
Loading

Look for the following string in non-test files to find these: // TODO: Replace `any` with type

At time of writing, there were 6 instances.
@mcmire mcmire mentioned this issue Jan 4, 2024
Open
19 tasks
@desi
Copy link
Contributor

desi commented Feb 8, 2024

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

@mcmire
Copy link
Contributor Author

mcmire commented Feb 8, 2024

Investigate whether args on query can be changed along with the return type.

@MajorLift MajorLift mentioned this issue Feb 9, 2024
Draft
3 tasks
@desi
Copy link
Contributor

desi commented Feb 15, 2024

For this ticket we will not handle the query function. There will be a separate ticket for that. This one will handle the 5 straight forward fixes.

@mcmire mcmire mentioned this issue Feb 23, 2024
Closed
3 tasks
@cryptodev-2s cryptodev-2s self-assigned this Feb 26, 2024
@cryptodev-2s cryptodev-2s mentioned this issue Feb 26, 2024
Merged
3 tasks
cryptodev-2s added a commit that referenced this issue Mar 5, 2024
@cryptodev-2s
refactor(controller-utils): replace any with types for type safety (#…
e387b17 
…3975)

## Explanation

The current implementation uses any type for parameters in certain
utility functions within controller-utils, which lacks type safety and
can lead to runtime errors if incorrect values are passed. This approach
needs to change to ensure the reliability and maintainability of the
codebase.

## References

- Fixes #3717

## 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/controller-utils`

#### Fixed

- **BREAKING**: Replaced any type with BN for BNToHex and fractionBN
functions to enhance type safety.
- **BREAKING**: Replaced any type with unknown in logOrRethrowError.
- **BREAKING**: Replaced any type with string in isNetworkType.


## 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.

refactor(controller-utils): replace any with types for type safety MetaMask/core
3 participants
@mcmire @desi @cryptodev-2s