update message.proto
Add some comments so that I don't forget about these License: MIT Signed-off-by: David Dias <daviddias.p@gmail.com>
David Dias committed
Dec 6, 2016 at 18:53 UTC
38703a8a7fb7e255ac58fe6de0b58b51ced78494
1 file changed
+9
-9
exchange/bitswap/message/pb/message.proto
+9
-9
@@ -5,21 +5,21 @@ message Message {
5
message Wantlist {
6
7
message Entry {
8
- optional string block = 1; // the block key
9
- optional int32 priority = 2; // the priority (normalized). default to 1
10
- optional bool cancel = 3; // whether this revokes an entry
8
+ optional string block = 1; // the block cid (cidV0 in bitswap 1.0.0, cidV1 in bitswap 1.1.0)
9
+ optional int32 priority = 2; // the priority (normalized). default to 1
10
+ optional bool cancel = 3; // whether this revokes an entry
11
}
12
13
- repeated Entry entries = 1; // a list of wantlist entries
14
- optional bool full = 2; // whether this is the full wantlist. default to false
13
+ repeated Entry entries = 1; // a list of wantlist entries
14
+ optional bool full = 2; // whether this is the full wantlist. default to false
15
}
16
17
message Block {
18
- optional bytes prefix = 1;
19
- optional bytes data = 2;
18
+ optional bytes prefix = 1; // CID prefix (cid version, multicodec and multihash prefix (type + length)
19
+ optional bytes data = 2;
20
}
21
22
optional Wantlist wantlist = 1;
23
- repeated bytes blocks = 2;
24
- repeated Block payload = 3;
23
+ repeated bytes blocks = 2; // used to send Blocks in bitswap 1.0.0
24
+ repeated Block payload = 3; // used to send Blocks in bitswap 1.1.0
25
}