New messages for pull rumors

docs/protocol.md

@@ -20,6 +20,7 @@
     - [Sending a heartbeat message to servers](#sending-a-heartbeat-message-to-servers)
     - [Retrieving messages from server using ids ](#retrieving-messages-from-server-using-ids-)
     - [Spreading a Rumor](#spreading-a-rumor)
+    - [Sharing rumor state](#sharing-rumor-state)
   - [Answer](#answer)
     - [RPC answer error](#rpc-answer-error)
 - [Mid-level (message) communication](#mid-level-message-communication)
@@ -191,6 +192,9 @@ and its arguments (`params`).
         },
         {
             "$ref": "method/rumor.json"
+        },
+        {
+            "$ref": "method/rumor_state.json"
         }
     ],
 
@@ -211,6 +215,8 @@ Here are the different methods that can be called:
 * Publish
 * Heartbeat
 * GetMessagesById
+* Rumor
+* RumorState
 
 ### Greeting a server
 🧭 **RPC Message** > **Query** > **Greet Server**
@@ -227,15 +233,15 @@ Notification
 ```json5
 // ../protocol/examples/query/greet_server/greet_server.json
 
-{
-  "jsonrpc": "2.0",
-  "method": "greet_server",
-  "params": {
-    "public_key": "J9fBzJV70Jk5c-i3277Uq4CmeL4t53WDfUghaK0HpeM=",
-    "client_address": "wss://popdemo.dedis.ch:9000/client",
-    "server_address": "wss://popdemo.dedis.ch:9001/server"
-  }
-}
+{
+  "jsonrpc": "2.0",
+  "method": "greet_server",
+  "params": {
+    "public_key": "J9fBzJV70Jk5c-i3277Uq4CmeL4t53WDfUghaK0HpeM=",
+    "client_address": "wss://popdemo.dedis.ch:9000/client",
+    "server_address": "wss://popdemo.dedis.ch:9001/server"
+  }
+}
 
 ```
 
@@ -1062,6 +1068,82 @@ RPC
 ```
 </details>
 
+### Sharing rumor state
+
+🧭 **RPC Message** > **Query** > **Rumor state**
+
+The purpose of this RPC is to share to other servers a snapshot of the last rumor ID received from each neighbor. 
+
+Upon reception of this state, the receiver will send back missing rumors to the querier, which will then propagate new rumors accross the network.
+
+```json5
+// ../protocol/examples/query/rumor_state/rumor_state.json
+
+{
+    "jsonrpc": "2.0",
+    "id": 4,
+    "method": "rumor_state",
+    "params": {
+        "rumor_state": {
+            "J9fBzJV70Jk5c-i3277Uq4CmeL4t53WDfUghaK0HpeM=": 3,
+            "RZOPi59Iy5gkpS2mkpfQJNl44HKc2jVbF0iTGm0RvfU=": 5,
+            "CfG2ByLhtLJH--T2BL9hZ6eGm11tpkE-5KuvysSCY0I=": 1,
+            "r8cG9HyJ1FGBke_5IblCdH19mvy39MvLFSArVmY3FpY=": 10
+        }
+    }
+}
+
+```
+
+<details>
+<summary>
+💡 See the full specification
+</summary>
+
+```json5
+// ../protocol/query/method/object/rumor_state.json
+
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://raw.githubusercontent.com/dedis/popstellar/master/protocol/query/method/object/rumor_state.json",
+    "title": "State of received rumors",
+    "description": "An object containing key-value pairs where each key is a server public key and each value is the last rumor_id it received from this server",
+    "type": "object",
+    "additionalProperties": false,
+    "patternProperties": {
+        "^(?:[a-zA-Z0-9-_]{4})*(?:|[a-zA-Z0-9-_]{3}=|[a-zA-Z0-9+-_]{2}==|[a-zA-Z0-9+-_]===)$": {
+            "description": "[Integer] ID of the rumor",
+            "type": "integer",
+            "minimum": 0
+        }
+    }
+}
+
+```
+
+```json5
+// ../protocol/query/method/object/rumor_state.json
+
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://raw.githubusercontent.com/dedis/popstellar/master/protocol/query/method/object/rumor_state.json",
+    "title": "State of received rumors",
+    "description": "An object containing key-value pairs where each key is a server public key and each value is the last rumor_id it received from this server",
+    "type": "object",
+    "additionalProperties": false,
+    "patternProperties": {
+        "^(?:[a-zA-Z0-9-_]{4})*(?:|[a-zA-Z0-9-_]{3}=|[a-zA-Z0-9+-_]{2}==|[a-zA-Z0-9+-_]===)$": {
+            "description": "[Integer] ID of the rumor",
+            "type": "integer",
+            "minimum": 0
+        }
+    }
+}
+
+```
+
+</details>
+
 ## Answer
 
 🧭 **RPC Message** > **Answer**

protocol/examples/query/rumor_state/rumor_state.json

@@ -0,0 +1,13 @@
+{
+    "jsonrpc": "2.0",
+    "id": 4,
+    "method": "rumor_state",
+    "params": {
+        "rumor_state": {
+            "J9fBzJV70Jk5c-i3277Uq4CmeL4t53WDfUghaK0HpeM=": 3,
+            "RZOPi59Iy5gkpS2mkpfQJNl44HKc2jVbF0iTGm0RvfU=": 5,
+            "CfG2ByLhtLJH--T2BL9hZ6eGm11tpkE-5KuvysSCY0I=": 1,
+            "r8cG9HyJ1FGBke_5IblCdH19mvy39MvLFSArVmY3FpY=": 10
+        }
+    }
+}

protocol/examples/query/rumor_state/wrong_rumor_state_additionnal_params.json

@@ -0,0 +1,14 @@
+{
+    "jsonrpc": "2.0",
+    "id": 4,
+    "method": "rumor_state",
+    "params": {
+        "rumor_state": {
+            "J9fBzJV70Jk5c-i3277Uq4CmeL4t53WDfUghaK0HpeM=": 3,
+            "RZOPi59Iy5gkpS2mkpfQJNl44HKc2jVbF0iTGm0RvfU=": 5,
+            "CfG2ByLhtLJH--T2BL9hZ6eGm11tpkE-5KuvysSCY0I=": 1,
+            "r8cG9HyJ1FGBke_5IblCdH19mvy39MvLFSArVmY3FpY=": 10
+        },
+        "additionalParams": ""
+    }
+}

protocol/examples/query/rumor_state/wrong_rumor_state_negative_rumor_id.json

@@ -0,0 +1,13 @@
+{
+    "jsonrpc": "2.0",
+    "id": 4,
+    "method": "rumor_state",
+    "params": {
+        "rumor_state": {
+            "J9fBzJV70Jk5c-i3277Uq4CmeL4t53WDfUghaK0HpeM=": 3,
+            "RZOPi59Iy5gkpS2mkpfQJNl44HKc2jVbF0iTGm0RvfU=": 5,
+            "CfG2ByLhtLJH--T2BL9hZ6eGm11tpkE-5KuvysSCY0I=": 1,
+            "r8cG9HyJ1FGBke_5IblCdH19mvy39MvLFSArVmY3FpY=": -10
+        }
+    }
+}

protocol/examples/query/rumor_state/wrong_rumor_state_wrong_key.json

@@ -0,0 +1,13 @@
+{
+    "jsonrpc": "2.0",
+    "id": 4,
+    "method": "rumor_state",
+    "params": {
+        "rumor_state": {
+            "notInBase64": 3,
+            "RZOPi59Iy5gkpS2mkpfQJNl44HKc2jVbF0iTGm0RvfU=": 5,
+            "CfG2ByLhtLJH--T2BL9hZ6eGm11tpkE-5KuvysSCY0I=": 1,
+            "r8cG9HyJ1FGBke_5IblCdH19mvy39MvLFSArVmY3FpY=": 10
+        }
+    }
+}

protocol/query/method/object/rumor_state.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://raw.githubusercontent.com/dedis/popstellar/master/protocol/query/method/object/rumor_state.json",
+    "title": "State of received rumors",
+    "description": "An object containing key-value pairs where each key is a server public key and each value is the last rumor_id it received from this server",
+    "type": "object",
+    "additionalProperties": false,
+    "patternProperties": {
+        "^(?:[a-zA-Z0-9-_]{4})*(?:|[a-zA-Z0-9-_]{3}=|[a-zA-Z0-9+-_]{2}==|[a-zA-Z0-9+-_]===)$": {
+            "description": "[Integer] ID of the rumor",
+            "type": "integer",
+            "minimum": 0
+        }
+    }
+}

protocol/query/method/rumor_state.json

@@ -0,0 +1,34 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://raw.githubusercontent.com/dedis/popstellar/master/protocol/query/method/rumor_state.json",
+    "description": "Match sharing state of last rumor seen per sender",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "method": {
+            "description": "[String] operation to be performed by the query",
+            "const": "rumor_state"
+        },
+
+        "params": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "rumor_state": {
+                    "$ref": "object/rumor_state.json"
+                }
+            },
+            "required": ["rumor_state"]
+        },
+
+        "jsonrpc": {
+            "$comment": "Defined by the parent, but needed here for the validation"
+        },
+
+        "id": {
+            "type": "integer"
+        }
+    },
+
+    "required": ["method", "params", "id", "jsonrpc"]
+}

protocol/query/query.json

@@ -44,6 +44,9 @@
         },
         {
             "$ref": "method/rumor.json"
+        },
+        {
+            "$ref": "method/rumor_state.json"
         }
     ],
 

protocol/test/main.js

@@ -18,6 +18,8 @@ const method_get_messages_by_id_schema = require("../query/method/get_messages_b
 const method_greet_server_schema = require("../query/method/greet_server.json");
 
 const method_rumor_schema = require("../query/method/rumor.json")
+const method_rumor_state_schema = require("../query/method/rumor_state.json")
+const object_rumor_state_schema = require("../query/method/object/rumor_state.json")
 
 const message_data_schema = require("../query/method/message/data/data.json");
 const message_data_roll_call_close_schema = require("../query/method/message/data/dataCloseRollCall.json");
@@ -83,6 +85,8 @@ ajv.addSchema([
     method_greet_server_schema,
 
     method_rumor_schema,
+    method_rumor_state_schema,
+    object_rumor_state_schema,
 
     message_data_schema,
 

protocol/test/main.test.js

@@ -81,7 +81,8 @@ describe("Check root schema", () => {
             "query/heartbeat",
             "query/get_messages_by_id",
             "query/greet_server",
-            "query/rumor"
+            "query/rumor",
+            "query/rumor_state"
         ],
         rootSchema
     );