Skip to content

fix(bip32): rename Xpub and Xpriv fields from network to network_kind #4611

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

luisschwab
Copy link
Contributor

@luisschwab luisschwab commented Jun 10, 2025

Closes #4582.

Changelog

  • Rename Xpriv.network to Xpriv.network_kind.
  • Rename Xpub.network to Xpub.network_kind.
  • Rename Common.network to Common.network_kind.
  • Related methods also corrected.

Yes, it's a breaking change, but it should have been done on #2232 as well.

@github-actions github-actions bot added the C-bitcoin PRs modifying the bitcoin crate label Jun 10, 2025
Copy link

🚨 API BREAKING CHANGE DETECTED

To see the changes click details on "Check semver breaks / PR Semver - stable toolchain" job then expand "Run semver checker script" and scroll to the end of the section.

@github-actions github-actions bot added the API break This PR requires a version bump for the next release label Jun 10, 2025
@apoelstra
Copy link
Member

I think we have a weak consensus against this change, unless we need to break this structure's API for other reasons.

@coveralls
Copy link

coveralls commented Jun 10, 2025

Pull Request Test Coverage Report for Build 15572079372

Details

  • 16 of 16 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.03%) to 84.41%

Totals Coverage Status
Change from base Build 15568752627: 0.03%
Covered Lines: 23542
Relevant Lines: 27890

💛 - Coveralls

@tcharding
Copy link
Member

Yeah I thought that is what we discussed as well.

@luisschwab luisschwab force-pushed the fix/bip32-network-kind branch from 660f872 to b6c25c4 Compare June 10, 2025 23:04
Copy link

🚨 API BREAKING CHANGE DETECTED

To see the changes click details on "Check semver breaks / PR Semver - stable toolchain" job then expand "Run semver checker script" and scroll to the end of the section.

@luisschwab
Copy link
Contributor Author

I think we have a weak consensus against this change

Yes, I understand that, but this will eventually get patched. Is it better to rip the band-aid now or later?

@tcharding
Copy link
Member

What do you mean "this will eventually get patched"?

@luisschwab
Copy link
Contributor Author

It's not the plan to leave the inaccurate name forever, right?

@tcharding
Copy link
Member

The bip32 module needs a total overhaul but its not high priority right now. This change can easily be made when we do that and then we don't unnecessarily break downstream until there is real benefit.

@luisschwab
Copy link
Contributor Author

Got it, I'll just leave this here as draft then.

@luisschwab luisschwab marked this pull request as draft June 11, 2025 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API break This PR requires a version bump for the next release C-bitcoin PRs modifying the bitcoin crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename Xpriv.network to Xpriv.network_kind
4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy