Skip to content

Commit d454bad

Browse files
committed
Updated network-spec
1 parent 736ff01 commit d454bad

File tree

3 files changed

+54
-52
lines changed

3 files changed

+54
-52
lines changed

docs/network-spec/miniprotocols.tex

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ \subsection{Handshake}
194194
{Handshake Mini Protocol}
195195
{handshake-protocol}
196196
{This protocol is used for version negotiation.}
197-
{ouroboros-network-framework/src/Ouroboros/Network/Protocol/Handshake/Type.hs}
198-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-framework/Ouroboros-Network-Protocol-Handshake-Type.html\#t:Handshake}
197+
{ouroboros-network/framework/lib/Ouroboros/Network/Protocol/Handshake/Type.hs}
198+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/framework/Ouroboros-Network-Protocol-Handshake-Type.html\#t:Handshake}
199199

200200
\subsection{Node-to-node mini-protocols}
201201

@@ -205,36 +205,36 @@ \subsection{Node-to-node mini-protocols}
205205
{Chain Synchronisation Protocol}
206206
{chain-sync-protocol}
207207
{The protocol by which a downstream chain consumer follows an upstream chain producer.}
208-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ChainSync/Type.hs}
209-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-ChainSync-Type.html\#t:ChainSync}
208+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/ChainSync/Type.hs}
209+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-ChainSync-Type.html\#t:ChainSync}
210210

211211
\miniEntry
212212
{Block Fetch Protocol}
213213
{block-fetch-protocol}
214214
{The block fetching mechanism enables a node to download ranges of blocks.}
215-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/BlockFetch/Type.hs}
216-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-BlockFetch-Type.html\#t:BlockFetch}
215+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/BlockFetch/Type.hs}
216+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-BlockFetch-Type.html\#t:BlockFetch}
217217

218218
\miniEntry
219219
{Transaction Submission Protocol v2}
220220
{tx-submission-protocol2}
221221
{A Protocol for transmitting transactions between core nodes.}
222-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/TxSubmission2/Type.hs}
223-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-TxSubmission2-Type.html\#t:TxSubmission2}
222+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/TxSubmission2/Type.hs}
223+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-TxSubmission2-Type.html\#t:TxSubmission2}
224224

225225
\miniEntry
226226
{Keep Alive Protocol}
227227
{keep-alive-protocol}
228228
{A protocol for sending keep alive messages and doing round trip measurements}
229-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/KeepAlive/Type.hs}
230-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-KeepAlive-Type.html\#t:KeepAlive}
229+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/KeepAlive/Type.hs}
230+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-KeepAlive-Type.html\#t:KeepAlive}
231231

232232
\miniEntry
233233
{Peer Sharing Protocol}
234234
{peer-sharing-protocol}
235235
{A mini-protocol which allows to share peer addresses}
236-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/PeerSharing/Type.hs}
237-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-PeerSharing-Type.html\#t:PeerSharing}
236+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/PeerSharing/Type.hs}
237+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-PeerSharing-Type.html\#t:PeerSharing}
238238

239239
\subsection{Node-to-client mini-protocols}
240240

@@ -246,29 +246,29 @@ \subsection{Node-to-client mini-protocols}
246246
{Chain Synchronisation Protocol}
247247
{chain-sync-protocol}
248248
{The protocol by which a downstream chain consumer follows an upstream chain producer.}
249-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ChainSync/Type.hs}
250-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-ChainSync-Type.html\#t:ChainSync}
249+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/ChainSync/Type.hs}
250+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-ChainSync-Type.html\#t:ChainSync}
251251

252252
\miniEntry
253253
{Local State Query Mini Protocol}
254254
{local-state-query-protocol}
255255
{Protocol used by local clients to query ledger state}
256-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/LocalStateQuery/Type.hs}
257-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalStateQuery-Type.html\#t:LocalStateQuery}
256+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/LocalStateQuery/Type.hs}
257+
{https://ouroboros-network.cardano.intersectmbo.org/cardano-diffusion/protocols/Cardano-Network-Protocol-LocalStateQuery-Type.html\#t:LocalStateQuery}
258258

259259
\miniEntry
260260
{Local Tx Submission Mini Protocol}
261261
{local-tx-submission-protocol}
262262
{Protocol used by local clients to submit transactions}
263-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/LocalTxSubmission/Type.hs}
264-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalTxSubmission-Type.html\#t:LocalTxSubmission}
263+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/LocalTxSubmission/Type.hs}
264+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-LocalTxSubmission-Type.html\#t:LocalTxSubmission}
265265

266266
\miniEntry
267267
{Local Tx Monitor Mini Protocol}
268268
{local-tx-monitor-protocol}
269269
{Protocol used by local clients to monitor transactions}
270-
{ouroboros-network-protocols/src/Ouroboros/Network/Protocol/LocalTxMonitor/Type.hs}
271-
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalTxMonitor-Type.html\#t:LocalTxMonitor}
270+
{ouroboros-network/protocols/lib/Ouroboros/Network/Protocol/LocalTxMonitor/Type.hs}
271+
{https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/protocols/Ouroboros-Network-Protocol-LocalTxMonitor-Type.html\#t:LocalTxMonitor}
272272

273273

274274
\section{CBOR and CDDL}
@@ -414,8 +414,8 @@ \subsubsection{State machine}
414414
\end{table}
415415

416416
\section{Handshake mini-protocol}
417-
\protocolhaddockref{Ouroboros.Network.Protocol.Handshake.Type}{ouroboros-network-framework/Ouroboros-Network-Protocol-Handshake-Type\#t:Handshake}\\
418-
\codechaddockref{Ouroboros.Network.Protocol.Handshake.Codec}{ouroboros-network-framework/Ouroboros-Network-Protocol-Handshake-Codec\#v:codecHandshake}\\
417+
\protocolhaddockref{Ouroboros.Network.Protocol.Handshake.Type}{ouroboros-network/framework/Ouroboros-Network-Protocol-Handshake-Type.html\#t:Handshake}\\
418+
\codechaddockref{Ouroboros.Network.Protocol.Handshake.Codec}{ouroboros-network/framework/Ouroboros-Network-Protocol-Handshake-Codec.html\#v:codecHandshake}\\
419419
\hyperref[table:node-to-node-protocol-numbers]{\textit{node-to-node mini-protocol number}}: \texttt{0}\\
420420
\hyperref[table:node-to-client-protocol-numbers]{\textit{node-to-client mini-protocol number}}: \texttt{0}\\
421421
\hyperref[sec:nodetoclientcddl]{node-to-client handshake CDDL spec}
@@ -536,6 +536,7 @@ \subsection{Timeouts per state}
536536
\end{table}
537537

538538
\subsection{Node-to-node handshake}
539+
\codechaddockref{Cardano.Network.NodeToNode}{cardano-diffusion/Cardano-Network-NodeToNode.html\#v:nodeToNodeHandshakeCodec}\\
539540

540541
The node-to-node handshake instantiates version data\footnote{To be precise, in
541542
ouroboros-network, we instantiate version data to CBOR terms and do encoding
@@ -605,6 +606,7 @@ \subsubsection{Timeouts per state}
605606
\end{table}
606607

607608
\subsection{Node-to-client handshake}
609+
\codechaddockref{Cardano.Network.NodeToClient}{cardano-diffusion/Cardano-Network-NodeToClient.html\#v:nodeToClientHandshakeCodec}\\
608610

609611
The node-to-node handshake instantiates version data to a record which consists
610612
of
@@ -770,15 +772,15 @@ \subsection{CDDL encoding specification}\label{handshake-cddl}
770772
messages. First, one is used by the node-to-node protocol, and the other is used by the
771773
node-to-client protocol.
772774
\subsubsection{Node-to-node handshake mini-protocol}
773-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/handshake-node-to-node-v14.cddl}
775+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/handshake-node-to-node-v14.cddl}
774776

775777
\subsubsection{Node-to-client handshake mini-protocol}
776-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/handshake-node-to-client.cddl}
778+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/handshake-node-to-client.cddl}
777779

778780
\section{Chain-Sync mini-protocol}
779781
\label{chain-sync-protocol}
780-
\protocolhaddockref{Ouroboros.Network.Protocol.ChainSync.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-ChainSync-Type\#t:ChainSync}\\
781-
\codechaddockref{Ouroboros.Network.Protocol.ChainSync.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-ChainSync-Codec\#v:codecChainSync}\\
782+
\protocolhaddockref{Ouroboros.Network.Protocol.ChainSync.Type}{ouroboros-network/protocols/Ouroboros-Network-Protocol-ChainSync-Type.html\#t:ChainSync}\\
783+
\codechaddockref{Ouroboros.Network.Protocol.ChainSync.Codec}{ouroboros-network/protocols/Ouroboros-Network-Protocol-ChainSync-Codec.html\#v:codecChainSync}\\
782784
\hyperref[table:node-to-node-protocol-numbers]{\textit{node-to-node mini-protocol number}}: \texttt{2}\\
783785
\hyperref[table:node-to-client-protocol-numbers]{\textit{node-to-client mini-protocol number}}: \texttt{5}\\
784786

@@ -1109,13 +1111,13 @@ \subsection{Implementation of the Chain Consumer}
11091111
\end{description}
11101112

11111113
\subsection{CDDL encoding specification}
1112-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/chain-sync.cddl}
1114+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/chain-sync.cddl}
11131115
See appendix \ref{cddl-common} for common definitions.
11141116

11151117
\section{Block-Fetch mini-protocol}
11161118
\label{block-fetch-protocol}
1117-
\protocolhaddockref{Ouroboros.Network.Protocol.BlockFetch.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-BlockFetch-Type\#t:BlockFetch}\\
1118-
\codechaddockref{Ouroboros.Network.Protocol.BlockFetch.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-BlockFetch-Codec\#v:codecBlockFetch}\\
1119+
\protocolhaddockref{Ouroboros.Network.Protocol.BlockFetch.Type}{ouroboros-network/protocols/Ouroboros-Network-Protocol-BlockFetch-Type.html\#t:BlockFetch}\\
1120+
\codechaddockref{Ouroboros.Network.Protocol.BlockFetch.Codec}{ouroboros-network/protocols/Ouroboros-Network-Protocol-BlockFetch-Codec.html\#v:codecBlockFetch}\\
11191121
\hyperref[table:node-to-node-protocol-numbers]{\textit{node-to-node mini-protocol number}}: \texttt{3}\\
11201122

11211123
\renewcommand{\StIdle}{\state{StIdle}}
@@ -1238,12 +1240,12 @@ \subsection{Timeouts per state}
12381240
\end{table}
12391241

12401242
\subsection{CDDL encoding specification}
1241-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/block-fetch.cddl}
1243+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/block-fetch.cddl}
12421244
See appendix \ref{cddl-common} for common definitions.
12431245

12441246
\section{Tx-Submission mini-protocol}
1245-
\protocolhaddockref{Ouroboros.Network.Protocol.TxSubmission2.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-TxSubmission2-Type\#t:TxSubmission2}\\
1246-
\codechaddockref{Ouroboros.Network.Protocol.TxSubmission2.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-TxSubmission2-Codec\#v:codecTxSubmission2}\\
1247+
\protocolhaddockref{Ouroboros.Network.Protocol.TxSubmission2.Type}{ouroboros-network/protocols/Ouroboros-Network-Protocol-TxSubmission2-Type.html\#t:TxSubmission2}\\
1248+
\codechaddockref{Ouroboros.Network.Protocol.TxSubmission2.Codec}{ouroboros-network/protocols/Ouroboros-Network-Protocol-TxSubmission2-Codec.html\#v:codecTxSubmission2}\\
12471249
\hyperref[table:node-to-node-protocol-numbers]{\textit{node-to-node mini-protocol number}}: \texttt{4}\\
12481250
\label{tx-submission-protocol}
12491251
\label{tx-submission-protocol2}
@@ -1469,7 +1471,7 @@ \subsection{Timeouts per state}
14691471
\end{table}
14701472

14711473
\subsection{CDDL encoding specification}\label{tx-submission2-cddl}
1472-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/tx-submission2.cddl}
1474+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/tx-submission2.cddl}
14731475

14741476
\subsection{Client and Server Implementation}
14751477
The protocol has two design goals: It must diffuse transactions with high efficiency
@@ -1514,8 +1516,8 @@ \subsection{Client and Server Implementation}
15141516
A blocking request, on the other side, waits until at least one transaction is available.
15151517

15161518
\section{Keep Alive Mini Protocol}
1517-
\protocolhaddockref{Ouroboros.Network.Protocol.KeepAlive.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-KeepAlive-Type\#t:KeepAlive}\\
1518-
\codechaddockref{Ouroboros.Network.Protocol.KeepAlive.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-KeepAlive-Codec\#v:codecKeepAlive\_v2}\\
1519+
\protocolhaddockref{Ouroboros.Network.Protocol.KeepAlive.Type}{ouroboros-network/protocols/Ouroboros-Network-Protocol-KeepAlive-Type.html\#t:KeepAlive}\\
1520+
\codechaddockref{Ouroboros.Network.Protocol.KeepAlive.Codec}{ouroboros-network/protocols/Ouroboros-Network-Protocol-KeepAlive-Codec.html\#v:codecKeepAlive\_v2}\\
15191521
\hyperref[table:node-to-node-protocol-numbers]{\textit{node-to-node mini-protocol number}}: \texttt{8}\\
15201522

15211523
\label{keep-alive-protocol}
@@ -1604,11 +1606,11 @@ \subsection{Timeouts per state}
16041606
\end{table}
16051607

16061608
\subsection{CDDL encoding specification}
1607-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/keep-alive.cddl}
1609+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/keep-alive.cddl}
16081610

16091611
\section{Peer Sharing mini-protocol}
1610-
\protocolhaddockref{Ouroboros.Network.Protocol.PeerSharing.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-PeerSharing-Type\#t:PeerSharing}\\
1611-
\codechaddockref{Ouroboros.Network.Protocol.PeerSharing.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-PeerSharing-Codec\#v:codecPeerSharing}\\
1612+
\protocolhaddockref{Ouroboros.Network.Protocol.PeerSharing.Type}{ouroboros-network/protocols/Ouroboros-Network-Protocol-PeerSharing-Type.html\#t:PeerSharing}\\
1613+
\codechaddockref{Ouroboros.Network.Protocol.PeerSharing.Codec}{ouroboros-network/protocols/Ouroboros-Network-Protocol-PeerSharing-Codec.html\#v:codecPeerSharing}\\
16121614
\hyperref[table:node-to-node-protocol-numbers]{\textit{node-to-node mini-protocol number}}: \texttt{10}\\
16131615
\label{peer-sharing-protocol}
16141616
\subsection{Description}
@@ -1766,11 +1768,11 @@ \subsection{Server Implementation Details}
17661768
\texttt{PeerSelectionState} with this function via a \texttt{TVar}.
17671769

17681770
\subsection{CDDL encoding specification ($\geq 14$)}\label{peersharing-cddl}
1769-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/peer-sharing-v14.cddl}
1771+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/peer-sharing-v14.cddl}
17701772

17711773
\section{Local Tx-Submission mini-protocol}
1772-
\protocolhaddockref{Ouroboros.Network.Protocol.LocalTxSubmission.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalTxSubmission-Type\#t:LocalTxSubmission}\\
1773-
\codechaddockref{Ouroboros.Network.Protocol.LocalTxSubmission.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalTxSubmission-Codec\#v:codecLocalTxSubmission}\\
1774+
\protocolhaddockref{Ouroboros.Network.Protocol.LocalTxSubmission.Type}{ouroboros-network/protocols/Ouroboros-Network-Protocol-LocalTxSubmission-Type.html\#t:LocalTxSubmission}\\
1775+
\codechaddockref{Ouroboros.Network.Protocol.LocalTxSubmission.Codec}{ouroboros-network/protocols/Ouroboros-Network-Protocol-LocalTxSubmission-Codec.html\#v:codecLocalTxSubmission}\\
17741776
\hyperref[table:node-to-client-protocol-numbers]{\textit{node-to-client mini-protocol number}}: \texttt{6}\\
17751777
\label{local-tx-submission-protocol}
17761778
\subsection{Description}
@@ -1842,13 +1844,13 @@ \subsection{Timeouts per state}
18421844
No timeouts.
18431845

18441846
\subsection{CDDL encoding specification}
1845-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/local-tx-submission.cddl}
1847+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/local-tx-submission.cddl}
18461848
See appendix \ref{cddl-common} for common definitions.
18471849

18481850
\section{Local State Query mini-protocol}
18491851
\label{local-state-query-protocol}
1850-
\protocolhaddockref{Ouroboros.Network.Protocol.LocalStateQuery.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalStateQuery-Type\#t:LocalStateQuery}\\
1851-
\codechaddockref{Ouroboros.Network.Protocol.LocalStateQuery.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalStateQuery-Codec\#v:codecLocalStateQuery}\\
1852+
\protocolhaddockref{Cardano.Network.Protocol.LocalStateQuery.Type}{cardano-diffusion/protocols/Cardano-Network-Protocol-LocalStateQuery-Type.html\#t:LocalStateQuery}\\
1853+
\codechaddockref{Cardano.Network.Protocol.LocalStateQuery.Codec}{cardano-diffusion/protocols/Cardano-Network-Protocol-LocalStateQuery-Codec.html\#v:codecLocalStateQuery}\\
18521854
\hyperref[table:node-to-client-protocol-numbers]{\textit{node-to-client mini-protocol number}}: \texttt{7}\\
18531855
\newcommand{\StAcquiring}{\state{Acquiring}}
18541856
\newcommand{\StAcquired}{\state{Acquired}}
@@ -1976,12 +1978,12 @@ \subsection{Timeouts per state}
19761978
No timeouts.
19771979

19781980
\subsection{CDDL encoding specification}
1979-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/local-state-query.cddl}
1981+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/local-state-query.cddl}
19801982
See appendix \ref{cddl-common} for common definitions.
19811983

19821984
\section{Local Tx-Monitor mini-protocol}
1983-
\protocolhaddockref{Ouroboros.Network.Protocol.LocalTxMonitor.Type}{ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalTxMonitor-Type\#t:LocalTxMonitor}\\
1984-
\codechaddockref{Ouroboros.Network.Protocol.LocalTxMonitor.Codec}{ouroboros-network-protocols/Ouroboros-Network-Protocol-LocalTxMonitor-Codec\#v:codecLocalTxMonitor}\\
1985+
\protocolhaddockref{Cardano.Network.Protocol.LocalTxMonitor.Type}{cardano-diffusion/protocols/Cardano-Network-Protocol-LocalTxMonitor-Type.html\#t:LocalTxMonitor}\\
1986+
\codechaddockref{Cardano.Network.Protocol.LocalTxMonitor.Codec}{cardano-diffusion/protocols/Cardano-Network-Protocol-LocalTxMonitor-Codec.html\#v:codecLocalTxMonitor}\\
19851987
\hyperref[table:node-to-client-protocol-numbers]{\textit{node-to-client mini-protocol number}}: \texttt{9}\\
19861988
\label{local-tx-monitor-protocol}
19871989
\newcommand{\MsgAwaitAcquire}{\msg{MsgAwaitAcquire}}
@@ -2130,7 +2132,7 @@ \subsection{Timeouts per state}
21302132
No timeouts.
21312133

21322134
\subsection{CDDL encoding specification}
2133-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/local-tx-monitor.cddl}
2135+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/local-tx-monitor.cddl}
21342136
See appendix \ref{cddl-common} for common definitions.
21352137

21362138
\section{Pipelining of Mini Protocols}

docs/network-spec/network-spec.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@
211211

212212
\chapter{Common CDDL definitions}
213213
\label{cddl-common}
214-
\lstinputlisting[style=cddl]{../../ouroboros-network-protocols/cddl/specs/network.base.cddl}
214+
\lstinputlisting[style=cddl]{../../cardano-diffusion/protocols/cddl/specs/network.base.cddl}
215215

216216
\chapter{Historical protocol versions}
217217
\label{historical-protocol-versions}

nix/network-docs.nix

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ inputs: final: prev: {
1414
buildPhase =
1515
let
1616
src = ../.;
17-
cddl-specs = ../ouroboros-network-protocols/cddl/specs;
17+
cddl-specs = ../cardano-diffusion/protocols/cddl/specs;
1818
in
1919
''
2020
for d in network-design network-spec; do
@@ -24,8 +24,8 @@ inputs: final: prev: {
2424
2525
touch docs/network-spec/.isRelease
2626
27-
mkdir -p ouroboros-network-protocols/cddl/specs
28-
cp ${cddl-specs}/*.cddl ouroboros-network-protocols/cddl/specs
27+
mkdir -p cardano-diffusion/protocols/cddl/specs
28+
cp ${cddl-specs}/*.cddl cardano-diffusion/protocols/cddl/specs
2929
3030
mkdir -p $out
3131

0 commit comments

Comments
 (0)