Fix serialization errors #29
Open
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
Used CIP-19 as reference
…trip property for sets
For some reason, CSL serializes `ScriptPubkey` as a `NativeScript` instead. `NativeScript` is a tagged record, of which the first variant (variant tag `0`) is of type `ScriptPubkey`. CDL represents a `ScriptPubkey` as a newtype wrapper over a Ed25519KeyHash, so it simply serializes the hash whenever the `ScriptPubKey` needs to be serialized. But CSL instead serializes a `ScriptPubKey` by first serializing the tag `0` followed by the actual hash (so, in reality, it is serializing the parent component `NativeScript`). The truth is that there is little reason to serialize a `ScriptPubKey` alone, because this type is only used as a variant of `NativeScript`. So this choice has no consequence when serializing/deserializing entire transactions (both CSL and CDL know how to leverage the serialize/deserialize methods of `ScriptPubKey` to serialize/deserialize a `NativeScript` correctly). But this difference in implementation does trigger errors in our suite, since we test each separate component, including each branch of every sum type. For the moment I just blacklisted this variant so it's not added to the test tree, but this behaviour might happen with other (if not all) tagged records that use variants with types that are never used alone. If that is the case, we might need to change how we serialize tagged records and its variants to match CSL's behaviour.
|
@itsfarseen With these final fixes we are finally passing both the serialization and the API suite. I think the PR is ready for review and eventual merging. |
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.
No description provided.