Fix various mistakes in the README API documentation #157
Conversation
This file contains 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
The README included various mistakes in the API documentation. * The `signTypedDataLegacy` function was listed as `signTypedData` * The `signTypedData` function was listed as `signTypedData_v3` * The `recoverTypedSignatureLegacy` function was listed as `recoverTypedSignature` * The `recoverTypedSignature` function was missing * The `recoverTypedSignature_v4` function was listed as `recoverTypedSignature_V4` Lastly, the way that `signTypedData` (i.e. `eth_signTypedData_v3`) and `signTypedData_v4` are characterized has been updated. Previously the V3 function was described as fully compliant with EIP-712, whereas V4 was "an extension" of EIP-712, because of added support for arrays and recursive data structures. But in fact, V3 complies with no version of EIP-712. There was never a version that included the `\x19\x01` prefix [1] used by V3 but not support or arrays and recursive data structures. The spec supported arrays and recursive data structures since before that prefix was added. V4 has been the version that complies with the specification. The documentation has been updated to instead describe V4 as spec- compliant, and V3 as spec-compliant except for the lack of support for arrays and recursive data structures. Fixes #64
Gudahtt
force-pushed
the
fix-README-mistakes
branch
from
61cc5b2
to
cea50a3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The README included various mistakes in the API documentation.
signTypedDataLegacyfunction was listed assignTypedDatasignTypedDatafunction was listed assignTypedData_v3recoverTypedSignatureLegacyfunction was listed asrecoverTypedSignaturerecoverTypedSignaturefunction was missingrecoverTypedSignature_v4function was listed asrecoverTypedSignature_V4Lastly, the way that
signTypedData(i.e.eth_signTypedData_v3) andsignTypedData_v4are characterized has been updated. Previously the V3 function was described as fully compliant with EIP-712, whereas V4 was "an extension" of EIP-712, because of added support for arrays and recursive data structures.But in fact, V3 complies with no version of EIP-712. There was never a version that included the
\x19\x01prefix used by V3 but not support for arrays and recursive data structures. The spec supported arrays and recursive data structures since before that prefix was added. V4 has been the version that complies with the specification.The documentation has been updated to instead describe V4 as spec-compliant, and V3 as spec-compliant except for the lack of support for arrays and recursive data structures.
Fixes #64