Bitmessage/PyBitmessage-2024-12-13
Archived
2
0
Fork 0
Code Issues 168 Pull Requests 53 Actions Packages Projects Releases 5 Wiki Activity

Adding Protocol specification to docs (WIP) #1727

Closed
g1itch wants to merge 12 commits from doc into v0.6
pull from: doc
merge into: Bitmessage:v0.6
Conversation 8 Commits 12 Files Changed 9 +26
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit cf8c2eb4e9 - Show all commits

26
docs/protocol.rst
View File

@ -394,12 +394,30 @@ addr
Provide information on known nodes of the network. Non-advertised nodes should Provide information on known nodes of the network. Non-advertised nodes should
be forgotten after typically 3 hours be forgotten after typically 3 hours
Payload:
+------------+-------------+-----------+---------------------------------------+
| Field Size | Description | Data type | Comments |
+============+=============+===========+=======================================+
| 1+ | count | |var_int| | Number of address entries (max: 1000) |
+------------+-------------+-----------+---------------------------------------+
| 38 | addr_list | net_addr | Address of other nodes on the network.|
+------------+-------------+-----------+---------------------------------------+
inv inv
^^^ ^^^
Allows a node to advertise its knowledge of one or more objects. Payload Allows a node to advertise its knowledge of one or more objects. Payload
(maximum payload length: 50000 items): (maximum payload length: 50000 items):
+------------+-------------+------------+-----------------------------+
| Field Size | Description | Data type | Comments |
+============+=============+============+=============================+
| ? | count | |var_int| | Number of inventory entries |
+------------+-------------+------------+-----------------------------+
| 32x? | inventory | inv_vect[] | Inventory vectors |
+------------+-------------+------------+-----------------------------+
getdata getdata
^^^^^^^ ^^^^^^^
@ -409,6 +427,14 @@ specific object after filtering known elements.
Payload (maximum payload length: 50000 entries): Payload (maximum payload length: 50000 entries):
+------------+-------------+------------+-----------------------------+
| Field Size | Description | Data type | Comments |
+============+=============+============+=============================+
| ? | count | |var_int| | Number of inventory entries |
+------------+-------------+------------+-----------------------------+
| 32x? | inventory | inv_vect[] | Inventory vectors |
+------------+-------------+------------+-----------------------------+
object object
^^^^^^ ^^^^^^