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 experimental code leak in Cardano.Api non-experimental modules #681

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Nov 15, 2024

Changelog

- description: |
    Remove experimental code exposure in `Cardano.Api` non-experimental modules
# 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

This PR reverts:

Removes exposure of types and functions from Cardano.Api.Experimental through other Cardano.Api modules.

Fixes #675

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 Try to revert experimental code in Cardano.Api.Fees Remove experimental code in Cardano.Api Nov 15, 2024
@carbolymer carbolymer force-pushed the mgalazyn/fix/revert-experimental-eras-in-non-experimental-api branch from 90af87d to dddbc55 Compare November 15, 2024 18:27
@carbolymer carbolymer force-pushed the mgalazyn/fix/revert-experimental-eras-in-non-experimental-api branch from dddbc55 to da8485b Compare November 15, 2024 18:42
@carbolymer carbolymer changed the title Remove experimental code in Cardano.Api Remove experimental code leak in Cardano.Api non-experimental modules Nov 15, 2024
@carbolymer carbolymer marked this pull request as ready for review November 15, 2024 19:05

deriving instance
(Exp.IsEra era, IsShelleyBasedEra era) => Show (BalancedTxBody era)
data BalancedTxBody era
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice change getting rid of a useless GADT 🫶

Copy link
Contributor Author

Choose a reason for hiding this comment

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

By the way, what's wrong with GADT? 😃

@carbolymer carbolymer added this pull request to the merge queue Nov 19, 2024
Merged via the queue into master with commit 7df31dc Nov 19, 2024
32 of 34 checks passed
@carbolymer carbolymer deleted the mgalazyn/fix/revert-experimental-eras-in-non-experimental-api branch November 19, 2024 13:35
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.

[BUG] - BalancedTx contains UnsignedTx field type from Experimental API, forcing users to use the latter
3 participants