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

Deprecate TxVotesSupportedInEra #154

Merged
merged 1 commit into from
Jul 31, 2023

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Jul 29, 2023

Changelog

- description: |
    Deprecate `TxVotesSupportedInEra`
  compatibility: breaking
  type: feature

Context

TxVotesSupportedInEra and ConwayEraOnwards are near identical.

Using ConwayEraOnwards everywhere instead.

The deprecation and switch to ConwayEraOnwards serves the following purpose:

  • Reduce the size of the API
  • Documentation that a type, constructor or function only works from Conway era onwards. Use of TxVotesSupportedInEra did not make this clear
  • Reduce the amount of glue code required for different parts of the CLI to work together.

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 marked this pull request as ready for review July 29, 2023 03:24
@newhoggy newhoggy force-pushed the newhoggy/deprecate-TxVotesSupportedInEra branch from 56f74d2 to 978cd0c Compare July 29, 2023 04:08
@newhoggy newhoggy force-pushed the newhoggy/deprecate-TxVotesSupportedInEra branch from 978cd0c to 07418f5 Compare July 29, 2023 04:15
@@ -47,7 +48,7 @@ data TxVotes era where
TxVotesNone :: TxVotes era

TxVotes
:: TxVotesSupportedInEra era
:: ConwayEraOnwards era
Copy link
Contributor

Choose a reason for hiding this comment

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

So this assumes that we will always have voting in the Conway era onwards, which is a reasonable assumption.

@newhoggy newhoggy added this pull request to the merge queue Jul 31, 2023
Merged via the queue into main with commit eabbed9 Jul 31, 2023
17 checks passed
@newhoggy newhoggy deleted the newhoggy/deprecate-TxVotesSupportedInEra branch July 31, 2023 14:44
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.

2 participants