Adding support for a generalized Utxow rule #2176
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
JaredCorduan
reviewed
Mar 9, 2021
shelley/chain-and-ledger/executable-spec/src/Cardano/Ledger/AuxiliaryData.hs
Outdated
Show resolved
Hide resolved
alonzo/impl/test/lib/Test/Cardano/Ledger/Alonzo/Serialisation/Generators.hs
Outdated
Show resolved
Hide resolved
shelley/chain-and-ledger/executable-spec/src/Shelley/Spec/Ledger/Address.hs
Outdated
Show resolved
Hide resolved
JaredCorduan
approved these changes
Mar 13, 2021
There was a problem hiding this comment.
Thank you @TimSheard , this is a ton of great work! There are a few comments that can be removed, but besides that this looks really good!
wrote a generic version. Replaced Shelley, Allegra, and Mary with this generic version. Next step write an Alonzo version that calls the generice version, and then does Alonzo stuff.
Still to do: Add a new type for errors in the Utxow rule. Make some Hasfield instances
The Alonzo Script datatype had a stub for Plutus scripts. Imported the right type and completed Show, Eq, PrettyA, ToCBOR and FromCBOR instances. The Uxtow rule is now complete. Introduced AlonzoPredFail the UtxoW PredicateFailure type for the Alonzo era. It embeds the PredicateFaliure type from the Shelley and ShelleyMa Eras. Wrote Show, Eq, ToCBOR and FromCBOR instances. The Utxow rule now uses this type for Failures. Generalized the ShelleyStyleWitness to lift from one PredicateFailure type to another so it could be reused in any ERa that uses this style of PredicateFailure Embedding.
The missing HasField instances needed for the Uxtow rule were added. Generalized the ValidateScript class to have the method 'scriptPrefixTag' and made a default method for 'hashScript' Had to move a few things in the Shelley Era to make the dependencies work out.
The ValidateScript class was moved from Shelley.Tx(..) to Cardano.Ledger.Era(..). The field had it type changed to scriptPrefixTag :: Core.Script era -> BS.ByteString this way the tag written can be chosen dynamically by looking at the script. Filled in the mising CBOR instances fo the PredicateFailure for Utxos rule. Wrote roundtrip serilaization tests for all of the new PredicateFailure type. BIG TODO, some Alonzo era PredicateFailure type encode Scripts, and Scripts do not have FromCBOR instances (they have FromCBOR(Annotator Script) instance.) We will have to address this.
nc6
approved these changes
Mar 15, 2021
| ) => | ||
| AlonzoPredFail era -> | ||
| Encode 'Open (AlonzoPredFail era) | ||
| encodePredFail (Embed x) = Sum Embed 0 !> E toCBOR x |
There was a problem hiding this comment.
It might be better to flatten the encoding here, since we'd like the implementation detail (that we're wrapping) to be hidden. Shouldn't need any extra boilerplate, I think?
There was a problem hiding this comment.
This is a bit involved, since the CBOR instances for (UtxowPredicateFailure era) in the Shelley era (ie. the type of x in (Embed x)) is written by hand, so making it inline would require going back and changing that. For a future time? Even if we flattened in CBOR, it remains unflattened (and visible) in the type AlonzoPredFail.
alonzo/impl/test/test/Test/Cardano/Ledger/Alonzo/Serialisation/Tripping.hs
Show resolved
Hide resolved
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.
First steps in writing a generalized Utxow rule that can be applied to the Alonzo Era.
Generalized wisFromWitnessSet (now witsFromTxWitnesses), scriptsNeeded, validateAuxiliaryData, validateScript, verifiedWits. Made a new WellFormed constraint
HasField "adHash" (Core.TxBody era) (StrictMaybe (AuxiliaryDataHash (Crypto era)))"