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

Bump ed25519 => v2; k256 => v0.13; signature => v2 #1285

Merged
merged 5 commits into from
Apr 4, 2023

Conversation

tony-iqlusion
Copy link
Collaborator

@tony-iqlusion tony-iqlusion commented Mar 10, 2023

Closes: #1290

Bumps all of the above dependencies to their latest versions, which use the new signature v2 release:

RustCrypto/traits#1211

  • Referenced an issue explaining the need for the change
  • Updated all relevant documentation in docs
  • Updated all code comments where relevant
  • Wrote tests
  • Added entry in .changelog/

@tony-iqlusion tony-iqlusion force-pushed the ed25519-v2+k256-v0.13+signature-v2 branch from ad347a6 to 9bdc063 Compare March 10, 2023 17:05
@tony-iqlusion
Copy link
Collaborator Author

Note: there's a PR to use the signature v2 crate's traits with ed25519-consensus here:

penumbra-zone/ed25519-consensus#6

@tony-iqlusion tony-iqlusion force-pushed the ed25519-v2+k256-v0.13+signature-v2 branch 2 times, most recently from 5f33dcd to c9617b8 Compare March 10, 2023 17:26
Bumps all of the above dependencies to their latest versions, which use
the new `signature` v2 release:

RustCrypto/traits#1211
@tony-iqlusion tony-iqlusion force-pushed the ed25519-v2+k256-v0.13+signature-v2 branch from c9617b8 to d746c1d Compare March 10, 2023 17:28
@tony-iqlusion
Copy link
Collaborator Author

Hmmm, the docs failure seems to be coming from generic-array:

https://github.com/informalsystems/tendermint-rs/actions/runs/4386941224/jobs/7681624555#step:4:290

@tony-iqlusion
Copy link
Collaborator Author

tony-iqlusion commented Mar 10, 2023

Appears to be a bug in the generic-array crate, unfortunately:

fizyk20/generic-array#133

I can see if I can configure the docs job to skip that crate.

@tony-iqlusion
Copy link
Collaborator Author

D'oh, cargo doc --exclude only works for crates in the same workspace.

Not sure how to fix the doc build without an upstream fix in generic-array. The best I can do is point it at that PR using patch.crates-io

The `generic-array` crate's docs won't build without this, which breaks
the docs build in CI
@tony-iqlusion tony-iqlusion force-pushed the ed25519-v2+k256-v0.13+signature-v2 branch from fc52cc1 to 829d083 Compare March 10, 2023 17:51
Cargo.toml Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Apr 4, 2023

Codecov Report

Merging #1285 (73cdb64) into main (60e10ab) will decrease coverage by 0.1%.
The diff coverage is 70.5%.

❗ Current head 73cdb64 differs from pull request most recent head 6f06f84. Consider uploading reports for the commit 6f06f84 to get more accurate results

@@           Coverage Diff           @@
##            main   #1285     +/-   ##
=======================================
- Coverage   64.1%   64.0%   -0.1%     
=======================================
  Files        271     271             
  Lines      24291   24330     +39     
=======================================
+ Hits       15584   15594     +10     
- Misses      8707    8736     +29     
Impacted Files Coverage Δ
tendermint/src/public_key.rs 75.6% <25.0%> (+5.6%) ⬆️
tendermint/src/signature.rs 44.6% <33.3%> (-0.5%) ⬇️
tendermint/src/account.rs 82.5% <100.0%> (ø)
tendermint/src/crypto/default/signature.rs 92.0% <100.0%> (ø)
tendermint/src/test.rs 100.0% <100.0%> (ø)
tendermint/src/vote.rs 78.3% <100.0%> (ø)
tendermint/tests/alt_crypto.rs 92.5% <100.0%> (ø)

... and 6 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@tony-iqlusion
Copy link
Collaborator Author

tony-iqlusion commented Apr 4, 2023

The build failure is an unrelated semi-recent nightly regression.

The docs build on nightly-2023-03-01, for example. (I'm not sure why it's using nightly in the first place?)

@tony-iqlusion tony-iqlusion force-pushed the ed25519-v2+k256-v0.13+signature-v2 branch from bdde454 to 7ecde70 Compare April 4, 2023 02:07
@tony-iqlusion
Copy link
Collaborator Author

Pinned the nightly used to build the docs and it passed, but that seems like an unrelated build failure which would impact any branch

@romac
Copy link
Member

romac commented Apr 4, 2023

I'm not sure why it's using nightly in the first place?

I believe we are building the docs on nightly to match what docs.rs is doing.

@romac
Copy link
Member

romac commented Apr 4, 2023

LGTM, thanks Tony!

@romac romac merged commit db9cb21 into main Apr 4, 2023
@romac romac deleted the ed25519-v2+k256-v0.13+signature-v2 branch April 4, 2023 08:58
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.

Update ed25519, k256 and signature to their latest version which use the new signature v2 release
3 participants