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

New MaryEraOnly eon. Disjoint functions #312

Merged
merged 3 commits into from
Oct 12, 2023
Merged

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Oct 12, 2023

Changelog

- description: |
    New `MaryEraOnly` eon
    New functions:
    - `caseMaryEraOnlyOrAlonzoEraOnwards`
    - `disjointByronEraOnlyAndShelleyBasedEra`
    - `disjointAlonzoEraOnlyAndBabbageEraOnwards`
    Deprecate:
    - `noByronEraInShelleyBasedEra`.  Use `disjointByronEraOnlyAndShelleyBasedEra` 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

MaryEraOnly is not used yet, its use is anticipated as there some Mary-specific code exists.

The disjointX functions are used to prove that two eons don't overlap so the cases associated with those eons don't have to be handled.

This is similar to how use sometimes do this case someValue of {}.

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
  • Self-reviewed the diff

@@ -2656,7 +2656,7 @@ convWithdrawals txWithdrawals =

convTransactionFee :: ShelleyBasedEra era -> TxFee era -> Ledger.Coin
convTransactionFee sbe = \case
TxFeeImplicit w -> noByronEraInShelleyBasedEra sbe w
TxFeeImplicit w -> disjointByronEraOnlyAndShelleyBasedEra w sbe
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Here we are using disjointByronEraOnlyAndShelleyBasedEra to prove that the w and sbe eons don't overlap so this case doesn't need to be handled.

In this case w happens to be ByronEraOnly which does not overlap with ShelleyBasedEra.

@newhoggy newhoggy marked this pull request as ready for review October 12, 2023 11:44
@newhoggy newhoggy changed the title New MaryEraOnly eon New MaryEraOnly eon. Disjoint functions Oct 12, 2023
Copy link
Contributor

@smelc smelc left a comment

Choose a reason for hiding this comment

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

LGTM 🍻

@newhoggy newhoggy added this pull request to the merge queue Oct 12, 2023
Merged via the queue into main with commit 0c9eba4 Oct 12, 2023
22 checks passed
@newhoggy newhoggy deleted the newhoggy/new-MaryEraOnly-eon branch October 12, 2023 14:49
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

2 participants