From 9fa3a7a3997244f906c92a45581cc577e84bb500 Mon Sep 17 00:00:00 2001
From: Pavol Rusnak <stick@gk2.sk>
Date: Sun, 22 Jul 2018 20:56:41 +0200
Subject: [PATCH] protob: more meta info in monero messages

---
 protob/graph.py              | 12 +++++++++++-
 protob/messages-monero.proto | 38 ++++++++++++++++++++++++------------
 2 files changed, 36 insertions(+), 14 deletions(-)

diff --git a/protob/graph.py b/protob/graph.py
index f6f5fab117..6b6543e0a7 100755
--- a/protob/graph.py
+++ b/protob/graph.py
@@ -7,6 +7,8 @@ from graphviz import Digraph
 class Message(object):
     def __init__(self, name, attrs):
         self.name = name
+        if len(attrs) == 0:
+            raise ValueError("message '%s' has no attributes" % name)
         t = attrs[0][0]
         if t in ["start", "end", "auxstart", "auxend", "embed", "ignore"]:
             self.typ = t
@@ -14,12 +16,18 @@ class Message(object):
         elif t == "next":
             self.typ = "normal"
             attrs = attrs
+        elif t == "wrap":
+            self.typ = "normal"
+            attrs = attrs
         else:
-            raise ValueError("wrong message type in message '%s'" % m.name)
+            raise ValueError("wrong message type in message '%s'" % name)
         self.next = []
+        self.wrap = []
         for a in attrs:
             if a[0] == "next":
                 self.next.append(a[1])
+            elif a[0] == "wrap":
+                self.wrap.append(a[1])
 
 
 def generate_messages(files):
@@ -55,6 +63,8 @@ def generate_graph(msgs, fn):
     for m in msgs.values():
         for n in m.next:
             dot.edge(m.name, n)
+        for n in m.wrap:
+            dot.edge(m.name, n)
     dot.render(fn)
 
 
diff --git a/protob/messages-monero.proto b/protob/messages-monero.proto
index 0ec70477bf..623a180c4d 100644
--- a/protob/messages-monero.proto
+++ b/protob/messages-monero.proto
@@ -94,6 +94,7 @@ message MoneroTransactionInitRequest {
 
 /**
  * Response: Response to transaction signing initialization.
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionInitAck {
     optional uint32 version = 1;
@@ -115,6 +116,7 @@ message MoneroTransactionSetInputRequest {
 
 /**
  * Response: Response to setting UTXO for signature. Contains sealed values needed for further protocol steps.
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionSetInputAck {
     optional bytes vini = 1;      // xmrtypes.TxinToKey
@@ -135,6 +137,7 @@ message MoneroTransactionInputsPermutationRequest {
 
 /**
  * Response: Response to setting permutation on key images
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionInputsPermutationAck {
 }
@@ -153,6 +156,7 @@ message MoneroTransactionInputViniRequest {
 
 /**
  * Response: Response to setting UTXO to the device
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionInputViniAck {
 }
@@ -168,6 +172,7 @@ message MoneroTransactionSetOutputRequest {
 
 /**
  * Response: Response to setting transaction destination. Contains sealed values needed for further protocol steps.
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionSetOutputAck {
     optional bytes tx_out = 1;  // xmrtypes.TxOut
@@ -186,6 +191,7 @@ message MoneroTransactionAllOutSetRequest {
 
 /**
  * Response: After all outputs are sent the initial RCT signature fields are sent.
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionAllOutSetAck {
     optional bytes extra = 1;
@@ -210,6 +216,7 @@ message MoneroTransactionMlsagDoneRequest {
 
 /**
  * Response: Contains full message hash needed for the signature
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionMlsagDoneAck {
     optional bytes full_message_hash = 1;
@@ -231,6 +238,7 @@ message MoneroTransactionSignInputRequest {
 
 /**
  * Response: Contains full MG signature of the UTXO + multisig data if applicable.
+ * @next MoneroTransactionSignRequest
  */
 message MoneroTransactionSignInputAck {
     optional bytes signature = 1;
@@ -257,15 +265,15 @@ message MoneroTransactionFinalAck {
 
 /**
  * Request: Wrapping request for transaction signature protocol.
- * @next MoneroTransactionInitAck
- * @next MoneroTransactionSetInputAck
- * @next MoneroTransactionInputsPermutationAck
- * @next MoneroTransactionInputViniAck
- * @next MoneroTransactionSetOutputAck
- * @next MoneroTransactionAllOutSetAck
- * @next MoneroTransactionMlsagDoneAck
- * @next MoneroTransactionSignInputAck
- * @next MoneroTransactionFinalAck
+ * @wrap MoneroTransactionInitRequest
+ * @wrap MoneroTransactionSetInputRequest
+ * @wrap MoneroTransactionInputsPermutationRequest
+ * @wrap MoneroTransactionInputViniRequest
+ * @wrap MoneroTransactionSetOutputRequest
+ * @wrap MoneroTransactionAllOutSetRequest
+ * @wrap MoneroTransactionMlsagDoneRequest
+ * @wrap MoneroTransactionSignInputRequest
+ * @wrap MoneroTransactionFinalRequest
  */
 message MoneroTransactionSignRequest {
     optional MoneroTransactionInitRequest init = 1;
@@ -281,6 +289,7 @@ message MoneroTransactionSignRequest {
 
 /**
  * Request: Sub request of MoneroKeyImageSync. Initializing key image sync.
+ * @start
  * @next MoneroKeyImageExportInitAck
  */
 message MoneroKeyImageExportInitRequest {
@@ -300,9 +309,9 @@ message MoneroKeyImageExportInitRequest {
 
 /**
  * Response: Response to key image sync initialization.
+ * @next MoneroKeyImageSyncRequest
  */
 message MoneroKeyImageExportInitAck {
-
 }
 
 /**
@@ -324,6 +333,7 @@ message MoneroKeyImageSyncStepRequest {
 
 /**
  * Response: Response to key image sync step. Contains encrypted exported key image.
+ * @next MoneroKeyImageSyncRequest
  */
 message MoneroKeyImageSyncStepAck {
     repeated MoneroExportedKeyImage kis = 1;
@@ -346,6 +356,7 @@ message MoneroKeyImageSyncFinalRequest {
 
 /**
  * Response: Response to key image sync step. Contains encryption keys for exported key images.
+ * @end
  */
 message MoneroKeyImageSyncFinalAck {
     optional bytes enc_key = 1;
@@ -353,9 +364,9 @@ message MoneroKeyImageSyncFinalAck {
 
 /**
  * Request: Wrapping request for key image sync protocol.
- * @next MoneroKeyImageExportInitAck
- * @next MoneroKeyImageSyncStepAck
- * @next MoneroKeyImageSyncFinalAck
+ * @wrap MoneroKeyImageExportInitRequest
+ * @wrap MoneroKeyImageSyncStepRequest
+ * @wrap MoneroKeyImageSyncFinalRequest
  */
 message MoneroKeyImageSyncRequest {
     optional MoneroKeyImageExportInitRequest init = 1;
@@ -365,6 +376,7 @@ message MoneroKeyImageSyncRequest {
 
 /**
  * Request: Universal Monero protocol implementation diagnosis request.
+ * @start
  * @next DebugMoneroDiagAck
  */
 message DebugMoneroDiagRequest {