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

Move transaction command implementation to era based #196

Conversation

newhoggy
Copy link
Contributor

@newhoggy newhoggy commented Aug 22, 2023

Changelog

- description: |
    Move transaction command implementation to era based
# 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
  - improvement    # QoL changes e.g. refactoring
  # - 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

This means that cardano-cli <era> transaction commands now exist. They behave just like the legacy ones except they don't take --<era> flags by instead relying on the top-level parent to determine the era.

The change involves duplicating the transaction command structure from legacy into era-based, parameterising then parameterising TransactionCmd with era.

Legacy has LegacyTransactionCmd as well as runLegacyTx*Cmd functions which just unpacks the AnyCardanoEra and forwards the parameterised era to runTx*Cmd in era-based.

It can be observed from the CLI golden file diffs that the legacy commands remain unchanged and that the transaction command group now exists in era-based under each era.

This PR touches only 9 Haskell files, but does inevitably involve changing 139 golden files.

This PR make sit possible (although it hasn't been done yet) for conway transaction build command to have these two command line options:

                                              [--vote-file FILE]
                                              [--constitution-file FILE]

Whilst having them absent for other eras.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@newhoggy newhoggy marked this pull request as ready for review August 22, 2023 11:36
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.

We'll merge this after #174

@newhoggy
Copy link
Contributor Author

newhoggy commented Aug 22, 2023

After #174 is good. I don't anticipate any large conflicts because that PR doesn't (yet) touch transactions.

@newhoggy newhoggy force-pushed the newhoggy/move-transaction-command-implementation-to-era-based branch from 8877dae to e1ef783 Compare August 26, 2023 03:37
@newhoggy newhoggy force-pushed the newhoggy/move-transaction-command-implementation-to-era-based branch from e1ef783 to bee9a2c Compare August 29, 2023 09:56
@newhoggy newhoggy closed this Sep 5, 2023
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.

3 participants