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

Delete TxVotes and VotingEntry and use VotingProcedures instead #209

Merged
merged 3 commits into from
Aug 25, 2023
Merged

Delete TxVotes and VotingEntry and use VotingProcedures instead #209

merged 3 commits into from
Aug 25, 2023

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Aug 24, 2023 •
edited
Loading

Changelog

- description: |
    Delete `TxVotes` and `VotingEntry` and use `VotingProcedures` instead
# 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

VotingProcedures is able to replace both VotingEntry and TxVotes.

It is a newtype wrapper around the ledger types so creating generators for it is very easy.

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 24, 2023 14:03
@newhoggy newhoggy changed the title Delete TxVotes and use VotingProcedures instead Delete TxVotes and VotingEntry and use VotingProcedures instead Aug 24, 2023
@newhoggy newhoggy force-pushed the newhoggy/delete-TxVotes branch from d28c9bf to 0db72f0 Compare August 24, 2023 14:08
@newhoggy newhoggy changed the base branch from main to cardano-api-8.2.x August 24, 2023 14:19
@newhoggy newhoggy requested a review from a team as a code owner August 24, 2023 14:19
@newhoggy newhoggy changed the base branch from cardano-api-8.2.x to main August 24, 2023 14:19
@newhoggy newhoggy force-pushed the newhoggy/delete-TxVotes branch 4 times, most recently from 2397806 to 301173e Compare August 25, 2023 03:07
@newhoggy newhoggy force-pushed the newhoggy/delete-TxVotes branch from d63e139 to 7b5d25e Compare August 25, 2023 14:05
@newhoggy newhoggy enabled auto-merge August 25, 2023 14:42
@newhoggy newhoggy added this pull request to the merge queue Aug 25, 2023
Jimbo4350
Jimbo4350 approved these changes Aug 25, 2023
View reviewed changes
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! Minor comments

cardano-api/internal/Cardano/Api/Governance/Actions/VotingEntry.hs
Copy link
Contributor

Choose a reason for hiding this comment

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

🎉

cardano-api/internal/Cardano/Api/TxBody.hs
, txGovernanceActions = fromLedgerProposalProcedure sbe body
, txVotes = fromLedgerTxVotes sbe body
, txGovernanceActions = fromLedgerProposalProcedure sbe body
, txVotingProcedures = fromLedgerVotingProcedures sbe body
Copy link
Contributor

Choose a reason for hiding this comment

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

Some strange spacing here

cardano-api/internal/Cardano/Api/TxBody.hs
@@ -3430,7 +3427,7 @@ getByronTxBodyContent (Annotated Byron.UnsafeTx{txInputs, txOutputs} _) =
, txMintValue = TxMintNone
, txScriptValidity = TxScriptValidityNone
, txGovernanceActions = TxGovernanceActionsNone
, txVotes = TxVotesNone
, txVotingProcedures = Nothing
Copy link
Contributor

Choose a reason for hiding this comment

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

Spacing

cardano-api/internal/Cardano/Api/TxBody.hs
$ Just
$ Featured w
$ VotingProcedures
$ body ^. L.votingProceduresTxBodyL)
Copy link
Contributor

Choose a reason for hiding this comment

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

🎉

Merged via the queue into main with commit 1bc13d5 Aug 25, 2023
@newhoggy newhoggy deleted the newhoggy/delete-TxVotes branch August 25, 2023 16:15
newhoggy pushed a commit that referenced this pull request Mar 11, 2024
@carbolymer
Merge pull request #209 from input-output-hk/jordan/bump-chap-for-car…
509004a 
…dano-api

Update to `cardano-api-8.19`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carbolymer carbolymer carbolymer approved these changes

@Jimbo4350 Jimbo4350 Jimbo4350 approved these changes

@dcoutts dcoutts Awaiting requested review from dcoutts

@erikd erikd Awaiting requested review from erikd

@disassembler disassembler Awaiting requested review from disassembler

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@newhoggy @carbolymer @Jimbo4350