wip on wire protocol

doc/wire-protocol.md

@@ -0,0 +1,82 @@
+# MuWire network protocol
+
+The MuWire protocol operates over a TCP-like streaming layer offered by the I2P streaming library, except for "Result" type messages which are delivered of I2P datagrams.
+
+## Handshake
+
+A connection begins with the word "MuWire" followed by a space and either the word "leaf" or "peer", depending on whether Alice is in a leaf or an ultrapeer role.  This allows Bob to immediately drop the connection without allocating any more resources if it is a leaf or if it does not have any more connection slots.
+
+## Compression
+
+All traffic after the handshake is compressed using the same compression algorithm in Gnutella.
+
+## Messages
+
+After the handhsake follows a stream of messages.  Messages can arrive in any order.  Each message consists of 3 bytes - the most significant bit of the first message indicates if the payload is binary or JSON.  The remaining 23 bits indicate the length of the message.
+
+The JSON payload has two mandatory top-level fields - type and version:
+
+```
+{
+    type : "MessageType",
+    version : 1,
+    ...
+}
+```
+
+Binary messages can be two types: full bloom filter or a patch message to be applied to a previously sent bloom filter.  Binary messages travel only between ultrapeers.
+
+### Leaf to ultrapeer
+
+#### "Upsert"
+
+This message is sent from a leaf to ultrapeer to indicating that the leaf is sharing a given file:
+
+```
+{
+    type : "Upsert",
+    version : 1,
+    infoshash : "asdfasf...",
+    names : [ "file name 1", "file name 2"...]
+}
+```
+
+Multiple file names per infohash are allowed.  In future versions this message may be extended to carry metadata such as artist, album and so on.
+
+#### "Delete"
+
+The opposite of Upsert - the leaf is no longer sharing the specified file.  The file is identified only by the infohash.
+
+```
+{
+    type: "Delete",
+    version: 1,
+    infohash "asdfasdf..."
+}
+```
+
+#### "Ping"
+
+Sent when the leaf wants to find the addresses of more ultrapeers to connect to.  Other than the header this message has no payload.
+
+#### "Search"
+
+Sent by a leaf when performing a search.  Contains the reply-to b64 destination for I2P datagrams.
+
+```
+{
+    type : "Search",
+    version: 1,
+    keywords : "great speeches"
+    replyTo : "asdfasf..."
+}
+```
+
+### Ultrapeer to leaf
+
+The only message sent from an ultrapeer to leaf is the "Search" message which is identical to the one sent from the leaf.
+
+### Between Ultrapeers
+
+
+