Merge pull request #112 from demibrener/documentation

Documentation

.gitignore

@@ -2,3 +2,4 @@
 *.swo
 node_modules/
 build/
+.DS_Store/

docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = zeppelin-solidity
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file

docs/source/basictoken.rst

+BasicToken
+=============================================
+
+Simpler version of StandardToken, with no allowances
+
+balanceOf(address _owner) constant returns (uint balance)
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+Returns the token balance of the passed address.
+
+function transfer(address _to, uint _value) returns (bool success)
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+Transfers tokens from sender's account. Amount must not be greater than sender's balance.
\ No newline at end of file

docs/source/bounty.rst

+Bounty
+=============================================
+
+To create a bounty for your contract, inherit from the base `Bounty` contract and provide an implementation for ```deployContract()``` returning the new contract address.::
+
+	import {Bounty, Target} from "./zeppelin/Bounty.sol";
+	import "./YourContract.sol";
+
+	contract YourBounty is Bounty {
+	function deployContract() internal returns(address) {
+	return new YourContract()
+	  }
+	}
+
+
+Next, implement invariant logic into your smart contract.
+Your main contract should inherit from the Target class and implement the checkInvariant method. This is a function that should check everything your contract assumes to be true all the time. If this function returns false, it means your contract was broken in some way and is in an inconsistent state. This is what security researchers will try to acomplish when trying to get the bounty.
+
+At contracts/YourContract.sol::
+
+
+	import {Bounty, Target} from "./zeppelin/Bounty.sol";
+	contract YourContract is Target {
+	  function checkInvariant() returns(bool) {
+	    // Implement your logic to make sure that none of the invariants are broken.
+	  }
+	}
+
+Next, deploy your bounty contract along with your main contract to the network.
+
+At ```migrations/2_deploy_contracts.js```::
+
+	module.exports = function(deployer) {
+	  deployer.deploy(YourContract);
+	  deployer.deploy(YourBounty);
+	};
+
+Next, add a reward to the bounty contract
+
+After deploying the contract, send reward funds into the bounty contract.
+
+From ```truffle console```::
+
+	bounty = YourBounty.deployed();
+	address = 0xb9f68f96cde3b895cc9f6b14b856081b41cb96f1; // your account address
+	reward = 5; // reward to pay to a researcher who breaks your contract
+
+	web3.eth.sendTransaction({
+	  from: address,
+	  to: bounty.address,
+	  value: web3.toWei(reward, "ether")
+	})
+
+If researchers break the contract, they can claim their reward.
+
+For each researcher who wants to hack the contract and claims the reward, refer to our `Test <https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/test/Bounty.js/>`_ for the detail.
+
+Finally, if you manage to protect your contract from security researchers, you can reclaim the bounty funds. To end the bounty, kill the contract so that all the rewards go back to the owner.::
+
+	bounty.kill();

docs/source/claimable.rst

+Claimable
+=============================================
+
+Extension for the Ownable contract, where the ownership needs to be claimed
+
+transfer(address newOwner) onlyOwner
+""""""""""""""""""""""""""""""""""""""
+
+Sets the passed address as the pending owner.
+
+modifier onlyPendingOwner
+""""""""""""""""""""""""""""""""""""""
+
+Function only runs if called by pending owner.
+
+claimOwnership( ) onlyPendingOwner
+""""""""""""""""""""""""""""""""""""""
+
+Completes transfer of ownership by setting pending owner as the new owner.
+

docs/source/conf.py

+# -*- coding: utf-8 -*-
+#
+# zeppelin-solidity documentation build configuration file, created by
+# sphinx-quickstart on Tue Dec 13 11:35:05 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'zeppelin-solidity'
+copyright = u'2016, Smart Contract Solutions, Inc'
+author = u'Smart Contract Solutions, Inc'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.0.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+import sphinx_rtd_theme
+
+html_theme = "sphinx_rtd_theme"
+
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'zeppelin-soliditydoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'zeppelin-solidity.tex', u'zeppelin-solidity Documentation',
+     u'Zeppelin', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'zeppelin-solidity', u'zeppelin-solidity Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'zeppelin-solidity', u'zeppelin-solidity Documentation',
+     author, 'zeppelin-solidity', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/source/contract-security-patterns.rst

+Common Contract Security Patterns
+=============================================
+
+Zeppelin smart contracts are developed using industry standard contract security patterns and best practices. To learn more, please see `Onward with Ethereum Smart Contract Security <https://medium.com/zeppelin-blog/onward-with-ethereum-smart-contract-security-97a827e47702#.ybvzeyz0k/>`_.

