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

Replace CertificatesSupportedInEra with ShelleyBasedEra #259

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Sep 22, 2023

Changelog

- description: |
    Delete `CertificatesSupportedInEra`.  Use `ShelleyBasedEra` instead.
    Delete `certificatesSupportedInEra`.  Use `inEonForEra` instead.
# 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

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 force-pushed the newhoggy/replace-CertificatesSupportedInEra-with-ShelleyBasedEra branch from 4369592 to 5f005f8 Compare September 22, 2023 11:27
let certificates = body ^. L.certsTxBodyL in
if null certificates
then TxCertificatesNone
else TxCertificates sbe (map (fromShelleyCertificate sbe) $ toList certificates) ViewTx
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This function is simplified via the use of shelleyBasedEraConstraints.

@@ -1687,13 +1656,14 @@ deriving instance Show (TxWithdrawals build era)

data TxCertificates build era where
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we replace this with

Suggested change
data TxCertificates build era where
type TxCertificates build era
= Featured ShelleyBasedEra era
( [Certificate era]
, BuildTxWith build (Map StakeCredential (Witness WitCtxStake era))
)

?

Feels like it would simplify era-witness checking down the line.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep. Can do that in a future commit.

Copy link
Contributor

@Jimbo4350 Jimbo4350 Sep 26, 2023

Choose a reason for hiding this comment

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

Please don't. Having this as a data definition makes it clearer what it is when using it.

@newhoggy newhoggy added this pull request to the merge queue Sep 26, 2023
Merged via the queue into main with commit 680f0db Sep 26, 2023
22 checks passed
@newhoggy newhoggy deleted the newhoggy/replace-CertificatesSupportedInEra-with-ShelleyBasedEra branch September 26, 2023 04:26
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.

🚀

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