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

Parameterise Certificate type with phantom era type argument #83

Merged
merged 1 commit into from
Jun 30, 2023

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Jun 28, 2023

Changelog

- description: |
    - Parameterise `Certificate` type with phantom `era` type argument
    - Additional `CardanoEra era` argument for:
      - `makeCommitteeDelegationCertificate`
      - `makeCommitteeHotKeyUnregistrationCertificate`
      - `makeMIRCertificate`
      - `makeStakeAddressDeregistrationCertificate`
      - `makeStakeAddressPoolDelegationCertificate`
      - `makeStakeAddressRegistrationCertificate`
      - `makeStakePoolRegistrationCertificate`
      - `makeStakePoolRetirementCertificate`
    - New functions:
      - `cardanoEraConstraints`
      - `textEnvelopeTypeInEra`
    - Delete `Certificate` constructor arguments from:
      - `PoolRegistration`
      - `PoolReRegistration`
  compatibility: breaking
  type: feature

Context

The addition of the era type parameter is necessary for the Conway era which not only introduces new certificate types but also modifies existing certificates in a backward compatible but not forward compatible way.

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
  • Any changes are noted in the CHANGELOG.md for affected package
  • 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

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 June 28, 2023 13:53
@newhoggy newhoggy force-pushed the newhoggy/stub-era-type-parameter branch from 23a121d to c6b558b Compare June 28, 2023 13:55
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.

Requesting changes so I have a chance to review

Copy link
Contributor

@erikd erikd 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 be squashed down to s single commit but otherwise LGTM.

@newhoggy newhoggy force-pushed the newhoggy/stub-era-type-parameter branch from c6b558b to 6007ef6 Compare June 29, 2023 23:30
@newhoggy newhoggy requested a review from Jimbo4350 June 29, 2023 23:30
@newhoggy newhoggy dismissed Jimbo4350’s stale review June 29, 2023 23:32

Have walked through this changes with Mateusz and Jordan

@newhoggy newhoggy changed the title Stub era type parameter for Certificate type Parameterise Certificate type with phantom era type argument Jun 29, 2023
@newhoggy newhoggy added this pull request to the merge queue Jun 29, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jun 30, 2023
@newhoggy newhoggy added this pull request to the merge queue Jun 30, 2023
@newhoggy newhoggy removed this pull request from the merge queue due to a manual request Jun 30, 2023
@newhoggy newhoggy merged commit 1fba2c9 into main Jun 30, 2023
@newhoggy newhoggy deleted the newhoggy/stub-era-type-parameter branch June 30, 2023 02:04
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.

4 participants