Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes for auto impl of AbiEncode; encoding version and better tests #5481

Merged
merged 10 commits into from
Jan 26, 2024

Conversation

xunilrj
Copy link
Contributor

@xunilrj xunilrj commented Jan 16, 2024

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:
          {
            "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

Checklist

  • I have linked to any relevant issues.
  • 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).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

tritao
tritao previously approved these changes Jan 16, 2024
IGI-111 pushed a commit to FuelLabs/fuel-abi-types that referenced this pull request Jan 23, 2024
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
@xunilrj xunilrj force-pushed the xunilrj/trait-auto-impl branch from 4441de3 to b6c0e8b Compare January 23, 2024 13:37
@xunilrj xunilrj requested a review from tritao January 24, 2024 16:46
Copy link
Contributor

@jjcnn jjcnn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@xunilrj xunilrj enabled auto-merge (squash) January 26, 2024 18:02
@xunilrj xunilrj force-pushed the xunilrj/trait-auto-impl branch from 52c6131 to 18bca03 Compare January 26, 2024 18:02
@xunilrj xunilrj force-pushed the xunilrj/trait-auto-impl branch from 18bca03 to f3a654a Compare January 26, 2024 21:58
@xunilrj xunilrj merged commit 27a7924 into master Jan 26, 2024
33 checks passed
@xunilrj xunilrj deleted the xunilrj/trait-auto-impl branch January 26, 2024 22:28
@xunilrj xunilrj added compiler General compiler. Should eventually become more specific as the issue is triaged breaking May cause existing user code to break. Requires a minor or major release. labels Jan 29, 2024
@xunilrj xunilrj self-assigned this Jan 29, 2024
xunilrj added a commit 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 xunilrj mentioned this pull request Feb 1, 2024
14 tasks
xunilrj added a commit 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
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants