debug: improve Debug impl for Ed25519 VerificationKeys #1272
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since the `ed25519_consensus::VerificationKey` is no longer used, the
`VerificationKey`s go back to having raw debug output that's hard to read when
it appears in logs. This commit restores the hex-formatting previously
inherited from `ed25519_consensus`, allowing nice output like (in use in `pd`
downstream):
```
2023-02-24T03:34:57.002766Z DEBUG abci:EndBlock{height=187}:end_block:staking:build_tendermint_validator_updates: updates=[Update { pub_key: Ed25519(7423aa71eb844cdde4dc0b8c72ef1225931dc54c21a102cbe2fded2645d4e814), power: Power(50000000000) }]
```
In the future, another option could be to have the key be base64-encoded, to
match Tendermint's data structures, but this is a less obtrusive change (not
requiring a base64 encoder) to restore functionality first.
hdevalence
force-pushed
the
ed25519-debug
branch
from
e79752a to
7325b10
Compare
Codecov Report
@@ Coverage Diff @@
## main #1272 +/- ##
=====================================
Coverage 64.3% 64.3%
=====================================
Files 250 250
Lines 21618 21626 +8
=====================================
+ Hits 13915 13923 +8
Misses 7703 7703
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since the
ed25519_consensus::VerificationKeyis no longer used, theVerificationKeys go back to having raw debug output that's hard to read when it appears in logs. This commit restores the hex-formatting previously inherited fromed25519_consensus, allowing nice output like (in use inpddownstream):In the future, another option could be to have the key be base64-encoded, to match Tendermint's data structures, but this is a less obtrusive change (not requiring a base64 encoder) to restore functionality first.