docs/source/crowdsaletoken.rst

+CrowdsaleToken
+=============================================
+
+Simple ERC20 Token example, with crowdsale token creation.
+
+Inherits from contract StandardToken.
+
+createTokens(address recipient) payable
+"""""""""""""""""""""""""""""""""""""""""
+Creates tokens based on message value and credits to the recipient.
+
+getPrice() constant returns (uint result)
+"""""""""""""""""""""""""""""""""""""""""
+Returns the amount of tokens per 1 ether.
\ No newline at end of file

docs/source/developer-resources.rst

+Developer Resources
+=============================================
+
+Building a distributed application, protocol or organization with Zeppelin?
+
+Ask for help and follow progress at: https://zeppelin-slackin.herokuapp.com/
+
+Interested in contributing to Zeppelin?
+
+* Framework proposal and roadmap: https://medium.com/zeppelin-blog/zeppelin-framework-proposal-and-development-roadmap-fdfa9a3a32ab#.iain47pak
+* Issue tracker: https://github.com/OpenZeppelin/zeppelin-solidity/issues
+* Contribution guidelines: https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/CONTRIBUTING.md
\ No newline at end of file

docs/source/getting-started.rst

+Getting Started
+=============================================
+
+Zeppelin integrates with `Truffle <https://github.com/ConsenSys/truffle/>`_, an Ethereum development environment. Please install Truffle and initialize your project with ``truffle init``::
+
+	npm install -g truffle
+	mkdir myproject && cd myproject
+	truffle init
+
+To install the Zeppelin library, run::
+
+	npm i zeppelin-solidity
+
+After that, you'll get all the library's contracts in the contracts/zeppelin folder. You can use the contracts in the library like so::
+
+	import "./zeppelin/Ownable.sol";
+
+	contract MyContract is Ownable {
+	  ...
+	}
+
+.. epigraph::
+
+   NOTE: The current distribution channel is npm, which is not ideal. `We're looking into providing a better tool for code distribution <https://github.com/OpenZeppelin/zeppelin-solidity/issues/13/>`_ , and ideas are welcome.
+
+Truffle Beta Support
+""""""""""""""""""""""""
+We also support Truffle Beta npm integration. If you're using Truffle Beta, the contracts in ``node_modules`` will be enough, so feel free to delete the copies at your ``contracts`` folder. If you're using Truffle Beta, you can use Zeppelin contracts like so::
+
+	import "zeppelin-solidity/contracts/Ownable.sol";
+
+	contract MyContract is Ownable {
+	  ...
+	}
+
+For more info see the `Truffle Beta package management tutorial <http://truffleframework.com/tutorials/package-management/>`_.

docs/source/index.rst

+.. zeppelin-solidity documentation master file, created by
+   sphinx-quickstart on Tue Dec 13 11:35:05 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Zeppelin-Solidity
+=============================================
+
+Zeppelin is a library for writing secure Smart Contracts on Ethereum. 
+
+With Zeppelin, you can build distributed applications, protocols and organizations:
+
+* using :doc:`contract-security-patterns`
+* in the `Solidity language <https://solidity.readthedocs.io/en/develop/>`_.
+
+The code is open-source, and `available on github <https://github.com/OpenZeppelin/zeppelin-solidity>`_. 
+
+.. toctree::
+   :maxdepth: 2
+
+   getting-started
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Smart Contracts
+   
+   ownable
+   stoppable
+   killable
+   claimable
+   migrations
+   safemath
+   limitbalance
+   pullpayment
+   standardtoken
+   basictoken
+   crowdsaletoken
+   bounty
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developer Resources
+   
+   contract-security-patterns
+   developer-resources
+   license
\ No newline at end of file

docs/source/killable.rst

+Killable
+=============================================
+
+Base contract that can be killed by owner.
+
+Inherits from contract Ownable.
+
+kill( ) onlyOwner
+"""""""""""""""""""
+
+Destroys the contract and sends funds back to the owner.
\ No newline at end of file

docs/source/license.rst

+The MIT License (MIT)
+=============================================
+
+Copyright (c) 2016 Smart Contract Solutions, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, 
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to 
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file

docs/source/limitbalance.rst

+LimitBalance
+=============================================
+
+Base contract that provides mechanism for limiting the amount of funds a contract can hold.
+
+LimitBalance(unit _limit)
+""""""""""""""""""""""""""""
+Constructor takes an unisgned integer and sets it as the limit of funds this contract can hold.
+
+modifier limitedPayable()
+""""""""""""""""""""""""""""
+Throws an error if this contract's balance is already above the limit.
\ No newline at end of file

