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

Draft the new, definite textEnvelopeType for Tx #630

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ch1bo
Copy link
Contributor

@ch1bo ch1bo commented Sep 9, 2024

All transactions are now serialized and deserialized as 'Witnessed' transactions using the Ledger binary format.

Changelog

- description: |
    **BREAKING** Text envelope type of `Tx era` is now always using the new `Witnessed Tx` prefix.
# 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

Draft for the transaction envelope type that a cardano-api transaction should have going forward. Before, only serialiseTxLedgerCddl would produce the correctly parseable Witnessed Tx ConwayEra for example. However, that function is deprecated and we should fix the serialiseToTextEnvelope invocation for Tx era directly.

How to trust this PR

There are probably several things missing and this is just a draft for how I, as a user, would want the cardano-api/-cli to operate (using a single Witnessed Tx <era> type).

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

All transactions are now serialized and deserialized as 'Witnessed'
transactions using the Ledger binary format.
ch1bo added a commit to cardano-scaling/hydra that referenced this pull request Sep 9, 2024
Using the upstream serialization from cardano-api includes a
description. Also left a note why we are using a deprecated function
here now (they'll fix it in cardano-api).

See IntersectMBO/cardano-api#630
ch1bo added a commit to cardano-scaling/hydra that referenced this pull request Sep 9, 2024
Using the upstream serialization from cardano-api includes a
description. Also left a note why we are using a deprecated function
here now (they'll fix it in cardano-api).

See IntersectMBO/cardano-api#630
ch1bo added a commit to cardano-scaling/hydra that referenced this pull request Sep 10, 2024
Using the upstream serialization from cardano-api includes a
description. Also left a note why we are using a deprecated function
here now (they'll fix it in cardano-api).

See IntersectMBO/cardano-api#630
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.

1 participant