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

Tighten era bounds of Conway specific API to ConwayEraOnwards #132

Closed
wants to merge 1 commit into from

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Jul 24, 2023

Changelog

- description: |
    Constraint the following functions to `ConwayEraOnwards`:
    - createProposalProcedure
    - createVotingProcedure
    - eraDecodeVotingCredential
    - fromGovernanceAction
    - fromProposalProcedure
    - makeGoveranceActionId
    - toGovernanceAction
    - toVoterRole
    - toVotingCredential
  type:
    - 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
  # - documentation  # change in code docs, haddocks...

Context

Those functions and data types were constrained to ShelleyBasedEra previously, but that's too lose for something that's applicable to only Conway onwards.

Those functions are now constrained to ConwayEraOnwards instead.

Constraining to ConwayEraOnwards tightly allows the CLI parser to integrate with it in a type-safe way. This type-safety is what controls the visibility of CLI commands and options based on whether the era is Conway onwards.

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
    • roundtrip tests
  • 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

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

@newhoggy newhoggy force-pushed the newhoggy/tighten-to-conway-era-onwards branch from 95d87c2 to 6e2610e Compare July 24, 2023 11:54
@newhoggy newhoggy changed the title Newhoggy/tighten to conway era onwards Tighten era bounds of VotingProcedure and ProposalProcedure to ConwayEraOnwards Jul 24, 2023
@newhoggy newhoggy marked this pull request as ready for review July 24, 2023 11:55
@newhoggy newhoggy changed the title Tighten era bounds of VotingProcedure and ProposalProcedure to ConwayEraOnwards Tighten era bounds of Conway specific API to ConwayEraOnwards Jul 24, 2023
@newhoggy newhoggy force-pushed the newhoggy/tighten-to-conway-era-onwards branch 2 times, most recently from f47298b to d0d45fc Compare July 24, 2023 12:50
@newhoggy newhoggy requested a review from a team as a code owner July 24, 2023 12:56
@newhoggy newhoggy force-pushed the newhoggy/tighten-to-conway-era-onwards branch from 0b32f86 to cf4e5e7 Compare July 24, 2023 12:58
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@newhoggy newhoggy force-pushed the newhoggy/tighten-to-conway-era-onwards branch 2 times, most recently from f140db1 to d91f6af Compare July 24, 2023 13:04
Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

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

This needs to wait till after we have made sufficient progress in the cli.

@newhoggy newhoggy force-pushed the newhoggy/tighten-to-conway-era-onwards branch 3 times, most recently from bf13f20 to 3749ee4 Compare July 25, 2023 07:32
@newhoggy newhoggy mentioned this pull request Jul 25, 2023
10 tasks
@newhoggy newhoggy force-pushed the newhoggy/tighten-to-conway-era-onwards branch 9 times, most recently from 28f54eb to cd151fc Compare July 29, 2023 04:15
@newhoggy newhoggy force-pushed the newhoggy/tighten-to-conway-era-onwards branch 2 times, most recently from 6f01365 to eed9c9a Compare August 4, 2023 16:05
@github-actions
Copy link

This PR is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Stale label Sep 22, 2023
@newhoggy newhoggy closed this Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants