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

Fewer constraints in functions #310

Merged
merged 12 commits into from
Oct 11, 2023
Merged

Conversation

newhoggy
Copy link
Collaborator

Changelog

- description: |
    Fewer constraints in functions
# 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
  • Self-reviewed the diff

@newhoggy newhoggy marked this pull request as ready for review October 10, 2023 12:22
@newhoggy newhoggy requested a review from smelc October 10, 2023 12:24
@@ -76,6 +77,7 @@ type MaryEraOnwardsConstraints era =
, L.EraPParams (ShelleyLedgerEra era)
, L.EraTx (ShelleyLedgerEra era)
, L.EraTxBody (ShelleyLedgerEra era)
, L.EraUTxO (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.

How do you know that it is valid to add such a constraint here? Is this something you infer from the ledger?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If you can add and the the constraints function still compiles, in this case maryEraOnwardsConstraints, then adding the constraint is valid.

This constraint was added because code in MaryEraOnwards needed the constraint.

Copy link
Contributor

@smelc smelc Oct 11, 2023

Choose a reason for hiding this comment

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

@newhoggy> And the maryEraOnwardsConstraints obtains the constraints in context thanks to the various imports right?

So in the end, this list of constraints here show what we actually need to use (as opposed to the full set of constraints if we were importing everything available)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

maryEraOnwardsConstraints obtains the constraints by case matching on the GADT. The case match tells the compiler what the specific era that is being used is after which the compiler can figure out the constraints.

The imports don't play into it except to allow use to write the XConstraints type and the Constraints type tells the compiler which of those constraints it knows about should be captured for the continuation.

@newhoggy newhoggy added this pull request to the merge queue Oct 11, 2023
Merged via the queue into main with commit 20a58e1 Oct 11, 2023
@newhoggy newhoggy deleted the newhoggy/fewer-constraints-in-functions branch October 11, 2023 12:05
newhoggy added a commit that referenced this pull request Mar 11, 2024
…cardano-api-8.22.0.0

Update to cardano api 8.22.0.0
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