0 Members and 1 Guest are viewing this topic.
I've started on this bounty. Initial progress is here: https://github.com/drltc/docblockI have some questions here: https://github.com/drltc/docblock/blob/master/questions.mdSince bytemaster is most familiar with the core code, I suspect he'll be answering most of them. But any other developers or random forum lurkers are encouraged to answer to conserve bytemaster's time
Over the next two weeks, I'd like to work on documenting the blockchain format. In particular, going from a block as a sequence of bytes; to fields with particular data types (uint32, hash); to semantic information about entities like accounts, balances, delegates, orders, and votes. To keep the scope manageable, I'd like to limit my contribution to focusing on parsing the serialized blockchain.I'll include information on the following:- Byte-by-byte documentation of the serialized block format- Constraints between various fields (e.g. the value in each block's parent block hash field must be equal to the value obtained by computing the hash of the serialization of the parent block).- Reasons for design decisions- Genesis-block parameters that can easily be tweaked- Highlight major BitShares Toolkit features that either mimic features of other cryptocoins, or are different from other cryptocoins- Describe in detail the implementation of high-level semantic nouns and verbs (e.g.: What is a short position and how do you cover it? How do we make TITAN transactions invisible?)I'll post here with the Github URL when I start.Also, since the bounty was posted before snapshot was taken, I'd like to ask if the bounty will include the BTSX spawned by the 500 PTS?Hopefully this post satisfies the "scope and requirements" laid out in the opening post, and we can change from pending to active.
There is a work in progress, I think this bounty is better done cooperatively than competitively. Equal expected return per hour but higher chance of getting the bounty before feb 28thhttps://github.com/nmushegian/BitShares/blob/spec/doc/spec.md
Quote from: bytemaster on January 20, 2014, 12:22:50 amQuote from: naturalog on January 20, 2014, 12:19:08 amI checked in a version that finishes (hopefully) all the explanation of the classes in block.hpp and transaction.hpp.Please guide me for more work.https://github.com/nmushegian/BitShares/blob/master/doc/spec.mdFor an example of you Bitcoin documented this:https://en.bitcoin.it/wiki/Protocol_specificationIt would be very difficult for me to build BitShares X starting only with the spec you have provided.Ok so we're talking about the whole protocol specification, not only blockchain structure.
Quote from: naturalog on January 20, 2014, 12:19:08 amI checked in a version that finishes (hopefully) all the explanation of the classes in block.hpp and transaction.hpp.Please guide me for more work.https://github.com/nmushegian/BitShares/blob/master/doc/spec.mdFor an example of you Bitcoin documented this:https://en.bitcoin.it/wiki/Protocol_specificationIt would be very difficult for me to build BitShares X starting only with the spec you have provided.
I checked in a version that finishes (hopefully) all the explanation of the classes in block.hpp and transaction.hpp.Please guide me for more work.https://github.com/nmushegian/BitShares/blob/master/doc/spec.md
Quote from: toast on January 03, 2014, 07:16:05 pmbytemaster you said you wanted to help bootstrap this, can you say some more words? I'm going to work on merging in whatever parts of naturalog's work that I can and then the most up-to-date work will be in the spec branch on my repo.is it ready already? can i continue on your branch?
bytemaster you said you wanted to help bootstrap this, can you say some more words? I'm going to work on merging in whatever parts of naturalog's work that I can and then the most up-to-date work will be in the spec branch on my repo.
bytemaster, can you please supply some explanation about the block state structure?toast, do you plan working on this doc? Otherwise I'll work on my fork.see my work so far herehttps://github.com/naturalog/BitShares/blob/master/doc/BitSharesBlockchainDesign.md
Conversely, I'll gladly do the merge if we want to work in my branch.https://github.com/nmushegian/BitShares/blob/spec/doc/spec.md
Hijack!I have ported what naturalog has written so far to markdown and put it on github ("spec" branch). I'm gonna be working on this / BTS explorer tonight and didn't have access to the repo. Also I added naturalog as a contributor (both "naturalog" and "ohadasor").https://github.com/nmushegian/BitShares/blob/spec/doc/spec.mdbitshare explorer bounty threadhttps://bitsharestalk.org/index.php?topic=1829.0;topicseenedit: bytemaster, since this is a separate branch, want to just pull it into the II/BitShares repo right now? edit 2: nvm then you need to grant repo permissions
Quote from: toast on December 29, 2013, 02:20:47 amAck. May I suggest using markdown instead of HTML? There are plenty render-md-as-html tools, and in the meantime we can have a readable format which github will render nicely for us.Sounds like a great idea, admits all requirements as can be seen here https://help.github.com/articles/github-flavored-markdown
Ack. May I suggest using markdown instead of HTML? There are plenty render-md-as-html tools, and in the meantime we can have a readable format which github will render nicely for us.
Interesting job. I'm starting to work on it.How do you imagine the document?Explaining in fluent English the classes and their relations, or more a reference-type document giving details on every class?Initial version can be found here https://github.com/naturalog/BitShares/blob/master/doc/BitSharesBlockchainDesign.html