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

documented the new transaction structure

Browse Source
This commit is contained in:
Rodolphe Marques 2016-04-18 15:24:24 +02:00
parent 7a75dc1700
commit b8aeb228e8
1 changed files with 71 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
docs/source/models.md
View File

@ -7,37 +7,88 @@ Transactions, blocks and votes are represented using JSON documents with the fol
```json ```json
{ {
"id": "<sha3 hash>", "id": "<sha3 hash>",
"version": "<transaction version number>",
"transaction": { "transaction": {
"current_owner": "<pub-key>", "fulfillments": ["<list of <fullfillment>"],
"new_owner": "<pub-key>", "conditions": ["<list of <condition>"],
"input": "<sha3 hash>",
"operation": "<string>", "operation": "<string>",
"timestamp": "<timestamp from client>", "timestamp": "<timestamp from client>",
"data": { "data": {
"hash": "<SHA3-256 hash hexdigest of payload>", "hash": "<SHA3-256 hash hexdigest of payload>",
"payload": { "payload": "<generic json document>"
"title": "The Winds of Plast",
"creator": "Johnathan Plunkett",
"IPFS_key": "QmfQ5QAjvg4GtA3wg3adpnDJug8ktA1BxurVqBD8rtgVjP"
}
} }
}, }
"signature": "<signature of the transaction>"
} }
``` ```
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` 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. The `id` is also the DB primary key. - **Transaction header**:
- `current_owner`: Public key of the current owner of the digital content with hash `hash` - `id`: sha3 hash of the transaction. The `id` is also the DB primary key.
- `new_owner`: Public key of the new owner of the digital content with hash `hash` - `version`: Version of the transaction. For future compability with changes in the transaction model.
- `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. - **Transaction body**:
- `operation`: String representation of the operation being performed (REGISTER, TRANSFER, ...) this will define how - `fulfillments`: List of fulfillments. Each _fulfillment_ contains a pointer to a unspent digital asset
the transactions should be validated and a _crypto fulfillment_ that satisfies a spending condition set on the unspent digital asset. A _fulfillment_
- `timestamp`: Time of creation of the transaction in UTC. It's provided by the client. is usually a signature proving the ownership of the digital asset.
- `data`: JSON object describing the asset (digital content). It contains at least the field `hash` which is a See [conditions and fulfillments](models.md#conditions-and-fulfillments)
sha3 hash of the digital content. - `conditions`: List of conditions. Each _condition_ a _crypto condition_ that needs to be fulfilled by the
- `signature`: Signature of the transaction with the `current_owner` private key new owner in order to spend the digital asset.
See [conditions and fulfillments](models.md#conditions-and-fulfillments)
- `operation`: String representation of the operation being performed (CREATE, TRANSFER, ...) this will define how
the transactions should be validated
- `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.
## Conditions and Fulfillments
### Conditions
```json
{
"cid": "<condition index>",
"condition": {
"details": {
"bitmask": "<explain>",
"public_key": "<explain>",
"signature": null,
"type": "fulfillment",
"type_id": "<explain>"
},
"uri": "<explain>"
},
"new_owners": ["<explain>"]
}
```
- **Condition header**:
- `cid`: Condition index so that we can reference this output as an input to another transaction. It also matches
the input `fid`, making this the condition to fulfill in order to spend the digital asset used as input with `fid`
- `new_owners`: List of public keys of the new owners.
- **Condition body**:
- `bitmask`:
- `public_key`:
- `signature`:
- `type`:
- `type_id`:
- `uri`:
- Simple signatures
- Multisignatures
### Fulfillments
```json
{
"current_owners": ["5nRNzUc2QoGaTKDPjpZV9p9qWKJaB5vowQWVEmXkEC6k"],
"fid": 0,
"fulfillment": "cf:4:RxFzIE679tFBk8zwEgizhmTuciAylvTUwy6EL6ehddHFJOhK5F4IjwQ1xLu2oQK9iyRCZJdfWAefZVjTt3DeG5j2exqxpGliOPYseNkRAWEakqJ_UrCwgnj92dnFRAEE",
"input": {
"cid": 0,
"txid": "11b3e7d893cc5fdfcf1a1706809c7def290a3b10b0bef6525d10b024649c42d3"
}
}
```
## The Block Model ## The Block Model