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

Prepare deprecation of ProtocolParameters #547

Merged
merged 2 commits into from
Jun 7, 2024

Conversation

smelc
Copy link
Contributor

@smelc smelc commented May 30, 2024

Changelog

- description: |
    Prepare deprecation of ProtocolParameters: deprecate a number of functions producing them
# 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

How to trust this PR

It's only comments

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • Self-reviewed the diff

@smelc smelc marked this pull request as ready for review May 31, 2024 13:10
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.

LGTM! One minor comment.

@@ -1728,6 +1731,7 @@ fromShelleyPParams pp =
}


{-# DEPRECATED fromAlonzoPParams "Use the ledger's PParams type instead of ProtocolParameters." #-}
Copy link
Contributor

Choose a reason for hiding this comment

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

We should indicate in all the deprecation pragmas that we can access this type via the module Cardano.Api.Ledger

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Jimbo4350> done 👍

@smelc smelc force-pushed the smelc/deprecate-protocol-parameters branch from edf999c to 0481fd8 Compare June 7, 2024 13:19
@smelc smelc enabled auto-merge June 7, 2024 13:20
@smelc smelc disabled auto-merge June 7, 2024 14:08
@smelc smelc merged commit dc448a2 into main Jun 7, 2024
21 of 32 checks passed
@smelc smelc deleted the smelc/deprecate-protocol-parameters branch June 7, 2024 14:09
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