Merge pull request #133 from bigchaindb/clarify-timestamps-in-docs

Clarify the meaning of some timestamps in the docs
This commit is contained in:
Troy McConaghy 2016-03-14 17:21:30 +01:00
commit fdd1f297a6
1 changed files with 5 additions and 5 deletions

View File

@ -12,7 +12,7 @@ Transactions, blocks and votes are represented using JSON documents with the fol
"new_owner": "<pub-key>",
"input": "<sha3 hash>",
"operation": "<string>",
"timestamp": "<timestamp>",
"timestamp": "<timestamp from client>",
"data": {
"hash": "<SHA3-256 hash hexdigest of payload>",
"payload": {
@ -28,13 +28,13 @@ Transactions, blocks and votes are represented using JSON documents with the fol
A transaction is an operation between the `current_owner` and the `new_owner` over the digital content described by `hash`. For example if could be a transfer of ownership of the digital content `hash`
- `id`: sha3 hash of the transaction. Also the RethinkDB primary key. By using the hash of the transaction as the primary key, we eliminate the problem of duplicated transactions, if for some reason two nodes decide to create the same transaction
- `id`: sha3 hash of the transaction. The `id` is also the DB primary key.
- `current_owner`: Public key of the current owner of the digital content with hash `hash`
- `new_owner`: Public key of the new owner of the digital content with hash `hash`
- `input`: id (sha3 hash) of the transaction in which the content was transfered to the user (similar to input in the blockchain). Right now we will assume that there is only one input per transaction to simplify the prototype. This can be changed in the future to allow multiple inputs per transaction.
- `operation`: String representation of the operation being performed (REGISTER, TRANSFER, ...) this will define how
the transactions should be validated
- `timestamp`: Time of creation of the transaction in UTC
- `timestamp`: Time of creation of the transaction in UTC. It's provided by the client.
- `data`: JSON object describing the asset (digital content). It contains at least the field `hash` which is a
sha3 hash of the digital content.
- `signature`: Signature of the transaction with the `current_owner` private key
@ -45,7 +45,7 @@ sha3 hash of the digital content.
{
"id": "<sha3 hash of the serialized block contents>",
"block": {
"timestamp": "<RethinkDB timestamp>",
"timestamp": "<block-creation timestamp>",
"transactions": ["<list of transactions>"],
"node_pubkey": "<public key of the node creating the block>",
"voters": ["<list of federation nodes public keys>"]
@ -62,7 +62,7 @@ A block contains a group of transactions and includes the hash of the hash of th
- `id`: sha3 hash of the contents of `block` (i.e. the timestamp, list of transactions, node_pubkey, and voters). This is also a RethinkDB primary key; that's how we ensure that all blocks are unique.
- `block`: The actual block
- `timestamp`: timestamp when the block was created
- `timestamp`: timestamp when the block was created. It's provided by the node that created the block.
- `transactions`: the list of transactions included in the block
- `node_pubkey`: the public key of the node that create the block
- `voters`: list public keys of the federation nodes. Since the size of the