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

chore: deprecate bech32 addresses #3204

Closed
wants to merge 11 commits into from
Closed

Conversation

maschad
Copy link
Member

@maschad maschad commented Sep 24, 2024

Closes TS-660

Release notes

In this release, we:

  • Deprecated the bech32Address type in favour of hexadecimal address format going forward.

Summary

This PR uses adds the deprecated JS-doc tag as well as makes note in the relevant documentation of the deprecation notice.

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

Copy link

vercel bot commented Sep 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
create-fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 5:56pm
fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 5:56pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 5:56pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
create-fuels-counter-example ⬜️ Ignored (Inspect) Sep 27, 2024 5:56pm

Copy link

codspeed-hq bot commented Sep 24, 2024

CodSpeed Performance Report

Merging #3204 will degrade performances by 31.31%

Comparing mc/chore/deprecate-bech32 (f7c1009) with master (e7c2c30)

Summary

❌ 1 regressions
✅ 20 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark master mc/chore/deprecate-bech32 Change
should successfully execute a contract mint 65.2 ms 94.9 ms -31.31%

CONTRIBUTING.md Outdated Show resolved Hide resolved
packages/address/src/address.ts Outdated Show resolved Hide resolved
packages/address/src/address.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@Torres-ssf Torres-ssf left a comment

Choose a reason for hiding this comment

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

@maschad Why are we adding @deprecated to toEvmAddress, toBytes, toAssetId? These methods will continue to exist.

Also, I understand that toB256 should be deprecated, as it won't be required anymore when we drop the use of bech32. However, every @deprecated tag is recommending this method, which is also being deprecated. Isn't that misleading?

@maschad
Copy link
Member Author

maschad commented Sep 25, 2024

@maschad Why are we adding @deprecated to toEvmAddress, toBytes, toAssetId? These methods will continue to exist.

With the exception of toAssetId all of those methods all operate on the bech32 address type. Deprecating the associated methods along with the type is a good practice because:

  • It provides a clear signal to developers that the entire API surface related to this type is being phased out.
  • It prevents new code from being written that depends on the deprecated type.
  • It makes it easier to track usage and eventually remove all related code.

Also, I understand that toB256 should be deprecated, as it won't be required anymore when we drop the use of bech32. However, every @deprecated tag is recommending this method, which is also being deprecated. Isn't that misleading?

That's a valid point, I've updated the language 43ae005

@Torres-ssf

This comment was marked as resolved.

arboleya

This comment was marked as resolved.

@maschad
Copy link
Member Author

maschad commented Sep 26, 2024

@Torres-ssf I suppose since the method name nor signatures will change (although the internal logic will) , you're correct we shouldn't deprecate them 👍🏾

"@fuel-ts/errors": patch
---

chore: deprecate bech32 addresses
Copy link
Member

Choose a reason for hiding this comment

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

Warning

Please do not merge this PR until further notice.

This is a hot topic, and there's been some last-minute pondering about this deprecation.

I'll reply to or close this comment with news once there is a consensus about it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Converting this to a draft until we have an consensus around this.

danielbate
danielbate previously approved these changes Sep 26, 2024
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
76.67%(+0%) 71.48%(+0%) 75.65%(+0%) 76.76%(+0%)
Changed Files:

Coverage values did not change👌.

@petertonysmith94 petertonysmith94 marked this pull request as draft September 30, 2024 16:35
@maschad maschad changed the base branch from master to next September 30, 2024 17:53
@maschad maschad dismissed danielbate’s stale review September 30, 2024 17:53

The base branch was changed.

@arboleya arboleya deleted the branch next October 9, 2024 10:26
@arboleya arboleya closed this Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issue is a chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate bech32 address format
5 participants