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

Modify queryGenesisParameters so that its type advertises it only returns genesis parameters for the Shelley era #181

Merged
merged 1 commit into from Aug 10, 2023

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Aug 10, 2023

Changelog

- description: |
    Modify `queryGenesisParameters` so that its type advertises it only returns genesis parameters for the Shelley era
# 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

Additional context for the PR goes here.

The actual query in Consensus does not return the genesis parameters for any era other than Shelley. To have a type that advertises otherwise is misleading.

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 August 10, 2023 09:29
@@ -240,7 +240,7 @@ data QueryInShelleyBasedEra era result where
:: QueryInShelleyBasedEra era EpochNo

QueryGenesisParameters
:: QueryInShelleyBasedEra era GenesisParameters
:: QueryInShelleyBasedEra ShelleyEra GenesisParameters
Copy link
Contributor

Choose a reason for hiding this comment

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

Why though?

@Jimbo4350 Jimbo4350 self-requested a review August 10, 2023 13:41
@newhoggy newhoggy added this pull request to the merge queue Aug 10, 2023
Merged via the queue into main with commit 7f6d56d Aug 10, 2023
24 checks passed
@newhoggy newhoggy deleted the newhoggy/queryGenesisParameters-in-shelley-era-only branch August 10, 2023 14:11
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