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

Encapsulation for std-lib #5658

Merged
merged 12 commits into from
Mar 3, 2024
Merged

Encapsulation for std-lib #5658

merged 12 commits into from
Mar 3, 2024

Conversation

bitzoic
Copy link
Member

@bitzoic bitzoic commented Feb 26, 2024

Description

Merges the staging branch into master from the following PRs:

#5640
#5630
#5621
#5613

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.

## Description

Updates the following heap types to have private struct variables:

- `Bytes`
- `RawBytes`
- `Vec`
- `RawVec`
- `String`

Note: This PR merges into a staging branch

## Checklist

- [ ] 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.
## Description

Updates the following heap types to have private struct variables:

- `StorageSlot`

As private fields can only be accessed from within the same file, the
`new()`, `slot()`, `offset()`, and `field_id()` functions have been
moved to core.

Note: This PR merges into a staging branch

## 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.
## Description

Updates the following numeric types to have private struct variables:

- `B512`
- `U128`

As `U256` is deprecated this type has not been updated. 

This PR also renames the `B512` field from `bytes` to `bits` and renames
the `EvmAddress` field from `bytes` to `bits` with a field accessor
function.

Note: This PR merges into a staging branch

## Checklist

- [ ] 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.
## Description

Updates the following blockchain types to have private struct variables:
- `Address`
- `ContractId`
- `AssetId`

Note: This PR merges into a staging branch

## Checklist

- [ ] 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.
@bitzoic bitzoic added lib: std Standard library breaking May cause existing user code to break. Requires a minor or major release. labels Feb 26, 2024
@bitzoic bitzoic requested review from IGI-111 and a team February 26, 2024 05:07
@bitzoic bitzoic self-assigned this Feb 26, 2024
IGI-111
IGI-111 previously approved these changes Feb 26, 2024
Copy link
Contributor

@IGI-111 IGI-111 left a comment

Choose a reason for hiding this comment

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

LGTM but you'll need to fix the conflicts

@Brennaheartt

This comment was marked as spam.

@bitzoic bitzoic requested a review from IGI-111 February 27, 2024 05:40
@IGI-111 IGI-111 merged commit d5b8cb8 into master Mar 3, 2024
38 checks passed
@IGI-111 IGI-111 deleted the bitzoic-encapsulation branch March 3, 2024 05:48
@bitzoic bitzoic mentioned this pull request Mar 5, 2024
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. lib: std Standard library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants