From e5b8ba148dd19b6b7faf3d9869c92ba14d0e5286 Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Thu, 21 Oct 2021 07:09:21 +0200 Subject: [PATCH 1/3] network-spec: document all messages of LocalStateQuery * MsgRelease * MsgDone --- docs/network-spec/miniprotocols.tex | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/network-spec/miniprotocols.tex b/docs/network-spec/miniprotocols.tex index be61b71e04f..e1b74edc51b 100644 --- a/docs/network-spec/miniprotocols.tex +++ b/docs/network-spec/miniprotocols.tex @@ -1292,13 +1292,17 @@ \subsection{State machine} \node[state, myblue, right of=Idle] (Acquiring) {\StAcquiring}; \node[state, mygreen, right of=Acquiring] (Acquired) {\StAcquired}; \node[state, myblue, right of=Acquired] (Querying) {\StQuerying}; + \node[state, below of=Idle] (Done) {\StDone}; \draw (Idle) edge[bend left=45] node{\MsgAcquire} (Acquiring); \draw (Acquiring) edge[bend left=45] node{\MsgFailure} (Idle); \draw (Acquiring) edge[bend left=45] node{\MsgAcquired} (Acquired); \draw (Acquired) edge[bend left=45] node{\MsgReAcquire} (Acquiring); \draw (Acquired) edge[bend left=45] node{\MsgQuery} (Querying); + \draw (Acquired.275) + to[in=-65, out=-115] node{\MsgRelease} (Idle.260); \draw (Querying) edge[bend left=45] node{\MsgResult} (Acquired); + \draw (Idle) edge node[left]{\MsgDone} (Done) \end{tikzpicture} \caption{State machine of the Local State Query mini-protocol.} \end{figure} @@ -1313,9 +1317,11 @@ \subsection{State machine} \StIdle & \MsgAcquire & $Maybe\ point$ & \StAcquiring \\\hline \StAcquiring & \MsgFailure & $AcquireFailure$ & \StIdle \\\hline \StAcquiring & \MsgAcquired & & \StAcquired \\\hline - \StAcquired & \MsgReAcquire & $Maybe\ point$ & \StAcquiring \\\hline \StAcquired & \MsgQuery & $query$ & \StQuerying \\\hline \StQuerying & \MsgResult & $result$ & \StAcquired \\\hline + \StAcquired & \MsgReAcquire & $Maybe\ point$ & \StAcquiring \\\hline + \StAcquired & \MsgRelease & & \StIdle \\\hline + \StIdle & \MsgDone & & \StDone \\\hline \end{tabular} \caption{Local State Query mini-protocol messages.} \end{figure} From 90c6f35ce4c304ef62b52a2a8cb0cde4684d6b4e Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Thu, 21 Oct 2021 07:30:24 +0200 Subject: [PATCH 2/3] network-spec: fixed a misspelled command --- docs/network-spec/miniprotocols.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/network-spec/miniprotocols.tex b/docs/network-spec/miniprotocols.tex index e1b74edc51b..914c5b42a34 100644 --- a/docs/network-spec/miniprotocols.tex +++ b/docs/network-spec/miniprotocols.tex @@ -518,7 +518,7 @@ \subsection{Client and Server Implementation} \item if either of them accepts a version by returning \texttt{Accept}, the other one must accept the same value, i.e. in this case \texttt{acceptable proposed received == acceptable received proposed} - \item if either of them refuses to accept (returns \textt{Refuse reason}) + \item if either of them refuses to accept (returns \texttt{Refuse reason}) the other one shall return \texttt{Refuse} as well. \end{itemize} \end{description} From 4b6378f8540aadcddfbcc1009642305ddf0e623c Mon Sep 17 00:00:00 2001 From: Marcin Szamotulski Date: Thu, 21 Oct 2021 07:40:22 +0200 Subject: [PATCH 3/3] network-spec: removed reference to a non existing section --- docs/network-spec/miniprotocols.tex | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/network-spec/miniprotocols.tex b/docs/network-spec/miniprotocols.tex index 914c5b42a34..932f9be4f27 100644 --- a/docs/network-spec/miniprotocols.tex +++ b/docs/network-spec/miniprotocols.tex @@ -372,8 +372,6 @@ \subsection{Description} and the protocol parameters that are used by the client and the server. It is run exactly once when a new connection is initialised and consists of a single request from the client and a single reply from the server. -Section \ref{peer-setup-section} explains the live cycle of a connection and the role of -the handshake mini protocol in more detail. The handshake mini protocol is a generic protocol that can negotiate any kind protocol parameters. It only assumes that protocol parameters can be encoded to, and decoded from, CBOR terms.