Rework the ABI spec to use event tag hashes instead of integers as type ids #5954
Assignees
Labels
ABI
Everything to do the ABI, especially the JSON representation
breaking
May cause existing user code to break. Requires a minor or major release.
compiler
General compiler. Should eventually become more specific as the issue is triaged
logging
Related to logging (tracing, stdout, stderr, log-files)
Comments
IGI-111
added
compiler
6 tasks
8 tasks
IGI-111
pushed a commit
to FuelLabs/fuel-specs
that referenced
this issue
Jul 13, 2024
[#5151](FuelLabs/sway#5151) [#5952](FuelLabs/sway#5952) [#5954](FuelLabs/sway#5954) Adds specification for how hashes based ids are generated from a string representation of types. Updates `json-abi-format.md` with versions, program type, and hash based ids. ### Before requesting review - [x] I have reviewed the code myself ### After merging, notify other teams [Add or remove entries as needed] - [ ] [Rust SDK](https://github.com/FuelLabs/fuels-rs/) - [ ] [Typescript SDK](https://github.com/FuelLabs/fuels-ts/) - [ ] [Sway compiler](https://github.com/FuelLabs/sway/) - [ ] [Platform documentation](https://github.com/FuelLabs/devrel-requests/issues/new?assignees=&labels=new+request&projects=&template=NEW-REQUEST.yml&title=%5BRequest%5D%3A+) (for out-of-organization contributors, the person merging the PR will do this) - [ ] Someone else?
6 tasks
IGI-111
pushed a commit
to FuelLabs/fuel-specs
that referenced
this issue
Jul 24, 2024
FuelLabs/sway#5151 FuelLabs/sway#5952 FuelLabs/sway#5954 [Rendered file](https://github.com/FuelLabs/fuel-specs/blob/882a860a4aa11ba8c6f91085a0ab4d483c6ce3fb/src/abi/json-abi-format.md) With the changes proposed in this PR, functions,loggedTypes, messagesTypes and configurables will only rely on hash based ids of concrete types. This change is required because types on the types arrays can be abstract types, so the hash based ids could not include the generic parameters of the concrete types used. For instance a method with two args, `Option<u64>` and `Option<u32>`, would generate two distinct hash based ids based on `sha256("enum std::option::Option<u64>")` and `sha256("enum std::option::Option<u32>")`, but there was a single type for Option. With the proposed changes we can now have multiple hash based ids for generic types, while still having access to the same generated types as the new `concreteTypes` map easily to the `typesMetadata` (old `types`). ### Before requesting review - [x] I have reviewed the code myself ### After merging, notify other teams - [ ] [Rust SDK](https://github.com/FuelLabs/fuels-rs/) - [ ] [Typescript SDK](https://github.com/FuelLabs/fuels-ts/) - [ ] [Sway compiler](https://github.com/FuelLabs/sway/) - [ ] [Platform documentation](https://github.com/FuelLabs/devrel-requests/issues/new?assignees=&labels=new+request&projects=&template=NEW-REQUEST.yml&title=%5BRequest%5D%3A+) (for out-of-organization contributors, the person merging the PR will do this) - [ ] Someone else?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Change the ABI specification to use the event tag type definitions and their 64 bit hashes as type ids.
This change should also include a new versioning field for the ABI files that uses a semver string (this would be version
0.1.0.As part of this change,
LOGandLOGDreceipts should no longer emit both a type id and an event hash but just the event hash (which is now also the type id).The text was updated successfully, but these errors were encountered: