neobytes-project/neobytes
neobytes-project/neobytes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge pull request #1072 from UdjinM6/updateProtoDoc

Browse Source 
update protocol-documentation.md
This commit is contained in:
Evan Duffield 2016-10-12 13:34:21 -07:00 committed by GitHub
commit ef87e4ccb1
1 changed files with 126 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

235
dash-docs/protocol-documentation.md
View File

@ -11,174 +11,187 @@ uint256 => char[32]
CScript => uchar[]
### COutpoint
### COutPoint
Bitcoin Input
Bitcoin Outpoint https://bitcoin.org/en/glossary/outpoint
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 32 | hash | uint256 | Hash of transactional output which is being referenced
| 4 | n | uint32_t | Index of transaction which is being referenced
### CTXIn
### CTxIn
Bitcoin Input
Bitcoin Input https://bitcoin.org/en/glossary/input
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 36 | prevout | COutPoint | The previous output from an existing transaction, in the form of an unspent output
| 1+ | script length | var_int | The length of the signature script
| ? | script | CScript | The script which is validated for this input to be spent
| 4 | nSequence | uint_32t | Transaction version as defined by the sender. Intended for "replacement" of transactions when information is updated before inclusion into a block.
### CPubkey
### CTxOut
Bitcoin Public Key
Bitcoin Output https://bitcoin.org/en/glossary/output
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 33-65 | vch | char[] | Encapcilated public key of masternode in serialized varchar form
| 8 | nValue | int64_t | Transfered value
| ? | scriptPubKey | CScript | The script for indicating what conditions must be fulfilled for this output to be further spent
### Masternode Winner
### CPubKey
When a new block is found on the network, a masternode quorum will be determined and those 10 selected masternodes will issue a masternode winner command to pick the next winning node.
Bitcoin Public Key https://bitcoin.org/en/glossary/public-key
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 41+ | vinMasternode | CTXIn | The unspent output of the masternode which is signing the message
| 4 | nBlockHeight | int | The blockheight which the payee should be paid
| ? | payeeAddress | CScript | The address to pay to
| 71-73 | sig | char[] | Signature of the masternode)
| 33-65 | vch | char[] | The public portion of a keypair which can be used to verify signatures made with the private portion of the keypair.
## Message Types
### Masternode Winner
### MNANNOUNCE - "mnb"
When a new block is found on the network, a masternode quorum will be determined and those 10 selected masternodes will issue a masternode winner command to pick the next winning node.
| Field Size | Description | Data type | Comments |
| ---------- | ----------- | --------- | -------- |
| 41+ | vinMasternode | CTXIn | The unspent output of the masternode which is signing the message
| 4 | nBlockHeight | int | The blockheight which the payee should be paid
| ? | payeeAddress | CScript | The address to pay to
| 71-73 | sig | char[] | Signature of the masternode)
### Governance Vote
Masternodes use governance voting in response to new proposals, contracts, settings or finalized budgets.
| Field Size | Description | Data type | Comments |
| ---------- | ----------- | --------- | -------- |
| 41+ | Unspent Output | CTXIn | Unspent output for the masternode which is voting
| 32 | nParentHash | uint256 | Object which we're voting on (proposal, contract, setting or final budget)
| 4 | nVote | int | Yes (1), No(2) or Abstain(0)
| 8 | nTime | int_64t | Time which the vote was created
| 71-73 | vchSig | char[] | Signature of the masternode
### Governance Object
A proposal, contract or setting.
| Field Size | Description | Data type | Comments |
| ---------- | ----------- | --------- | -------- |
| 1-20 | strName | std::string | Name of the governance object
| 1-64 | strURL | std::string | URL where detailed information about the governance object can be found
| 8 | nTime | int_64t | Time which this object was created
| 4 | nBlockStart | int | Starting block, which the first payment will occur
| 4 | nBlockEnd | int | Ending block, which the last payment will occur
| 8 | nAmount | int_64t | The amount in satoshi's that will be paid out each time
| ? | payee | CScript | Address which will be paid out to
| 32 | nFeeTXHash | uint256 | Hash of the collateral fee transaction
### Finalized Budget
Contains a finalized list of the order in which the next budget will be paid.
| Field Size | Description | Data type | Comments |
| ---------- | ----------- | --------- | -------- |
| 41+ | strBudgetName | CTXIn | The unspent output of the masternode which is signing the message
| 4 | nBlockStart | int | The blockheight which the payee should be paid
| ? | vecBudgetPayments | CScript | The address to pay to
| 32 | nFeeTXHash | uint256 | Hash of the collateral fee transaction
### Masternode Announce
CMasternodeBroadcast
Whenever a masternode comes online or a client is syncing, they will send this message which describes the masternode entry and how to validate messages from it.
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 41+ | vin | CTXIn | The unspent output of the masternode which is signing the message
| 41 | vin | CTxIn | The unspent output which is holding 1000 DASH
| # | addr | CService | Address of the main 1000 DASH unspent output
| 33-65 | pubkey | CPubkey | CPubKey of the main 1000 DASH unspent output
| 33-65 | pubkey2 | CPubkey | CPubkey of the secondary signing key (For all other messaging other than announce message)
| 33-65 | pubKeyCollateralAddress | CPubKey | CPubKey of the main 1000 DASH unspent output
| 33-65 | pubKeyMasternode | CPubKey | CPubKey of the secondary signing key (For all other messaging other than announce message)
| 71-73 | sig | char[] | Signature of this message
| 8 | sigTime | int_64t | Time which the signature was created
| 4 | protocolVersion | int | The protocol version of the masternode
| # | lastPing | CMasternodePing | The last time the masternode pinged the network
| 8 | nLastDsq | int_64t | The last time the masternode sent a DSQ message (for darksend mixing)
| 8 | sigTime | int64_t | Time which the signature was created
| 4 | nProtocolVersion | int | The protocol version of the masternode
| # | lastPing | CMasternodePing | The last known ping of the masternode
| 8 | nLastDsq | int64_t | The last time the masternode sent a DSQ message (for mixing)
### Masternode Ping
### MNPING - "mnp"
CMasternodePing
Every few minutes, masternodes ping the network with a message that propagates the whole network.
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 41+ | vin | CTXIn | The unspent output of the masternode which is signing the message
| 41 | vin | CTxIn | The unspent output of the masternode which is signing the message
| 32 | blockHash | uint256 | Current chaintip blockhash minus 12
| 8 | sigTime | int_64t | Signature time for this ping
| 71-73 | vchSig | char[] | Signature of this message by masternode (verifiable via pubkey2)
| 8 | sigTime | int64_t | Signature time for this ping
| 71-73 | vchSig | char[] | Signature of this message by masternode (verifiable via pubKeyMasternode)
### Masternode DSTX
### MASTERNODEPAYMENTVOTE - "mnw"
Masternodes can broadcast subsidised transactions without fees for the sake of security in Darksend. This is done via the DSTX message.
CMasternodePaymentVote
| Field Size | Description | Data type | Comments |
When a new block is found on the network, a masternode quorum will be determined and those 10 selected masternodes will issue a masternode payment vote message to pick the next winning node.
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| # | tx | CTransaction | The unspent output of the masternode which is signing the message
| 41+ | vin | CTXIn | Masternode unspent output
| 71-73 | vchSig | char[] | Signature of this message by masternode (verifiable via pubkey2)
| 8 | sigTime | int_64_t | Time this message was signed
| 41 | vinMasternode | CTxIn | The unspent output of the masternode which is signing the message
| 4 | nBlockHeight | int | The blockheight which the payee should be paid
| ? | payeeAddress | CScript | The address to pay to
| 71-73 | sig | char[] | Signature of the masternode which is signing the message
### DSSTATUSUPDATE - DSSU
### DSTX - "dstx"
Darksend pool status update
CDarksendBroadcastTx
| Field Size | Description | Data type | Comments |
Masternodes can broadcast subsidised transactions without fees for the sake of security in mixing. This is done via the DSTX message.
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 4 | sessionID | int | The unspent output of the masternode which is signing the message
| 4 | GetState | int | Masternode unspent output
| 4 | GetEntriesCount | int | Number of entries
| 4 | Status | int | Status of the mixing process
| 4 | errorID | int | Error ID if any
| # | tx | CTransaction | The transaction
| 41 | vin | CTxIn | Masternode unspent output
| 71-73 | vchSig | char[] | Signature of this message by masternode (verifiable via pubKeyMasternode)
| 8 | sigTime | int64_t | Time this message was signed
### DSSTATUSUPDATE - DSQ
### DSSTATUSUPDATE - "dssu"
Asks users to sign final Darksend tx message.
Mixing pool status update
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 4 | vDenom | int | Which denominations are allowed in this mixing session
| 4 | vin | int | unspend output from masternode which is hosting this session
| 4 | time | int | the time this DSQ was created
| 4 | ready | int | if the mixing pool is ready to be executed
| 71-73 | vchSig | char[] | Signature of this message by masternode (verifiable via pubkey2)
| 4 | nMsgSessionID | int | Session ID
| 4 | nMsgState | int | Current state of mixing process
| 4 | nMsgEntriesCount | int | Number of entries in the mixing pool
| 4 | nMsgAccepted | int | Was entries accepted or not
| 4 | nMsgErrorID | int | Error ID if any
### DSSTATUSUPDATE - DSA
### DSQUEUE - "dsq"
Response to DSQ message which allows the user to join a Darksend mixing pool
CDarksendQueue
| Field Size | Description | Data type | Comments |
Asks users to sign final mixing tx message.
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 4 | sessionDenom | int | denomination that will be exclusively used when submitting inputs into the pool
| 4 | txCollateral | int | unspend output from masternode which is hosting this session
| 4 | nDenom | int | Which denomination is allowed in this mixing session
| 41 | vin | CTxIn | unspend output from masternode which is hosting this session
| 4 | nTime | int | the time this DSQ was created
| 4 | fReady | int | if the mixing pool is ready to be executed
| 71-73 | vchSig | char[] | Signature of this message by masternode (verifiable via pubKeyMasternode)
### DSSTATUSUPDATE - DSS
### DSACCEPT - "dsa"
User's signed inputs for a group transaction in a Darksend session
Response to DSQ message which allows the user to join a mixing pool
| Field Size | Description | Data type | Comments |
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| # | inputs | CTXIn[] | signed inputs for Darksend session
| 4 | nDenom | int | denomination that will be exclusively used when submitting inputs into the pool
| 41+ | txCollateral | int | collateral tx that will be charged if this client acts maliciousely
### DSVIN - "dsi"
CDarkSendEntry
When queue is ready user is expected to send his entry to start actual mixing
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| ? | vecTxDSIn | CTxDSIn[] | vector of users inputs (CTxDSIn serialization is equal to CTxIn serialization)
| 8 | nAmount | int64_t | depreciated since 12.1, it's used for backwards compatibility only and can be removed with future protocol bump
| ? | txCollateral | CTransaction | Collateral transaction which is used to prevent misbehavior and also to charge fees randomly
| ? | vecTxDSOut | CTxDSOut[] | vector of user outputs (CTxDSOut serialization is equal to CTxOut serialization)
### DSSIGNFINALTX - "dss"
User's signed inputs for a group transaction in a mixing session
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| # | inputs | CTxIn[] | signed inputs for mixing session
### MNGOVERNANCEOBJECT - "govobj"
Governance Object
A proposal, contract or setting.
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 32 | nHashParent | uint256 | Parent object, 0 is root
| 4 | nRevision | int | Object revision in the system
| 8 | nTime | int64_t | Time which this object was created
| 32 | nCollateralHash | uint256 | Hash of the collateral fee transaction
| 0-16384 | strData | string | Data field - can be used for anything
| 4 | nObjectType | int | ????
| 41 | vinMasternode | CTxIn | Unspent output for the masternode which is signing this object
| 71-73 | vchSig | char[] | Signature of the masternode
### MNGOVERNANCEOBJECTVOTE - "govobjvote"
Governance Vote
Masternodes use governance voting in response to new proposals, contracts, settings or finalized budgets.
| Field Size | Field Name | Data type | Description |
| ---------- | ----------- | --------- | -------- |
| 4 | nVoteSignal | int | ???
| 41+ | vinMasternode | CTxIn | Unspent output for the masternode which is voting
| 32 | nParentHash | uint256 | Object which we're voting on (proposal, contract, setting or final budget)
| 4 | nVoteOutcome | int | ???
| 8 | nTime | int64_t | Time which the vote was created
| 71-73 | vchSig | char[] | Signature of the masternode