Abi Generation V2 #1459
Merged
Abi Generation V2 #1459
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
Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com>
abi/README.md
Outdated
| - Built-in types include Address and Bytes. | ||
|
|
||
| ## Code Generation | ||
| Use cmd/abigen to automatically generate Go structs from JSON. No newline at end of file |
There was a problem hiding this comment.
Can we add instructions instead of saying that this is handled by cmd/abigen ?
abi/README.md
Outdated
| - JSON files should align with their corresponding .hex files. | ||
|
|
||
| ## Hash verification | ||
| Wallets use ABI to display proper action names and field names. To verify ABI implementation in other languages, marshal the ABI into binary, hash it, and compare with the known hash. |
There was a problem hiding this comment.
Could you explain why?
abi/README.md
Outdated
Comment on lines
36
to
39
| To create an implementation of this package in any other langauge: | ||
| - Copy the testdata folder. | ||
| - Ensure all marshaling is identical to the Go implementation. | ||
| - JSON files should align with their corresponding .hex files. |
There was a problem hiding this comment.
Let's add a little more detail here. Could we explain the structure of the testdata folder and how an implementation should use it to ensure compliance?
aaronbuchwald
approved these changes
Sep 12, 2024
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.
A clean version of #1301
Generate a JSON representation of all VM actions and their fields.
This includes all commits from #1198, so it should be merged after that.
When reviewing the code, please compare it with the code in PR 1198, not with the main branch.