doc: brief doc on the type system #26
Merged
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
prestwich
commented
May 10, 2023
abi/type_system.md
Outdated
| ### Trait Layout | ||
|
|
||
| ``` | ||
| SolType |
There was a problem hiding this comment.
this is no longer true. SolError does not implement SolType
DaniPopes
requested changes
May 10, 2023
abi/type_system.md
Outdated
Comment on lines
109
to
116
| - `SolType` - Provides type name and properties, and basic ABI coding | ||
| - `SolDataType` - Provides EIP-712 and `encodePacked` | ||
| - `SolError` - describes custom Error types with selector, and provides | ||
| specialized coding methods | ||
| - `SolCall` - describes function **arguments** with selector, and provides | ||
| specialized coding methods | ||
| - `SolEvent` - describes Event types with topic 0 and internal tuple, and | ||
| provides specialized coding methods |
There was a problem hiding this comment.
Should we href types/traits to docs.rs?
https://docs.rs/ethers-abi-enc/latest/ethers_abi_enc/<item>.<Name>.html
There was a problem hiding this comment.
yes, when we've 100% finalized the traits
prestwich
force-pushed
the
prestwich/sol-doc
branch
from
75f4ed1
to
0d25fa9
Compare
DaniPopes
approved these changes
May 12, 2023
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.
Adds a md doc to the abi crate describing the solidity type representation