[WIP] Add ObjectDiffusion miniprotocol for Peras cert and vote diffusion #5181
+946
−5
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
coot
reviewed
Aug 7, 2025
Comment on lines
+75
to
+81
| pattern ReflOutboundAgency :: ReflRelativeAgency ClientAgency (r :: RelativeAgency) (r :: RelativeAgency) | ||
| pattern ReflOutboundAgency = ReflClientAgency | ||
| type ReflOutboundAgency = 'ReflClientAgency | ||
|
|
||
| pattern ReflInboundAgency :: ReflRelativeAgency ServerAgency (r :: RelativeAgency) (r :: RelativeAgency) | ||
| pattern ReflInboundAgency = ReflServerAgency | ||
| type ReflInboundAgency = 'ReflServerAgency |
There was a problem hiding this comment.
One should not need these patterns at all so I wouldn't include them.
Comment on lines
+153
to
+157
| data StBlockingStyle where | ||
| -- | In this sub-state the reply need not be prompt. There is no timeout. | ||
| StBlocking :: StBlockingStyle | ||
| -- | In this state the peer must reply. There is a timeout. | ||
| StNonBlocking :: StBlockingStyle |
There was a problem hiding this comment.
Why not import this type from Ouroboros.Network.Protocol.TxSubmission2.Type? It can also be exported here.
Comment on lines
+125
to
+127
| type SingObjectDiffusion :: | ||
| ObjectDiffusion initAgency objectId object -> | ||
| Type |
There was a problem hiding this comment.
Please check our style guide in ./docs/StyleGuide.md
Suggested change
| type SingObjectDiffusion :: | |
| ObjectDiffusion initAgency objectId object -> | |
| Type | |
| type SingObjectDiffusion | |
| :: ObjectDiffusion initAgency objectId object | |
| -> Type |
Comment on lines
+88
to
+89
| type ObjectDiffusion :: Agency -> Type -> Type -> Type | ||
| data ObjectDiffusion initAgency objectId object where |
There was a problem hiding this comment.
Suggested change
| type ObjectDiffusion :: Agency -> Type -> Type -> Type | |
| data ObjectDiffusion initAgency objectId object where | |
| type ObjectDiffusion :: Type -> Type -> Type | |
| data ObjectDiffusion objectId object where |
The initAgency doesn't seem to be used anywhere in the protocol definitions, can it be dropped?
| -- of these constraints is also a protocol error. The constraints are intended | ||
| -- to ensure that implementations are able to work in bounded space. | ||
| instance Protocol (ObjectDiffusion initAgency objectId object) where | ||
| -- \| The messages in the object diffusion protocol. |
There was a problem hiding this comment.
Suggested change
| -- \| The messages in the object diffusion protocol. | |
| -- | The messages in the object diffusion protocol. |
I know haddock doesn't support it yet, but it also doesn't complain about it, doesn't it?
Comment on lines
+322
to
+324
| deriving instance Eq (SingBlockingStyle b) | ||
|
|
||
| deriving instance Show (SingBlockingStyle b) |
There was a problem hiding this comment.
Suggested change
| deriving instance Eq (SingBlockingStyle b) | |
| deriving instance Show (SingBlockingStyle b) | |
| deriving instance Eq (SingBlockingStyle b) | |
| deriving instance Show (SingBlockingStyle b) |
Comment on lines
+326
to
+330
| type instance Sing = SingBlockingStyle | ||
|
|
||
| instance SingI StBlocking where sing = SingBlocking | ||
|
|
||
| instance SingI StNonBlocking where sing = SingNonBlocking |
There was a problem hiding this comment.
Suggested change
| type instance Sing = SingBlockingStyle | |
| instance SingI StBlocking where sing = SingBlocking | |
| instance SingI StNonBlocking where sing = SingNonBlocking | |
| type instance Sing = SingBlockingStyle | |
| instance SingI StBlocking where sing = SingBlocking | |
| instance SingI StNonBlocking where sing = SingNonBlocking |
Comment on lines
+343
to
+349
| deriving instance (Eq a) => Eq (BlockingReplyList blocking a) | ||
|
|
||
| deriving instance (Show a) => Show (BlockingReplyList blocking a) | ||
|
|
||
| deriving instance Foldable (BlockingReplyList blocking) | ||
|
|
||
| instance (NFData a) => NFData (BlockingReplyList blocking a) where |
There was a problem hiding this comment.
Suggested change
| deriving instance (Eq a) => Eq (BlockingReplyList blocking a) | |
| deriving instance (Show a) => Show (BlockingReplyList blocking a) | |
| deriving instance Foldable (BlockingReplyList blocking) | |
| instance (NFData a) => NFData (BlockingReplyList blocking a) where | |
| deriving instance (Eq a) => Eq (BlockingReplyList blocking a) | |
| deriving instance (Show a) => Show (BlockingReplyList blocking a) | |
| deriving instance Foldable (BlockingReplyList blocking) | |
| instance (NFData a) => NFData (BlockingReplyList blocking a) where |
coot
reviewed
Aug 7, 2025
| -- object identifiers. | ||
| data Message (ObjectDiffusion initAgency objectId object) from to where | ||
| MsgInit :: | ||
| Message (ObjectDiffusion initAgency objectId object) StInit StIdle |
There was a problem hiding this comment.
Or did you mean:
MsgInit :: Message (ObjectDiffusion initAgency objectId object) initAgency StIdle
|
@coot Thanks for the comments! Note though that this is early stage code (ie this is a draft PR), not yet intended for review by the Network team 😅 |
…either the inbound or outbound peer
amesgen
force-pushed
the
peras/object-diffusion
branch
from
5f76136 to
bca44ca
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.
Closes tweag/cardano-peras#57. IntersectMBO/ouroboros-consensus#1615 depends on this PR.
Defines a new miniprotocol, ObjectDiffusion, highly inspired from TxSubmission.
It supports two modes (
initAgencytype parameter), one where the inbound peer initiates the communication, and the other where the outbound peer does.For that, it relies on the
InboundAgencyandOutboundAgencytypes (see ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ObjectDiffusion/Type.hs). So far, they are aliases for hardcodedServerAgencyandClientAgency. It doesn't bother us too much for now, as client/server roles are purely arbitrary and symmetrical from atyped-protocolsPoV, but apparently for production they carry a particular meaning, so we should find a way to fix that.On a side note, this PR also adds a new miniprotocol parameter (and a corresponding default value) for the number of certs to ack for PerasCert diffusion (based on ObjectDiffusion).