Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1544 from bigchaindb/update-docs-re-vote-model

Browse Source 
Updated the docs page about the vote model
This commit is contained in:
Troy McConaghy 2017-06-15 14:38:31 +02:00 committed by GitHub
commit d1a4aa28a6
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/server/source/data-models/vote-model.md
View File

@ -4,17 +4,24 @@ A vote has the following structure:
```json ```json
{ {
"id": "<RethinkDB-generated ID for the vote>", "node_pubkey": "<The public key of the voting node>",
"node_pubkey": "<the public key of the voting node>",
"vote": { "vote": {
"voting_for_block": "<id of the block the node is voting for>", "voting_for_block": "<ID of the block the node is voting on>",
"previous_block": "<id of the block previous to this one>", "previous_block": "<ID of the block previous to the block being voted on>",
"is_block_valid": "<true|false>", "is_block_valid": "<true OR false>",
"invalid_reason": "<None|DOUBLE_SPEND|TRANSACTIONS_HASH_MISMATCH|NODES_PUBKEYS_MISMATCH", "invalid_reason": null,
"timestamp": "<Unix time when the vote was generated, provided by the voting node>" "timestamp": "<Unix time when the vote was generated, provided by the voting node>"
}, },
"signature": "<signature of vote>" "signature": "<Cryptographic signature of vote>"
} }
``` ```
Note: The `invalid_reason` was not being used and may be dropped in a future version of BigchainDB. See [Issue #217](https://github.com/bigchaindb/bigchaindb/issues/217) on GitHub. **Notes**
* Votes have no ID (or `"id"`), as far as users are concerned. (The backend database uses one internally, but it's of no concern to users and it's never reported to them via BigchainDB APIs.)
* At the time of writing, the value of `"invalid_reason"` was always `null`. In other words, it wasn't being used. It may be used or dropped in a future version of BigchainDB. See [Issue #217](https://github.com/bigchaindb/bigchaindb/issues/217) on GitHub.
* For more information about the vote `"timestamp"`, see [the page about timestamps in BigchainDB](https://docs.bigchaindb.com/en/latest/timestamps.html).
* For more information about how the `"signature"` is calculated, see [the page about cryptography in BigchainDB](../appendices/cryptography.html).