docs: improve eip712 docs and discoverability #940
Merged
+29
−17
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
DaniPopes
requested review from
Copilot
and removed request for
mattsse and
yash-atreya
There was a problem hiding this comment.
Pull Request Overview
This PR improves the discoverability and clarity of the EIP-712 documentation by updating hyperlinks and descriptions for type hash, hash struct, and signing hash computations.
- Updated documentation in the SolStruct trait to accurately describe the computation of EIP-712 values.
- Enhanced documentation for the TypedData struct in dyn-abi to improve clarity and consistency with EIP-712 specifications.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| crates/sol-types/src/types/struct.rs | Improved documentation for EIP-712 type hash and signing hash functions. |
| crates/dyn-abi/src/eip712/typed_data.rs | Enhanced clarity and updated hyperlinks for EIP-712 type and signing hash computations. |
mattsse
approved these changes
Apr 26, 2025
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.
Ref alloy-rs/alloy#2349