Documentation on Transaction Concepts, and some other stuff #343
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current coverage is 88.14%@@ master #343 diff @@
==========================================
Files 18 18
Lines 1206 1206
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
Hits 1063 1063
Misses 143 143
Partials 0 0
|
ghost
added
the
| BigchainDB stores all its records in JSON documents. | ||
|
|
||
| The three main kinds of records are transactions, blocks and votes. | ||
| _Transactions_ are used to register, issue, create or transfer things (e.g. assets). Multiple transactions are combined with some other metadata to form _blocks_. Nodes append _votes_ to blocks. This section is a reference on the details of transactions, blocks and votes. |
There was a problem hiding this comment.
maybe we should chose only one between register, issue, create
There was a problem hiding this comment.
This was added after a discussion with Bruce... A transaction with no inputs can have many uses, and they can't all be captured with one verb, or at least I don't think they can.
In any case, if we remove the "operation" from the transaction data model (as suggested in issue #340), we're free to use whatever verb we like when describing what one of these input-free transactions is doing.
sbellem
pushed a commit
to sbellem/bigchaindb
that referenced
this pull request
Oct 24, 2016
…del-details Documentation on Transaction Concepts, and some other stuff
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was no documentation explaining the basics of transactions (i.e. what they are, the kinds, how they work), so I wrote some documentation about that. I put it in The Transaction, Block and Vote Models section of the docs.
Note: This section of the docs will also strongly influence (or become) revisions to the BigchainDB whitepaper, so it's important for it to have minimal errors.
I also made a some other minor changes to the docs.
@diminator I assigned you to this PR because I may have made some technical errors and you're among the people most familiar with the technicalities of transactions.