Adapt packages to use Protocol type class #2498
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jhartzell42
force-pushed
the
os/open-protocol-pr
branch
3 times, most recently
from
0d28c0e
to
068e593
Compare
|
Per @nc6 , we don't have to support GHC 8.6, and those are the only tests that are failing, so we can go ahead with this. |
jhartzell42
changed the title
jhartzell42
requested review from
DavidEichmann,
dcoutts,
erikd,
Jimbo4350 and
newhoggy
as code owners
jhartzell42
changed the title
jhartzell42
force-pushed
the
os/open-protocol-pr
branch
from
e17fad5
to
2de0102
Compare
jhartzell42
changed the title
jhartzell42
force-pushed
the
os/open-protocol-pr
branch
7 times, most recently
from
4c9f837
to
9b57f62
Compare
jhartzell42
force-pushed
the
os/open-protocol-pr
branch
2 times, most recently
from
a9013ff
to
d59426d
Compare
|
bors merge |
|
bors r- |
|
Canceled. |
|
Sorry I didn't see the comment at first. Thanks! |
2 tasks
iohk-bors bot
added a commit
that referenced
this pull request
Apr 19, 2021
2547: API refactoring to move scripts into the txbody r=Jimbo4350 a=dcoutts REMOVE: Merge #2498 after this PR has been merged This is the first step in a refactoring that we will need for Alonzo support. The refactoring will put the scripts within the tx body at the sites where they are used. For Shelley era scripts we can do it either way round, but for Alonzo it makes much more sense to place the script at the use sites. So to break the Alonzo changes into steps we do the refactoring for the existing Shelley-based eras first. The ideas here have been co-authored with Jordan Millar and most of the code changes here appeared first in his Alonzo branch. - [x] Update the API tests for these API changes - [x] Update the CLI for these API changes There are a couple breaking changes: - You must specify auxiliary scripts with `--auxiliary-script-file` instead of `--script-file` - Scripts witnessing txins, certificates, withdrawals and minting must be paired with the thing they are witnessing. E.g: ``` --certificate-file $certfile --certificate-script-file $scriptfile --tx-out $txout --minting-script-file $scriptfile --withdrawal $withdrawal --withdrawal-script-file $scriptfile --tx-in $txin --txin-script-file $scriptfile ``` - Scripts are no longer specified at the tx signing stage. They are specified at the txbody stage. Co-authored-by: Duncan Coutts <duncan@well-typed.com> Co-authored-by: Jordan Millar <jordan.millar@iohk.io>
The way ouroboros-network exposes Protocol information to clients such as cardano-api and cardano-node was changed from a Protocol GADT, which lived in ouroboros-network, to a type class that lives in this repo; similarly for ProtocolClient. These changes make the universe of Protocols that can be run more open than before. cardano-api, cardano-cli, cardano-node, and cardano-node-chairman are here modified to use this type class as much as possible. At some point they do have to close their assumptions on which modes are supported, but this is pushed up to the top-level as much as possible.
jhartzell42
force-pushed
the
os/open-protocol-pr
branch
from
d59426d
to
7402029
Compare
|
bors r+ |
|
Build succeeded: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR depends on IntersectMBO/ouroboros-network#2978
In that PR, the
Protocoltype that the cardano-node packages use is removed. This is so that ouroboros-network does not need to enumerate all the consensus modes it implements. The majority of changes in this PR are in reaction to that, creating a type class to replace it.We found that it would take a significant increase in code complexity to remove the explicit enumeration of supported consensus modes in two places:
For that purpose, we have written the GADT
BlockTypewhich provides the little bit of type discovery these places need.In addition, we have removed the
Enuminstance forAnyCardanoEra. The motivation is that we anticipate the inclusion of experimental eras and consensus modes in the code base which cannot reasonably be said to be enumerable among the mainnet eras. This instance does not appear to be used anywhere. If it needs to be preserved then we will need an answer on how to handle eras we don't expect to be part of mainnet (at least when they are first implemented).