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

Rename SomeWitness to SomeSigningWitness. Rename constructors to avoid name conflicts. #284

Merged
merged 2 commits into from
Sep 18, 2023

Conversation

newhoggy
Copy link
Contributor

@newhoggy newhoggy commented Sep 17, 2023

Changelog

- description: |
    Rename `SomeWitness` to `SomeSigningWitness`.  Rename constructors to avoid name conflicts.  Move to `Key` module.
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

The word "witness" on its own can be ambiguous because we use that word in the context of proving an operation is valid in an era. To avoid any confusion, rename SomeWitness to SomeSigningWitness.

Furthermore, the constructor names in SomeWitness types conflict with that of SomeSigningKey. Rename those constructors to end with SigningWitness instead of SigningKey to deconflict.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@newhoggy newhoggy marked this pull request as ready for review September 17, 2023 07:10
@newhoggy newhoggy added this pull request to the merge queue Sep 18, 2023
Merged via the queue into main with commit d634aaf Sep 18, 2023
19 checks passed
@newhoggy newhoggy deleted the newhoggy/rename-SomeWitness branch September 18, 2023 21:10
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

3 participants