Fix plutus double CBOR encoding bug #720
Open
+383
−37
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
Jimbo4350
changed the title
3 tasks
Jimbo4350
force-pushed
the
jordan/plutus-script-in-era
branch
3 times, most recently
from
36cb43d to
b2d6cf8
Compare
Jimbo4350
requested review from
dcoutts,
erikd,
newhoggy,
carbolymer,
smelc,
palas,
kevinhammond,
CarlosLopezDeLara and
disassembler
as code owners
carbolymer
reviewed
Jan 10, 2025
| Right (_, needToEncode) -> | ||
| case CBOR.deserialiseFromBytes CBOR.decodeBytes $ LBS.fromStrict needToEncode of | ||
| Left _ -> NotDoubleEncoded | ||
| Right (_, final) -> IsDoubleEncoded $ CBOR.toStrictByteString $ CBOR.encodeBytes final |
There was a problem hiding this comment.
Why is the script getting encoded here again? Are you expecting needToEncode to be different than CBOR.encodeBytes final
You're encoding final before returning. Why is that? Doesn't that make it double encoded again?
Comment on lines
468
to
474
| data IsDoubleEncoded | ||
| = -- | Original plutus script bytes | ||
| IsDoubleEncoded | ||
| Crypto.ByteString | ||
| | NotDoubleEncoded | ||
|
|
||
| isPlutusScriptDoubleEncoded :: LBS.ByteString -> IsDoubleEncoded |
There was a problem hiding this comment.
data IsDoubleEncoded
= -- | Original plutus script bytes
IsDoubleEncoded
Crypto.ByteString
| NotDoubleEncoded
isPlutusScriptDoubleEncoded :: LBS.ByteString -> IsDoubleEncodedI think those types are a little bit unwieldy. It forces the user to pattern match on the type to extract the bytes. I know it's only used internally in the tests and in the deserialisation instance, but I think it could be improved.
What do you think about something like that:
data IsPlutusScriptDoubleEncoded
= DoubleEncodedPlutusScript
| NotDoubleEncodedPlutusScript
normalisePlutusScriptCborEncoding
:: LBS.ByteString -- ^ original plutus script, possibly doubly encoded
-> (IsPlutusScriptDoubleEncoded, LBS.ByteString)
-- ^ singly encoded plutus script - if the original script was singly encoded,
-- returns original bytesthis way if the user is not interested in the encoding problem, they can ignore the first element of the tuple and just use the resulting bytes
There was a problem hiding this comment.
It forces the user to pattern match on the type to extract the bytes
I think we should get rid of the IsPlutusScriptDoubleEncoded type. I'll push some changes.
Jimbo4350
force-pushed
the
jordan/plutus-script-in-era
branch
3 times, most recently
from
8eaa6a5 to
f9fd11d
Compare
carbolymer
approved these changes
Jan 14, 2025
Jimbo4350
force-pushed
the
jordan/plutus-script-in-era
branch
3 times, most recently
from
b77b45f to
3b0a1ac
Compare
(Script lang) instance Implement removePlutusScriptDoubleEncoding function Utilize removePlutusScriptDoubleEncoding in the SerialiseAsCBOR (PlutusScript lang)
When decoding plutus script bytes to this type the validity of those bytes are checked and the decoder will fail if they are invalid This type is used in testing to double check we can still decode double encoded plutus script bytes and that the resulting bytes are valid
This function decodes a double encoded plutus script and checks if the bytes are valid. It essentially tests if the existing SerialiseAsCBOR instance for PlutusScript lang can decode a double encoded plutus script correctly.
scripts correctly
Jimbo4350
force-pushed
the
jordan/plutus-script-in-era
branch
from
3b0a1ac to
ed0a681
Compare
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.
Resolves: #685
Changelog
Context
Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.
How to trust this PR
Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.
Checklist