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

Remove contract_id() in favor of ContractId::this() #5867

Merged
merged 5 commits into from
Apr 18, 2024
Merged

Conversation

bitzoic
Copy link
Member

@bitzoic bitzoic commented Apr 17, 2024

Description

We currently support 2 methods of getting the contract id of a contract in an internal context:

  • contract_id()
  • ContractId::this()

The this() associated function is a constructor that returns Self and should be the primary method of getting the contract id. This idiomatically follows Rust's syntax and contract_id() has been removed.

The same syntax is followed with AssetId::base().

Closes #5834

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.

@bitzoic bitzoic added lib: std Standard library breaking May cause existing user code to break. Requires a minor or major release. labels Apr 17, 2024
@bitzoic bitzoic requested a review from a team April 17, 2024 01:15
@bitzoic bitzoic self-assigned this Apr 17, 2024
@bitzoic bitzoic linked an issue Apr 17, 2024 that may be closed by this pull request
@bitzoic bitzoic enabled auto-merge (squash) April 18, 2024 13:58
@bitzoic bitzoic merged commit 3f47df8 into master Apr 18, 2024
31 checks passed
@bitzoic bitzoic deleted the bitzoic-5834 branch April 18, 2024 14:24
IGI-111 added a commit that referenced this pull request Oct 28, 2024
…Id` in Native Assets Documentation (#6141)

## Description
The syntax `std::call_frames::ContractId` has been updated in the latest
version of Sway. The new syntax is `std::contract_id::ContractId`. To
ensure the documentation is accurate and consistent with the latest
version, this update is necessary.

## Reason for Change:
- The `std::call_frames::ContractId` syntax has been deprecated or
modified in the latest version of Sway.
- Using the latest `std::contract_id::ContractId` syntax ensures the
documentation is accurate and helps developers avoid using outdated
syntax.

## Reference
#5867 

## 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).
- [ ] 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).
- [ ] I have requested a review from the relevant team or maintainers.

Co-authored-by: IGI-111 <igi-111@protonmail.com>
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.

Deprecate the contract_id() function
3 participants