[Peras 4] Add ObjectDiffusion and `PerasCert` diffusion (instance of ObjectDiffusion) #1679

tbagrel1 · 2025-09-12T13:08:57Z

This pull request introduces support for the ObjectDiffusion mini-protocol, required for Peras (for certificates and votes diffusion). It also plugs the PerasCertDiffusion (instance of ObjectDiffusion) mini-protocol in the networking layer.

This PR depends on an updated version of ouroboros-network, see IntersectMBO/ouroboros-network#5202 and https://github.com/IntersectMBO/ouroboros-network/tree/peras-staging/pr-5202-v2

Peras ObjectDiffusion Mini-protocol:

Added modules Ouroboros.Consensus.MiniProtocol.ObjectDiffusion{.Inbound,.Outbound} with implementations of the ObjectDiffusion protocol (quite similar/inspired from TX-submission, except that client = inbound, server = outbound)
Added module Ouroboros.Consensus.MiniProtocol.ObjectDiffusion.ObjectPool.API defining ObjectPool{Reader,Writer} interfaces, through which ObjectDiffusion accesses/stores the objects to send/that have been received.
Added modules Ouroboros.Consensus.MiniProtocol.ObjectDiffusion.PerasCert and Ouroboros.Consensus.MiniProtocol.ObjectDiffusion.ObjectPool.PerasCert containing definitions specific to PerasCert diffusion through the ObjectDiffusion mini-protocol
Modifies Ouroboros.Consensus.Node.Serialisation to add CBOR serialisation (SerialiseNodeToNode) for Point blk, Tip blk, and PerasCert blk
Modifies Ouroboros.Consensus{.Node,.Node.Tracer,.Network.NodeToNode} to wire-in PerasCertDiffusion similarly to other mini-protocols (e.g. TX-submission)

Tests and benchmarks

Added module Test.Consensus.MiniProtocol.ObjectDiffusion.Smoke with smoke test for the general ObjectDiffusion mini-protocol (using mock objects)
Added module Test.Consensus.MiniProtocol.ObjectDiffusion.PerasCert.Smoke with smoke test specific to PerasCert diffusion through ObjectDiffusion
Updates Test.ThreadNet.Network in unstable-diffusion-testlib accordingly to the changes made in Ouroboros.Consensus.Network.NodeToNode

Network Protocol Version Updates:

Depends on ouroboros-network rev https://github.com/IntersectMBO/ouroboros-network/tree/peras-staging/pr-5202-v2 through source-repository-package directive
Added support in ouroboros-consensus for NodeToNodeV_16

...onsensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/Inbound.hs

agustinmista

LGTM, minor comments only.

...sensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Network/NodeToNode.hs

cabal.project

tbagrel1 · 2025-10-22T07:58:37Z

@amesgen TX-submission V1 had initially hidden a "ensure no thunk" logic in the continueWithState__ helpers. I tried to keep it in this new version (thinking it was important) with checkState st & go___ lines, but:

I'm not sure exactly why we need that here
I'm not sure my attempt at replicating it is working as intended
Could you please confirm whether or not we should keep/modify that?

tbagrel1 · 2025-10-22T08:26:42Z

I think I have adressed all comments from @agustinmista and @amesgen,I guess we are ready for a client review now?

...onsensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/Inbound.hs

Also use defaultMiniProtocolParameters instead of hardcoded value in unstable-diffusion-testlib to account for newly defined parameters in the new `ouroboros-network` version. Also integrate `NodeToNodeV_16`. Co-authored-by: Agustin Mista <[email protected]> Co-authored-by: Alexander Esgen <[email protected]> Co-authored-by: Georgy Lukyanov <[email protected]> Co-authored-by: Thomas BAGREL <[email protected]> Co-authored-by: Nicolas BACQUEY <[email protected]> Co-authored-by: Nicolas "Niols" Jeannerod <[email protected]>

