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

Update ADR-4: Replace CurrentEra & UpcomingEra with concrete era names #51

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

carbolymer
Copy link
Collaborator

@carbolymer carbolymer commented Jul 29, 2024

Changes:

  • move each sentence to a separate line for easier tracking of changes
  • Replace CurrentEra and UpcomingEra with the concrete eras names.

Rendered

@carbolymer carbolymer force-pushed the mgalazyn/adr-4-use-specific-eras-instead-of-current-upcoming branch from 7019aa0 to d26356e Compare July 29, 2024 13:58
@carbolymer carbolymer changed the title ADR-4: Update r Update ADR-4: Replace CurrentEra & UpcomingEra with concrete era names Jul 29, 2024
@carbolymer carbolymer force-pushed the mgalazyn/adr-4-use-specific-eras-instead-of-current-upcoming branch from d26356e to 9f6be99 Compare July 29, 2024 14:02

This deprecation will happen only after the hardfork has been successful. There should be no need for consumers of the api to need the prior era's specific functionality. If users for some reason want this, we can direct them to use the ledger's api directly.

## Downsides
Copy link
Collaborator Author

@carbolymer carbolymer Jul 29, 2024

Choose a reason for hiding this comment

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

I don't think this description of downsides is relevant anymore, so I've removed it: the dead code won't be an issue anymore.

@carbolymer carbolymer marked this pull request as ready for review July 29, 2024 14:05
@carbolymer carbolymer requested review from a team as code owners July 29, 2024 14:05
@Jimbo4350 Jimbo4350 self-requested a review August 28, 2024 19:28
The new api should be created adjacant to the existing one.
We then slowly replace the use of the existing api in cardano-api, eventually deprecating the "old" api.

With respect to cardano-cli, we should introduce top level `current-era` and `upcoming-era` commands.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thinking about this again we should just use the era. Why? These names would have the same problem we just ran into with cardano-cli latest.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think I agree with you. On the era boundary this will break most of the scripts relying on the latest being a particular era.

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