CIP-1694 API - Part 1

[newhoggy]

Description

CIP-1694

• Incorporate the ability to specify votes and governance actions in transactions
• Introduce TxVotes and TxGovernanceActions types
• This is still a work in progress

Changelog

- description: |
    - Conway related
    - Incorporate the ability to specify votes and governance actions in transactions
    - Introduce TxVotes and TxGovernanceActions types
  compatibility: breaking
  type: feature

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
  • roundtrip tests
  • integration tests
    See Runnings tests for more details
• Any changes are noted in the CHANGELOG.md for affected package
• 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
• Self-reviewed the diff

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

[newhoggy]

TODO

[newhoggy]

TODO

[newhoggy]

This is actually called "unregister" instead of "deregister" in the ledger. A future version of the ledger will call it "resign" instead. See https://input-output-rnd.slack.com/archives/C057E9CJTPH/p1685008671862099?thread_ts=1684866116.549819&cid=C057E9CJTPH

[newhoggy]

We are adding multiple types. Instead of adding a feature per introduced era sensitive type, we could use a single feature OnChainGovernanceFeature.

This has a number of advantages:

• We don't have to add lots of *SupportedInEra types as we go. Just the one OnChainGovernanceFeature will do.
• We get a free generator for FeatureValue OnChainGovernanceFeature a provided we have a generator for a. This will help us get our generators more uniform. We have not handle era-sensitive types consistently in the past.
• Our types can be simpler. For instance TxGovernanceAction and TxVote are regular product types, not GADTs.
• We don't have to plural types like TxGovernanceActions or TxVotes. Both of these were needed because it's the list that is era-sensitive. Using FeatureValue OnChainGovernanceFeature [a] we don't have to wrap lists anymore.