Bitmessage/PyBitmessage-2024-12-06
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 +8 -4
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 5b923a86e4 - Show all commits

12
docs/protocol.rst
View File

@ -335,6 +335,8 @@ Further values for the message encodings can be decided upon by the community.
Any MIME or MIME-like encoding format, should they be used, should make use of Any MIME or MIME-like encoding format, should they be used, should make use of
Bitmessage's 8-bit bytes. Bitmessage's 8-bit bytes.
.. _behavior-bitfield:
Pubkey bitfield features Pubkey bitfield features
"""""""""""""""""""""""" """"""""""""""""""""""""
@ -631,7 +633,7 @@ A version 2 pubkey. This is still in use and supported by current clients but
- Data type - Data type
- Comments - Comments
* - 4 * - 4
- behavior bitfield - |behavior_bitfield|
- uint32_t - uint32_t
- A bitfield of optional behaviors and features that can be expected from - A bitfield of optional behaviors and features that can be expected from
the node receiving the message. the node receiving the message.
@ -655,7 +657,7 @@ A version 2 pubkey. This is still in use and supported by current clients but
- Data type - Data type
- Comments - Comments
* - 4 * - 4
- behavior bitfield - |behavior_bitfield|
- uint32_t - uint32_t
- A bitfield of optional behaviors and features that can be expected from - A bitfield of optional behaviors and features that can be expected from
the node receiving the message. the node receiving the message.
@ -750,7 +752,7 @@ python code below:
- Data type - Data type
- Comments - Comments
* - 4 * - 4
- behavior bitfield - |behavior_bitfield|
- uint32_t - uint32_t
- A bitfield of optional behaviors and features that can be expected from - A bitfield of optional behaviors and features that can be expected from
the node receiving the message. the node receiving the message.
@ -877,7 +879,7 @@ Unencrypted data format:
- var_int - var_int
- The sender's stream number - The sender's stream number
* - 4 * - 4
- behavior bitfield - |behavior_bitfield|
- uint32_t - uint32_t
- A bitfield of optional behaviors and features that can be expected from - A bitfield of optional behaviors and features that can be expected from
the owner of this pubkey. the owner of this pubkey.
@ -934,3 +936,5 @@ Unencrypted data format:
version down through the message. In protocol v3, it covers the version down through the message. In protocol v3, it covers the
unencrypted object header starting with the time, all appended with unencrypted object header starting with the time, all appended with
the decrypted data. the decrypted data.
.. |behavior_bitfield| replace:: :ref:`behavior bitfield <behavior-bitfield>`