Whitepaper - Ethereum Classic With Cover

More documents

Recommendations

Info

Ethereum Classic Documentation, Release 0.1 of the receipt trie is part of the block header alongside the roots of state and state-trie. In a broad sense from the external perspective receipts are part of the Ethereum system state except that they are not readable contracts internally. 1.10 The Classic Documentation Initiative 1.10.1 Purpose and Audience This guide should serve to be an entry level for all Ethereum users and developers. The goal is to create documentation with information, short tutorials, and examples that will cover all of the basic and intermediate functionality of using Ethereum to interact with dapps or develop a dapp. Any information that is overly specific, technical, or not necessary to accomplish the documentation’s goal will remain on the Ethereum Github Wiki. It may be referenced in this guide if necessary. Although much of the information will be similar between the Frontier Guide and the Homestead Guide, efforts need to be made to make sure the information ported over is still accurate. This document is client agnostic and examples and tutorials may be based on any client that the author decides to write on, as long as a distinction is made as to what client is being used in the examples/tutorials. Although overly specific and technical documentation will not be included in the first iterations of this guide, community use and popularity of this guide will dictate future decisions to move Github wiki documentation to this format. Examples of overly specific and technical documentation include: • ETHash, CASPER, ABI, RLP, or other technical specs. • Full API specs for protocols. Caveat: If an example, information, or tutorial needs to reference API calls for a client or interface in order to fulfill its example it is acceptable to reference the specific call. Be sure to make a reference where the user can find remaining pieces of the specific documentation that may be on the GitHub Wiki. 1.10.2 Resources for Exemplary Documentation Here are some examples of previous Ethereum documentation + good examples of documentation. • Solidity Docs - https://ethereum.github.io/solidity/docs/home/ • Frontier Guide - https://ethereum.gitbooks.io/frontier-guide/content/ • Gav’s TurboEthereum Guide - https://gavofyork.gitbooks.io/turboethereum/content/ • Ancient EthereumBuilder’s Guide - https://ethereumbuilders.gitbooks.io/guide/content/en/index.html • Other Ethereum Links: https://souptacular.gitbooks.io/ethereum-tutorials-and-tips-byhudson/content/giant_ethereum_resource_list.html • Django Docs - https://docs.djangoproject.com/en/1.9/ 1.10.3 Restructured Text Markup, Sphinx • Best Cheat Sheet - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst • Quick Reference - http://docutils.sourceforge.net/docs/user/rst/quickref.html • Official Cheat Sheet - http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt -> http://docutils.sourceforge.net/docs/user/rst/cheatsheet.html 1.10. The Classic Documentation Initiative 123
Ethereum Classic Documentation, Release 0.1 • RST Primer http://sphinx-doc.org/rest.html • http://sphinx-doc.org/markup/inline.html 1.10.4 Compilation and Deployment We use make with the autogenerated read-the-docs Makefile to build the doc. git clone https://github.com/ethereum/homestead-guide cd homestead-guide make html 1.10.5 Processing Tips Fix section delimiter lines (always use 80-long ones to have correct length, unless the title is greater than 80 chars in length) for f in `ls source/*/*.rst`; do cat $f|perl -pe 's/\=+$/========================================= for f in `ls source/*/*.rst`; do cat $f|perl -pe 's/\*+$/***************************************** for f in `ls source/*/*.rst`; do cat $f|perl -pe 's/\-+$/----------------------------------------- for f in `ls source/*/*.rst`; do cat $f|perl -pe 's/\++$/+++++++++++++++++++++++++++++++++++++++++ for f in `ls source/*/*.rst`; do cat $f|perl -pe 's/\#+$/######################################### 1.10.6 Referencing Old Documentation old-docs-for-reference folder has all of the Frontier Gitbook and Ethereum Wiki doc. Feel free to copy/paste information from those documents that is still relevant. 1.10.7 Migrate and Convert Old Wiki Content Using Pandoc If you still want to clone the absolute latest Ethereum Wiki and Frontier Guide docs: git clone git@github.com:ethereum/go-ethereum.wiki.git git clone git@github.com:ethereum/wiki.wiki.git mkdir main-wiki.rst mkdir go-ethereum-wiki.rst for f in `ls wiki.wiki/*.md`; do pandoc $f -o main-wiki.rst/`basename $f .md`.rst; done for f in `ls go-ethereum.wiki/*.md`; do pandoc $f -o go-ethereum-wiki.rst/`basename $f .md`.rst; d 124 Chapter 1. Contents
Page 1 and 2:
ETHEREUM CLASSIC WHITEPAPER
Page 4 and 5:
Contents 1 Contents 3 1.1 Introduct
Page 6 and 7:
Using geth . . . . . . . . . . . .
Page 8 and 9:
Ethereum Classic Documentation, Rel
Page 10 and 11:
CHAPTER 1 Contents 1.1 Introduction
Page 12 and 13:
Page 14 and 15:
Page 16 and 17:
Page 18 and 19:
Page 20 and 21:
Page 22 and 23:
Page 24 and 25:
Page 26 and 27:
Page 28 and 29:
Page 30 and 31:
Page 32 and 33:
Page 34 and 35:
Page 36 and 37:
Page 38 and 39:
Page 40 and 41:
Page 42 and 43:
Page 44 and 45:
Page 46 and 47:
Page 48 and 49:
Page 50 and 51:
Page 52 and 53:
Page 54 and 55:
Page 56 and 57:
Page 58 and 59:
Page 60 and 61:
Page 62 and 63:
Page 64 and 65:
Page 66 and 67:
Page 68 and 69:
Page 70 and 71:
Page 72 and 73:
Page 74 and 75:
Page 76 and 77:
Page 78 and 79:
Page 80 and 81: Ethereum Classic Documentation, Rel
Page 132 and 133: CHAPTER 2 Improve the Documentation
Page 134: Index A abiDefinition, 82 C code, 8
show all

Whitepaper - Ethereum Classic With Cover

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?