[ADP-3359] Simplify construction of API errors relating to recent eras. #4603
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathanknowles
changed the title
This commit adjusts the golden file for `ApiError.json` so that
`supported_recent_eras` fields:
- do not include duplicate eras
- list eras in alphabetic order
This is necessary, as the Haskell type for this field has changed from a
list to a `Set`, which changes the behaviour of the generator for the
`ApiErrorNodeNotYetInRecentEra` data type.
jonathanknowles
force-pushed
the
jonathanknowles/all-recent-eras
branch
from
52a29bf
to
e7481b6
Compare
jonathanknowles
commented
May 22, 2024
| @@ -463,13 +471,21 @@ instance Bounded AnyRecentEra where | |||
| minBound = AnyRecentEra RecentEraBabbage | |||
| maxBound = AnyRecentEra RecentEraConway | |||
|
|
|||
| instance Ord AnyRecentEra where | |||
| compare = compare `on` fromEnum | |||
There was a problem hiding this comment.
This instance is needed in order to have a Set AnyRecentEra.
Anviking
reviewed
May 22, 2024
| instance Show AnyRecentEra where | ||
| show (AnyRecentEra era) = "AnyRecentEra " <> show era | ||
|
|
||
| instance Eq AnyRecentEra where | ||
| AnyRecentEra e1 == AnyRecentEra e2 = | ||
| isJust $ testEquality e1 e2 | ||
|
|
||
| -- | The complete set of supported recent eras. | ||
| -- | ||
| supportedRecentEras :: Set AnyRecentEra |
There was a problem hiding this comment.
supportedRecentEras
What would an unsupported recent era be?
It seems like it's saying the same things twice. I.e. could it be more suitable to name it allRecentEras or supportedErasForTxConstruction (the latter more for the api, not here) ?
paolino
approved these changes
May 22, 2024
In response to review feedback: #4603 (comment)
I agree with you! Though hopefully this refactoring goes in the right direction: the definition of the set of recent eras is now in the |
jonathanknowles
changed the title
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
recentEras :: Set AnyRecentEraApiErrorNodeNotYetInRecentEraApiErrorUnsupportedEraIssue
ADP-3359
Follow-on from #4595.