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

Add --verification-key option to committee key-hash command #187

Merged
merged 2 commits into from
Aug 18, 2023

Conversation

newhoggy
Copy link
Contributor

Changelog

- description: |
    Add `--verification-key` option to `committee key-hash` command
# 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

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 force-pushed the newhoggy/committee-key-hash-command-improvement branch from c8099b5 to 3e12ca6 Compare August 18, 2023 12:59
@@ -794,7 +794,10 @@ Usage: cardano-cli conway governance committee key-gen-hot --verification-key-fi

Create a cold key pair for a Constitutional Committee Member

Usage: cardano-cli conway governance committee key-hash --verification-key-file FILE
Usage: cardano-cli conway governance committee key-hash
( --verification-key STRING
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adds this command line option ⬆️

--verification-key-file FILE
Input filepath of the verification key.
Input filepath of the Constitutional Committee Member
key (hot or cold).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

More descriptive help.

let asTypes =
[ FromSomeType (AsVerificationKey AsCommitteeHotKey ) ACommitteeHotKey
, FromSomeType (AsVerificationKey AsCommitteeColdKey) ACommitteeColdKey
]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We are still reasonably strict about what keys are accepted.

@newhoggy newhoggy marked this pull request as ready for review August 18, 2023 13:01
@newhoggy newhoggy requested review from Jimbo4350 and carbolymer and removed request for Jimbo4350 August 18, 2023 13:04

-- | The source from which a verification key of an unspecified key role can be
-- derivied.
data AnyVerificationKeySource
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Using the naming convention that XyzSource is a thing from which an Xyz can be derived.

In this case, the Xyz is VerificationKey. The Any prefix means any keyrole.

@newhoggy newhoggy force-pushed the newhoggy/committee-key-hash-command-improvement branch from 3e12ca6 to aed9e56 Compare August 18, 2023 13:26
@newhoggy newhoggy force-pushed the newhoggy/committee-key-hash-command-improvement branch from aed9e56 to ac35314 Compare August 18, 2023 13:27
@newhoggy newhoggy enabled auto-merge August 18, 2023 13:43
@newhoggy newhoggy added this pull request to the merge queue Aug 18, 2023
Merged via the queue into main with commit 44bbb40 Aug 18, 2023
@newhoggy newhoggy deleted the newhoggy/committee-key-hash-command-improvement branch August 18, 2023 14:45
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.

3 participants