[WIP] Peras/10.5 Playground

cardano-node/src/Cardano/Node/TraceConstraints.hs

@@ -23,6 +23,7 @@ import           Ouroboros.Consensus.Ledger.SupportsMempool (ApplyTxErr, HasTxId
 import           Ouroboros.Consensus.Node.NetworkProtocolVersion
                    (HasNetworkProtocolVersion (BlockNodeToClientVersion, BlockNodeToNodeVersion))
 import           Ouroboros.Consensus.Node.Run (RunNode, SerialiseNodeToNodeConstraints)
+import           Ouroboros.Consensus.Peras.SelectView
 import           Ouroboros.Consensus.Protocol.Abstract (SelectView, ValidationErr)
 import           Ouroboros.Consensus.Shelley.Ledger.Mempool (GenTx, TxId)
 import           Ouroboros.Network.Block (Serialised)
@@ -51,7 +52,7 @@ type TraceConstraints blk =
     , ToObject (LedgerError blk)
     , ToObject (LedgerEvent blk)
     , ToObject (OtherHeaderEnvelopeError blk)
-    , ToObject (SelectView (BlockProtocol blk))
+    , ToObject (WeightedSelectView (BlockProtocol blk))
     , ToObject (ValidationErr (BlockProtocol blk))
     , ToObject (CannotForge blk)
     , ToObject (ForgeStateUpdateError blk)
@@ -66,7 +67,7 @@ type TraceConstraints blk =
     , LogFormatting (LedgerUpdate blk)
     , LogFormatting (LedgerWarning blk)
     , LogFormatting (OtherHeaderEnvelopeError blk)
-    , LogFormatting (SelectView (BlockProtocol blk))
+    , LogFormatting (WeightedSelectView (BlockProtocol blk))
     , LogFormatting (ValidationErr (BlockProtocol blk))
     , LogFormatting (CannotForge blk)
     , LogFormatting (ForgeStateUpdateError blk)

cardano-node/src/Cardano/Node/Tracing/Documentation.hs

@@ -117,6 +117,7 @@ import qualified Network.Mux as Mux
 import qualified Network.Socket as Socket
 import qualified Options.Applicative as Opt
 import           System.IO
+import qualified Ouroboros.Consensus.MiniProtocol.ObjectDiffusion.PerasCert as Consensus
 
 
 data TraceDocumentationCmd
@@ -371,6 +372,24 @@ docTracersFirstPhase condConfigFileName = do
     mempoolTrDoc <- documentTracer (mempoolTr ::
       Logging.Trace IO (TraceEventMempool blk))
 
+    perasCertDiffusionInboundTr <- mkCardanoTracer
+                trBase trForward mbTrEKG
+                ["Peras", "CertDiffusion", "Inbound"]
+    configureTracers configReflection trConfig [perasCertDiffusionInboundTr]
+    perasCertDiffusionInboundTrDoc <- documentTracer (perasCertDiffusionInboundTr ::
+      Logging.Trace IO (BlockFetch.TraceLabelPeer
+                  remotePeer
+                  (Consensus.TracePerasCertDiffusionInbound blk)))
+
+    perasCertDiffusionOutboundTracer <- mkCardanoTracer
+                trBase trForward mbTrEKG
+                ["Peras", "CertDiffusion", "Outbound"]
+    configureTracers configReflection trConfig [perasCertDiffusionOutboundTracer]
+    perasCertDiffusionOutboundTrDoc <- documentTracer (perasCertDiffusionOutboundTracer ::
+      Logging.Trace IO (BlockFetch.TraceLabelPeer
+                  remotePeer
+                  (Consensus.TracePerasCertDiffusionOutbound blk)))
+
     forgeTr <-  mkCardanoTracer
                 trBase trForward mbTrEKG
                 ["Forge", "Loop"]
@@ -778,6 +797,8 @@ docTracersFirstPhase condConfigFileName = do
             <> txOutboundTrDoc
             <> localTxSubmissionServerTrDoc
             <> mempoolTrDoc
+            <> perasCertDiffusionInboundTrDoc
+            <> perasCertDiffusionOutboundTrDoc
             <> forgeTrDoc
             <> forgeStatsTrDoc
             <> blockchainTimeTrDoc

cardano-node/src/Cardano/Node/Tracing/Era/Byron.hs

@@ -29,7 +29,7 @@ import           Ouroboros.Consensus.Byron.Ledger (ByronBlock (..),
 import           Ouroboros.Consensus.Byron.Ledger.Inspect (ByronLedgerUpdate (..),
                    ProtocolUpdate (..), UpdateState (..))
 import           Ouroboros.Consensus.Ledger.SupportsMempool (GenTx, txId)
-import           Ouroboros.Consensus.Protocol.PBFT (PBftSelectView (..))
+import           Ouroboros.Consensus.Protocol.PBFT (PBft, PBftTiebreakerView (..))
 import           Ouroboros.Consensus.Util.Condense (condense)
 import           Ouroboros.Network.Block (blockHash, blockNo, blockSlot)
 
@@ -213,10 +213,9 @@ instance LogFormatting ByronOtherHeaderEnvelopeError where
       , "slot" .= slot
       ]
 
-instance LogFormatting PBftSelectView where
-  forMachine _dtal (PBftSelectView blkNo isEBB) =
+instance LogFormatting PBftTiebreakerView where
+  forMachine _dtal (PBftTiebreakerView isEBB) =
     mconcat
       [ "kind" .= String "PBftSelectView"
-      , "blockNo" .= blkNo
       , "isEBB" .= fromIsEBB isEBB
       ]

cardano-node/src/Cardano/Node/Tracing/Era/HardFork.hs

@@ -19,14 +19,14 @@ import           Cardano.Logging
 import           Cardano.Slotting.Slot (EpochSize (..))
 import           Cardano.Tracing.OrphanInstances.HardFork ()
 import           Ouroboros.Consensus.Block (BlockProtocol, CannotForge, ForgeStateInfo,
-                   ForgeStateUpdateError)
+                   ForgeStateUpdateError, PerasWeight (..))
 import           Ouroboros.Consensus.BlockchainTime (getSlotLength)
 import           Ouroboros.Consensus.Cardano.Condense ()
 import           Ouroboros.Consensus.HardFork.Combinator
 import           Ouroboros.Consensus.HardFork.Combinator.AcrossEras (EraMismatch (..),
                    OneEraCannotForge (..), OneEraEnvelopeErr (..), OneEraForgeStateInfo (..),
                    OneEraForgeStateUpdateError (..), OneEraLedgerError (..),
-                   OneEraLedgerUpdate (..), OneEraLedgerWarning (..), OneEraSelectView (..),
+                   OneEraLedgerUpdate (..), OneEraLedgerWarning (..), OneEraTiebreakerView (..),
                    OneEraValidationErr (..), mkEraMismatch)
 import           Ouroboros.Consensus.HardFork.Combinator.Condense ()
 import           Ouroboros.Consensus.HardFork.History
