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

key non-extended-key: support drep extended keys #377

Merged
merged 3 commits into from
Oct 31, 2023

Conversation

smelc
Copy link
Contributor

@smelc smelc commented Oct 17, 2023

Changelog

- description: |
    Support converting a drep extended key to its non-extended version
# 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

Fixes #358

Roadmap

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
  • NA 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
  • Self-reviewed the diff

@@ -0,0 +1,5 @@
{
"type": "DRepVerificationKey_ed25519",
"description": "",
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have a description for that key here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@carbolymer> I added a description in commit drep verification key: extended->non extended: specify description. Is that what you had in mind?

I did the minimal change to avoid disturbing existing tests and code.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I should've been more explicit. It's an open question from my side whether we should have a description here.
@CarlosLopezDeLara what do you think, should we put a description here, and which one?

Copy link
Contributor

@CarlosLopezDeLara CarlosLopezDeLara Oct 30, 2023

Choose a reason for hiding this comment

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

"Delegate Representative Verification Key"
@carbolymer

Copy link
Contributor

Choose a reason for hiding this comment

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

@smelc The text value is already defined here: https://github.com/input-output-hk/cardano-cli/blob/main/cardano-cli/src/Cardano/CLI/EraBased/Run/Governance.hs#L98
it would be nice to re-use it (and move it somewhere probably).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I made the constant a top-level symbol of Cardano.CLI.EraBased.Run.Key and reused it from Governance. I looked around but saw no obvious destinations and didn't want to introduce a Constant module.

@carbolymer> let me know if that suits you.

I also propose to put descriptions when converting other types of extended keys, but will do that in another PR, to avoid delaying this one.

@smelc smelc force-pushed the smelc/support-extended-drep-keys branch from a98fc17 to 7c4395e Compare October 31, 2023 10:07
@smelc smelc force-pushed the smelc/support-extended-drep-keys branch from 7c4395e to 789e9fd Compare October 31, 2023 10:18
@smelc smelc enabled auto-merge October 31, 2023 10:24
@smelc smelc added this pull request to the merge queue Oct 31, 2023
Merged via the queue into main with commit d32fce0 Oct 31, 2023
19 checks passed
@smelc smelc deleted the smelc/support-extended-drep-keys branch October 31, 2023 10:49
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.

Convert a dRep extended vkey to a non-extended one:
3 participants