Skip to content

Commit

Permalink
comment: add TODO comment for ApprovalRequest type to use ApprovalType (
Browse files Browse the repository at this point in the history
#4209)

## Explanation

We are receiving a typescript error in metamask-extension when comparing
ApprovalRequest.type value to ApprovalType values (example:
MetaMask/metamask-extension#24182)
<img width="1045" alt="Screenshot 2024-04-24 at 3 37 16 PM"
src="https://github.com/MetaMask/core/assets/20778143/5bec8d91-1581-4cab-9faa-bed441784d69">
<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

## References

<!--
Are there any issues that this pull request is tied to? Are there other
links that reviewers should consult to understand these changes better?

For example:

* Fixes #12345
* Related to #67890
-->

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

- **comment**: add TODO comment for ApprovalRequest type to use
ApprovalType


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

---------

Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
  • Loading branch information
digiwand and MajorLift authored Apr 26, 2024
1 parent 5cf233b commit 46e9351
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions packages/approval-controller/src/ApprovalController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ export type ApprovalRequest<RequestData extends ApprovalRequestData> = {

/**
* The type of the approval request.
* Unfortunately, not all values will match the `ApprovalType` enum, so we are using `string` here.
* TODO: Replace `string` with `ApprovalType` when all `type` values used by the clients can be encompassed by the `ApprovalType` enum.
*/
type: string;

Expand Down

0 comments on commit 46e9351

Please sign in to comment.