joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-28 10:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Governance updates

Browse source 
- Guide updated to show both stages of govsync
 - Reference
  - Correcte ssc typo and add sync item detail
  - Update govobjvote to include detail about propagation
  - Update govsync details
This commit is contained in:
thephez 2017-10-18 12:11:22 -04:00
parent 3a3778e6a9
commit 96919848df
3 changed files with 67 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

18
_includes/devdoc/guide_p2p_network.md
View file

@ -637,7 +637,8 @@ last stage of the Masternode sync process (following the sync of sporks, the
Masternode list, and Masternode payments).
The `govsync` message initiates a sync of the governance system. Masternodes
respond to the `govsync` message with several items:
ignore this request if they are not fully synced. Otherwise, they respond to
the `govsync` message with several items:
* First, the Masternode sends one `ssc` message (Sync Status Count) for `govobj`
objects and one for `govobjvote` objects. These messages indicate how many
@ -655,10 +656,19 @@ nodes until all the governance objects have been synchronized.
*Governance Sync Data Flow*
| **Syncing Node Message** | **Direction** | **Masternode Response** | **Description** |
| `govsync` message | → | | Syncing node initiates governance sync
| | ← | `ssc` message (govobj) | Number of governance objects
| | ← | `ssc` message (govobjvote)| Number of governance object votes
| **Inital request** | | | **Requests all governance objects (without votes)** |
| `govsync` message | → | | Syncing node initiates governance sync (hash set to all zeros)
| | ← | `ssc` message (govobj) | Number of governance objects (0 or more)
| | ← | `ssc` message (govobjvote)| Number of governance object votes *(0 since votes are only returned if a specific hash is provided with the `govsync` message)*
| | ← | `inv` message (govobj) | Governance object inventories
| `getdata` message (govobj) | → | | (Optional) Syncing node requests govobj
| | ← | `govobj` message | (If requested) Governance object
| | | | |
| **Follow up requests** | | | **Requests governance object (with votes)** |
| `govsync` message | → | | Syncing node requests governance sync for a specific governance object
| | ← | `ssc` message (govobj) | Number of governance objects (1)
| | ← | `ssc` message (govobjvote)| Number of governance object votes (0 or more)
| | ← | `inv` message (govobj) | Governance object inventory
| | ← | `inv` message (govobjvote)| Governance object vote inventories
| `getdata` message (govobj) | → | | (Optional) Syncing node requests govobj
| | ← | `govobj` message | (If requested) Governance object

76
_includes/devdoc/ref_p2p_networking.md
View file

@ -2165,24 +2165,23 @@ dd6cc6c11211793b239c2e311f1496e2
{% autocrossref %}
The `ssc` message is used to track the sync status of masternode objects. This
message is sent in response to sync requests for masternode payments
(`mnw` message), masternode list (`mnget` message),
governance objects (`govsync` message), and governance object votes (`govsync` message).
message is sent in response to sync requests for the list of masternodes
(`dseg` message), masternode payments (`mnget` message), governance objects
(`govsync` message), and governance object votes (`govsync` message).
| Bytes | Name | Data type | Required | Description |
| ---------- | ----------- | --------- | -------- | -------- |
| 4 | nItemID | int | Required | Masternode Sync Item ID
| 4 | nCount | int | Required | Masternode Sync Count
| 4 | nCount | int | Required | Number of items to sync
Sync Item IDs
| ID | Description
|------|--------------
| 2 | MASTERNODE_SYNC_LIST
| 3 | MASTERNODE_SYNC_MNW
| 4 | MASTERNODE_SYNC_GOVERNANCE
| 10 | MASTERNODE_SYNC_GOVOBJ
| 11 | MASTERNODE_SYNC_GOVOBJ_VOTE
| ID | Description | Response To
|------|--------------|---------------
| 2 | MASTERNODE_SYNC_LIST | `dseg` message
| 3 | MASTERNODE_SYNC_MNW | `mnget` message
| 10 | MASTERNODE_SYNC_GOVOBJ | `govsync` message
| 11 | MASTERNODE_SYNC_GOVOBJ_VOTE | `govsync` message with non-zero hash
The following annotated hexdump shows a `ssc` message. (The
message header has been omitted.)
@ -2259,6 +2258,8 @@ For additional details on the governance system, see this [Budget System page](h
![Overview Of P2P Protocol Governance Request And Reply Messages](/img/dev/en-p2p-governance-messages.svg)
For additional details, refer to the Developer Guide [Governance section](developer-guide#governance).
{% endautocrossref %}
#### govobj
@ -2267,7 +2268,7 @@ For additional details on the governance system, see this [Budget System page](h
{% autocrossref %}
The `govobj` message contains a governance object that is generally a proposal,
contract, or setting.
contract, or setting. Masternodes ignore this request if they are not fully synced.
| Bytes | Name | Data type | Required | Description |
| ---------- | ----------- | --------- | -------- | -------- |
@ -2331,10 +2332,22 @@ Transaction input
{% autocrossref %}
The `govobjvote` message is sent by masternodes to indicate their intention (yes,
no, abstain) regarding a governance object. A sufficient number of yes votes
results in the proposed funding being payed out in the next superblock (assuming
their are sufficient funds available in the budget).
The `govobjvote` message is used to indicate the voting status of a governance
object. Voting status is comprised of the vote outcome (how the masternode
voted) and the vote signal (the network support status). A sufficient number of
yes votes results in the proposed funding being payed out in the next
superblock (assuming their are sufficient funds available in the budget).
The initial `govobjvote` message is created by a masternode to vote on a
governance object (proposal, etc.). When the masternode votes, it broadcasts
the `govobjvote` message to all its peers.
When a node receives a valid, **new** `govobjvote` message, it relays the message
to all its connected peers to propagate the vote.
Additionally, nodes can request `govobjvote` messages for specific governance
objects via a `govsync` message. Masternodes ignore requests for votes if they
are not fully synced.
| Bytes | Name | Data type | Required | Description |
| ---------- | ----------- | --------- | -------- | -------- |
@ -2345,6 +2358,15 @@ their are sufficient funds available in the budget).
| 8 | nTime | int64_t | Required | Time the vote was created
| 66* | vchSig | char[] | Required | Signature of the masternode (66 bytes in most cases. Length (1 byte) + Signature (65 bytes))
Governance Object Vote Signals (defined by src/governance-object.h)
| Value | Name | Description
|------|-------|------------
| 1 | Funding | Minimum network support has been reached for this object to be funded (doesn't mean it will for sure though)
| 2 | Valid | Minimum network support has been reached flagging this object as a valid and understood governance object (e.g, the serialized data is correct format, etc.)
| 3 | Delete | Minimum network support has been reached saying this object should be deleted from the system entirely
| 4 | Endorsed | Minimum network support has been reached flagging this object as endorsed by an elected representative body
The following annotated hexdump shows a `govobjvote` message. (The
message header has been omitted.)
@ -2380,24 +2402,26 @@ dc45e9c09ee0427223e332b52e8d709e
{% autocrossref %}
The `govsync` message is used to request syncing of governance objects
(`govobj` message and `govobjvote` message) with peers.
(`govobj` message and `govobjvote` message) with peers. Masternodes ignore this
request if they are not fully synced.
This message responds in two ways depending on the request:
This message responds in one of two ways depending on the request:
1. When a masternode receives a `govsync` message with a hash of all zeros, it
responds with a `govobj` inventory message (MSG_GOVERNANCE_OBJECT - 0x17) for
all valid governance objects. Governance object votes are excluded in this type
of response.
responds with one `ssc` message for `govobj` objects and one for `govobjvote`
objects. The masternode also sends an `inv` message (MSG_GOVERNANCE_OBJECT - 0x17)
for all valid `govobj` governance objects.
*Governance object votes are excluded in this type of response.*
2. When a masternode receives a `govsync` message with a specific hash, it
responds with both a `govobj` inventory message (MSG_GOVERNANCE_OBJECT - 0x17)
and a `govobjvote` inventory message (MSG_GOVERNANCE_OBJECT_VOTE - 0x18) for
the single goverance object requested.
responds with one `ssc` message for `govobj` objects and one for `govobjvote`
objects. The masternode also sends both a `govobj` inventory message
(MSG_GOVERNANCE_OBJECT - 0x17) and `govobjvote` inventory messages
(MSG_GOVERNANCE_OBJECT_VOTE - 0x18) for the single governance object requested.
| Bytes | Name | Data type | Required | Description |
| ---------- | ----------- | --------- | -------- | -------- |
| 32 | nHash | uint256 | Required |
| 32 | nHash | uint256 | Required | Hash of governance object to request<br>Set to all zeros to request all objects (excludes votes)
| # | filter | CBloomFiter | Required | Only supported since [protocol version 70206][section protocol versions]
Note: Both the hash and bloom filter fields can be set to all zeros.