..  This file was auto generated by generate_schema_documentation.py

===========
Vote Schema
===========

Vote
----

A Vote is an endorsement of a Block (identified by a hash) by
a node (identified by a public key).

The outer Vote object contains the details of the vote being made
as well as the signature and identifying information of the node
passing the vote.


Vote.node_pubkey
^^^^^^^^^^^^^^^^

**type:** string

Ed25519 public key identifying the voting node.



Vote.signature
^^^^^^^^^^^^^^

**type:** string

Ed25519 signature of the `Vote Details`_ object.


Vote.vote
^^^^^^^^^

**type:** object

`Vote Details`_ to be signed.





Vote Details
------------

`Vote Details`_ to be signed.


Vote.previous_block
^^^^^^^^^^^^^^^^^^^

**type:** string

ID (SHA3 hash) of the block that precedes the block being voted on.
The notion of a "previous" block is subject to vote.



Vote.voting_for_block
^^^^^^^^^^^^^^^^^^^^^

**type:** string

ID (SHA3 hash) of the block being voted on.



Vote.is_block_valid
^^^^^^^^^^^^^^^^^^^

**type:** boolean

This field is ``true`` if the block was deemed valid by the node.



Vote.invalid_reason
^^^^^^^^^^^^^^^^^^^

**type:** string or null

Reason the block is voted invalid, or ``null``.

.. container:: notice

  **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.



Vote.timestamp
^^^^^^^^^^^^^^

**type:** string

Unix timestamp that the vote was created by the node, according
to the system time of the node.






.. raw:: html

    <style>
    #vote-schema h2 {
         border-top: solid 3px #6ab0de;
         background-color: #e7f2fa;
         padding: 5px;
    }
    #vote-schema h3 {
         background: #f0f0f0;
         border-left: solid 3px #ccc;
         font-weight: bold;
         padding: 6px;
         font-size: 100%;
         font-family: monospace;
    }
    .document .section p {
        margin-bottom: 16px;
    }
    .notice {
        margin: 0px 16px 16px 16px;
        background-color: white;
        border: 1px solid gold;
        padding: 3px 6px;
    }
    </style>