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

Remove redundant era conversion functions. Handle IO Exceptions in consensus queries. Refactor Cardano.Api.Convenience.Query to work in ExceptT e IO. #566

Merged
merged 1 commit into from
Jun 28, 2024

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Jun 28, 2024

Changelog

- description: |
    - Remove redundant era conversion functions. Use `toCardanoEra` instead.
    - Add IO Exception handling to consensus query execution.
    - Refactor Cardano.Api.Convenience.Query to return `ExceptT e IO a` instead of `IO (Either e a)`

# 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

Make things more composable.

@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-redundant-era-conversions branch from 3f728c4 to 731e613 Compare June 28, 2024 10:25
@carbolymer carbolymer changed the title Remove redundant era conversion functions Remove redundant era conversion functions. Handle IO Exceptions in consensus queries. Refactor Cardano.Api.Convenience.Query to work in ExceptT e IO. Jun 28, 2024
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-redundant-era-conversions branch from 731e613 to 51ca561 Compare June 28, 2024 10:29
* Remove redundant era conversion functions.
* Add IO Exception handling to consensus query execution.
* Refactor Cardano.Api.Convenience.Query to return `ExceptT e IO a`
  instead of `IO (Either e a)`
@carbolymer carbolymer marked this pull request as ready for review June 28, 2024 10:42
@carbolymer carbolymer requested a review from dcoutts as a code owner June 28, 2024 10:42
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-redundant-era-conversions branch from 51ca561 to 0f27cc7 Compare June 28, 2024 10:42
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.

Nice 👍

@carbolymer carbolymer added this pull request to the merge queue Jun 28, 2024
Merged via the queue into main with commit dfaf1e9 Jun 28, 2024
23 checks passed
@carbolymer carbolymer deleted the mgalazyn/refactor/remove-redundant-era-conversions branch June 28, 2024 13:05
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.

@carbolymer have you checked with consumers of the api in IOG that they are not using the functions you have removed?

@carbolymer
Copy link
Contributor Author

@Jimbo4350 no I haven't, because the removed functions can be simply swapped with toCardanoEra. I've mentioned that in changelog.

@CarlosLopezDeLara CarlosLopezDeLara mentioned this pull request Jul 2, 2024
2 tasks
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.

3 participants