encoding version inside ProgramABI #17
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
8 tasks
jjcnn
approved these changes
Jan 23, 2024
IGI-111
approved these changes
Jan 23, 2024
xunilrj
added a commit
to FuelLabs/sway
that referenced
this pull request
Jan 26, 2024
…5481) ## Description This PR is a continuation of #5306. - I am fixing some code reviews issues that were raised in the other PR; - I am incorporating the encoding version inside the JSON ABI as: ```json { "configurables": [], "encoding": "1", <- look here "functions": [ { "attributes": null, "inputs": [], "name": "main", "output": { "name": "", "type": 13, "typeArguments": null } } ], ``` This field is a string to allow any kind of versioning we choose. - This PR has also improved testing and making more explicit how each type is being encoded. ## Dependencies - [x] FuelLabs/fuel-abi-types#17 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [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.
xunilrj
added a commit
to FuelLabs/sway
that referenced
this pull request
Feb 1, 2024
…5481) ## Description This PR is a continuation of #5306. - I am fixing some code reviews issues that were raised in the other PR; - I am incorporating the encoding version inside the JSON ABI as: ```json { "configurables": [], "encoding": "1", <- look here "functions": [ { "attributes": null, "inputs": [], "name": "main", "output": { "name": "", "type": 13, "typeArguments": null } } ], ``` This field is a string to allow any kind of versioning we choose. - This PR has also improved testing and making more explicit how each type is being encoded. ## Dependencies - [x] FuelLabs/fuel-abi-types#17 ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [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.
xunilrj
added a commit
to FuelLabs/sway
that referenced
this pull request
Feb 1, 2024
…5481) This PR is a continuation of #5306. - I am fixing some code reviews issues that were raised in the other PR; - I am incorporating the encoding version inside the JSON ABI as: ```json { "configurables": [], "encoding": "1", <- look here "functions": [ { "attributes": null, "inputs": [], "name": "main", "output": { "name": "", "type": 13, "typeArguments": null } } ], ``` This field is a string to allow any kind of versioning we choose. - This PR has also improved testing and making more explicit how each type is being encoded. - [x] FuelLabs/fuel-abi-types#17 - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [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.
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.
This PR adds the field "encoding: Version" to the ProgramABI. This will be used later by Sway to inform the SDK which version of the encoding was used.
The current version will be "0", which can also be represented with
encoding: None; and the new one we are developing now will be version "1".The new JSON is at FuelLabs/sway#5481