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.

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

Rename signTypedData-related types. #218

Merged
merged 2 commits into from
Sep 21, 2021

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Sep 21, 2021

The type EIP712TypedData has been renamed to TypedDataV1Field so that it does not get confused for a valid signTypedData message or field. This type is only used for V1 of signTypedData, which was based on an early draft version of EIP-712 and doesn't reflect the state of that EIP today at all.

The type Version has been renamed to SignTypedDataVersion. This ensures it doesn't get confused for an encryption version, for example. It's directly exported from this package, so it might not be clear at first that it's related to signTypedData.

The type `EIP712TypedData` has been renamed to `TypedDataV1Field` so
that it does not get confused for a valid `signTypedData` message or
field. This type is only used for `V1` of `signTypedData`, which was
based on an early draft version of EIP-712 and doesn't reflect the
state of that EIP today at all.

The type `Version` has been renamed to `SignTypedDataVersion`. This
ensures it doesn't get confused for an encryption version, for example.
It's directly exported from this package, so it might not be clear at
first that it's related to `signTypedData`.
@Gudahtt Gudahtt force-pushed the rename-sign-typed-data-related-types branch from bf7f13d to ab7ccc8 Compare September 21, 2021 23:17
@Gudahtt Gudahtt marked this pull request as ready for review September 21, 2021 23:17
@Gudahtt Gudahtt requested a review from a team as a code owner September 21, 2021 23:17
Copy link
Member

@rekmarks rekmarks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@Gudahtt Gudahtt merged commit c2a0158 into main Sep 21, 2021
@Gudahtt Gudahtt deleted the rename-sign-typed-data-related-types branch September 21, 2021 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants