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.

Sign up for GitHub

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

Jump to bottom

Remove deprecated functions and update types and update writeTxFileTextEnvelopeCddl to use new format #746

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove deprecated functions and update types and update writeTxFileTextEnvelopeCddl to use new format #746

wants to merge 1 commit into from

Conversation

palas
Copy link
Contributor

@palas palas commented Feb 4, 2025 •
edited
Loading

Changelog

- description: |
    Removed `serialiseTxLedgerCddl` and `deserialiseTxLedgerCddl`, and updated `writeTxFileTextEnvelopeCddl` to use new format.
  type:
  - breaking

Context

serialiseTxLedgerCddl and deserialiseTxLedgerCddl have been deprecated for two months, so I am removing them. Just realised writeTxFileTextEnvelopeCddl is still using the old format, so I updated that and I will remove the compatibility layer in two months.

How to trust this PR

Check that what I say in Context is true. Also that I haven't removed any still relevant tests.

Check together with: IntersectMBO/cardano-cli#1052

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

@palas palas self-assigned this Feb 4, 2025
@palas palas changed the title Remove deprecated functions and update types and update serialiseTxLedgerCddl to use new format Remove deprecated functions and update types and update writeTxFileTextEnvelopeCddl to use new format Feb 4, 2025
@palas palas changed the title Remove deprecated functions and update types and update writeTxFileTextEnvelopeCddl to use new format Remove deprecated functions and update types and update writeTxFileTextEnvelopeCddl to use new format Feb 4, 2025
@palas palas force-pushed the remove-deprecated-functions branch from cc69489 to 28adec6 Compare February 4, 2025 14:54
@palas palas force-pushed the remove-deprecated-functions branch from 28adec6 to 2bdd8f0 Compare February 4, 2025 14:59
@palas palas mentioned this pull request Feb 4, 2025
Open
3 tasks
Jimbo4350
Jimbo4350 reviewed Feb 4, 2025
View reviewed changes
cardano-api/test/cardano-api-test/Test/Cardano/Api/CBOR.hs
era
( H.tripping
x
(serialiseToTextEnvelope (Just (TextEnvelopeDescr "Ledger Cddl Format")))
Copy link
Contributor

Choose a reason for hiding this comment

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

These should be replaced with roundtrip tests that use serialiseToTextEnvelope and deserialiseFromTextEnvelope. We still care about having coherent instances!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jimbo4350 Jimbo4350 Jimbo4350 left review comments

@dcoutts dcoutts Awaiting requested review from dcoutts dcoutts is a code owner

@erikd erikd Awaiting requested review from erikd erikd is a code owner

@newhoggy newhoggy Awaiting requested review from newhoggy newhoggy is a code owner

@carbolymer carbolymer Awaiting requested review from carbolymer carbolymer is a code owner

@smelc smelc Awaiting requested review from smelc smelc is a code owner

@kevinhammond kevinhammond Awaiting requested review from kevinhammond kevinhammond is a code owner

@CarlosLopezDeLara CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara CarlosLopezDeLara is a code owner

@disassembler disassembler Awaiting requested review from disassembler disassembler is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@palas palas

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove deprecated functions and update types and update writeTxFileTextEnvelopeCddl to use new format
2 participants
@palas @Jimbo4350