docs/source/migrations.rst

+Migrations
+=============================================
+
+Base contract that allows for a new instance of itself to be created at a different address.
+
+Inherits from contract Ownable.
+
+upgrade(address new_address) onlyOwner
+""""""""""""""""""""""""""""""""""""""""
+
+Creates a new instance of the contract at the passed address.
+
+setCompleted(uint completed) onlyOwner**
+""""""""""""""""""""""""""""""""""""""""
+
+Sets the last time that a migration was completed.
\ No newline at end of file

docs/source/ownable.rst

+Ownable
+=============================================
+
+Base contract with an owner.
+
+Ownable( )
+""""""""""""""""""""""""""""""""""""""
+Sets the address of the creator of the contract as the owner.
+
+modifier onlyOwner( )
+""""""""""""""""""""""""""""""""""""""
+Prevents function from running if it is called by anyone other than the owner.
+
+transfer(address newOwner) onlyOwner
+""""""""""""""""""""""""""""""""""""""
+Transfers ownership of the contract to the passed address.
\ No newline at end of file

docs/source/pullpayment.rst

+PullPayment
+=============================================
+
+Base contract supporting async send for pull payments. Inherit from this contract and use asyncSend instead of send.
+
+asyncSend(address dest, uint amount) internal
+"""""""""""""""""""""""""""""""""""""""""""""""
+Adds sent amount to available balance that payee can pull from this contract, called by payer.
+
+withdrawPayments( )
+"""""""""""""""""""""""""""""""""""""""""""""""
+Sends designated balance to payee calling the contract. Throws error if designated balance is 0, if contract does not hold enough funds ot pay the payee, or if the send transaction is not successful.
\ No newline at end of file

docs/source/safemath.rst

+SafeMath
+=============================================
+
+Provides functions of mathematical operations with safety checks.
+
+assert(bool assertion) internal
+"""""""""""""""""""""""""""""""""""""""""""""""""
+
+Throws an error if the passed result is false. Used in this contract by checking mathematical expressions.
+
+safeMul(uint a, uint b) internal returns (uint)
+"""""""""""""""""""""""""""""""""""""""""""""""""
+
+Multiplies two unisgned integers. Asserts that dividing the product by the non-zero multiplicand results in the multiplier.
+
+safeSub(uint a, unit b) internal returns (uint)
+"""""""""""""""""""""""""""""""""""""""""""""""""
+
+Checks that b is not greater than a before subtracting.
+
+safeAdd(unit a, unit b) internal returns (uint)
+"""""""""""""""""""""""""""""""""""""""""""""""""
+
+Checks that the result is greater than both a and b.
\ No newline at end of file

docs/source/standardtoken.rst

+StandardToken
+=============================================
+
+Based on code by FirstBlood: `Link FirstBloodToken.sol <https://github.com/Firstbloodio/token/blob/master/smart_contract/FirstBloodToken.sol/>`_
+
+Inherits from contract SafeMath. Implementation of abstract contract ERC20 (see https://github.com/ethereum/EIPs/issues/20)
+
+approve(address _spender, uint _value) returns (bool success)
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+Sets the amount of the sender's token balance that the passed address is approved to use.
+
+allowance(address _owner, address _spender) constant returns (uint remaining)
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+Returns the approved amount of the owner's balance that the spender can use.
+
+balanceOf(address _owner) constant returns (uint balance)
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+Returns the token balance of the passed address.
+
+transferFrom(address _from, address _to, uint _value) returns (bool success)
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+Transfers tokens from an account that the sender is approved to transfer from. Amount must not be greater than the approved amount or the account's balance.
+
+function transfer(address _to, uint _value) returns (bool success)
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+Transfers tokens from sender's account. Amount must not be greater than sender's balance.
\ No newline at end of file

docs/source/stoppable.rst

+Stoppable
+=============================================
+
+Base contract that provides an emergency stop mechanism.
+
+Inherits from contract Ownable.
+
+emergencyStop( ) external onlyOwner
+"""""""""""""""""""""""""""""""""""""
+
+Triggers the stop mechanism on the contract. After this function is called (by the owner of the contract), any function with modifier stopInEmergency will not run.
+
+modifier stopInEmergency
+"""""""""""""""""""""""""""""""""""""
+
+Prevents function from running if stop mechanism is activated.
+
+modifier onlyInEmergency
+"""""""""""""""""""""""""""""""""""""
+
+Only runs if stop mechanism is activated.
+
+release( ) external onlyOwner onlyInEmergency
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+Deactivates the stop mechanism.
\ No newline at end of file