Fixup naming in cardano-crypto-leios#675
Merged
Merged
Conversation
* usage of `committeeVoters` was inconsistent with type name `LeiosCommittee` and `leios CommitteeSize, hence it was renamed to `leiosCommitteeVoters` * Using `newtype` deriving will always produce more efficient code than using `Generics` for instance deriving, hence switch from `anyclass` to `newtype` derriving strategy
Having exported bindings with names like `signers` in a huge project crypto project like Cardano is guaranteed to cause name clashes and potential confusion. Also prefixes are used throughtout the whole project, which makes consistency is another reason for the rename. CDDL snippet was removed from the Haddock, since we have a proper place for CDDL specification. Moreover, including code in Haddock pretty much guarantees that it will become outdated sooner or later, unless it is tested with doctest.
ch1bo
reviewed
Jun 29, 2026
ch1bo
approved these changes
Jun 29, 2026
ch1bo
left a comment
ch1bo
left a comment
Contributor
There was a problem hiding this comment.
Prefixing all field names is not my personal favorite, and I'd argue there is not really a precedent in this repository (e.g. Cardano.Crypto.VRF.Praos has many non-Praos named generic types and functions exported), but I can live with it 🤷
We need this version because of byteArrayFromByteString
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Some of the feedback in #670 was not fully addressed. This PR fixes that.
Checklist
CHANGELOG.mdfor the affected packages.New section is never added with the code changes. (See RELEASING.md)
.cabalandCHANGELOG.mdfiles according to theversioning process.
.cabalfiles for all affected packages are updated.If you change the bounds in a cabal file, that package itself must have a version increase. (See RELEASING.md)