AnnotatedCodec #74
Merged
AnnotatedCodec #74
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces AnnotatedCodec to the typed-protocols library, which enables retaining the original bytes received from the network during message decoding. This is particularly useful for cryptographic applications where the exact received bytes must be preserved for signature verification.
Key changes include:
- Generalization of the
Codectype toCodecFwith type aliases for backward compatibility - Creation of a new
codec-propertieslibrary for testing utilities - Addition of comprehensive QuickCheck properties for the new annotated codec functionality
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| typed-protocols/typed-protocols.cabal | Version bump to 1.1.0.0 and addition of new codec-properties library |
| typed-protocols/src/Network/TypedProtocol/Codec.hs | Core implementation of CodecF generalization and AnnotatedCodec type |
| typed-protocols/properties/Network/TypedProtocol/Codec/Properties.hs | New comprehensive QuickCheck properties for codec testing |
| typed-protocols/examples/Network/TypedProtocol/ReqResp/Codec.hs | Example implementation of annotated codec for ReqResp protocol |
| typed-protocols/test/Network/TypedProtocol/ReqResp/Tests.hs | Test integration for the new annotated codec properties |
7 tasks
coot
force-pushed
the
coot/annotated-codec
branch
3 times, most recently
from
a959766 to
fcb0a53
Compare
crocodile-dentist
approved these changes
Aug 4, 2025
crocodile-dentist
left a comment
crocodile-dentist
left a comment
There was a problem hiding this comment.
lgtm - with some minor comments.
Moved `prop_codec` properties to a sublibrary. All properties return QuickCheck's `Property` type.
coot
force-pushed
the
coot/annotated-codec
branch
from
fcb0a53 to
ee05d80
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.
This PR provides
AnnotatedCodectotyped-protocolswhich allows to retainbytes received from the network. It also includes new quickcheck properties
for the new codec as well as an example implementation for
ReqRespmini-protocol.