@@ -36,7 +36,8 @@ import           Ouroboros.Consensus.HeaderValidation (OtherHeaderEnvelopeError)
 import           Ouroboros.Consensus.Ledger.Abstract (LedgerError)
 import           Ouroboros.Consensus.Ledger.Inspect (LedgerUpdate, LedgerWarning)
 import           Ouroboros.Consensus.Ledger.SupportsMempool (ApplyTxErr)
-import           Ouroboros.Consensus.Protocol.Abstract (SelectView, ValidationErr)
+import           Ouroboros.Consensus.Peras.SelectView
+import           Ouroboros.Consensus.Protocol.Abstract (TiebreakerView (..), ValidationErr)
 import           Ouroboros.Consensus.TypeFamilyWrappers
 import           Ouroboros.Consensus.Util.Condense (Condense (..))
 
@@ -349,19 +350,22 @@ instance LogFormatting (ForgeStateUpdateError blk) => LogFormatting (WrapForgeSt
 -- instances for HardForkSelectView
 --
 
-instance All (LogFormatting `Compose` WrapSelectView) xs => LogFormatting (HardForkSelectView xs) where
-    -- elide BlockNo as it is already contained in every per-era SelectView
-    -- TODO: use level DMinimal for a textual representation without the block number,
-    -- like this: `forMachine DMinimal . getHardForkSelectView`, and update the different SelectView instances
-    -- to not print the blockNr
-    forMachine dtal = forMachine dtal . dropBlockNo . getHardForkSelectView
+instance All (LogFormatting `Compose` WrapTiebreakerView) xs => LogFormatting (HardForkTiebreakerView xs) where
+    forMachine dtal = forMachine dtal . getHardForkTiebreakerView
 
-instance All (LogFormatting `Compose` WrapSelectView) xs => LogFormatting (OneEraSelectView xs) where
+instance LogFormatting (TiebreakerView protocol) => LogFormatting (WeightedSelectView protocol) where
+    forMachine dtal sv = mconcat
+        [ "length"  .= wsvLength sv
+        , "weightBoost" .= unPerasWeight (wsvWeightBoost sv)
+        , forMachine dtal (wsvTiebreaker sv)
+        ]
+
+instance All (LogFormatting `Compose` WrapTiebreakerView) xs => LogFormatting (OneEraTiebreakerView xs) where
     forMachine dtal =
           hcollapse
-        . hcmap (Proxy @(LogFormatting `Compose` WrapSelectView))
+        . hcmap (Proxy @(LogFormatting `Compose` WrapTiebreakerView))
                 (K . forMachine dtal)
-        . getOneEraSelectView
+        . getOneEraTiebreakerView
 
-instance LogFormatting (SelectView (BlockProtocol blk)) => LogFormatting (WrapSelectView blk) where
-    forMachine dtal = forMachine dtal . unwrapSelectView
+instance LogFormatting (TiebreakerView (BlockProtocol blk)) => LogFormatting (WrapTiebreakerView blk) where
+  forMachine dtal  = forMachine dtal  . unwrapTiebreakerView

cardano-node/src/Cardano/Node/Tracing/Era/Shelley.hs

@@ -59,7 +59,7 @@ import           Cardano.Tracing.OrphanInstances.Shelley ()
 import           Ouroboros.Consensus.Ledger.SupportsMempool (txId)
 import qualified Ouroboros.Consensus.Ledger.SupportsMempool as SupportsMempool
 import qualified Ouroboros.Consensus.Protocol.Praos as Praos
-import           Ouroboros.Consensus.Protocol.Praos.Common (PraosChainSelectView (..))
+import           Ouroboros.Consensus.Protocol.Praos.Common (PraosTiebreakerView (..))
 import           Ouroboros.Consensus.Protocol.TPraos (TPraosCannotForge (..))
 import           Ouroboros.Consensus.Shelley.Ledger hiding (TxId)
 import qualified Ouroboros.Consensus.Shelley.Ledger as Consensus
@@ -1292,20 +1292,18 @@ instance LogFormatting Praos.PraosEnvelopeError where
                 , "blockSize" .= blockSize
                 ]
 
