Adds concrete types distinction to JSON ABI. #599

esdrubal · 2024-07-16T14:09:12Z

FuelLabs/sway#5151
FuelLabs/sway#5952
FuelLabs/sway#5954

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

I have reviewed the code myself

After merging, notify other teams

Rust SDK
Typescript SDK
Sway compiler
Platform documentation (for out-of-organization contributors, the person merging the PR will do this)
Someone else?

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`).

src/abi/json-abi-format.md

FuelLabs/fuel-specs#599

src/abi/json-abi-format.md

FuelLabs/fuel-specs#599

src/abi/json-abi-format.md

hal3e

LGTM. Thanks for the hard work!

FuelLabs/fuel-specs#599 --------- Co-authored-by: hal3e <git@hal3e.io>

Voxelot · 2024-07-24T18:48:39Z

src/abi/json-abi-format.md

+  ],
+  "metadataTypes": [
+    {
+      "metadataTypeId": 1,


should we make metadataTypeId's string based in case we want to make them hashed later?

FuelLabs/fuel-specs#599 ### Checklist - [ ] I have linked to any relevant issues. - [ ] I have updated the documentation. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added necessary labels. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers. --------- Co-authored-by: hal3e <git@hal3e.io>

maschad · 2024-08-05T18:46:49Z

src/abi/json-abi-format.md

-    - `"typeArguments"`: an array of the _type arguments_ used when applying the type of the message data being sent, if the type is generic, and `null` otherwise. Each _type argument_ is a _type application_ represented as a JSON object that contains the following properties:
-      - `"type"`: the _type declaration_ hash based ID of the type of the _type argument_.
-      - `"typeArguments"`: an array of the _type arguments_ used when applying the type of the _type argument_, if the type is generic, and `null` otherwise. The format of the elements of this array recursively follows the rules described in this section.
+  - `"message_id"`: a unique string ID.


My apologies for the post-merge feedback, but was there any particular reason why this is snake case? @esdrubal

## Description Updates all the dependencies for the current release. Implements the fuel ABI generation changes proposed in FuelLabs/fuel-specs#599. Removes the flag `--json-abi-with-callpaths` and the behavior is as if it were true. We removed the flag because it is unsafe to produce JSON ABIs without callpaths, so we shouldn't allow it. Includes the LDC, BSIZ, BLDD and ED19 changes from:#6409. Fixes #5954 Fixes #5151 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. --------- Co-authored-by: Vaivaswatha Nagaraj <vaivaswatha.nagaraj@fuel.sh> Co-authored-by: Kaya Gokalp <kayagokalp123@gmail.com> Co-authored-by: Kaya Gökalp <kaya.gokalp@fuel.sh> Co-authored-by: Igor Rončević <ironcev@hotmail.com> Co-authored-by: IGI-111 <igi-111@protonmail.com> Co-authored-by: Sophie Dankel <47993817+sdankel@users.noreply.github.com>

FuelLabs/fuel-specs#599 ### Checklist - [ ] I have linked to any relevant issues. - [ ] I have updated the documentation. - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added necessary labels. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers. --------- Co-authored-by: hal3e <git@hal3e.io>

esdrubal added the ABI Contract ABI label Jul 16, 2024

esdrubal self-assigned this Jul 16, 2024

esdrubal force-pushed the esdrubal/abi-changes2 branch from 75a28bb to 16307d4 Compare July 16, 2024 14:15

esdrubal force-pushed the esdrubal/abi-changes2 branch from 16307d4 to 882a860 Compare July 16, 2024 14:16

esdrubal requested review from a team July 16, 2024 14:19

nedsalk reviewed Jul 17, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

nedsalk reviewed Jul 17, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

nedsalk reviewed Jul 17, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

nedsalk reviewed Jul 17, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

nedsalk reviewed Jul 17, 2024

View reviewed changes

src/abi/json-abi-format.md Show resolved Hide resolved

esdrubal added a commit to FuelLabs/fuel-abi-types that referenced this pull request Jul 17, 2024

Implements abi spec changes.

f248327

FuelLabs/fuel-specs#599

esdrubal mentioned this pull request Jul 17, 2024

Implements abi spec changes. FuelLabs/fuel-abi-types#25

Merged

esdrubal added a commit to FuelLabs/fuel-abi-types that referenced this pull request Jul 17, 2024

Implements abi spec changes.

084aeef

FuelLabs/fuel-specs#599

esdrubal force-pushed the esdrubal/abi-changes2 branch from 671a030 to 46d64e2 Compare July 17, 2024 17:11

Applies review changes.

2fa4986

esdrubal force-pushed the esdrubal/abi-changes2 branch from 46d64e2 to 2fa4986 Compare July 17, 2024 17:16

nedsalk reviewed Jul 17, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

More review changes.

f4b0437

esdrubal added a commit to FuelLabs/fuel-abi-types that referenced this pull request Jul 18, 2024

Implements abi spec changes.

114f9e3

FuelLabs/fuel-specs#599

esdrubal added a commit to FuelLabs/fuel-abi-types that referenced this pull request Jul 18, 2024

Implements abi spec changes.

a90f3f9

FuelLabs/fuel-specs#599

esdrubal mentioned this pull request Jul 18, 2024

feat!: implement abi spec changes FuelLabs/fuels-rs#1465

Merged

6 tasks

nedsalk reviewed Jul 19, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

nedsalk reviewed Jul 19, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

Renames typesMetadata to metadataTypes.

1aee040

arboleya reviewed Jul 23, 2024

View reviewed changes

src/abi/json-abi-format.md Outdated Show resolved Hide resolved

arboleya requested a review from nedsalk July 23, 2024 10:51

Fixes typos.

32bb9ba

esdrubal requested a review from arboleya July 23, 2024 16:29

hal3e approved these changes Jul 24, 2024

View reviewed changes

nedsalk approved these changes Jul 24, 2024

View reviewed changes

digorithm approved these changes Jul 24, 2024

View reviewed changes

arboleya approved these changes Jul 24, 2024

View reviewed changes

IGI-111 merged commit b095eb2 into master Jul 24, 2024
6 checks passed

IGI-111 deleted the esdrubal/abi-changes2 branch July 24, 2024 14:17

esdrubal mentioned this pull request Jul 24, 2024

Updates JSON ABI, LDC, BSIZ, BLDD and ED19. FuelLabs/sway#6254

Merged

8 tasks

IGI-111 pushed a commit to FuelLabs/fuel-abi-types that referenced this pull request Jul 24, 2024

Implements abi spec changes. (#25)

7474403

FuelLabs/fuel-specs#599 --------- Co-authored-by: hal3e <git@hal3e.io>

Voxelot reviewed Jul 24, 2024

View reviewed changes

nedsalk mentioned this pull request Jul 25, 2024

chore!: support new encoding schema FuelLabs/fuels-ts#2826

Closed

4 tasks

arboleya mentioned this pull request Jul 29, 2024

feat!: adding abi transpiler FuelLabs/fuels-ts#2856

Merged

4 tasks

nedsalk mentioned this pull request Aug 1, 2024

chore!: internalize old JsonAbi format FuelLabs/fuels-ts#2862

Merged

4 tasks

maschad reviewed Aug 5, 2024

View reviewed changes

fuel-service-user mentioned this pull request Aug 19, 2024

ci(release): v0.94.0 @ master FuelLabs/fuels-ts#2863

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds concrete types distinction to JSON ABI. #599

Adds concrete types distinction to JSON ABI. #599

esdrubal commented Jul 16, 2024 •

edited

Loading

hal3e left a comment

Voxelot Jul 24, 2024

maschad Aug 5, 2024

Adds concrete types distinction to JSON ABI. #599

Adds concrete types distinction to JSON ABI. #599

Conversation

esdrubal commented Jul 16, 2024 • edited Loading

Before requesting review

After merging, notify other teams

hal3e left a comment

Choose a reason for hiding this comment

Voxelot Jul 24, 2024

Choose a reason for hiding this comment

maschad Aug 5, 2024

Choose a reason for hiding this comment

esdrubal commented Jul 16, 2024 •

edited

Loading