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.

Sign up for GitHub

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

Jump to bottom

Experimental API: remove redundant type families and functions #625

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Experimental API: remove redundant type families and functions #625

merged 1 commit into from
Sep 5, 2024

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Sep 2, 2024 •
edited
Loading

Changelog

- description: |
    Fix current treasury value in transaction building: default to `Nothing` instead of `0`.
    Experimental API: remove redundant type families and functions #625 
# 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
  # - refactoring    # QoL changes
   - 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

Removes redundant type families - we don't need them for marking the experimental API eras and the old eras.

Fixes the default value for current treasury value in transaction building.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@carbolymer carbolymer changed the title wip Add more experimental era functions Sep 2, 2024
@carbolymer carbolymer force-pushed the mgalazyn/feature/add-experimental-era-functions branch 4 times, most recently from a58f105 to 32d7c1e Compare September 3, 2024 21:07
@carbolymer carbolymer changed the title Add more experimental era functions Experimental API: remove redundant type families and functions Sep 3, 2024
@carbolymer carbolymer force-pushed the mgalazyn/feature/add-experimental-era-functions branch from 32d7c1e to 7e745d6 Compare September 3, 2024 21:13
@carbolymer carbolymer marked this pull request as ready for review September 3, 2024 21:13
smelc
smelc reviewed Sep 4, 2024
View reviewed changes
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.

Change to default treasury value is correct. I let @Jimbo4350 review the experimental API changes 👍

cardano-api/internal/Cardano/Api/Experimental/Eras.hs
type family ApiEraToLedgerEra era = (r :: Type) | r -> era where
ApiEraToLedgerEra Api.BabbageEra = Ledger.Babbage
ApiEraToLedgerEra Api.ConwayEra = Ledger.Conway
data Some (f :: Type -> Type) 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 you write a comment giving some intuition what this is used for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a comment explaining usage

Copy link
Contributor

Choose a reason for hiding this comment

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

Where is this used?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a replacement for EraInEon. Used here:

cardano-api/test/cardano-api-test/Test/Cardano/Api/Typed/TxBody.hs Show resolved Hide resolved
@carbolymer carbolymer force-pushed the mgalazyn/feature/add-experimental-era-functions branch from 7e745d6 to c376f6c Compare September 4, 2024 12:39
@carbolymer carbolymer force-pushed the mgalazyn/feature/add-experimental-era-functions branch from c376f6c to a9cabb0 Compare September 4, 2024 12:40
@carbolymer carbolymer mentioned this pull request Sep 4, 2024
Merged
3 tasks
Jimbo4350
Jimbo4350 approved these changes Sep 5, 2024
View reviewed changes
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.

Nice work. I'm not a fan of the name of Some but it's minor.

@carbolymer carbolymer added this pull request to the merge queue Sep 5, 2024
Merged via the queue into main with commit b238068 Sep 5, 2024
25 checks passed
@carbolymer carbolymer deleted the mgalazyn/feature/add-experimental-era-functions branch September 5, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smelc smelc smelc left review comments

@Jimbo4350 Jimbo4350 Jimbo4350 approved these changes

@dcoutts dcoutts Awaiting requested review from dcoutts

@erikd erikd Awaiting requested review from erikd

@newhoggy newhoggy Awaiting requested review from newhoggy

@palas palas Awaiting requested review from palas

@kevinhammond kevinhammond Awaiting requested review from kevinhammond

@CarlosLopezDeLara CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara

@disassembler disassembler Awaiting requested review from disassembler

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@carbolymer @smelc @Jimbo4350