…eader,Writer}` API Co-authored-by: Agustin Mista <[email protected]> Co-authored-by: Alexander Esgen <[email protected]> Co-authored-by: Georgy Lukyanov <[email protected]> Co-authored-by: Thomas BAGREL <[email protected]> Co-authored-by: Nicolas BACQUEY <[email protected]> Co-authored-by: Nicolas "Niols" Jeannerod <[email protected]>

Co-authored-by: Agustin Mista <[email protected]> Co-authored-by: Alexander Esgen <[email protected]> Co-authored-by: Georgy Lukyanov <[email protected]> Co-authored-by: Thomas BAGREL <[email protected]> Co-authored-by: Nicolas BACQUEY <[email protected]> Co-authored-by: Nicolas "Niols" Jeannerod <[email protected]>

…fusion Co-authored-by: Agustin Mista <[email protected]> Co-authored-by: Alexander Esgen <[email protected]> Co-authored-by: Georgy Lukyanov <[email protected]> Co-authored-by: Thomas BAGREL <[email protected]> Co-authored-by: Nicolas BACQUEY <[email protected]> Co-authored-by: Nicolas "Niols" Jeannerod <[email protected]>

Co-authored-by: Agustin Mista <[email protected]> Co-authored-by: Alexander Esgen <[email protected]> Co-authored-by: Georgy Lukyanov <[email protected]> Co-authored-by: Thomas BAGREL <[email protected]> Co-authored-by: Nicolas BACQUEY <[email protected]> Co-authored-by: Nicolas "Niols" Jeannerod <[email protected]>

tbagrel1 · 2025-11-10T09:12:50Z

Hello everyone,
This PR is now ready for review! Thanks in advance for your time :)

dnadales · 2025-11-14T17:20:34Z

...sensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Network/NodeToNode.hs

-          (decodePoint (decodeRawHash p))
-          (encodeTip (encodeRawHash p))
-          (decodeTip (decodeRawHash p))
+          enc


Maybe these should be renamed after the thing they encode/decode, as it used to be (eg encPoint)

dnadales · 2025-11-14T18:17:49Z

ouroboros-consensus/changelog.d/20250918_104810_thomas.bagrel_object_diffusion.md

+
+-->
+
+### Breaking


We should use the same verb tense.

dnadales · 2025-11-14T18:51:02Z

...s/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/ObjectPool/API.hs

+  -- ^ Get the list of objects available in the pool with a ticketNo greater
+  -- than the specified one. The number of returned objects is capped by the
+  -- given Word64. Only the IDs and ticketNos of the objects are directly
+  -- accessible; each actual object must be loaded through a monadic action.


Would it make sense to explain why does the object has to be retrieved via a monadic action? And also, does the interface guarantees the object to always be available?

I guess this is why we also have opwHasObject, but in any case it might be worth clarifying this.

dnadales · 2025-11-14T18:51:14Z

...s/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/ObjectPool/API.hs

+  -- ^ Get the list of objects available in the pool with a ticketNo greater
+  -- than the specified one. The number of returned objects is capped by the
+  -- given Word64. Only the IDs and ticketNos of the objects are directly
+  -- accessible; each actual object must be loaded through a monadic action.


Suggested change

-- accessible; each actual object must be loaded through a monadic action.

-- accessible; each actual object must be retrieved through a monadic action.

dnadales · 2025-11-14T19:24:40Z

...ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/ObjectPool/PerasCert.hs

+          take (fromIntegral limit) $
+            [ (ticketNo, getPerasCertRound cert, pure (getPerasCert cert))
+            | (ticketNo, cert) <-
+                Map.toAscList $


Aren't we worried about the performance of this map to list conversion? How often do we expect it to be performed?

dnadales · 2025-11-14T19:54:23Z

...consensus/test/consensus-test/Test/Consensus/MiniProtocol/ObjectDiffusion/PerasCert/Smoke.hs

+    frequency
+      [ (1, pure $ Point Origin)
+      ,
+        ( 4


Do we expect the Genesis point to be picked in 20% of the cases in practice?

dnadales · 2025-11-14T20:08:18Z

ouroboros-consensus/test/consensus-test/Test/Consensus/MiniProtocol/ObjectDiffusion/Smoke.hs

+              ( (\(ticketNo, smokeObject) -> (ticketNo, getSmokeObjectId smokeObject, pure smokeObject))
+                  <$> zip [(0 :: Int) ..] poolContent
+              )
+    , oprZeroTicketNo = -1 -- objectPoolObjectIdsAfter uses strict comparison, and first ticketNo is 0.


This is a bit confusing. Probably users won't see this -1, but still. I wonder if it's possible to either start numbering tickets at 1, or use a different name for oprZeroTicketNo. Also it's probably not a big thing, but we're losing half of the space by using -1 as the number before the first ticket number.

dnadales · 2025-11-14T20:11:40Z

ouroboros-consensus/test/consensus-test/Test/Consensus/MiniProtocol/ObjectDiffusion/Smoke.hs

+            threadDelay 1000 -- give a head start to the other threads
+            atomically $ writeTVar controlMessage Terminate
+            threadDelay 1000 -- wait for the other threads to finish
+          waitAnyThread [outboundThread, inboundThread, controlMessageThread]


Will this waiting condition give time to all the threads to send/receive all the objects?

dnadales · 2025-11-14T20:12:04Z

ouroboros-consensus/test/consensus-test/Test/Consensus/MiniProtocol/ObjectDiffusion/Smoke.hs

+          controlMessageThread <- forkLinkedThread reg "ObjectDiffusion Control thread" $ do
+            threadDelay 1000 -- give a head start to the other threads
+            atomically $ writeTVar controlMessage Terminate
+            threadDelay 1000 -- wait for the other threads to finish


Any rationale on why we choose 1k here?

dnadales · 2025-11-14T20:15:37Z

ouroboros-consensus/test/storage-test/Test/Ouroboros/Storage/PerasCertDB/StateMachine.hs

+    action ->
+      model.open && case action of
+        CloseDB -> True
+        -- Do not add equivocating certificates.


Don't we actually want to test the addition of equivocated certificates?

tbagrel1 changed the base branch from main to main-pr/weighted-chain-selec September 12, 2025 13:09

tbagrel1 changed the title ~~Add ObjectDiffusion and PerasCert diffusion (instace of ObjectDiffusion)~~ Add ObjectDiffusion and PerasCert diffusion (instance of ObjectDiffusion) Sep 12, 2025

tbagrel1 added the peras label Sep 12, 2025

tbagrel1 changed the title ~~Add ObjectDiffusion and PerasCert diffusion (instance of ObjectDiffusion)~~ [Peras #4] Add ObjectDiffusion and PerasCert diffusion (instance of ObjectDiffusion) Sep 12, 2025

tbagrel1 force-pushed the main-pr/object-diffusion branch from 80d3c69 to f88b3ae Compare September 12, 2025 14:32

tbagrel1 force-pushed the main-pr/weighted-chain-selec branch 6 times, most recently from dca0315 to d7c3c64 Compare September 18, 2025 08:47

tbagrel1 force-pushed the main-pr/object-diffusion branch 3 times, most recently from 37a9f85 to 222f4be Compare September 18, 2025 09:25

tbagrel1 force-pushed the main-pr/weighted-chain-selec branch from d7c3c64 to f1158c0 Compare September 19, 2025 07:58

tbagrel1 force-pushed the main-pr/object-diffusion branch from 222f4be to d47c331 Compare September 19, 2025 08:04

tbagrel1 changed the title ~~[Peras #4] Add ObjectDiffusion and PerasCert diffusion (instance of ObjectDiffusion)~~ [Peras 4] Add ObjectDiffusion and PerasCert diffusion (instance of ObjectDiffusion) Sep 25, 2025

tbagrel1 force-pushed the main-pr/object-diffusion branch from d47c331 to 918307c Compare September 26, 2025 13:47

amesgen force-pushed the main-pr/weighted-chain-selec branch from f1158c0 to 90131b2 Compare October 2, 2025 19:01

amesgen force-pushed the main-pr/weighted-chain-selec branch 4 times, most recently from 8aba6fc to 8b987f6 Compare October 10, 2025 16:57

amesgen force-pushed the main-pr/weighted-chain-selec branch from 328b50a to 1018f6e Compare October 20, 2025 15:25

tbagrel1 force-pushed the main-pr/object-diffusion branch 2 times, most recently from f8083cc to 8a88eb7 Compare October 20, 2025 17:24

agustinmista reviewed Oct 21, 2025

View reviewed changes

...onsensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/Inbound.hs Outdated Show resolved Hide resolved

agustinmista reviewed Oct 21, 2025

View reviewed changes

...onsensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/Inbound.hs Outdated Show resolved Hide resolved

agustinmista reviewed Oct 21, 2025

View reviewed changes

...onsensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ObjectDiffusion/Inbound.hs Show resolved Hide resolved

agustinmista reviewed Oct 21, 2025

View reviewed changes

Base automatically changed from main-pr/weighted-chain-selec to main October 21, 2025 10:03

amesgen reviewed Oct 21, 2025

View reviewed changes

...sensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Network/NodeToNode.hs Show resolved Hide resolved

cabal.project Show resolved Hide resolved

tbagrel1 force-pushed the main-pr/object-diffusion branch from 8a88eb7 to d9c165b Compare October 22, 2025 08:23

amesgen reviewed Oct 22, 2025

View reviewed changes

tbagrel1 force-pushed the main-pr/object-diffusion branch from d9c165b to bef68f5 Compare October 22, 2025 11:20

amesgen mentioned this pull request Oct 24, 2025

[Peras 3] Make ChainDB aware of PerasCertDB, and switch to weighted chain selection #1678

Merged

tbagrel1 mentioned this pull request Nov 7, 2025

Initial mini-protocols for Peras IntersectMBO/ouroboros-network#5202

Open

7 tasks

tbagrel1 force-pushed the main-pr/object-diffusion branch from bef68f5 to 0c3b30f Compare November 7, 2025 13:42

tbagrel1 mentioned this pull request Nov 7, 2025

Adapt to improved ObjectDiffusion inbound interface #1719

Closed

tbagrel1 force-pushed the main-pr/object-diffusion branch from 0c3b30f to 2e7a690 Compare November 7, 2025 17:58

tbagrel1 and others added 8 commits November 7, 2025 19:06

More refined precondition on PerasCertDB StateModel tests

1feeddb

tbagrel1 force-pushed the main-pr/object-diffusion branch from 2e7a690 to 09669d1 Compare November 7, 2025 18:06

tbagrel1 marked this pull request as ready for review November 10, 2025 09:11

tbagrel1 requested review from bladyjoker, dnadales, fraser-iohk, geo2a, jasagredo and nfrisby as code owners November 10, 2025 09:11

dnadales reviewed Nov 14, 2025

View reviewed changes

	-- accessible; each actual object must be loaded through a monadic action.
	-- accessible; each actual object must be retrieved through a monadic action.


		-->

		### Breaking

[Peras 4] Add ObjectDiffusion and PerasCert diffusion (instance of ObjectDiffusion) #1679

Are you sure you want to change the base?

[Peras 4] Add ObjectDiffusion and PerasCert diffusion (instance of ObjectDiffusion) #1679

Conversation

tbagrel1 commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Peras ObjectDiffusion Mini-protocol:

Tests and benchmarks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

agustinmista left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tbagrel1 commented Oct 22, 2025

Uh oh!

tbagrel1 commented Oct 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tbagrel1 commented Nov 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

[Peras 4] Add ObjectDiffusion and `PerasCert` diffusion (instance of ObjectDiffusion) #1679

[Peras 4] Add ObjectDiffusion and `PerasCert` diffusion (instance of ObjectDiffusion) #1679

tbagrel1 commented Sep 12, 2025 •

edited

Loading