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

Deprecate schnorrsig #411

Merged
merged 4 commits into from
Mar 4, 2022
Merged

Conversation

tcharding
Copy link
Member

@tcharding tcharding commented Mar 1, 2022

Recently we moved from using the identifier 'schnorrsig' to 'schnorr' but we missed a few places.

Change identifiers to use 'schnorr' instead of 'schnorrsig', deprecate if necessary.

Please note, does not touch secp256k1-sys. Use of 'schnorrsig' remains in secp256k1-sys,

apoelstra
apoelstra previously approved these changes Mar 2, 2022
Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK cc30497

I think the since should be 0.22.0 rather than 0.21.3, since 0.22.0 will be the first release with the deprecated symbols.

@tcharding
Copy link
Member Author

My bad for using the current release instead of upcoming. On the subject, is there any way to know what the next release version number is going to be? If one follows all PRs should that be obvious?

Will update to 0.22.0, thanks.

Recently we moved from using the identifier 'schnorrsig' to 'schnorr',
we omitted to update the schnorr public key size constant.

Deprecate `SCHNORRSIG_PUBLIC_KEY_SIZE` and add
`SCHONORR_PUBLIC_KEY_SIZE`.
Recently we moved from using the identifier 'schnorrsig' to 'schnorr',
we omitted to update the schnorr signature size constant.

Deprecate `SCHNORRSIG_SIGNATURE_SIZE` and add
`SCHONORR_SIGNATURE_SIZE`.
Recently we moved from using the identifier 'schnorrsig' to 'schnorr',
we omitted to update a helper function.
Recently we moved from using the identifier 'schnorrsig' to 'schnorr',
we omitted to update the tests.

While we are at it use more idiomatic Rust unit test names (i.e., do not
start test name with `test_` because it stutters when the name is read
in output of `cargo test`).
@tcharding
Copy link
Member Author

Re-based, only changes were update of 'deprecate since' version.

Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK 7b91f9d

@apoelstra
Copy link
Member

No, there is no way to tell what the next version will be :) this crate especially is something of a one-man show and we don't usually have any epics or long-term goals, it's just a question of whether we have breaking API changes in the pipeline.

@apoelstra apoelstra merged commit 96430df into rust-bitcoin:master Mar 4, 2022
@tcharding tcharding deleted the deprecate-schnorrsig branch March 8, 2022 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants