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 shelleyCertificateConstraints and conwayCertificateConstraints #155

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Jul 29, 2023

Changelog

- description: |
    Deprecate `shelleyCertificateConstraints` and `conwayCertificateConstraints`
  compatibility: breaking
  type: feature

Context

shelleyToBabbageEraConstraints already provides all the constraints that shelleyCertificateConstraints.

conwayEraOnwardsConstraints already provides all the constraints that conwayCertificateConstraints.

Deprecating these functions will reduce the size of the API.

Going forward, when needing constraints for ShelleyToBabbageEra, one only need to use shelleyToBabbageEraConstraints.

Going forward, when needing constraints for ConwayEraOnwards, one only need to use conwayCertificateConstraints.

If more constraints are needed then those constraints can be added to shelleyCertificateConstraints and conwayCertificateConstraints.

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 04:33
ShelleyToBabbageEraMary -> id
ShelleyToBabbageEraAllegra -> id
ShelleyToBabbageEraShelley -> id
shelleyCertificateConstraints w f = shelleyToBabbageEraConstraints w f {- HLINT ignore "Eta reduce" -}
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Strangely ETA reduction doesn't work.

Not an issue for these functions are planned for deletion anyway

@newhoggy newhoggy force-pushed the newhoggy/deprecate-shelleyCertificateConstraints-and-conwayCertificateConstraints branch from 9f17afa to 07bc33c Compare July 29, 2023 04:39
( C.HashAlgorithm (L.HASH (L.EraCrypto ledgerera))
, C.Signable (L.VRF (L.EraCrypto ledgerera)) L.Seed
type ShelleyToBabbageEraConstraints era =
( C.HashAlgorithm (L.HASH (L.EraCrypto (ShelleyLedgerEra era)))
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not ShelleyLedgerEra era ~ ledgerera? It would be a little bit more readable imo.

@newhoggy newhoggy added this pull request to the merge queue Jul 31, 2023
Merged via the queue into main with commit b9dc2d1 Jul 31, 2023
17 checks passed
@newhoggy newhoggy deleted the newhoggy/deprecate-shelleyCertificateConstraints-and-conwayCertificateConstraints branch July 31, 2023 13:42
newhoggy pushed a commit that referenced this pull request Mar 11, 2024
…al-governance-action

Add conway governance action create-treasury-withdrawal
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