-instance Ledger.Crypto c => LogFormatting (PraosChainSelectView c) where
-  forMachine _ PraosChainSelectView {
-      csvChainLength
-    , csvSlotNo
-    , csvIssuer
-    , csvIssueNo
-    , csvTieBreakVRF
+instance Ledger.Crypto c => LogFormatting (PraosTiebreakerView c) where
+  forMachine _ PraosTiebreakerView {
+      ptvSlotNo
+    , ptvIssuer
+    , ptvIssueNo
+    , ptvTieBreakVRF
     } =
-      mconcat [ "kind" .= String "PraosChainSelectView"
-              , "chainLength" .= csvChainLength
-              , "slotNo" .= csvSlotNo
-              , "issuerHash" .= hashKey csvIssuer
-              , "issueNo" .= csvIssueNo
-              , "tieBreakVRF" .= renderVRF csvTieBreakVRF
+      mconcat [ "kind" .= String "PraosTiebreakerView"
+              , "slotNo" .= ptvSlotNo
+              , "issuerHash" .= hashKey ptvIssuer
+              , "issueNo" .= ptvIssueNo
+              , "tieBreakVRF" .= renderVRF ptvTieBreakVRF
               ]
     where
       renderVRF = Text.decodeUtf8 . B16.encode . Crypto.getOutputVRFBytes

cardano-node/src/Cardano/Node/Tracing/Tracers.hs

@@ -316,6 +316,16 @@ mkConsensusTracers configReflection trBase trForward mbTrEKG _trDataPoint trConf
                 ["Mempool"]
     configureTracers configReflection trConfig [mempoolTr]
 
+    !perasCertDiffusionInboundTr <- mkCardanoTracer
+                trBase trForward mbTrEKG
+                ["Peras", "CertDiffusion", "Inbound"]
+    configureTracers configReflection trConfig [perasCertDiffusionInboundTr]
+
+    !perasCertDiffusionOutboundTr <- mkCardanoTracer
+                trBase trForward mbTrEKG
+                ["Peras", "CertDiffusion", "Outbound"]
+    configureTracers configReflection trConfig [perasCertDiffusionOutboundTr]
+
     !forgeTr    <- mkCardanoTracer
                 trBase trForward mbTrEKG
                 ["Forge", "Loop"]
@@ -408,6 +418,8 @@ mkConsensusTracers configReflection trBase trForward mbTrEKG _trDataPoint trConf
           traceWith consensusCsjTr
       , Consensus.dbfTracer = Tracer $
           traceWith consensusDbfTr
+      , Consensus.perasCertDiffusionInboundTracer = Tracer $ traceWith perasCertDiffusionInboundTr
+      , Consensus.perasCertDiffusionOutboundTracer = Tracer $ traceWith perasCertDiffusionOutboundTr
       }
 
 mkNodeToClientTracers :: forall blk.
@@ -492,6 +504,11 @@ mkNodeToNodeTracers configReflection trBase trForward mbTrEKG _trDataPoint trCon
                 ["TxSubmission", "Remote"]
     configureTracers configReflection trConfig [txSubmission2Tracer]
 
+    !perasCertDiffusionTracer <-  mkCardanoTracer
+                trBase trForward mbTrEKG
+                ["Peras", "CertDiffusion", "Remote"]
+    configureTracers configReflection trConfig [perasCertDiffusionTracer]
+
     !keepAliveTracer  <-  mkCardanoTracer
                 trBase trForward mbTrEKG
                 ["KeepAlive", "Remote"]
@@ -517,6 +534,8 @@ mkNodeToNodeTracers configReflection trBase trForward mbTrEKG _trDataPoint trCon
           traceWith keepAliveTracer
       , NtN.tPeerSharingTracer = Tracer $
           traceWith peerSharingTracer
+      , NtN.tPerasCertDiffusionTracer = Tracer $
+          traceWith perasCertDiffusionTracer
       }
 
 mkDiffusionTracers