This repository was archived by the owner on Oct 7, 2024. It is now read-only.
Narrow return type of signTypedMessage and encryption methods
#249
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
mikesposito
previously approved these changes
Jul 17, 2023
Member
mikesposito
left a comment
mikesposito
left a comment
There was a problem hiding this comment.
LGTM!
I just noticed we have the same problem with getEncryptionPublicKey anddecryptMessage, we can fix them separately but we could also take this chance
3 tasks
Gudahtt
changed the title
signTypedMessagesignTypedMessage and encryption methods
Member
Author
|
Oh, good catch! I have updated those two methods as well, and updated the PR title & description accordingly. Figured we may as well fix them here since it's the same problem. |
The method `signTypedMessage` always returns a string, but the declared return type was `Bytes` (which is a type union of `string` along with other things). This made the method more difficult to use, as callers had to handle the other `Bytes` types as return values as well. The method has been updated to use `string` as the return type.
Gudahtt
force-pushed
the
fix-sign-typed-message-return-type
branch
from
242b788 to
2d07efc
Compare
mikesposito
approved these changes
Jul 17, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The methods
signTypedMessage,getEncryptionPublicKey, anddecryptMessagealways return a string, but the declared return type wasBytes(which is a type union ofstringalong with other things). This made the methods more difficult to use, as callers had to handle the otherBytestypes as return values as well.The methods have been updated to use
stringas the return type.Changes
signTypedMessage,getEncryptionPublicKey, anddecryptMessagenow returnstringrather thanBytesBytestype includesstringReferences
Helps to unblock MetaMask/core#1441
Checklist