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

Expose functions and types from cardano-ledger-alonzo and cardano-ledger-byron required by cardano-cli #647

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

palas
Copy link
Contributor

@palas palas commented Oct 1, 2024

Note to self: write API changes in changelog before merging

Changelog

- description: |
    Exposed functions and types from cardano-ledger-alonzo, and cardano-ledger-byron required by cardano-cli.
    Breaking changes:
      * `Address` type and its constructor `ByronAddress` are no longer exported by `Cardano.Api.Byron`, but they are both exported by `Cardano.Api` now, together with `ShelleyAddress` constructor.
      * The types `TxId`, `TxIn`, `TxOut`, and `TxIx`, with their constructors are no longer exported by `Cardano.Api.Byron`.
  type:
  - breaking       # the API has changed in a breaking way
  - refactoring     # QoL changes

Context

As part of the work targeted at addressing issues pointed out in #608, this PR aims to provide cardano-cli with everything it needs from ledger (in this PR alonzo and byron parts),

How to trust this PR

Make sure it is just a refactoring for cardano-cli.

Make sure the way new things are exposed is sensible.

Look at it in conjunction with: IntersectMBO/cardano-cli#920

Most commits are linked 1 to 1 with commits in the cardano-cli PR.

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

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.

LGTM 👏

Thanks for the detailed How to trust this PR instructions 💯

cardano-api/internal/Cardano/Api/ByronDelegation.hs Outdated Show resolved Hide resolved
cardano-api/internal/Cardano/Api/SpecialByron.hs Outdated Show resolved Hide resolved
cardano-api/internal/Cardano/Api/TxIn.hs Outdated Show resolved Hide resolved
cardano-api/cardano-api.cabal Outdated Show resolved Hide resolved
@palas palas force-pushed the remove-transitive-deps-ledger-backport branch from 320811f to af99006 Compare October 4, 2024 17:26
@Jimbo4350 Jimbo4350 self-requested a review October 4, 2024 17:39
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!

@palas palas force-pushed the remove-transitive-deps-ledger-backport branch from af99006 to a7470b6 Compare October 4, 2024 18:06
@palas palas force-pushed the remove-transitive-deps-ledger-backport branch from a7470b6 to 4f9b7d6 Compare October 4, 2024 18:08
@palas palas enabled auto-merge October 4, 2024 18:09
@palas palas added this pull request to the merge queue Oct 4, 2024
Merged via the queue into main with commit 00f025d Oct 4, 2024
25 checks passed
@palas palas deleted the remove-transitive-deps-ledger-backport branch October 4, 2024 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] - Documentation and Integration Clarification
3 participants