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

Fix various mistakes in the README API documentation #157

Merged
merged 3 commits into from
Jul 15, 2021
Merged

Fix various mistakes in the README API documentation #157

merged 3 commits into from
Jul 15, 2021

Commits on Jul 15, 2021

  1. Fix various mistakes in the README API documentation 

    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
    Gudahtt committed Jul 15, 2021
    Configuration menu
    Copy the full SHA
    cea50a3 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into fix-README-mistakes

    @Gudahtt
    Gudahtt authored Jul 15, 2021
    Configuration menu
    Copy the full SHA
    396517c View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into fix-README-mistakes

    @Gudahtt
    Gudahtt authored Jul 15, 2021
    Configuration menu
    Copy the full SHA
    97f91f8 View commit details
    Browse the repository at this point in the history