ignore /docs/build/ dir
This commit is contained in:
Rodolphe Marques
parent
3f531e5976
commit
20347dff1f
|
|
@ -0,0 +1 @@
|
|||
docs/build/
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -1,4 +0,0 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 8dc1a9ea9783726b3464255c38fc8f81
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
|
@ -1,143 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Hashes — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<p>Cryptographic algorithms and python implementations that we use.</p>
|
||||
<p>The implementations that we have chosen for now are just for fast prototyping. Some of them are pure python
|
||||
implementations which may be slow. As future work we should look at other alternatives</p>
|
||||
<div class="section" id="hashes">
|
||||
<span id="hashes"></span><h1>Hashes<a class="headerlink" href="#hashes" title="Permalink to this headline">¶</a></h1>
|
||||
<p>For hashing we are using the sha3-256 algorithm and <a class="reference external" href="https://bitbucket.org/tiran/pykeccak">pysha3</a> as the python
|
||||
implementation. We store the hex encoded hash in the bigchain.</p>
|
||||
<div class="section" id="example">
|
||||
<span id="example"></span><h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">hashlib</span>
|
||||
<span class="c1"># monkey patch hashlib with sha3 functions</span>
|
||||
<span class="kn">import</span> <span class="nn">sha3</span>
|
||||
|
||||
<span class="n">data</span> <span class="o">=</span> <span class="s2">"message"</span>
|
||||
<span class="n">tx_hash</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha3_256</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="keys">
|
||||
<span id="keys"></span><h1>Keys<a class="headerlink" href="#keys" title="Permalink to this headline">¶</a></h1>
|
||||
<p>For signing and veryfing signatures we are using the ECDSA with 192bit key lengths and
|
||||
<a class="reference external" href="https://github.com/warner/python-ecdsa">python-ecdsa</a> as the python implementation.</p>
|
||||
<p>The public-key or verification key are converted to string and hex encoded before storing them to the blockchain</p>
|
||||
<div class="section" id="example">
|
||||
<span id="id1"></span><h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">binascii</span>
|
||||
<span class="kn">from</span> <span class="nn">ecdsa</span> <span class="kn">import</span> <span class="n">SigningKey</span>
|
||||
|
||||
<span class="c1"># generate signing key in hex encoded form</span>
|
||||
<span class="n">sk</span> <span class="o">=</span> <span class="n">SigningKey</span><span class="o">.</span><span class="n">generate</span><span class="p">()</span>
|
||||
<span class="n">sk_hex</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">sk</span><span class="o">.</span><span class="n">to_string</span><span class="p">())</span>
|
||||
|
||||
<span class="c1"># get signing key from hex</span>
|
||||
<span class="n">sk</span> <span class="o">=</span> <span class="n">SigningKey</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="n">sk_hex</span><span class="p">))</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Hashes</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#keys">Keys</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/Cryptography.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/Cryptography.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Why do we use blocks and don’t just create the chain with transactions — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="why-do-we-use-blocks-and-don-t-just-create-the-chain-with-transactions">
|
||||
<span id="why-do-we-use-blocks-and-don-t-just-create-the-chain-with-transactions"></span><h1>Why do we use blocks and don’t just create the chain with transactions<a class="headerlink" href="#why-do-we-use-blocks-and-don-t-just-create-the-chain-with-transactions" title="Permalink to this headline">¶</a></h1>
|
||||
<p>With distributed data stores there is no guarantees in the order in which transactions will be commited to the
|
||||
database. Witouth knowing what is previous transactions to be commited to the database we cannot include its hash in
|
||||
the current transaction to build the chain.</p>
|
||||
<p>To solve this problem we decided to use blocks and create the chain with the blocks.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/FAQ.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/FAQ.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,201 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Transaction Model — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="transaction-model">
|
||||
<span id="transaction-model"></span><h1>Transaction Model<a class="headerlink" href="#transaction-model" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="highlight-python"><div class="highlight"><pre>{
|
||||
"id": "<sha3 hash>",
|
||||
"transaction": {
|
||||
"current_owner": "<pub-key>",
|
||||
"new_owner": "<pub-key>",
|
||||
"input": "<sha3 hash>",
|
||||
"operation": "<string>",
|
||||
"timestamp": "<rethinkdb timestamp>",
|
||||
"data": {
|
||||
"hash": "<sha3 hash>",
|
||||
...
|
||||
}
|
||||
},
|
||||
"signature": "<ECDSA signature of the transaction>"
|
||||
}
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="explanation">
|
||||
<span id="explanation"></span><h2>Explanation<a class="headerlink" href="#explanation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>A transaction is an operation between the <code class="docutils literal"><span class="pre">current_owner</span></code> and the <code class="docutils literal"><span class="pre">new_owner</span></code> over the digital content described by
|
||||
<code class="docutils literal"><span class="pre">hash</span></code>. For example if could be a transfer of ownership of the digital content <code class="docutils literal"><span class="pre">hash</span></code></p>
|
||||
<ul class="simple">
|
||||
<li><code class="docutils literal"><span class="pre">id</span></code>: sha3 hash of the transaction and rethinkdb primary key. By using the hash of the transaction of the
|
||||
primary key we eliminate the problem of duplicated transactions, if for some reason two nodes decide to create the
|
||||
same transaction</li>
|
||||
<li><code class="docutils literal"><span class="pre">current_owner</span></code>: Public key of the current owner of the digital content with hash <code class="docutils literal"><span class="pre">hash</span></code></li>
|
||||
<li><code class="docutils literal"><span class="pre">new_owner</span></code>: Public key of the new owner of the digital content with hash <code class="docutils literal"><span class="pre">hash</span></code></li>
|
||||
<li><code class="docutils literal"><span class="pre">input</span></code>: 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.</li>
|
||||
<li><code class="docutils literal"><span class="pre">operation</span></code>: String representation of the operation being performed (REGISTER, TRANSFER, ...) this will define how
|
||||
the transactions should be validated</li>
|
||||
<li><code class="docutils literal"><span class="pre">timestamp</span></code>: Time of creation of the transaction in UTC</li>
|
||||
<li><code class="docutils literal"><span class="pre">data</span></code>: Json object describing the asset (digital content). It contains at least the field <code class="docutils literal"><span class="pre">hash</span></code> which is a
|
||||
sha3 hash of the digital content.</li>
|
||||
<li><code class="docutils literal"><span class="pre">signature</span></code>: ECDSA signature of the transaction with the <code class="docutils literal"><span class="pre">current_owner</span></code> private key</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="block-model">
|
||||
<span id="block-model"></span><h1>Block Model<a class="headerlink" href="#block-model" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="highlight-json"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"<sha3 hash of the list of transactions + timestamp + nodes_pubkeys>"</span><span class="p">,</span>
|
||||
<span class="nt">"block"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"<RethinkDB timestamp>"</span><span class="p">,</span>
|
||||
<span class="nt">"transactions"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"<list of transactions>"</span><span class="p">],</span>
|
||||
<span class="nt">"node_pubkey"</span><span class="p">:</span> <span class="s2">"<public key of the node creating the block>"</span><span class="p">,</span>
|
||||
<span class="nt">"voters"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"<list of federation nodes pulic keys>"</span><span class="p">]</span>
|
||||
<span class="p">},</span>
|
||||
<span class="nt">"signature"</span><span class="p">:</span> <span class="s2">"<signature of the block>"</span><span class="p">,</span>
|
||||
<span class="nt">"votes"</span><span class="p">:</span> <span class="p">[]</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="explanation">
|
||||
<span id="id1"></span><h2>Explanation<a class="headerlink" href="#explanation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Still to be defined when new blocks are created (after x number of transactions, or after x amount of seconds,
|
||||
or both).
|
||||
A block contains a group of transactions and includes the hash of the hash of the previous block to build the chain.</p>
|
||||
<ul class="simple">
|
||||
<li><code class="docutils literal"><span class="pre">id</span></code>: sha3 hash of the current block. This is also a rethinkdb primary key, this way we make sure that all blocks are unique.</li>
|
||||
<li><code class="docutils literal"><span class="pre">block</span></code>: The actual block<ul>
|
||||
<li><code class="docutils literal"><span class="pre">timestamp</span></code>: timestamp when the block was created</li>
|
||||
<li><code class="docutils literal"><span class="pre">transactions</span></code>: the list of transactions included in the block</li>
|
||||
<li><code class="docutils literal"><span class="pre">node_pubkey</span></code>: the public key of the node that create the block</li>
|
||||
<li><code class="docutils literal"><span class="pre">voters</span></code>: list public keys of the federation nodes. Since the size of the
|
||||
federation may change over time this will tell us how many nodes existed
|
||||
in the federation when the block was created so that in a later point in
|
||||
time we can check that the block received the correct number of votes.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code class="docutils literal"><span class="pre">signature</span></code>: Signature of the block by the node that created the block</li>
|
||||
<li><code class="docutils literal"><span class="pre">votes</span></code>: Initially an empty list. Nodes in the voters list will append to it
|
||||
has they vote on the block</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="vote-model">
|
||||
<span id="vote-model"></span><h1>Vote Model<a class="headerlink" href="#vote-model" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This is the structure that each node will append to the block <code class="docutils literal"><span class="pre">votes</span></code> list.</p>
|
||||
<div class="highlight-json"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="nt">"node_pubkey"</span><span class="p">:</span> <span class="s2">"<the pubkey of the voting node>"</span><span class="p">,</span>
|
||||
<span class="nt">"vote"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="nt">"voting_for_block"</span><span class="p">:</span> <span class="s2">"<id of the block the node is voting for>"</span><span class="p">,</span>
|
||||
<span class="nt">"previous_block"</span><span class="p">:</span> <span class="s2">"<id of the block previous to this one>"</span><span class="p">,</span>
|
||||
<span class="nt">"is_block_valid"</span><span class="p">:</span> <span class="s2">"<true|false>"</span><span class="p">,</span>
|
||||
<span class="nt">"invalid_reason"</span><span class="p">:</span> <span class="s2">"<None|DOUBLE_SPEND|TRANSACTIONS_HASH_MISMATCH|NODES_PUBKEYS_MISMATCH"</span><span class="p">,</span>
|
||||
<span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"<rethinkdb timestamp of the voting action>"</span>
|
||||
<span class="p">},</span>
|
||||
<span class="nt">"signature"</span><span class="p">:</span> <span class="s2">"<ECDSA signature of vote block>"</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Transaction Model</a><ul>
|
||||
<li><a class="reference internal" href="#explanation">Explanation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#block-model">Block Model</a><ul>
|
||||
<li><a class="reference internal" href="#explanation">Explanation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#vote-model">Vote Model</a></li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/Models.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/Models.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,303 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>RethinkDB Benchamarks — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="rethinkdb-benchamarks">
|
||||
<span id="rethinkdb-benchamarks"></span><h1>RethinkDB Benchamarks<a class="headerlink" href="#rethinkdb-benchamarks" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="goals">
|
||||
<span id="goals"></span><h2>Goals<a class="headerlink" href="#goals" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The goal is to test rethinkdb scalability properties, understand its limits and
|
||||
see if we can reach a speed of 1M transactions per second.</p>
|
||||
</div>
|
||||
<div class="section" id="terminology">
|
||||
<span id="terminology"></span><h2>Terminology<a class="headerlink" href="#terminology" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="settings">
|
||||
<span id="settings"></span><h3>Settings<a class="headerlink" href="#settings" title="Permalink to this headline">¶</a></h3>
|
||||
<p>To test the writing performance of rethinkdb we have a process that inserts a
|
||||
block in the database in an infinite loop</p>
|
||||
<p>The block is a valid block with small transactions (transactions without any
|
||||
payload). The entire block has around 900KB</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
|
||||
<span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="n">table</span><span class="p">)</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">(</span><span class="n">BLOCK_SERIALIZED</span><span class="p">),</span> <span class="n">durability</span><span class="o">=</span><span class="s1">'soft'</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>In <code class="docutils literal"><span class="pre">hard</span></code> durability mode, writes are committed to disk before acknowledgments
|
||||
are sent; in <code class="docutils literal"><span class="pre">soft</span></code> mode, writes are acknowledged immediately after being stored
|
||||
in memory.</p>
|
||||
<p>This means that the insert will block until rethinkdb acknowledges that the data
|
||||
was cached. In each server we can start multiple process.</p>
|
||||
</div>
|
||||
<div class="section" id="write-units">
|
||||
<span id="write-units"></span><h3>Write units<a class="headerlink" href="#write-units" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Lets define <code class="docutils literal"><span class="pre">1</span> <span class="pre">write</span> <span class="pre">unit</span></code> as being 1 process. For example in a 32 node cluster
|
||||
with each node running 2 processes we would have <code class="docutils literal"><span class="pre">64</span> <span class="pre">writes</span></code>. This will make it
|
||||
easier to compare different tests.</p>
|
||||
</div>
|
||||
<div class="section" id="sharding">
|
||||
<span id="sharding"></span><h3>Sharding<a class="headerlink" href="#sharding" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Sharding in distributed datastores means partitioning a table so that the data
|
||||
can be evenly distributed between all nodes in the cluster. In rethinkdb and
|
||||
most distributed datastores there is a maximum limit of 32 shards per table.</p>
|
||||
<p>In rethinkdb a <code class="docutils literal"><span class="pre">shard</span></code> is also called a <code class="docutils literal"><span class="pre">primary</span> <span class="pre">replica</span></code>, since by default the
|
||||
replication factor is 1. Increasing the replication factor produces <code class="docutils literal"><span class="pre">secondary</span> <span class="pre">replicas</span></code> that are used for data redundancy (if a node holding a primary replica
|
||||
goes down another node holding a secondary replica of the same data can step up
|
||||
and become the primary replica)</p>
|
||||
<p>For these tests we are using 32 core ec2 instances with SSD storage and 10Gbps
|
||||
network connections (<code class="docutils literal"><span class="pre">c3.8xlarge</span></code>). For the tests we used either 32 or 64 node
|
||||
clusters all running on the same aws region.</p>
|
||||
<p>These tests show rethinkdb performance and what we can expect from the database.
|
||||
This does not show the performance of the bigchain</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="tests">
|
||||
<span id="tests"></span><h2>Tests<a class="headerlink" href="#tests" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="test-1">
|
||||
<span id="test-1"></span><h3>Test 1<a class="headerlink" href="#test-1" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 32</li>
|
||||
<li><strong>number of processes</strong>: 2 processes per node</li>
|
||||
<li><strong>write units</strong>: 32 x 2 = 64 writes</li>
|
||||
<li><strong>output</strong>: stable 1K writes per second</li>
|
||||
</ul>
|
||||
<p>This was the most successful test. We are able to reach a stable output of 1K
|
||||
blocks per second. The load on the machines is stable and the IO is at an
|
||||
average of 50-60 %.</p>
|
||||
<p>Other tests have shown that increasing the number write units per machine can
|
||||
lead to a stable performance up to 1.5K writes per second but the load on the
|
||||
nodes would increase until the node would eventually fail. This means that we
|
||||
are able to handle bursts for a short amount of time (10-20 min).</p>
|
||||
<p>This test can be used has a baseline for the future in where 64 writes equal 1K
|
||||
transactions per second. Or that each write unit produces an output of
|
||||
<code class="docutils literal"><span class="pre">1000/64</span></code> writes per second, approximately 16 writes per second.</p>
|
||||
</div>
|
||||
<div class="section" id="test-2">
|
||||
<span id="test-2"></span><h3>Test 2<a class="headerlink" href="#test-2" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 32</li>
|
||||
<li><strong>number of processes</strong>:<ul>
|
||||
<li>16 nodes running 2 processes</li>
|
||||
<li>16 nodes running 3 processes</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>write units</strong>: 16 x 3 + 16 x 2 = 80 writes</li>
|
||||
<li><strong>expected output</strong>: 1250 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1.2K writes per second</li>
|
||||
</ul>
|
||||
<p>Increasing a bit the number of write units shows an increase in output close to
|
||||
the expected value but in this case the IO around 90 % close to the limit that
|
||||
the machine can handle.</p>
|
||||
</div>
|
||||
<div class="section" id="test-3">
|
||||
<span id="test-3"></span><h3>Test 3<a class="headerlink" href="#test-3" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 32</li>
|
||||
<li><strong>number of processes</strong>:<ul>
|
||||
<li>16 nodes running 2 processes</li>
|
||||
<li>16 nodes running 4 processes</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>write units</strong>: 16 x 4 + 16 x 2 = 96 writes</li>
|
||||
<li><strong>expected output</strong>: 1500 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1.4K writes per second</li>
|
||||
</ul>
|
||||
<p>These test produces results similar to previous one. The reason why we don’t
|
||||
reach the expected output may be because rethinkdb needs time to cache results
|
||||
and at some point increasing the number of write units will not result in an
|
||||
higher output. Another problem is that as the rethinkdb cache fills (because the
|
||||
rethinkdb is not able to flush the data to disk fast enough due to IO
|
||||
limitations) the performance will decrease because the processes will take more
|
||||
time inserting blocks.</p>
|
||||
</div>
|
||||
<div class="section" id="test-4">
|
||||
<span id="test-4"></span><h3>Test 4<a class="headerlink" href="#test-4" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 64</li>
|
||||
<li><strong>number of processes</strong>: 1 process per node</li>
|
||||
<li><strong>write units</strong>: 64 x 1 = 64 writes</li>
|
||||
<li><strong>expected output</strong>: 1000 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1K writes per second</li>
|
||||
</ul>
|
||||
<p>In this case we are increasing the number of nodes in the cluster by 2x. This
|
||||
won’t have an impact in the write performance because the maximum amount of
|
||||
shards per table in rethinkdb is 32 (rethinkdb will probably increase this limit
|
||||
in the future). What this provides is more CPU power (and storage for replicas,
|
||||
more about replication in the next section). We just halved the amount write
|
||||
units per node maintaining the same output. The IO in the nodes holding the
|
||||
primary replica is the same has test 1.</p>
|
||||
</div>
|
||||
<div class="section" id="test-5">
|
||||
<span id="test-5"></span><h3>Test 5<a class="headerlink" href="#test-5" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 64</li>
|
||||
<li><strong>number of processes</strong>: 2 process per node</li>
|
||||
<li><strong>write units</strong>: 64 x 2 = 128 writes</li>
|
||||
<li><strong>expected output</strong>: 2000 writes per second</li>
|
||||
<li><strong>output</strong>: unstable 2K (peak) writes per second</li>
|
||||
</ul>
|
||||
<p>In this case we are doubling the amount of write units. We are able to reach the
|
||||
expected output but the output performance is unstable due to the fact that we
|
||||
reached the IO limit on the machines.</p>
|
||||
</div>
|
||||
<div class="section" id="test-6">
|
||||
<span id="test-6"></span><h3>Test 6<a class="headerlink" href="#test-6" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 64</li>
|
||||
<li><strong>number of processes</strong>:<ul>
|
||||
<li>32 nodes running 1 processes</li>
|
||||
<li>32 nodes running 2 processes</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>write units</strong>: 32 x 2 + 32 x 1 = 96 writes</li>
|
||||
<li><strong>expected output</strong>: 1500 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1.5K writes per second</li>
|
||||
</ul>
|
||||
<p>This test is similar to Test 3. The only difference is that now the write units
|
||||
are distributed between 64 nodes meaning that each node is writing to its local
|
||||
cache and we don’t overload the cache of the nodes like we did with Test 3. This
|
||||
is another advantage of adding more nodes beyond 32.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="testing-replication">
|
||||
<span id="testing-replication"></span><h2>Testing replication<a class="headerlink" href="#testing-replication" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Replication is used for data redundancy. In rethinkdb we are able to specify the
|
||||
number of shards and replicas per table. Data in secondary replicas is no
|
||||
directly used, its just a mirror of a primary replica and used in case the node
|
||||
holding the primary replica fails.</p>
|
||||
<p>Rethinkdb does a good job trying to distribute data evenly between nodes. We ran
|
||||
some tests to check this.</p>
|
||||
<p>Note that by increasing the number of replicas we also increase the number of
|
||||
writes in the cluster. For a replication factor of 2 we double the amount of
|
||||
writes on the cluster, with a replication factor of 3 we triple the amount of
|
||||
writes and so on.</p>
|
||||
<p>With 64 nodes and since we can only have 32 shards we have 32 nodes holding
|
||||
shards (primary replicas)</p>
|
||||
<p>With a replication factor of 2 we will have 64 replicas (32 primary replicas and
|
||||
32 secondary replicas). Since we already have 32 nodes holding the 32
|
||||
shards/primary replicas rethinkdb uses the other 32 nodes to hold the secondary
|
||||
replicas. So in a 64 node cluster with 32 shards and a replication factor of 2,
|
||||
32 nodes will be holding the primary replicas and the other 32 nodes will be holding
|
||||
the secondary replicas.</p>
|
||||
<p>With this setup if we run Test 4 now that we have a replication factor of 2 we
|
||||
will have twice the amount of writes but a nice result is that the IO in the
|
||||
nodes holding the primary replicas does not increase when compared to Test 4
|
||||
because all of the excess writing is now being done the 32 nodes holding the
|
||||
secondary replicas.</p>
|
||||
<p>Another fact about replication. If I have a 64 node cluster and create a table
|
||||
with 32 shards, 32 nodes will be holding primary replicas and the other nodes do
|
||||
not hold any data. If I create another table with 32 shards rethinkdb will
|
||||
create the shards in the nodes that where not holding any data, evenly
|
||||
distributing the data.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">RethinkDB Benchamarks</a><ul>
|
||||
<li><a class="reference internal" href="#goals">Goals</a></li>
|
||||
<li><a class="reference internal" href="#terminology">Terminology</a><ul>
|
||||
<li><a class="reference internal" href="#settings">Settings</a></li>
|
||||
<li><a class="reference internal" href="#write-units">Write units</a></li>
|
||||
<li><a class="reference internal" href="#sharding">Sharding</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#tests">Tests</a><ul>
|
||||
<li><a class="reference internal" href="#test-1">Test 1</a></li>
|
||||
<li><a class="reference internal" href="#test-2">Test 2</a></li>
|
||||
<li><a class="reference internal" href="#test-3">Test 3</a></li>
|
||||
<li><a class="reference internal" href="#test-4">Test 4</a></li>
|
||||
<li><a class="reference internal" href="#test-5">Test 5</a></li>
|
||||
<li><a class="reference internal" href="#test-6">Test 6</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#testing-replication">Testing replication</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/Rethinkdb-benchmarks.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/Rethinkdb-benchmarks.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,168 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Example — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<p>We need to clearly define how to serialize a json object to calculate the hash.</p>
|
||||
<p>The serialization should produce the same byte output independently of the architecture running the software. If
|
||||
there are diferences in the serialization hash validations will fail altough the transaction is correct</p>
|
||||
<div class="section" id="example">
|
||||
<span id="example"></span><h1>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="n">a</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">expr</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span><span class="o">.</span><span class="n">to_json</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">b</span><span class="o">.</span><span class="n">connection</span><span class="p">)</span>
|
||||
<span class="s1">u'{"a":1}'</span>
|
||||
|
||||
<span class="n">b</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
|
||||
<span class="s1">'{"a": 1}'</span>
|
||||
|
||||
<span class="n">a</span> <span class="o">==</span> <span class="n">b</span>
|
||||
<span class="bp">False</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>We should provide the serialization and deserialization so that the following is always true.</p>
|
||||
</div>
|
||||
<div class="section" id="example">
|
||||
<span id="id1"></span><h1>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="n">deserialize</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">data</span><span class="p">))</span> <span class="o">==</span> <span class="n">data</span>
|
||||
<span class="bp">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="standard-serialization-for-the-bigchain">
|
||||
<span id="standard-serialization-for-the-bigchain"></span><h1>Standard serialization for the bigchain<a class="headerlink" href="#standard-serialization-for-the-bigchain" title="Permalink to this headline">¶</a></h1>
|
||||
<p>After looking at this further I think that the python json module is still the best bet because it
|
||||
complies with the RFC. We can specify the encoding, separators used and enforce it to order by the keys to
|
||||
make sure that we obtain maximum interopelability.</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">json</span>
|
||||
|
||||
<span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">skipkeys</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">ensure_ascii</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span>
|
||||
<span class="n">separators</span><span class="o">=</span><span class="p">(</span><span class="s1">','</span><span class="p">,</span> <span class="s1">':'</span><span class="p">),</span> <span class="n">sort_keys</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><code class="docutils literal"><span class="pre">skipkeys</span></code>: With skipkeys <code class="docutils literal"><span class="pre">False</span></code> if the provided keys are not a string the serialization will fail. This way we
|
||||
enforce all keys to be strings</li>
|
||||
<li><code class="docutils literal"><span class="pre">ensure_ascii</span></code>: The RFC recommends <code class="docutils literal"><span class="pre">utf-8</span></code> for maximum interoperability. By setting ensure_ascii to <code class="docutils literal"><span class="pre">False</span></code> we
|
||||
allow unicode characters and force the encoding to <code class="docutils literal"><span class="pre">utf-8</span></code>.</li>
|
||||
<li><code class="docutils literal"><span class="pre">separators</span></code>: We need to define a standard separator to use in the serialization. We did not do this different
|
||||
implementations could use different separators for serialization resulting in a still valid transaction but with
|
||||
a different hash e. g. an extra whitespace introduced in the serialization would not still create a valid json object
|
||||
but the hash would be different</li>
|
||||
</ul>
|
||||
<div class="section" id="example">
|
||||
<span id="id2"></span><h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Everytime we need to perform some operation on the data like calculating the hash or signing/verifying the transaction
|
||||
we need to use the previous criteria to serialize the data and then use the <code class="docutils literal"><span class="pre">byte</span></code> representation of the serialized
|
||||
data (if we threat the data as bytes we eliminate possible enconding errors e.g. unicode characters)</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># calculate the hash of a transaction</span>
|
||||
<span class="c1"># the transaction is a dictionary</span>
|
||||
<span class="n">tx_serialized</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">tx</span><span class="p">))</span>
|
||||
<span class="n">tx_hash</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha3_256</span><span class="p">(</span><span class="n">tx_serialized</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
|
||||
|
||||
<span class="c1"># signing a transaction</span>
|
||||
<span class="n">tx_serialized</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">tx</span><span class="p">))</span>
|
||||
<span class="n">signature</span> <span class="o">=</span> <span class="n">sk</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">tx_serialized</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># verify signature</span>
|
||||
<span class="n">tx_serialized</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">tx</span><span class="p">))</span>
|
||||
<span class="n">vk</span><span class="o">.</span><span class="n">verify</span><span class="p">(</span><span class="n">signature</span><span class="p">,</span> <span class="n">tx_serialized</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Example</a></li>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
<li><a class="reference internal" href="#standard-serialization-for-the-bigchain">Standard serialization for the bigchain</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/Serialization.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/Serialization.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,119 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>bigspool — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<p>Here we define the components needed for the software implementation of the prototype.</p>
|
||||
<div class="section" id="bigspool">
|
||||
<span id="bigspool"></span><h1>bigspool<a class="headerlink" href="#bigspool" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Bigchain implementation of the spool protocol</p>
|
||||
</div>
|
||||
<div class="section" id="bigchain">
|
||||
<span id="bigchain"></span><h1>bigchain<a class="headerlink" href="#bigchain" title="Permalink to this headline">¶</a></h1>
|
||||
<p>API to create, read, and push transactions to the bigchain</p>
|
||||
</div>
|
||||
<div class="section" id="validator">
|
||||
<span id="validator"></span><h1>validator<a class="headerlink" href="#validator" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Transaction validator. Decides which transactions to include in the bigchain. Each node in the federation will be
|
||||
running this code and the a transaction will be valid as long as more then half the nodes decided that the transaction
|
||||
is valid</p>
|
||||
</div>
|
||||
<div class="section" id="processor">
|
||||
<span id="processor"></span><h1>processor<a class="headerlink" href="#processor" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Creates the blocks from the transactions and cleans the backlog.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">bigspool</a></li>
|
||||
<li><a class="reference internal" href="#bigchain">bigchain</a></li>
|
||||
<li><a class="reference internal" href="#validator">validator</a></li>
|
||||
<li><a class="reference internal" href="#processor">processor</a></li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/Software-Architecture.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/Software-Architecture.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,114 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Generic Validation — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="generic-validation">
|
||||
<span id="generic-validation"></span><h1>Generic Validation<a class="headerlink" href="#generic-validation" title="Permalink to this headline">¶</a></h1>
|
||||
<ol class="simple">
|
||||
<li>Query the bigchain and check if <code class="docutils literal"><span class="pre">current_owner</span></code> actually owns the <code class="docutils literal"><span class="pre">hash</span></code>.</li>
|
||||
<li>Check if the transaction was signed with <code class="docutils literal"><span class="pre">current_owner</span></code> private key.</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="specific-validation">
|
||||
<span id="specific-validation"></span><h1>Specific Validation<a class="headerlink" href="#specific-validation" title="Permalink to this headline">¶</a></h1>
|
||||
<ol class="simple">
|
||||
<li>Query the bigchain and check if <code class="docutils literal"><span class="pre">current_owner</span></code> actually owns the <code class="docutils literal"><span class="pre">hash</span></code>.</li>
|
||||
<li>Check if the transaction was signed with <code class="docutils literal"><span class="pre">current_owner</span></code> private key.</li>
|
||||
<li>Depending on the <code class="docutils literal"><span class="pre">operation</span></code> additional checks may need to be performed. This will be specified by the protocol
|
||||
running in the chain e. g. <a class="reference external" href="https://github.com/ascribe/spool">Spool protocol</a></li>
|
||||
</ol>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Generic Validation</a></li>
|
||||
<li><a class="reference internal" href="#specific-validation">Specific Validation</a></li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/Transaction Validation.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/Transaction Validation.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,637 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>bigchain.core — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../../',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../../_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="../../index.html" />
|
||||
<link rel="up" title="Module code" href="../index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for bigchain.core</h1><div class="highlight"><pre>
|
||||
<span class="kn">import</span> <span class="nn">rethinkdb</span> <span class="kn">as</span> <span class="nn">r</span>
|
||||
<span class="kn">import</span> <span class="nn">time</span>
|
||||
<span class="kn">import</span> <span class="nn">random</span>
|
||||
<span class="kn">import</span> <span class="nn">json</span>
|
||||
<span class="kn">import</span> <span class="nn">rapidjson</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">bigchain</span>
|
||||
<span class="kn">from</span> <span class="nn">bigchain.crypto</span> <span class="kn">import</span> <span class="n">hash_data</span><span class="p">,</span> <span class="n">PublicKey</span><span class="p">,</span> <span class="n">PrivateKey</span><span class="p">,</span> <span class="n">generate_key_pair</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Bigchain"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain">[docs]</a><span class="k">class</span> <span class="nc">Bigchain</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
||||
<span class="sd">"""Bigchain API</span>
|
||||
|
||||
<span class="sd"> Create, read, sign, write transactions to the database</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.__init__"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">dbname</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
||||
<span class="n">public_key</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">private_key</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">keyring</span><span class="o">=</span><span class="p">[]):</span>
|
||||
<span class="sd">"""Initialize the Bigchain instance</span>
|
||||
|
||||
<span class="sd"> There are three ways in which the Bigchain instance can get its parameters.</span>
|
||||
<span class="sd"> The order by which the parameters are chosen are:</span>
|
||||
|
||||
<span class="sd"> 1. Setting them by passing them to the `__init__` method itself.</span>
|
||||
<span class="sd"> 2. Setting them as environment variables</span>
|
||||
<span class="sd"> 3. Reading them from the `config.json` file.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> host (str): hostname where the rethinkdb is running.</span>
|
||||
<span class="sd"> port (int): port in which rethinkb is running (usually 28015).</span>
|
||||
<span class="sd"> dbname (str): the name of the database to connect to (usually bigchain).</span>
|
||||
<span class="sd"> public_key (str): the base58 encoded public key for the ECDSA secp256k1 curve.</span>
|
||||
<span class="sd"> private_key (str): the base58 encoded private key for the ECDSA secp256k1 curve.</span>
|
||||
<span class="sd"> keyring (list[str]): list of base58 encoded public keys of the federation nodes.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span> <span class="ow">or</span> <span class="n">bigchain</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'database'</span><span class="p">][</span><span class="s1">'host'</span><span class="p">]</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">port</span> <span class="o">=</span> <span class="n">port</span> <span class="ow">or</span> <span class="n">bigchain</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'database'</span><span class="p">][</span><span class="s1">'port'</span><span class="p">]</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">dbname</span> <span class="o">=</span> <span class="n">dbname</span> <span class="ow">or</span> <span class="n">bigchain</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'database'</span><span class="p">][</span><span class="s1">'name'</span><span class="p">]</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">me</span> <span class="o">=</span> <span class="n">public_key</span> <span class="ow">or</span> <span class="n">bigchain</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'keypair'</span><span class="p">][</span><span class="s1">'public'</span><span class="p">]</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">me_private</span> <span class="o">=</span> <span class="n">private_key</span> <span class="ow">or</span> <span class="n">bigchain</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'keypair'</span><span class="p">][</span><span class="s1">'private'</span><span class="p">]</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">federation_nodes</span> <span class="o">=</span> <span class="n">keyring</span> <span class="ow">or</span> <span class="n">bigchain</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">'keyring'</span><span class="p">]</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">reconnect</span><span class="p">()</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="nf">reconnect</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">port</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dbname</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.create_transaction"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.create_transaction">[docs]</a> <span class="k">def</span> <span class="nf">create_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_owner</span><span class="p">,</span> <span class="n">new_owner</span><span class="p">,</span> <span class="n">tx_input</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="n">payload</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
||||
<span class="sd">"""Create a new transaction</span>
|
||||
|
||||
<span class="sd"> A transaction in the bigchain is a transfer of a digital asset between two entities represented</span>
|
||||
<span class="sd"> by public keys.</span>
|
||||
|
||||
<span class="sd"> Currently the bigchain supports two types of operations:</span>
|
||||
|
||||
<span class="sd"> `CREATE` - Only federation nodes are allowed to use this operation. In a create operation</span>
|
||||
<span class="sd"> a federation node creates a digital asset in the bigchain and assigns that asset to a public</span>
|
||||
<span class="sd"> key. The owner of the private key can then decided to transfer this digital asset by using the</span>
|
||||
<span class="sd"> `transaction id` of the transaction as an input in a `TRANSFER` transaction.</span>
|
||||
|
||||
<span class="sd"> `TRANSFER` - A transfer operation allows for a transfer of the digital assets between entities.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> current_owner (str): base58 encoded public key of the current owner of the asset.</span>
|
||||
<span class="sd"> new_owner (str): base58 encoded public key of the new owner of the digital asset.</span>
|
||||
<span class="sd"> tx_input (str): id of the transaction to use as input.</span>
|
||||
<span class="sd"> operation (str): Either `CREATE` or `TRANSFER` operation.</span>
|
||||
<span class="sd"> payload (Optional[dict]): dictionary with information about asset</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> dict: unsigned transaction</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">data</span> <span class="o">=</span> <span class="bp">None</span>
|
||||
<span class="k">if</span> <span class="n">payload</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="n">hash_payload</span> <span class="o">=</span> <span class="n">hash_data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">payload</span><span class="p">))</span>
|
||||
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'hash'</span><span class="p">:</span> <span class="n">hash_payload</span><span class="p">,</span>
|
||||
<span class="s1">'payload'</span><span class="p">:</span> <span class="n">payload</span>
|
||||
<span class="p">}</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'data parameter needs to be a dictionary'</span><span class="p">)</span>
|
||||
|
||||
<span class="n">tx</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'current_owner'</span><span class="p">:</span> <span class="n">current_owner</span><span class="p">,</span>
|
||||
<span class="s1">'new_owner'</span><span class="p">:</span> <span class="n">new_owner</span><span class="p">,</span>
|
||||
<span class="s1">'input'</span><span class="p">:</span> <span class="n">tx_input</span><span class="p">,</span>
|
||||
<span class="s1">'operation'</span><span class="p">:</span> <span class="n">operation</span><span class="p">,</span>
|
||||
<span class="s1">'timestamp'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">(),</span>
|
||||
<span class="s1">'data'</span><span class="p">:</span> <span class="n">data</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="c1"># serialize and convert to bytes</span>
|
||||
<span class="n">tx_serialized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">tx</span><span class="p">)</span>
|
||||
<span class="n">tx_hash</span> <span class="o">=</span> <span class="n">hash_data</span><span class="p">(</span><span class="n">tx_serialized</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># create the transaction</span>
|
||||
<span class="n">transaction</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'id'</span><span class="p">:</span> <span class="n">tx_hash</span><span class="p">,</span>
|
||||
<span class="s1">'transaction'</span><span class="p">:</span> <span class="n">tx</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">transaction</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.sign_transaction"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.sign_transaction">[docs]</a> <span class="k">def</span> <span class="nf">sign_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transaction</span><span class="p">,</span> <span class="n">private_key</span><span class="p">):</span>
|
||||
<span class="sd">"""Sign a transaction</span>
|
||||
|
||||
<span class="sd"> A transaction signed with the `current_owner` corresponding private key.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> transaction (dict): transaction to sign.</span>
|
||||
<span class="sd"> private_key (str): base58 encoded private key to create a signature of the transaction.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> dict: transaction with the `signature` field included.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">private_key</span> <span class="o">=</span> <span class="n">PrivateKey</span><span class="p">(</span><span class="n">private_key</span><span class="p">)</span>
|
||||
<span class="n">signature</span> <span class="o">=</span> <span class="n">private_key</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">transaction</span><span class="p">))</span>
|
||||
<span class="n">signed_transaction</span> <span class="o">=</span> <span class="n">transaction</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
|
||||
<span class="n">signed_transaction</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'signature'</span><span class="p">:</span> <span class="n">signature</span><span class="p">})</span>
|
||||
<span class="k">return</span> <span class="n">signed_transaction</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.verify_signature"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.verify_signature">[docs]</a> <span class="k">def</span> <span class="nf">verify_signature</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">signed_transaction</span><span class="p">):</span>
|
||||
<span class="sd">"""Verify the signature of a transaction</span>
|
||||
|
||||
<span class="sd"> A valid transaction should have been signed `current_owner` corresponding private key.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> signed_transaction (dict): a transaction with the `signature` included.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> bool: True if the signature is correct, False otherwise.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">data</span> <span class="o">=</span> <span class="n">signed_transaction</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
|
||||
|
||||
<span class="c1"># if assignee field in the transaction, remove it</span>
|
||||
<span class="k">if</span> <span class="s1">'assignee'</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
|
||||
<span class="n">data</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'assignee'</span><span class="p">)</span>
|
||||
|
||||
<span class="n">signature</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'signature'</span><span class="p">)</span>
|
||||
<span class="n">public_key_base58</span> <span class="o">=</span> <span class="n">signed_transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'current_owner'</span><span class="p">]</span>
|
||||
<span class="n">public_key</span> <span class="o">=</span> <span class="n">PublicKey</span><span class="p">(</span><span class="n">public_key_base58</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">public_key</span><span class="o">.</span><span class="n">verify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">data</span><span class="p">),</span> <span class="n">signature</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.write_transaction"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.write_transaction">[docs]</a> <span class="k">def</span> <span class="nf">write_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">signed_transaction</span><span class="p">):</span>
|
||||
<span class="sd">"""Write the transaction to bigchain.</span>
|
||||
|
||||
<span class="sd"> When first writing a transaction to the bigchain the transaction will be kept in a backlog until</span>
|
||||
<span class="sd"> it has been validated by the nodes of the federation.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> singed_transaction (dict): transaction with the `signature` included.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> dict: database response</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="c1"># we will assign this transaction to `one` node. This way we make sure that there are no duplicate</span>
|
||||
<span class="c1"># transactions on the bigchain</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">federation_nodes</span><span class="p">:</span>
|
||||
<span class="n">assignee</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">federation_nodes</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># I am the only node</span>
|
||||
<span class="n">assignee</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">me</span>
|
||||
|
||||
<span class="c1"># update the transaction</span>
|
||||
<span class="n">signed_transaction</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'assignee'</span><span class="p">:</span> <span class="n">assignee</span><span class="p">})</span>
|
||||
|
||||
<span class="c1"># write to the backlog</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s1">'backlog'</span><span class="p">)</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">signed_transaction</span><span class="p">,</span> <span class="n">durability</span><span class="o">=</span><span class="s1">'soft'</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">response</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.get_transaction"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.get_transaction">[docs]</a> <span class="k">def</span> <span class="nf">get_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">txid</span><span class="p">):</span>
|
||||
<span class="sd">"""Retrieve a transaction with `txid` from bigchain.</span>
|
||||
|
||||
<span class="sd"> Queries the bigchain for a transaction that was already included in a block.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> txid (str): transaction id of the transaction to query</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> A dict with the transaction details if the transaction was found.</span>
|
||||
|
||||
<span class="sd"> If no transaction with that `txid` was found it returns `None`</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s1">'bigchain'</span><span class="p">)</span><span class="o">.</span><span class="n">concat_map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">doc</span><span class="p">:</span> <span class="n">doc</span><span class="p">[</span><span class="s1">'block'</span><span class="p">][</span><span class="s1">'transactions'</span><span class="p">])</span>\
|
||||
<span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">transaction</span><span class="p">:</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]</span> <span class="o">==</span> <span class="n">txid</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># transaction ids should be unique</span>
|
||||
<span class="n">transactions</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">transactions</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">transactions</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Transaction ids should be unique. There is a problem with the chain'</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">transactions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">None</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.get_tx_by_payload_hash"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.get_tx_by_payload_hash">[docs]</a> <span class="k">def</span> <span class="nf">get_tx_by_payload_hash</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">payload_hash</span><span class="p">):</span>
|
||||
<span class="sd">"""Retrieves transactions related to a digital asset.</span>
|
||||
|
||||
<span class="sd"> When creating a transaction one of the optional arguments is the `payload`. The payload is a generic</span>
|
||||
<span class="sd"> dict that contains information about the digital asset.</span>
|
||||
|
||||
<span class="sd"> To make it easy to query the bigchain for that digital asset we create a sha3-256 hash of the</span>
|
||||
<span class="sd"> serialized payload and store it with the transaction. This makes it easy for developers to keep track</span>
|
||||
<span class="sd"> of their digital assets in bigchain.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> payload_hash (str): sha3-256 hash of the serialized payload.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> A list of transactions containing that payload. If no transaction exists with that payload it</span>
|
||||
<span class="sd"> returns `None`</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">cursor</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s1">'bigchain'</span><span class="p">)</span>\
|
||||
<span class="o">.</span><span class="n">get_all</span><span class="p">(</span><span class="n">payload_hash</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="s1">'payload_hash'</span><span class="p">)</span>\
|
||||
<span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="p">)</span>
|
||||
|
||||
<span class="n">transactions</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">cursor</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">transactions</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.get_spent"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.get_spent">[docs]</a> <span class="k">def</span> <span class="nf">get_spent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">txid</span><span class="p">):</span>
|
||||
<span class="sd">"""Check if a `txid` was already used as an input.</span>
|
||||
|
||||
<span class="sd"> A transaction can be used as an input for another transaction. Bigchain needs to make sure that a</span>
|
||||
<span class="sd"> given `txid` is only used once.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> txid (str): transaction id.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> The transaction that used the `txid` as an input if it exists else it returns `None`</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="c1"># checks if an input was already spent</span>
|
||||
<span class="c1"># checks if the bigchain has any transaction with input `transaction_id`</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s1">'bigchain'</span><span class="p">)</span><span class="o">.</span><span class="n">concat_map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">doc</span><span class="p">:</span> <span class="n">doc</span><span class="p">[</span><span class="s1">'block'</span><span class="p">][</span><span class="s1">'transactions'</span><span class="p">])</span>\
|
||||
<span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">transaction</span><span class="p">:</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'input'</span><span class="p">]</span> <span class="o">==</span> <span class="n">txid</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># a transaction_id should have been spent at most one time</span>
|
||||
<span class="n">transactions</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">transactions</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">transactions</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'`{}` was spent more then once. There is a problem with the chain'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">txid</span><span class="p">))</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">transactions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">None</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.get_owned_ids"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.get_owned_ids">[docs]</a> <span class="k">def</span> <span class="nf">get_owned_ids</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">):</span>
|
||||
<span class="sd">"""Retrieve a list of `txids` that can we used has inputs.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> owner (str): base58 encoded public key.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> list: list of `txids` currently owned by `owner`</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s1">'bigchain'</span><span class="p">)</span>\
|
||||
<span class="o">.</span><span class="n">concat_map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">doc</span><span class="p">:</span> <span class="n">doc</span><span class="p">[</span><span class="s1">'block'</span><span class="p">][</span><span class="s1">'transactions'</span><span class="p">])</span>\
|
||||
<span class="o">.</span><span class="n">filter</span><span class="p">({</span><span class="s1">'transaction'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'new_owner'</span><span class="p">:</span> <span class="n">owner</span><span class="p">}})</span>\
|
||||
<span class="o">.</span><span class="n">pluck</span><span class="p">(</span><span class="s1">'id'</span><span class="p">)[</span><span class="s1">'id'</span><span class="p">]</span>\
|
||||
<span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="p">)</span>
|
||||
<span class="n">owned</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
||||
<span class="c1"># remove all inputs already spent</span>
|
||||
<span class="k">for</span> <span class="n">tx_input</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="n">response</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_spent</span><span class="p">(</span><span class="n">tx_input</span><span class="p">):</span>
|
||||
<span class="n">owned</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tx_input</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">owned</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.validate_transaction"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.validate_transaction">[docs]</a> <span class="k">def</span> <span class="nf">validate_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transaction</span><span class="p">):</span>
|
||||
<span class="sd">"""Validate a transaction.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> transaction (dict): transaction to validate.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> The transaction if the transaction is valid else it raises and exception</span>
|
||||
<span class="sd"> describing the reason why the transaction is invalid.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="c1"># If the operation is CREATE the transaction should have no inputs and should be signed by a</span>
|
||||
<span class="c1"># federation node</span>
|
||||
<span class="k">if</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'operation'</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'CREATE'</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'input'</span><span class="p">]:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'A CREATE operation has no inputs.'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'current_owner'</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">federation_nodes</span> <span class="o">+</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">me</span><span class="p">]:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Only federation nodes can use the operation `CREATE`'</span><span class="p">)</span>
|
||||
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># check if the input exists, is owned by the current_owner</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'input'</span><span class="p">]:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Only `CREATE` transactions can have null inputs'</span><span class="p">)</span>
|
||||
|
||||
<span class="n">tx_input</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'input'</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">tx_input</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'input `{}` does not exist in the bigchain'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'input'</span><span class="p">]))</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">tx_input</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'new_owner'</span><span class="p">]</span> <span class="o">!=</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'current_owner'</span><span class="p">]:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'current_owner `{}` does not own the input `{}`'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'current_owner'</span><span class="p">],</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'input'</span><span class="p">]))</span>
|
||||
|
||||
<span class="c1"># check if the input was already spent</span>
|
||||
<span class="n">spent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_spent</span><span class="p">(</span><span class="n">tx_input</span><span class="p">[</span><span class="s1">'id'</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">spent</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'input `{}` was already spent'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">][</span><span class="s1">'input'</span><span class="p">]))</span>
|
||||
|
||||
<span class="c1"># Check hash of the transaction</span>
|
||||
<span class="n">calculated_hash</span> <span class="o">=</span> <span class="n">hash_data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">transaction</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">]))</span>
|
||||
<span class="k">if</span> <span class="n">calculated_hash</span> <span class="o">!=</span> <span class="n">transaction</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Wrong transaction hash'</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Check signature</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">verify_signature</span><span class="p">(</span><span class="n">transaction</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Wrong transaction signature'</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">transaction</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.is_valid_transaction"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.is_valid_transaction">[docs]</a> <span class="k">def</span> <span class="nf">is_valid_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transaction</span><span class="p">):</span>
|
||||
<span class="sd">"""Check whether a transacion is valid or invalid.</span>
|
||||
|
||||
<span class="sd"> Similar to `validate_transaction` but does not raise an exception if the transaction is valid.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> transaction (dict): transaction to check.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> bool: `True` if the transaction is valid, `False` otherwise</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">validate_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">transaction</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">False</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.create_block"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.create_block">[docs]</a> <span class="k">def</span> <span class="nf">create_block</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">validated_transactions</span><span class="p">):</span>
|
||||
<span class="sd">"""Creates a block given a list of `validated_transactions`.</span>
|
||||
|
||||
<span class="sd"> Note that this method does not validate the transactions. Transactions should be validated before</span>
|
||||
<span class="sd"> calling create_block.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> validated_transactions (list): list of validated transactions.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> dict: created block.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="c1"># Create the new block</span>
|
||||
<span class="n">block</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'timestamp'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">(),</span>
|
||||
<span class="s1">'transactions'</span><span class="p">:</span> <span class="n">validated_transactions</span><span class="p">,</span>
|
||||
<span class="s1">'node_pubkey'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">me</span><span class="p">,</span>
|
||||
<span class="s1">'voters'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">federation_nodes</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="c1"># Calculate the hash of the new block</span>
|
||||
<span class="n">block_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">block</span><span class="p">)</span>
|
||||
<span class="n">block_hash</span> <span class="o">=</span> <span class="n">hash_data</span><span class="p">(</span><span class="n">block_data</span><span class="p">)</span>
|
||||
<span class="n">block_signature</span> <span class="o">=</span> <span class="n">PrivateKey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">me_private</span><span class="p">)</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">block_data</span><span class="p">)</span>
|
||||
|
||||
<span class="n">block</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'id'</span><span class="p">:</span> <span class="n">block_hash</span><span class="p">,</span>
|
||||
<span class="s1">'block'</span><span class="p">:</span> <span class="n">block</span><span class="p">,</span>
|
||||
<span class="s1">'signature'</span><span class="p">:</span> <span class="n">block_signature</span><span class="p">,</span>
|
||||
<span class="s1">'votes'</span><span class="p">:</span> <span class="p">[]</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">block</span></div>
|
||||
|
||||
<span class="c1"># TODO: check that the votings structure is correctly constructed</span>
|
||||
<div class="viewcode-block" id="Bigchain.validate_block"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.validate_block">[docs]</a> <span class="k">def</span> <span class="nf">validate_block</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block</span><span class="p">):</span>
|
||||
<span class="sd">"""Validate a block.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> block (dict): block to validate.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> The block if the block is valid else it raises and exception</span>
|
||||
<span class="sd"> describing the reason why the block is invalid.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="c1"># 1. Check if current hash is correct</span>
|
||||
<span class="n">calculated_hash</span> <span class="o">=</span> <span class="n">hash_data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">block</span><span class="p">[</span><span class="s1">'block'</span><span class="p">]))</span>
|
||||
<span class="k">if</span> <span class="n">calculated_hash</span> <span class="o">!=</span> <span class="n">block</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]:</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Wrong block hash'</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># 2. Validate all transactions in the block</span>
|
||||
<span class="k">for</span> <span class="n">transaction</span> <span class="ow">in</span> <span class="n">block</span><span class="p">[</span><span class="s1">'block'</span><span class="p">][</span><span class="s1">'transactions'</span><span class="p">]:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_valid_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">):</span>
|
||||
<span class="c1"># this will raise the exception</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">validate_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">block</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.is_valid_block"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.is_valid_block">[docs]</a> <span class="k">def</span> <span class="nf">is_valid_block</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block</span><span class="p">):</span>
|
||||
<span class="sd">"""Check whether a block is valid or invalid.</span>
|
||||
|
||||
<span class="sd"> Similar to `validate_block` but does not raise an exception if the block is invalid.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> block (dict): block to check.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> bool: `True` if the block is valid, `False` otherwise.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">validate_block</span><span class="p">(</span><span class="n">block</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">block</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">False</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.write_block"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.write_block">[docs]</a> <span class="k">def</span> <span class="nf">write_block</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block</span><span class="p">):</span>
|
||||
<span class="sd">"""Write a block to bigchain.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> block (dict): block to write to bigchain.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">block_serialized</span> <span class="o">=</span> <span class="n">rapidjson</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">block</span><span class="p">)</span>
|
||||
<span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s1">'bigchain'</span><span class="p">)</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">(</span><span class="n">block_serialized</span><span class="p">),</span> <span class="n">durability</span><span class="o">=</span><span class="s1">'soft'</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="p">,</span> <span class="n">noreply</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span></div>
|
||||
|
||||
<span class="c1"># TODO: Decide if we need this method</span>
|
||||
<span class="k">def</span> <span class="nf">transaction_exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transaction_id</span><span class="p">):</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s1">'bigchain'</span><span class="p">)</span><span class="o">.</span><span class="n">get_all</span><span class="p">(</span><span class="n">transaction_id</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="s1">'transaction_id'</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="bp">True</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">items</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> <span class="k">else</span> <span class="bp">False</span>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.create_genesis_block"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.create_genesis_block">[docs]</a> <span class="k">def</span> <span class="nf">create_genesis_block</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="sd">"""Create the genesis block</span>
|
||||
|
||||
<span class="sd"> Block created when bigchain is first initialized.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="c1"># 1. create one transaction</span>
|
||||
<span class="c1"># 2. create the block with one transaction</span>
|
||||
<span class="c1"># 3. write the block to the bigchain</span>
|
||||
|
||||
<span class="n">payload</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'message'</span><span class="p">:</span> <span class="s1">'Hello World from the Bigchain'</span><span class="p">}</span>
|
||||
<span class="n">transaction</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_transaction</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">me</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">me</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="s1">'GENESIS'</span><span class="p">,</span> <span class="n">payload</span><span class="o">=</span><span class="n">payload</span><span class="p">)</span>
|
||||
<span class="n">transaction_signed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sign_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">me_private</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># create the block</span>
|
||||
<span class="n">block</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_block</span><span class="p">([</span><span class="n">transaction_signed</span><span class="p">])</span>
|
||||
<span class="c1"># add block number before writing</span>
|
||||
<span class="n">block</span><span class="p">[</span><span class="s1">'block_number'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">write_block</span><span class="p">(</span><span class="n">block</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">block</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Bigchain.vote"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.vote">[docs]</a> <span class="k">def</span> <span class="nf">vote</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block</span><span class="p">,</span> <span class="n">previous_block_id</span><span class="p">,</span> <span class="n">decision</span><span class="p">,</span> <span class="n">invalid_reason</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
||||
<span class="sd">"""Cast your vote on the block given the previous_block_hash and the decision (valid/invalid)</span>
|
||||
<span class="sd"> return the block to the updated in the database.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> block (dict): Block to vote.</span>
|
||||
<span class="sd"> previous_block_id (str): The id of the previous block.</span>
|
||||
<span class="sd"> decision (bool): Whether the block is valid or invalid.</span>
|
||||
<span class="sd"> invalid_reason (Optional[str]): Reason the block is invalid</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">vote</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'voting_for_block'</span><span class="p">:</span> <span class="n">block</span><span class="p">[</span><span class="s1">'id'</span><span class="p">],</span>
|
||||
<span class="s1">'previous_block'</span><span class="p">:</span> <span class="n">previous_block_id</span><span class="p">,</span>
|
||||
<span class="s1">'is_block_valid'</span><span class="p">:</span> <span class="n">decision</span><span class="p">,</span>
|
||||
<span class="s1">'invalid_reason'</span><span class="p">:</span> <span class="n">invalid_reason</span><span class="p">,</span>
|
||||
<span class="s1">'timestamp'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">timestamp</span><span class="p">()</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="n">vote_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">vote</span><span class="p">)</span>
|
||||
<span class="n">signature</span> <span class="o">=</span> <span class="n">PrivateKey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">me_private</span><span class="p">)</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">vote_data</span><span class="p">)</span>
|
||||
|
||||
<span class="n">vote_signed</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'node_pubkey'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">me</span><span class="p">,</span>
|
||||
<span class="s1">'signature'</span><span class="p">:</span> <span class="n">signature</span><span class="p">,</span>
|
||||
<span class="s1">'vote'</span><span class="p">:</span> <span class="n">vote</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">vote_signed</span></div>
|
||||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="Bigchain.serialize"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.serialize">[docs]</a> <span class="k">def</span> <span class="nf">serialize</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>
|
||||
<span class="sd">"""Static method used to serialize a dict into a JSON formatted string.</span>
|
||||
|
||||
<span class="sd"> This method enforces rules like the separator and order of keys. This ensures that all dicts</span>
|
||||
<span class="sd"> are serialized in the same way.</span>
|
||||
|
||||
<span class="sd"> This is specially important for hashing data. We need to make sure that everyone serializes their data</span>
|
||||
<span class="sd"> in the same way so that we do not have hash mismatches for the same structure due to serialization</span>
|
||||
<span class="sd"> differences.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> data (dict): dict to serialize</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> str: JSON formatted string</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">skipkeys</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">ensure_ascii</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
|
||||
<span class="n">separators</span><span class="o">=</span><span class="p">(</span><span class="s1">','</span><span class="p">,</span> <span class="s1">':'</span><span class="p">),</span> <span class="n">sort_keys</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="Bigchain.deserialize"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.deserialize">[docs]</a> <span class="k">def</span> <span class="nf">deserialize</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>
|
||||
<span class="sd">"""Static method used to deserialize a JSON formatted string into a dict.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> data (str): JSON formatted string.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> dict: dict resulting from the serialization of a JSON formatted string.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="Bigchain.timestamp"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.timestamp">[docs]</a> <span class="k">def</span> <span class="nf">timestamp</span><span class="p">():</span>
|
||||
<span class="sd">"""Static method to calculate a UTC timestamp with microsecond precision.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> str: UTC timestamp.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span>
|
||||
<span class="k">return</span> <span class="s2">"{0:.6f}"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">(</span><span class="n">dt</span><span class="o">.</span><span class="n">timetuple</span><span class="p">())</span> <span class="o">+</span> <span class="n">dt</span><span class="o">.</span><span class="n">microsecond</span> <span class="o">/</span> <span class="mf">1e6</span><span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@staticmethod</span>
|
||||
<div class="viewcode-block" id="Bigchain.generate_keys"><a class="viewcode-back" href="../../reference.html#bigchain.Bigchain.generate_keys">[docs]</a> <span class="k">def</span> <span class="nf">generate_keys</span><span class="p">():</span>
|
||||
<span class="sd">"""Generates a key pair.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> tuple: `(private_key, public_key)`. ECDSA key pair using the secp256k1 curve encoded</span>
|
||||
<span class="sd"> in base58.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="c1"># generates and returns the keys serialized in hex</span>
|
||||
<span class="k">return</span> <span class="n">generate_key_pair</span><span class="p">()</span></div></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Module code</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,84 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Overview: module code — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="../index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>All modules for which code is available</h1>
|
||||
<ul><li><a href="bigchain/core.html">bigchain.core</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
Cryptographic algorithms and python implementations that we use.
|
||||
|
||||
The implementations that we have chosen for now are just for fast prototyping. Some of them are pure python
|
||||
implementations which may be slow. As future work we should look at other alternatives
|
||||
|
||||
### Hashes
|
||||
|
||||
For hashing we are using the sha3-256 algorithm and [pysha3](https://bitbucket.org/tiran/pykeccak) as the python
|
||||
implementation. We store the hex encoded hash in the bigchain.
|
||||
|
||||
##### Example
|
||||
|
||||
```python
|
||||
import hashlib
|
||||
# monkey patch hashlib with sha3 functions
|
||||
import sha3
|
||||
|
||||
data = "message"
|
||||
tx_hash = hashlib.sha3_256(data).hexdigest()
|
||||
```
|
||||
|
||||
### Keys
|
||||
|
||||
For signing and veryfing signatures we are using the ECDSA with 192bit key lengths and
|
||||
[python-ecdsa](https://github.com/warner/python-ecdsa) as the python implementation.
|
||||
|
||||
The public-key or verification key are converted to string and hex encoded before storing them to the blockchain
|
||||
|
||||
##### Example
|
||||
|
||||
```python
|
||||
import binascii
|
||||
from ecdsa import SigningKey
|
||||
|
||||
# generate signing key in hex encoded form
|
||||
sk = SigningKey.generate()
|
||||
sk_hex = binascii.hexlify(sk.to_string())
|
||||
|
||||
# get signing key from hex
|
||||
sk = SigningKey.from_string(binascii.unhexlify(sk_hex))
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
### Why do we use blocks and don't just create the chain with transactions
|
||||
|
||||
With distributed data stores there is no guarantees in the order in which transactions will be commited to the
|
||||
database. Witouth knowing what is previous transactions to be commited to the database we cannot include its hash in
|
||||
the current transaction to build the chain.
|
||||
|
||||
To solve this problem we decided to use blocks and create the chain with the blocks.
|
||||
|
|
@ -1,93 +0,0 @@
|
|||
### Transaction Model
|
||||
|
||||
```
|
||||
{
|
||||
"id": "<sha3 hash>",
|
||||
"transaction": {
|
||||
"current_owner": "<pub-key>",
|
||||
"new_owner": "<pub-key>",
|
||||
"input": "<sha3 hash>",
|
||||
"operation": "<string>",
|
||||
"timestamp": "<rethinkdb timestamp>",
|
||||
"data": {
|
||||
"hash": "<sha3 hash>",
|
||||
...
|
||||
}
|
||||
},
|
||||
"signature": "<ECDSA signature of the transaction>"
|
||||
}
|
||||
```
|
||||
|
||||
#### Explanation
|
||||
|
||||
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 and rethinkdb primary key. By using the hash of the transaction of the
|
||||
primary key we eliminate the problem of duplicated transactions, if for some reason two nodes decide to create the
|
||||
same transaction
|
||||
- `current_owner`: Public key of the current owner of the digital content with hash `hash`
|
||||
- `new_owner`: Public key of the new owner of the digital content with hash `hash`
|
||||
- `input`: 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.
|
||||
- `operation`: String representation of the operation being performed (REGISTER, TRANSFER, ...) this will define how
|
||||
the transactions should be validated
|
||||
- `timestamp`: Time of creation of the transaction in UTC
|
||||
- `data`: Json object describing the asset (digital content). It contains at least the field `hash` which is a
|
||||
sha3 hash of the digital content.
|
||||
- `signature`: ECDSA signature of the transaction with the `current_owner` private key
|
||||
|
||||
### Block Model
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "<sha3 hash of the list of transactions + timestamp + nodes_pubkeys>",
|
||||
"block": {
|
||||
"timestamp": "<RethinkDB timestamp>",
|
||||
"transactions": ["<list of transactions>"],
|
||||
"node_pubkey": "<public key of the node creating the block>",
|
||||
"voters": ["<list of federation nodes pulic keys>"]
|
||||
},
|
||||
"signature": "<signature of the block>",
|
||||
"votes": []
|
||||
}
|
||||
```
|
||||
|
||||
#### Explanation
|
||||
|
||||
Still to be defined when new blocks are created (after x number of transactions, or after x amount of seconds,
|
||||
or both).
|
||||
A block contains a group of transactions and includes the hash of the hash of the previous block to build the chain.
|
||||
|
||||
- `id`: sha3 hash of the current block. This is also a rethinkdb primary key, this way we make sure that all blocks are unique.
|
||||
- `block`: The actual block
|
||||
- `timestamp`: timestamp when the block was created
|
||||
- `transactions`: the list of transactions included in the block
|
||||
- `node_pubkey`: the public key of the node that create the block
|
||||
- `voters`: list public keys of the federation nodes. Since the size of the
|
||||
federation may change over time this will tell us how many nodes existed
|
||||
in the federation when the block was created so that in a later point in
|
||||
time we can check that the block received the correct number of votes.
|
||||
- `signature`: Signature of the block by the node that created the block
|
||||
- `votes`: Initially an empty list. Nodes in the voters list will append to it
|
||||
has they vote on the block
|
||||
|
||||
|
||||
### Vote Model
|
||||
|
||||
This is the structure that each node will append to the block `votes` list.
|
||||
|
||||
```json
|
||||
{
|
||||
"node_pubkey": "<the pubkey of the voting node>",
|
||||
"vote": {
|
||||
"voting_for_block": "<id of the block the node is voting for>",
|
||||
"previous_block": "<id of the block previous to this one>",
|
||||
"is_block_valid": "<true|false>",
|
||||
"invalid_reason": "<None|DOUBLE_SPEND|TRANSACTIONS_HASH_MISMATCH|NODES_PUBKEYS_MISMATCH",
|
||||
"timestamp": "<rethinkdb timestamp of the voting action>"
|
||||
},
|
||||
"signature": "<ECDSA signature of vote block>"
|
||||
}
|
||||
```
|
||||
|
|
@ -1,196 +0,0 @@
|
|||
# RethinkDB Benchamarks
|
||||
|
||||
#### Goals
|
||||
|
||||
The goal is to test rethinkdb scalability properties, understand its limits and
|
||||
see if we can reach a speed of 1M transactions per second.
|
||||
|
||||
#### Terminology
|
||||
|
||||
##### Settings
|
||||
|
||||
To test the writing performance of rethinkdb we have a process that inserts a
|
||||
block in the database in an infinite loop
|
||||
|
||||
The block is a valid block with small transactions (transactions without any
|
||||
payload). The entire block has around 900KB
|
||||
|
||||
```python
|
||||
while True:
|
||||
r.table(table).insert(r.json(BLOCK_SERIALIZED), durability='soft').run(conn)
|
||||
```
|
||||
|
||||
In `hard` durability mode, writes are committed to disk before acknowledgments
|
||||
are sent; in `soft` mode, writes are acknowledged immediately after being stored
|
||||
in memory.
|
||||
|
||||
This means that the insert will block until rethinkdb acknowledges that the data
|
||||
was cached. In each server we can start multiple process.
|
||||
|
||||
##### Write units
|
||||
|
||||
Lets define `1 write unit` as being 1 process. For example in a 32 node cluster
|
||||
with each node running 2 processes we would have `64 writes`. This will make it
|
||||
easier to compare different tests.
|
||||
|
||||
##### Sharding
|
||||
|
||||
Sharding in distributed datastores means partitioning a table so that the data
|
||||
can be evenly distributed between all nodes in the cluster. In rethinkdb and
|
||||
most distributed datastores there is a maximum limit of 32 shards per table.
|
||||
|
||||
In rethinkdb a `shard` is also called a `primary replica`, since by default the
|
||||
replication factor is 1. Increasing the replication factor produces `secondary
|
||||
replicas` that are used for data redundancy (if a node holding a primary replica
|
||||
goes down another node holding a secondary replica of the same data can step up
|
||||
and become the primary replica)
|
||||
|
||||
For these tests we are using 32 core ec2 instances with SSD storage and 10Gbps
|
||||
network connections (`c3.8xlarge`). For the tests we used either 32 or 64 node
|
||||
clusters all running on the same aws region.
|
||||
|
||||
These tests show rethinkdb performance and what we can expect from the database.
|
||||
This does not show the performance of the bigchain
|
||||
|
||||
#### Tests
|
||||
|
||||
##### Test 1
|
||||
|
||||
- **number of nodes**: 32
|
||||
- **number of processes**: 2 processes per node
|
||||
- **write units**: 32 x 2 = 64 writes
|
||||
- **output**: stable 1K writes per second
|
||||
|
||||
This was the most successful test. We are able to reach a stable output of 1K
|
||||
blocks per second. The load on the machines is stable and the IO is at an
|
||||
average of 50-60 %.
|
||||
|
||||
Other tests have shown that increasing the number write units per machine can
|
||||
lead to a stable performance up to 1.5K writes per second but the load on the
|
||||
nodes would increase until the node would eventually fail. This means that we
|
||||
are able to handle bursts for a short amount of time (10-20 min).
|
||||
|
||||
This test can be used has a baseline for the future in where 64 writes equal 1K
|
||||
transactions per second. Or that each write unit produces an output of
|
||||
`1000/64` writes per second, approximately 16 writes per second.
|
||||
|
||||
|
||||
##### Test 2
|
||||
|
||||
- **number of nodes**: 32
|
||||
- **number of processes**:
|
||||
- 16 nodes running 2 processes
|
||||
- 16 nodes running 3 processes
|
||||
- **write units**: 16 x 3 + 16 x 2 = 80 writes
|
||||
- **expected output**: 1250 writes per second
|
||||
- **output**: stable 1.2K writes per second
|
||||
|
||||
Increasing a bit the number of write units shows an increase in output close to
|
||||
the expected value but in this case the IO around 90 % close to the limit that
|
||||
the machine can handle.
|
||||
|
||||
|
||||
##### Test 3
|
||||
|
||||
- **number of nodes**: 32
|
||||
- **number of processes**:
|
||||
- 16 nodes running 2 processes
|
||||
- 16 nodes running 4 processes
|
||||
- **write units**: 16 x 4 + 16 x 2 = 96 writes
|
||||
- **expected output**: 1500 writes per second
|
||||
- **output**: stable 1.4K writes per second
|
||||
|
||||
These test produces results similar to previous one. The reason why we don't
|
||||
reach the expected output may be because rethinkdb needs time to cache results
|
||||
and at some point increasing the number of write units will not result in an
|
||||
higher output. Another problem is that as the rethinkdb cache fills (because the
|
||||
rethinkdb is not able to flush the data to disk fast enough due to IO
|
||||
limitations) the performance will decrease because the processes will take more
|
||||
time inserting blocks.
|
||||
|
||||
|
||||
##### Test 4
|
||||
|
||||
- **number of nodes**: 64
|
||||
- **number of processes**: 1 process per node
|
||||
- **write units**: 64 x 1 = 64 writes
|
||||
- **expected output**: 1000 writes per second
|
||||
- **output**: stable 1K writes per second
|
||||
|
||||
In this case we are increasing the number of nodes in the cluster by 2x. This
|
||||
won't have an impact in the write performance because the maximum amount of
|
||||
shards per table in rethinkdb is 32 (rethinkdb will probably increase this limit
|
||||
in the future). What this provides is more CPU power (and storage for replicas,
|
||||
more about replication in the next section). We just halved the amount write
|
||||
units per node maintaining the same output. The IO in the nodes holding the
|
||||
primary replica is the same has test 1.
|
||||
|
||||
|
||||
##### Test 5
|
||||
|
||||
- **number of nodes**: 64
|
||||
- **number of processes**: 2 process per node
|
||||
- **write units**: 64 x 2 = 128 writes
|
||||
- **expected output**: 2000 writes per second
|
||||
- **output**: unstable 2K (peak) writes per second
|
||||
|
||||
|
||||
In this case we are doubling the amount of write units. We are able to reach the
|
||||
expected output but the output performance is unstable due to the fact that we
|
||||
reached the IO limit on the machines.
|
||||
|
||||
|
||||
##### Test 6
|
||||
|
||||
|
||||
- **number of nodes**: 64
|
||||
- **number of processes**:
|
||||
- 32 nodes running 1 processes
|
||||
- 32 nodes running 2 processes
|
||||
- **write units**: 32 x 2 + 32 x 1 = 96 writes
|
||||
- **expected output**: 1500 writes per second
|
||||
- **output**: stable 1.5K writes per second
|
||||
|
||||
This test is similar to Test 3. The only difference is that now the write units
|
||||
are distributed between 64 nodes meaning that each node is writing to its local
|
||||
cache and we don't overload the cache of the nodes like we did with Test 3. This
|
||||
is another advantage of adding more nodes beyond 32.
|
||||
|
||||
|
||||
#### Testing replication
|
||||
|
||||
Replication is used for data redundancy. In rethinkdb we are able to specify the
|
||||
number of shards and replicas per table. Data in secondary replicas is no
|
||||
directly used, its just a mirror of a primary replica and used in case the node
|
||||
holding the primary replica fails.
|
||||
|
||||
Rethinkdb does a good job trying to distribute data evenly between nodes. We ran
|
||||
some tests to check this.
|
||||
|
||||
Note that by increasing the number of replicas we also increase the number of
|
||||
writes in the cluster. For a replication factor of 2 we double the amount of
|
||||
writes on the cluster, with a replication factor of 3 we triple the amount of
|
||||
writes and so on.
|
||||
|
||||
|
||||
With 64 nodes and since we can only have 32 shards we have 32 nodes holding
|
||||
shards (primary replicas)
|
||||
|
||||
With a replication factor of 2 we will have 64 replicas (32 primary replicas and
|
||||
32 secondary replicas). Since we already have 32 nodes holding the 32
|
||||
shards/primary replicas rethinkdb uses the other 32 nodes to hold the secondary
|
||||
replicas. So in a 64 node cluster with 32 shards and a replication factor of 2,
|
||||
32 nodes will be holding the primary replicas and the other 32 nodes will be holding
|
||||
the secondary replicas.
|
||||
|
||||
With this setup if we run Test 4 now that we have a replication factor of 2 we
|
||||
will have twice the amount of writes but a nice result is that the IO in the
|
||||
nodes holding the primary replicas does not increase when compared to Test 4
|
||||
because all of the excess writing is now being done the 32 nodes holding the
|
||||
secondary replicas.
|
||||
|
||||
Another fact about replication. If I have a 64 node cluster and create a table
|
||||
with 32 shards, 32 nodes will be holding primary replicas and the other nodes do
|
||||
not hold any data. If I create another table with 32 shards rethinkdb will
|
||||
create the shards in the nodes that where not holding any data, evenly
|
||||
distributing the data.
|
||||
|
|
@ -1,69 +0,0 @@
|
|||
We need to clearly define how to serialize a json object to calculate the hash.
|
||||
|
||||
The serialization should produce the same byte output independently of the architecture running the software. If
|
||||
there are diferences in the serialization hash validations will fail altough the transaction is correct
|
||||
|
||||
##### Example
|
||||
|
||||
```python
|
||||
a = r.expr({'a': 1}).to_json().run(b.connection)
|
||||
u'{"a":1}'
|
||||
|
||||
b = json.dumps({'a': 1})
|
||||
'{"a": 1}'
|
||||
|
||||
a == b
|
||||
False
|
||||
```
|
||||
|
||||
We should provide the serialization and deserialization so that the following is always true.
|
||||
|
||||
##### Example
|
||||
|
||||
```python
|
||||
deserialize(serialize(data)) == data
|
||||
True
|
||||
```
|
||||
|
||||
### Standard serialization for the bigchain
|
||||
|
||||
After looking at this further I think that the python json module is still the best bet because it
|
||||
complies with the RFC. We can specify the encoding, separators used and enforce it to order by the keys to
|
||||
make sure that we obtain maximum interopelability.
|
||||
|
||||
```python
|
||||
import json
|
||||
|
||||
json.dumps(data, skipkeys=False, ensure_ascii=False, encoding="utf-8",
|
||||
separators=(',', ':'), sort_keys=True)
|
||||
```
|
||||
|
||||
- `skipkeys`: With skipkeys `False` if the provided keys are not a string the serialization will fail. This way we
|
||||
enforce all keys to be strings
|
||||
- `ensure_ascii`: The RFC recommends `utf-8` for maximum interoperability. By setting ensure_ascii to `False` we
|
||||
allow unicode characters and force the encoding to `utf-8`.
|
||||
- `separators`: We need to define a standard separator to use in the serialization. We did not do this different
|
||||
implementations could use different separators for serialization resulting in a still valid transaction but with
|
||||
a different hash e. g. an extra whitespace introduced in the serialization would not still create a valid json object
|
||||
but the hash would be different
|
||||
|
||||
##### Example
|
||||
|
||||
Everytime we need to perform some operation on the data like calculating the hash or signing/verifying the transaction
|
||||
we need to use the previous criteria to serialize the data and then use the `byte` representation of the serialized
|
||||
data (if we threat the data as bytes we eliminate possible enconding errors e.g. unicode characters)
|
||||
|
||||
```python
|
||||
# calculate the hash of a transaction
|
||||
# the transaction is a dictionary
|
||||
tx_serialized = bytes(serialize(tx))
|
||||
tx_hash = hashlib.sha3_256(tx_serialized).hexdigest()
|
||||
|
||||
# signing a transaction
|
||||
tx_serialized = bytes(serialize(tx))
|
||||
signature = sk.sign(tx_serialized)
|
||||
|
||||
# verify signature
|
||||
tx_serialized = bytes(serialize(tx))
|
||||
vk.verify(signature, tx_serialized)
|
||||
```
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
Here we define the components needed for the software implementation of the prototype.
|
||||
|
||||
#### bigspool
|
||||
|
||||
Bigchain implementation of the spool protocol
|
||||
|
||||
#### bigchain
|
||||
|
||||
API to create, read, and push transactions to the bigchain
|
||||
|
||||
#### validator
|
||||
|
||||
Transaction validator. Decides which transactions to include in the bigchain. Each node in the federation will be
|
||||
running this code and the a transaction will be valid as long as more then half the nodes decided that the transaction
|
||||
is valid
|
||||
|
||||
#### processor
|
||||
|
||||
Creates the blocks from the transactions and cleans the backlog.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
### Generic Validation
|
||||
|
||||
1. Query the bigchain and check if `current_owner` actually owns the `hash`.
|
||||
2. Check if the transaction was signed with `current_owner` private key.
|
||||
|
||||
### Specific Validation
|
||||
|
||||
1. Query the bigchain and check if `current_owner` actually owns the `hash`.
|
||||
2. Check if the transaction was signed with `current_owner` private key.
|
||||
3. Depending on the `operation` additional checks may need to be performed. This will be specified by the protocol
|
||||
running in the chain e. g. [Spool protocol](https://github.com/ascribe/spool)
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
# Server/Cluster Deployment and Administration
|
||||
|
||||
This section covers everything which might concern a BigchainDB server/cluster administrator:
|
||||
* deployment
|
||||
* security
|
||||
* monitoring
|
||||
* troubleshooting
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# Contributing to the BigchainDB Project
|
||||
|
||||
If you're interested in contributing to the BigchainDB project, you can find out how in the [CONTRIBUTING.md file](https://github.com/BigchainDB/bigchaindb/blob/master/CONTRIBUTING.md) (in the root directory of the BigchainDB repository).
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
# Cryptography
|
||||
|
||||
The section documents the cryptographic algorithms and Python implementations that we use.
|
||||
|
||||
The implementations that we have chosen for now are just for fast prototyping. Some of them are pure Python implementations which may be slow. As future work, we should look at other alternatives.
|
||||
|
||||
## Hashes
|
||||
|
||||
For hashing we are using the sha3-256 algorithm and [pysha3](https://bitbucket.org/tiran/pykeccak) as the Python implementation. We store the hex encoded hash in the database. For example:
|
||||
|
||||
```python
|
||||
import hashlib
|
||||
# monkey patch hashlib with sha3 functions
|
||||
import sha3
|
||||
|
||||
data = "message"
|
||||
tx_hash = hashlib.sha3_256(data).hexdigest()
|
||||
```
|
||||
|
||||
## Keys
|
||||
|
||||
For signing and veryfing signatures we are using the ECDSA with 192bit key lengths and
|
||||
[python-ecdsa](https://github.com/warner/python-ecdsa) as the python implementation.
|
||||
|
||||
The public-key or verification key are converted to string and hex encoded before storing them to the blockchain. For example:
|
||||
|
||||
```python
|
||||
import binascii
|
||||
from ecdsa import SigningKey
|
||||
|
||||
# generate signing key in hex encoded form
|
||||
sk = SigningKey.generate()
|
||||
sk_hex = binascii.hexlify(sk.to_string())
|
||||
|
||||
# get signing key from hex
|
||||
sk = SigningKey.from_string(binascii.unhexlify(sk_hex))
|
||||
```
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
# Frequently Asked Questions (FAQ)
|
||||
|
||||
## Questions About the BigchainDB Whitepaper
|
||||
|
||||
**Question 1?**
|
||||
|
||||
Answer 1.
|
||||
|
||||
**Question 2?**
|
||||
|
||||
Answer 2.
|
||||
|
||||
## Other Questions
|
||||
|
||||
**Why do we use blocks and not just create the chain with transactions?**
|
||||
|
||||
With distributed data stores there is no guarantees in the order in which transactions will be commited to the database. Witouth knowing what is previous transactions to be commited to the database we cannot include its hash in the current transaction to build the chain.
|
||||
|
||||
To solve this problem we decided to use blocks and create the chain with the blocks.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# Getting Started
|
||||
|
||||
Some short examples of using BigchainDB, i.e. short tutorials.
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
.. You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
BigchainDB Documentation
|
||||
========================
|
||||
|
||||
Table of Contents
|
||||
-----------------
|
||||
|
||||
Note to reviewers of this documentation: For now, *all* documentation files (.rst and .md) are at the same level in the Table of Contents heirarchy. Later, we can organize them into a more sensible heirarchy.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:numbered:
|
||||
|
||||
installing
|
||||
getting-started
|
||||
admin
|
||||
contributing
|
||||
faq
|
||||
release-notes
|
||||
software-architecture
|
||||
the-bigchain-class
|
||||
cryptography
|
||||
models
|
||||
json-serialization
|
||||
transaction-validation
|
||||
rethinkdb-benchmarks
|
||||
|
||||
|
||||
Indices and Tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
# Installing BigchainDB
|
||||
|
||||
Link to RethinkDB installation instructions
|
||||
|
||||
How to install BigchainDB
|
||||
|
||||
Installing with Docker?
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
############
|
||||
Introduction
|
||||
############
|
||||
|
||||
This section will introduce BigchainDB.
|
||||
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
# JSON Serialization
|
||||
|
||||
We needed to clearly define how to serialize a JSON object to calculate the hash.
|
||||
|
||||
The serialization should produce the same byte output independently of the architecture running the software. If there are diferences in the serialization, hash validations will fail although the transaction is correct.
|
||||
|
||||
For example, consider the following two methods of serializing `{'a': 1}`:
|
||||
```python
|
||||
# Use a serializer provided by RethinkDB
|
||||
a = r.expr({'a': 1}).to_json().run(b.connection)
|
||||
u'{"a":1}'
|
||||
|
||||
# Use the serializer in Python's json module
|
||||
b = json.dumps({'a': 1})
|
||||
'{"a": 1}'
|
||||
|
||||
a == b
|
||||
False
|
||||
```
|
||||
|
||||
The results are not the same. We want a serialization and deserialization so that the following is always true:
|
||||
```python
|
||||
deserialize(serialize(data)) == data
|
||||
True
|
||||
```
|
||||
|
||||
After looking at this further, we decided that the python json module is still the best bet because it complies with the RFC. We can specify the encoding, separators used and enforce it to order by the keys to make sure that we obtain maximum interopelability.
|
||||
|
||||
```python
|
||||
import json
|
||||
|
||||
json.dumps(data, skipkeys=False, ensure_ascii=False,
|
||||
encoding="utf-8", separators=(',', ':'),
|
||||
sort_keys=True)
|
||||
```
|
||||
|
||||
- `skipkeys`: With skipkeys `False` if the provided keys are not a string the serialization will fail. This way we enforce all keys to be strings
|
||||
- `ensure_ascii`: The RFC recommends `utf-8` for maximum interoperability. By setting ensure_ascii to `False` we allow unicode characters and force the encoding to `utf-8`.
|
||||
- `separators`: We need to define a standard separator to use in the serialization. We did not do this different implementations could use different separators for serialization resulting in a still valid transaction but with a different hash e. g. an extra whitespace introduced in the serialization would not still create a valid json object but the hash would be different.
|
||||
|
||||
Every time we need to perform some operation on the data like calculating the hash or signing/verifying the transaction, we need to use the previous criteria to serialize the data and then use the `byte` representation of the serialized data (if we treat the data as bytes we eliminate possible encoding errors e.g. unicode characters). For example:
|
||||
```python
|
||||
# calculate the hash of a transaction
|
||||
# the transaction is a dictionary
|
||||
tx_serialized = bytes(serialize(tx))
|
||||
tx_hash = hashlib.sha3_256(tx_serialized).hexdigest()
|
||||
|
||||
# signing a transaction
|
||||
tx_serialized = bytes(serialize(tx))
|
||||
signature = sk.sign(tx_serialized)
|
||||
|
||||
# verify signature
|
||||
tx_serialized = bytes(serialize(tx))
|
||||
vk.verify(signature, tx_serialized)
|
||||
```
|
||||
|
|
@ -1,92 +0,0 @@
|
|||
# The Transaction, Block and Vote Models
|
||||
|
||||
Transactions, blocks and votes are represented using JSON documents with the following models (schemas).
|
||||
|
||||
## The Transaction Model
|
||||
|
||||
```
|
||||
{
|
||||
"id": "<sha3 hash>",
|
||||
"transaction": {
|
||||
"current_owner": "<pub-key>",
|
||||
"new_owner": "<pub-key>",
|
||||
"input": "<sha3 hash>",
|
||||
"operation": "<string>",
|
||||
"timestamp": "<rethinkdb timestamp>",
|
||||
"data": {
|
||||
"hash": "<sha3 hash>",
|
||||
...
|
||||
}
|
||||
},
|
||||
"signature": "<ECDSA 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`
|
||||
|
||||
- `id`: sha3 hash of the transaction and rethinkdb primary key. By using the hash of the transaction of the
|
||||
primary key we eliminate the problem of duplicated transactions, if for some reason two nodes decide to create the
|
||||
same transaction
|
||||
- `current_owner`: Public key of the current owner of the digital content with hash `hash`
|
||||
- `new_owner`: Public key of the new owner of the digital content with hash `hash`
|
||||
- `input`: 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.
|
||||
- `operation`: String representation of the operation being performed (REGISTER, TRANSFER, ...) this will define how
|
||||
the transactions should be validated
|
||||
- `timestamp`: Time of creation of the transaction in UTC
|
||||
- `data`: Json object describing the asset (digital content). It contains at least the field `hash` which is a
|
||||
sha3 hash of the digital content.
|
||||
- `signature`: ECDSA signature of the transaction with the `current_owner` private key
|
||||
|
||||
## The Block Model
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "<sha3 hash of the list of transactions + timestamp + nodes_pubkeys>",
|
||||
"block": {
|
||||
"timestamp": "<RethinkDB timestamp>",
|
||||
"transactions": ["<list of transactions>"],
|
||||
"node_pubkey": "<public key of the node creating the block>",
|
||||
"voters": ["<list of federation nodes pulic keys>"]
|
||||
},
|
||||
"signature": "<signature of the block>",
|
||||
"votes": []
|
||||
}
|
||||
```
|
||||
|
||||
Still to be defined when new blocks are created (after x number of transactions, or after x amount of seconds,
|
||||
or both).
|
||||
A block contains a group of transactions and includes the hash of the hash of the previous block to build the chain.
|
||||
|
||||
- `id`: sha3 hash of the current block. This is also a rethinkdb primary key, this way we make sure that all blocks are unique.
|
||||
- `block`: The actual block
|
||||
- `timestamp`: timestamp when the block was created
|
||||
- `transactions`: the list of transactions included in the block
|
||||
- `node_pubkey`: the public key of the node that create the block
|
||||
- `voters`: list public keys of the federation nodes. Since the size of the
|
||||
federation may change over time this will tell us how many nodes existed
|
||||
in the federation when the block was created so that in a later point in
|
||||
time we can check that the block received the correct number of votes.
|
||||
- `signature`: Signature of the block by the node that created the block
|
||||
- `votes`: Initially an empty list. Nodes in the voters list will append to it
|
||||
has they vote on the block
|
||||
|
||||
|
||||
## The Vote Model
|
||||
|
||||
This is the structure that each node will append to the block `votes` list.
|
||||
|
||||
```json
|
||||
{
|
||||
"node_pubkey": "<the pubkey of the voting node>",
|
||||
"vote": {
|
||||
"voting_for_block": "<id of the block the node is voting for>",
|
||||
"previous_block": "<id of the block previous to this one>",
|
||||
"is_block_valid": "<true|false>",
|
||||
"invalid_reason": "<None|DOUBLE_SPEND|TRANSACTIONS_HASH_MISMATCH|NODES_PUBKEYS_MISMATCH",
|
||||
"timestamp": "<rethinkdb timestamp of the voting action>"
|
||||
},
|
||||
"signature": "<ECDSA signature of vote block>"
|
||||
}
|
||||
```
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
#########
|
||||
Reference
|
||||
#########
|
||||
|
||||
This is the reference section of the documentation.
|
||||
|
||||
.. autoclass:: bigchain.Bigchain
|
||||
:members:
|
||||
|
||||
.. automethod:: bigchain.core.Bigchain.__init__
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# Release Notes
|
||||
|
||||
This section has the release notes for each version of BigChainDB.
|
||||
|
|
@ -1,195 +0,0 @@
|
|||
# RethinkDB Benchmarks
|
||||
|
||||
## Goal
|
||||
|
||||
The goal was to test RethinkDB scalability properties, to understand its limits, and to see if we could reach a speed of 1M transactions per second.
|
||||
|
||||
## Terminology
|
||||
|
||||
### Settings
|
||||
|
||||
To test the writing performance of rethinkdb we have a process that inserts a
|
||||
block in the database in an infinite loop
|
||||
|
||||
The block is a valid block with small transactions (transactions without any
|
||||
payload). The entire block has around 900KB
|
||||
|
||||
```python
|
||||
while True:
|
||||
r.table(table).insert(r.json(BLOCK_SERIALIZED), durability='soft').run(conn)
|
||||
```
|
||||
|
||||
In `hard` durability mode, writes are committed to disk before acknowledgments
|
||||
are sent; in `soft` mode, writes are acknowledged immediately after being stored
|
||||
in memory.
|
||||
|
||||
This means that the insert will block until rethinkdb acknowledges that the data
|
||||
was cached. In each server we can start multiple process.
|
||||
|
||||
### Write units
|
||||
|
||||
Lets define `1 write unit` as being 1 process. For example in a 32 node cluster
|
||||
with each node running 2 processes we would have `64 writes`. This will make it
|
||||
easier to compare different tests.
|
||||
|
||||
### Sharding
|
||||
|
||||
Sharding in distributed datastores means partitioning a table so that the data
|
||||
can be evenly distributed between all nodes in the cluster. In rethinkdb and
|
||||
most distributed datastores there is a maximum limit of 32 shards per table.
|
||||
|
||||
In rethinkdb a `shard` is also called a `primary replica`, since by default the
|
||||
replication factor is 1. Increasing the replication factor produces `secondary
|
||||
replicas` that are used for data redundancy (if a node holding a primary replica
|
||||
goes down another node holding a secondary replica of the same data can step up
|
||||
and become the primary replica)
|
||||
|
||||
For these tests we are using 32 core ec2 instances with SSD storage and 10Gbps
|
||||
network connections (`c3.8xlarge`). For the tests we used either 32 or 64 node
|
||||
clusters all running on the same aws region.
|
||||
|
||||
These tests show rethinkdb performance and what we can expect from the database.
|
||||
This does not show the performance of the bigchain
|
||||
|
||||
## Tests
|
||||
|
||||
### Test 1
|
||||
|
||||
- **number of nodes**: 32
|
||||
- **number of processes**: 2 processes per node
|
||||
- **write units**: 32 x 2 = 64 writes
|
||||
- **output**: stable 1K writes per second
|
||||
|
||||
This was the most successful test. We are able to reach a stable output of 1K
|
||||
blocks per second. The load on the machines is stable and the IO is at an
|
||||
average of 50-60 %.
|
||||
|
||||
Other tests have shown that increasing the number write units per machine can
|
||||
lead to a stable performance up to 1.5K writes per second but the load on the
|
||||
nodes would increase until the node would eventually fail. This means that we
|
||||
are able to handle bursts for a short amount of time (10-20 min).
|
||||
|
||||
This test can be used has a baseline for the future in where 64 writes equal 1K
|
||||
transactions per second. Or that each write unit produces an output of
|
||||
`1000/64` writes per second, approximately 16 writes per second.
|
||||
|
||||
|
||||
### Test 2
|
||||
|
||||
- **number of nodes**: 32
|
||||
- **number of processes**:
|
||||
- 16 nodes running 2 processes
|
||||
- 16 nodes running 3 processes
|
||||
- **write units**: 16 x 3 + 16 x 2 = 80 writes
|
||||
- **expected output**: 1250 writes per second
|
||||
- **output**: stable 1.2K writes per second
|
||||
|
||||
Increasing a bit the number of write units shows an increase in output close to
|
||||
the expected value but in this case the IO around 90 % close to the limit that
|
||||
the machine can handle.
|
||||
|
||||
|
||||
### Test 3
|
||||
|
||||
- **number of nodes**: 32
|
||||
- **number of processes**:
|
||||
- 16 nodes running 2 processes
|
||||
- 16 nodes running 4 processes
|
||||
- **write units**: 16 x 4 + 16 x 2 = 96 writes
|
||||
- **expected output**: 1500 writes per second
|
||||
- **output**: stable 1.4K writes per second
|
||||
|
||||
These test produces results similar to previous one. The reason why we don't
|
||||
reach the expected output may be because rethinkdb needs time to cache results
|
||||
and at some point increasing the number of write units will not result in an
|
||||
higher output. Another problem is that as the rethinkdb cache fills (because the
|
||||
rethinkdb is not able to flush the data to disk fast enough due to IO
|
||||
limitations) the performance will decrease because the processes will take more
|
||||
time inserting blocks.
|
||||
|
||||
|
||||
### Test 4
|
||||
|
||||
- **number of nodes**: 64
|
||||
- **number of processes**: 1 process per node
|
||||
- **write units**: 64 x 1 = 64 writes
|
||||
- **expected output**: 1000 writes per second
|
||||
- **output**: stable 1K writes per second
|
||||
|
||||
In this case we are increasing the number of nodes in the cluster by 2x. This
|
||||
won't have an impact in the write performance because the maximum amount of
|
||||
shards per table in rethinkdb is 32 (rethinkdb will probably increase this limit
|
||||
in the future). What this provides is more CPU power (and storage for replicas,
|
||||
more about replication in the next section). We just halved the amount write
|
||||
units per node maintaining the same output. The IO in the nodes holding the
|
||||
primary replica is the same has test 1.
|
||||
|
||||
|
||||
### Test 5
|
||||
|
||||
- **number of nodes**: 64
|
||||
- **number of processes**: 2 process per node
|
||||
- **write units**: 64 x 2 = 128 writes
|
||||
- **expected output**: 2000 writes per second
|
||||
- **output**: unstable 2K (peak) writes per second
|
||||
|
||||
|
||||
In this case we are doubling the amount of write units. We are able to reach the
|
||||
expected output but the output performance is unstable due to the fact that we
|
||||
reached the IO limit on the machines.
|
||||
|
||||
|
||||
### Test 6
|
||||
|
||||
|
||||
- **number of nodes**: 64
|
||||
- **number of processes**:
|
||||
- 32 nodes running 1 processes
|
||||
- 32 nodes running 2 processes
|
||||
- **write units**: 32 x 2 + 32 x 1 = 96 writes
|
||||
- **expected output**: 1500 writes per second
|
||||
- **output**: stable 1.5K writes per second
|
||||
|
||||
This test is similar to Test 3. The only difference is that now the write units
|
||||
are distributed between 64 nodes meaning that each node is writing to its local
|
||||
cache and we don't overload the cache of the nodes like we did with Test 3. This
|
||||
is another advantage of adding more nodes beyond 32.
|
||||
|
||||
|
||||
## Testing replication
|
||||
|
||||
Replication is used for data redundancy. In rethinkdb we are able to specify the
|
||||
number of shards and replicas per table. Data in secondary replicas is no
|
||||
directly used, its just a mirror of a primary replica and used in case the node
|
||||
holding the primary replica fails.
|
||||
|
||||
Rethinkdb does a good job trying to distribute data evenly between nodes. We ran
|
||||
some tests to check this.
|
||||
|
||||
Note that by increasing the number of replicas we also increase the number of
|
||||
writes in the cluster. For a replication factor of 2 we double the amount of
|
||||
writes on the cluster, with a replication factor of 3 we triple the amount of
|
||||
writes and so on.
|
||||
|
||||
|
||||
With 64 nodes and since we can only have 32 shards we have 32 nodes holding
|
||||
shards (primary replicas)
|
||||
|
||||
With a replication factor of 2 we will have 64 replicas (32 primary replicas and
|
||||
32 secondary replicas). Since we already have 32 nodes holding the 32
|
||||
shards/primary replicas rethinkdb uses the other 32 nodes to hold the secondary
|
||||
replicas. So in a 64 node cluster with 32 shards and a replication factor of 2,
|
||||
32 nodes will be holding the primary replicas and the other 32 nodes will be holding
|
||||
the secondary replicas.
|
||||
|
||||
With this setup if we run Test 4 now that we have a replication factor of 2 we
|
||||
will have twice the amount of writes but a nice result is that the IO in the
|
||||
nodes holding the primary replicas does not increase when compared to Test 4
|
||||
because all of the excess writing is now being done the 32 nodes holding the
|
||||
secondary replicas.
|
||||
|
||||
Another fact about replication. If I have a 64 node cluster and create a table
|
||||
with 32 shards, 32 nodes will be holding primary replicas and the other nodes do
|
||||
not hold any data. If I create another table with 32 shards rethinkdb will
|
||||
create the shards in the nodes that where not holding any data, evenly
|
||||
distributing the data.
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
# BigchainDB Software Architecture
|
||||
|
||||
Here we define the components needed for the software implementation of the prototype.
|
||||
|
||||
## bigspool
|
||||
|
||||
Bigchain implementation of the spool protocol
|
||||
|
||||
## bigchain
|
||||
|
||||
API to create, read, and push transactions to the bigchain
|
||||
|
||||
## validator
|
||||
|
||||
Transaction validator. Decides which transactions to include in the bigchain. Each node in the federation will be
|
||||
running this code and the a transaction will be valid as long as more then half the nodes decided that the transaction
|
||||
is valid
|
||||
|
||||
## processor
|
||||
|
||||
Creates the blocks from the transactions and cleans the backlog.
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
Test
|
||||
====
|
||||
|
||||
This is a test page.
|
||||
|
||||
This is a test sentence.
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
##################
|
||||
The Bigchain Class
|
||||
##################
|
||||
|
||||
The Bigchain class is the top-level API for BigchainDB. If you want to create and initialize a BigchainDB database, you create a Bigchain instance (object). Then you can use its various methods to create transactions, write transactions (to the object/database), read transactions, etc.
|
||||
|
||||
.. autoclass:: bigchain.Bigchain
|
||||
:members:
|
||||
|
||||
.. automethod:: bigchain.core.Bigchain.__init__
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Transaction Validation
|
||||
|
||||
## Generic Validation
|
||||
|
||||
1. Query the bigchain and check if `current_owner` actually owns the `hash`.
|
||||
2. Check if the transaction was signed with `current_owner` private key.
|
||||
|
||||
## Specific Validation
|
||||
|
||||
1. Query the bigchain and check if `current_owner` actually owns the `hash`.
|
||||
2. Check if the transaction was signed with `current_owner` private key.
|
||||
3. Depending on the `operation` additional checks may need to be performed. This will be specified by the protocol
|
||||
running in the chain e. g. [Spool protocol](https://github.com/ascribe/spool)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 673 B |
|
|
@ -1,593 +0,0 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
|
||||
font-size: 17px;
|
||||
background-color: white;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 940px;
|
||||
margin: 30px auto 0 auto;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 220px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
width: 220px;
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid #B1B4B6;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #3E4349;
|
||||
padding: 0 30px 0 30px;
|
||||
}
|
||||
|
||||
div.body > .section {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
width: 940px;
|
||||
margin: 20px auto 30px auto;
|
||||
font-size: 14px;
|
||||
color: #888;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #888;
|
||||
}
|
||||
|
||||
|
||||
div.relations {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #444;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a:hover {
|
||||
border-bottom: 1px solid #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
font-size: 14px;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 18px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.logo {
|
||||
padding: 0;
|
||||
margin: -10px 0 0 0px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper h1.logo {
|
||||
margin-top: -10px;
|
||||
text-align: center;
|
||||
margin-bottom: 5px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper h1.logo-name {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.blurb {
|
||||
margin-top: 0;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3,
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
color: #444;
|
||||
font-size: 24px;
|
||||
font-weight: normal;
|
||||
margin: 0 0 5px 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-size: 20px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo a,
|
||||
div.sphinxsidebar h3 a,
|
||||
div.sphinxsidebar p.logo a:hover,
|
||||
div.sphinxsidebar h3 a:hover {
|
||||
border: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #555;
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px 0;
|
||||
padding: 0;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul li.toctree-l1 > a {
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul li.toctree-l2 > a {
|
||||
font-size: 110%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #CCC;
|
||||
font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar hr {
|
||||
border: none;
|
||||
height: 1px;
|
||||
color: #AAA;
|
||||
background: #AAA;
|
||||
|
||||
text-align: left;
|
||||
margin-left: 0;
|
||||
width: 50%;
|
||||
}
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
a {
|
||||
color: #004B6B;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #6D4100;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
margin: 30px 0px 10px 0px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
|
||||
div.body h2 { font-size: 180%; }
|
||||
div.body h3 { font-size: 150%; }
|
||||
div.body h4 { font-size: 130%; }
|
||||
div.body h5 { font-size: 100%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #DDD;
|
||||
padding: 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
color: #444;
|
||||
background: #EAEAEA;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
line-height: 1.4em;
|
||||
}
|
||||
|
||||
div.admonition {
|
||||
margin: 20px 0px;
|
||||
padding: 10px 30px;
|
||||
background-color: #FCC;
|
||||
border: 1px solid #FAA;
|
||||
}
|
||||
|
||||
div.admonition tt.xref, div.admonition a tt {
|
||||
border-bottom: 1px solid #fafafa;
|
||||
}
|
||||
|
||||
dd div.admonition {
|
||||
margin-left: -60px;
|
||||
padding-left: 60px;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
font-size: 24px;
|
||||
margin: 0 0 10px 0;
|
||||
padding: 0;
|
||||
line-height: 1;
|
||||
}
|
||||
|
||||
div.admonition p.last {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.highlight {
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
dt:target, .highlight {
|
||||
background: #FAF3E8;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre, tt, code {
|
||||
font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.hll {
|
||||
background-color: #FFC;
|
||||
margin: 0 -12px;
|
||||
padding: 0 12px;
|
||||
display: block;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
}
|
||||
|
||||
tt.descname, tt.descclassname, code.descname, code.descclassname {
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
tt.descname, code.descname {
|
||||
padding-right: 0.08em;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils {
|
||||
border: 1px solid #888;
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
border: 1px solid #888;
|
||||
padding: 0.25em 0.7em;
|
||||
}
|
||||
|
||||
table.field-list, table.footnote {
|
||||
border: none;
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
table.footnote {
|
||||
margin: 15px 0;
|
||||
width: 100%;
|
||||
border: 1px solid #EEE;
|
||||
background: #FDFDFD;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
table.footnote + table.footnote {
|
||||
margin-top: -15px;
|
||||
border-top: none;
|
||||
}
|
||||
|
||||
table.field-list th {
|
||||
padding: 0 0.8em 0 0;
|
||||
}
|
||||
|
||||
table.field-list td {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.field-list p {
|
||||
margin-bottom: 0.8em;
|
||||
}
|
||||
|
||||
table.footnote td.label {
|
||||
width: 0px;
|
||||
padding: 0.3em 0 0.3em 0.5em;
|
||||
}
|
||||
|
||||
table.footnote td {
|
||||
padding: 0.3em 0.5em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
margin: 0 0 0 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul, ol {
|
||||
margin: 10px 0 10px 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
pre {
|
||||
background: #EEE;
|
||||
padding: 7px 30px;
|
||||
margin: 15px 0px;
|
||||
line-height: 1.3em;
|
||||
}
|
||||
|
||||
dl pre, blockquote pre, li pre {
|
||||
margin-left: 0;
|
||||
padding-left: 30px;
|
||||
}
|
||||
|
||||
dl dl pre {
|
||||
margin-left: -90px;
|
||||
padding-left: 90px;
|
||||
}
|
||||
|
||||
tt, code {
|
||||
background-color: #ecf0f3;
|
||||
color: #222;
|
||||
/* padding: 1px 2px; */
|
||||
}
|
||||
|
||||
tt.xref, code.xref, a tt {
|
||||
background-color: #FBFBFB;
|
||||
border-bottom: 1px solid white;
|
||||
}
|
||||
|
||||
a.reference {
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
a.reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a.footnote-reference {
|
||||
text-decoration: none;
|
||||
font-size: 0.7em;
|
||||
vertical-align: top;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
a.footnote-reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a:hover tt, a:hover code {
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
|
||||
@media screen and (max-width: 870px) {
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
margin-left: 0;
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.document {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.github {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
@media screen and (max-width: 875px) {
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
padding: 20px 30px;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: none;
|
||||
background: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: block;
|
||||
float: none;
|
||||
width: 102.5%;
|
||||
margin: 50px -30px -20px -30px;
|
||||
padding: 10px 20px;
|
||||
background: #333;
|
||||
color: #FFF;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
|
||||
div.sphinxsidebar h3 a {
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #AAA;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.body {
|
||||
min-height: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.rtd_doc_footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.document {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.github {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/* misc. */
|
||||
|
||||
.revsys-inline {
|
||||
display: none!important;
|
||||
}
|
||||
|
||||
/* Make nested-list/multi-paragraph items look better in Releases changelog
|
||||
* pages. Without this, docutils' magical list fuckery causes inconsistent
|
||||
* formatting between different release sub-lists.
|
||||
*/
|
||||
div#changelog > div.section > ul > li > p:only-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
/* Hide fugly table cell borders in ..bibliography:: directive output */
|
||||
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
|
||||
border: none;
|
||||
/* Below needed in some edge cases; if not applied, bottom shadows appear */
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
|
@ -1,599 +0,0 @@
|
|||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
width: 170px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
width: 30px;
|
||||
}
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable dl, table.indextable dd {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px 7px 0 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px 7px 0 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition dl {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
table.footnote td, table.footnote th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dt:target, .highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
margin-left: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
padding: 0 0.5em 0 0.5em;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
div.code-block-caption + div > div.highlight > pre {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
padding: 1em 1em 0;
|
||||
}
|
||||
|
||||
div.literal-block-wrapper div.highlight {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.4 KiB |
|
|
@ -1,263 +0,0 @@
|
|||
/*
|
||||
* doctools.js
|
||||
* ~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* select a different prefix for underscore
|
||||
*/
|
||||
$u = _.noConflict();
|
||||
|
||||
/**
|
||||
* make the code below compatible with browsers without
|
||||
* an installed firebug like debugger
|
||||
if (!window.console || !console.firebug) {
|
||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
||||
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
||||
"profile", "profileEnd"];
|
||||
window.console = {};
|
||||
for (var i = 0; i < names.length; ++i)
|
||||
window.console[names[i]] = function() {};
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s == 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node) {
|
||||
if (node.nodeType == 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
|
||||
var span = document.createElement("span");
|
||||
span.className = className;
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this);
|
||||
});
|
||||
}
|
||||
}
|
||||
return this.each(function() {
|
||||
highlight(this);
|
||||
});
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
var Documentation = {
|
||||
|
||||
init : function() {
|
||||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated == 'undefined')
|
||||
return string;
|
||||
return (typeof translated == 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated == 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
||||
addTranslations : function(catalog) {
|
||||
for (var key in catalog.messages)
|
||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||
this.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* add context elements like header anchor links
|
||||
*/
|
||||
addContextElements : function() {
|
||||
$('div[id] > :header:first').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this headline')).
|
||||
appendTo(this);
|
||||
});
|
||||
$('dt[id]').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this definition')).
|
||||
appendTo(this);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords : function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||
if (terms.length) {
|
||||
var body = $('div.body');
|
||||
if (!body.length) {
|
||||
body = $('body');
|
||||
}
|
||||
window.setTimeout(function() {
|
||||
$.each(terms, function() {
|
||||
body.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
}, 10);
|
||||
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
||||
.appendTo($('#searchbox'));
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* init the domain index toggle buttons
|
||||
*/
|
||||
initIndexTable : function() {
|
||||
var togglers = $('img.toggler').click(function() {
|
||||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
$('tr.cg-' + idnum).toggle();
|
||||
if (src.substr(-9) == 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
}).css('display', '');
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
||||
togglers.click();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords : function() {
|
||||
$('#searchbox .highlight-link').fadeOut(300);
|
||||
$('span.highlighted').removeClass('highlighted');
|
||||
},
|
||||
|
||||
/**
|
||||
* make the url absolute
|
||||
*/
|
||||
makeURL : function(relativeURL) {
|
||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||
},
|
||||
|
||||
/**
|
||||
* get the current relative url
|
||||
*/
|
||||
getCurrentURL : function() {
|
||||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this == '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
}
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
_ = Documentation.gettext;
|
||||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 347 B |
Binary file not shown.
|
Before Width: | Height: | Size: 347 B |
Binary file not shown.
|
Before Width: | Height: | Size: 358 B |
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
Binary file not shown.
|
Before Width: | Height: | Size: 173 B |
Binary file not shown.
|
Before Width: | Height: | Size: 173 B |
|
|
@ -1,65 +0,0 @@
|
|||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #eeffcc; }
|
||||
.highlight .c { color: #408090; font-style: italic } /* Comment */
|
||||
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
|
||||
.highlight .o { color: #666666 } /* Operator */
|
||||
.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #007020 } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
|
||||
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
||||
.highlight .go { color: #333333 } /* Generic.Output */
|
||||
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
|
||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||
.highlight .gt { color: #0044DD } /* Generic.Traceback */
|
||||
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #902000 } /* Keyword.Type */
|
||||
.highlight .m { color: #208050 } /* Literal.Number */
|
||||
.highlight .s { color: #4070a0 } /* Literal.String */
|
||||
.highlight .na { color: #4070a0 } /* Name.Attribute */
|
||||
.highlight .nb { color: #007020 } /* Name.Builtin */
|
||||
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
|
||||
.highlight .no { color: #60add5 } /* Name.Constant */
|
||||
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
|
||||
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
|
||||
.highlight .ne { color: #007020 } /* Name.Exception */
|
||||
.highlight .nf { color: #06287e } /* Name.Function */
|
||||
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
|
||||
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
|
||||
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #bb60d5 } /* Name.Variable */
|
||||
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #208050 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
|
||||
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
|
||||
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
|
||||
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #235388 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
|
||||
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
|
||||
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
|
||||
|
|
@ -1,651 +0,0 @@
|
|||
/*
|
||||
* searchtools.js_t
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilties for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Simple result scoring code.
|
||||
*/
|
||||
var Scorer = {
|
||||
// Implement the following function to further tweak the score for each result
|
||||
// The function takes a result array [filename, title, anchor, descr, score]
|
||||
// and returns the new score.
|
||||
/*
|
||||
score: function(result) {
|
||||
return result[4];
|
||||
},
|
||||
*/
|
||||
|
||||
// query matches the full name of an object
|
||||
objNameMatch: 11,
|
||||
// or matches in the last dotted part of the object name
|
||||
objPartialMatch: 6,
|
||||
// Additive scores depending on the priority of the object
|
||||
objPrio: {0: 15, // used to be importantResults
|
||||
1: 5, // used to be objectResults
|
||||
2: -5}, // used to be unimportantResults
|
||||
// Used when the priority is not in the mapping.
|
||||
objPrioDefault: 0,
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
// query found in terms
|
||||
term: 5
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
var Search = {
|
||||
|
||||
_index : null,
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
var query = params.q[0];
|
||||
$('input[name="q"]')[0].value = query;
|
||||
this.performSearch(query);
|
||||
}
|
||||
},
|
||||
|
||||
loadIndex : function(url) {
|
||||
$.ajax({type: "GET", url: url, data: null,
|
||||
dataType: "script", cache: true,
|
||||
complete: function(jqxhr, textstatus) {
|
||||
if (textstatus != "success") {
|
||||
document.getElementById("searchindexloader").src = url;
|
||||
}
|
||||
}});
|
||||
},
|
||||
|
||||
setIndex : function(index) {
|
||||
var q;
|
||||
this._index = index;
|
||||
if ((q = this._queued_query) !== null) {
|
||||
this._queued_query = null;
|
||||
Search.query(q);
|
||||
}
|
||||
},
|
||||
|
||||
hasIndex : function() {
|
||||
return this._index !== null;
|
||||
},
|
||||
|
||||
deferQuery : function(query) {
|
||||
this._queued_query = query;
|
||||
},
|
||||
|
||||
stopPulse : function() {
|
||||
this._pulse_status = 0;
|
||||
},
|
||||
|
||||
startPulse : function() {
|
||||
if (this._pulse_status >= 0)
|
||||
return;
|
||||
function pulse() {
|
||||
var i;
|
||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||
var dotString = '';
|
||||
for (i = 0; i < Search._pulse_status; i++)
|
||||
dotString += '.';
|
||||
Search.dots.text(dotString);
|
||||
if (Search._pulse_status > -1)
|
||||
window.setTimeout(pulse, 500);
|
||||
}
|
||||
pulse();
|
||||
},
|
||||
|
||||
/**
|
||||
* perform a search for something (or wait until index is loaded)
|
||||
*/
|
||||
performSearch : function(query) {
|
||||
// create the required interface elements
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
this.startPulse();
|
||||
|
||||
// index already loaded, the browser was quick!
|
||||
if (this.hasIndex())
|
||||
this.query(query);
|
||||
else
|
||||
this.deferQuery(query);
|
||||
},
|
||||
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query : function(query) {
|
||||
var i;
|
||||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
// stem the searchterms and add them to the correct list
|
||||
var stemmer = new Stemmer();
|
||||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = query.split(/\s+/);
|
||||
var objectterms = [];
|
||||
for (i = 0; i < tmp.length; i++) {
|
||||
if (tmp[i] !== "") {
|
||||
objectterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
|
||||
tmp[i] === "") {
|
||||
// skip this "word"
|
||||
continue;
|
||||
}
|
||||
// stem the word
|
||||
var word = stemmer.stemWord(tmp[i].toLowerCase());
|
||||
var toAppend;
|
||||
// select the correct list
|
||||
if (word[0] == '-') {
|
||||
toAppend = excluded;
|
||||
word = word.substr(1);
|
||||
}
|
||||
else {
|
||||
toAppend = searchterms;
|
||||
hlterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
// only add if not already in the list
|
||||
if (!$u.contains(toAppend, word))
|
||||
toAppend.push(word);
|
||||
}
|
||||
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
|
||||
|
||||
// console.debug('SEARCH: searching for:');
|
||||
// console.info('required: ', searchterms);
|
||||
// console.info('excluded: ', excluded);
|
||||
|
||||
// prepare search
|
||||
var terms = this._index.terms;
|
||||
var titleterms = this._index.titleterms;
|
||||
|
||||
// array of [filename, title, anchor, descr, score]
|
||||
var results = [];
|
||||
$('#search-progress').empty();
|
||||
|
||||
// lookup as object
|
||||
for (i = 0; i < objectterms.length; i++) {
|
||||
var others = [].concat(objectterms.slice(0, i),
|
||||
objectterms.slice(i+1, objectterms.length));
|
||||
results = results.concat(this.performObjectSearch(objectterms[i], others));
|
||||
}
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
for (i = 0; i < results.length; i++)
|
||||
results[i][4] = Scorer.score(results[i]);
|
||||
}
|
||||
|
||||
// now sort the results by score (in opposite order of appearance, since the
|
||||
// display function below uses pop() to retrieve items) and then
|
||||
// alphabetically
|
||||
results.sort(function(a, b) {
|
||||
var left = a[4];
|
||||
var right = b[4];
|
||||
if (left > right) {
|
||||
return 1;
|
||||
} else if (left < right) {
|
||||
return -1;
|
||||
} else {
|
||||
// same score: sort alphabetically
|
||||
left = a[1].toLowerCase();
|
||||
right = b[1].toLowerCase();
|
||||
return (left > right) ? -1 : ((left < right) ? 1 : 0);
|
||||
}
|
||||
});
|
||||
|
||||
// for debugging
|
||||
//Search.lastresults = results.slice(); // a copy
|
||||
//console.info('search results:', Search.lastresults);
|
||||
|
||||
// print the results
|
||||
var resultCount = results.length;
|
||||
function displayNextItem() {
|
||||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
if (dirname.match(/\/index\/$/)) {
|
||||
dirname = dirname.substring(0, dirname.length-6);
|
||||
} else if (dirname == 'index/') {
|
||||
dirname = '';
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
} else {
|
||||
// normal html builders
|
||||
listItem.append($('<a/>').attr('href',
|
||||
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
}
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
else {
|
||||
Search.stopPulse();
|
||||
Search.title.text(_('Search Results'));
|
||||
if (!resultCount)
|
||||
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
|
||||
else
|
||||
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
|
||||
Search.status.fadeIn(500);
|
||||
}
|
||||
}
|
||||
displayNextItem();
|
||||
},
|
||||
|
||||
/**
|
||||
* search for object names
|
||||
*/
|
||||
performObjectSearch : function(object, otherterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var objects = this._index.objects;
|
||||
var objnames = this._index.objnames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i;
|
||||
var results = [];
|
||||
|
||||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullname.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullname == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
score += Scorer.objPartialMatch;
|
||||
}
|
||||
var match = objects[prefix][name];
|
||||
var objname = objnames[match[1]][2];
|
||||
var title = titles[match[0]];
|
||||
// If more than one term searched for, we require other words to be
|
||||
// found in the name/title/description
|
||||
if (otherterms.length > 0) {
|
||||
var haystack = (prefix + ' ' + name + ' ' +
|
||||
objname + ' ' + title).toLowerCase();
|
||||
var allfound = true;
|
||||
for (i = 0; i < otherterms.length; i++) {
|
||||
if (haystack.indexOf(otherterms[i]) == -1) {
|
||||
allfound = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!allfound) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
var descr = objname + _(', in ') + title;
|
||||
|
||||
var anchor = match[3];
|
||||
if (anchor === '')
|
||||
anchor = fullname;
|
||||
else if (anchor == '-')
|
||||
anchor = objnames[match[1]][1] + '-' + fullname;
|
||||
// add custom score for some objects according to scorer
|
||||
if (Scorer.objPrio.hasOwnProperty(match[2])) {
|
||||
score += Scorer.objPrio[match[2]];
|
||||
} else {
|
||||
score += Scorer.objPrioDefault;
|
||||
}
|
||||
results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i, j, file;
|
||||
var fileMap = {};
|
||||
var scoreMap = {};
|
||||
var results = [];
|
||||
|
||||
// perform the search on the required terms
|
||||
for (i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
var files = [];
|
||||
var _o = [
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
|
||||
// no match but word was a required one
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
break;
|
||||
}
|
||||
// found search word in contents
|
||||
$u.each(_o, function(o) {
|
||||
var _files = o.files;
|
||||
if (_files === undefined)
|
||||
return
|
||||
|
||||
if (_files.length === undefined)
|
||||
_files = [_files];
|
||||
files = files.concat(_files);
|
||||
|
||||
// set score for the word in each file to Scorer.term
|
||||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {}
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
||||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
if (file in fileMap)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
}
|
||||
}
|
||||
|
||||
// now check if the files don't contain excluded terms
|
||||
for (file in fileMap) {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
titleterms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file) ||
|
||||
$u.contains(titleterms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// if we have still a valid result we can add it to the result list
|
||||
if (valid) {
|
||||
// select one (max) score for the file.
|
||||
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
|
||||
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
|
||||
results.push([filenames[file], titles[file], '', null, score]);
|
||||
}
|
||||
}
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurance, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
var i = textLower.indexOf(this.toLowerCase());
|
||||
if (i > -1)
|
||||
start = i;
|
||||
});
|
||||
start = Math.max(start - 120, 0);
|
||||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
return rv;
|
||||
}
|
||||
};
|
||||
|
||||
$(document).ready(function() {
|
||||
Search.init();
|
||||
});
|
||||
|
|
@ -1,999 +0,0 @@
|
|||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
|
||||
(function() {
|
||||
|
||||
// Baseline setup
|
||||
// --------------
|
||||
|
||||
// Establish the root object, `window` in the browser, or `global` on the server.
|
||||
var root = this;
|
||||
|
||||
// Save the previous value of the `_` variable.
|
||||
var previousUnderscore = root._;
|
||||
|
||||
// Establish the object that gets returned to break out of a loop iteration.
|
||||
var breaker = {};
|
||||
|
||||
// Save bytes in the minified (but not gzipped) version:
|
||||
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
|
||||
|
||||
// Create quick reference variables for speed access to core prototypes.
|
||||
var slice = ArrayProto.slice,
|
||||
unshift = ArrayProto.unshift,
|
||||
toString = ObjProto.toString,
|
||||
hasOwnProperty = ObjProto.hasOwnProperty;
|
||||
|
||||
// All **ECMAScript 5** native function implementations that we hope to use
|
||||
// are declared here.
|
||||
var
|
||||
nativeForEach = ArrayProto.forEach,
|
||||
nativeMap = ArrayProto.map,
|
||||
nativeReduce = ArrayProto.reduce,
|
||||
nativeReduceRight = ArrayProto.reduceRight,
|
||||
nativeFilter = ArrayProto.filter,
|
||||
nativeEvery = ArrayProto.every,
|
||||
nativeSome = ArrayProto.some,
|
||||
nativeIndexOf = ArrayProto.indexOf,
|
||||
nativeLastIndexOf = ArrayProto.lastIndexOf,
|
||||
nativeIsArray = Array.isArray,
|
||||
nativeKeys = Object.keys,
|
||||
nativeBind = FuncProto.bind;
|
||||
|
||||
// Create a safe reference to the Underscore object for use below.
|
||||
var _ = function(obj) { return new wrapper(obj); };
|
||||
|
||||
// Export the Underscore object for **Node.js**, with
|
||||
// backwards-compatibility for the old `require()` API. If we're in
|
||||
// the browser, add `_` as a global object via a string identifier,
|
||||
// for Closure Compiler "advanced" mode.
|
||||
if (typeof exports !== 'undefined') {
|
||||
if (typeof module !== 'undefined' && module.exports) {
|
||||
exports = module.exports = _;
|
||||
}
|
||||
exports._ = _;
|
||||
} else {
|
||||
root['_'] = _;
|
||||
}
|
||||
|
||||
// Current version.
|
||||
_.VERSION = '1.3.1';
|
||||
|
||||
// Collection Functions
|
||||
// --------------------
|
||||
|
||||
// The cornerstone, an `each` implementation, aka `forEach`.
|
||||
// Handles objects with the built-in `forEach`, arrays, and raw objects.
|
||||
// Delegates to **ECMAScript 5**'s native `forEach` if available.
|
||||
var each = _.each = _.forEach = function(obj, iterator, context) {
|
||||
if (obj == null) return;
|
||||
if (nativeForEach && obj.forEach === nativeForEach) {
|
||||
obj.forEach(iterator, context);
|
||||
} else if (obj.length === +obj.length) {
|
||||
for (var i = 0, l = obj.length; i < l; i++) {
|
||||
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
|
||||
}
|
||||
} else {
|
||||
for (var key in obj) {
|
||||
if (_.has(obj, key)) {
|
||||
if (iterator.call(context, obj[key], key, obj) === breaker) return;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Return the results of applying the iterator to each element.
|
||||
// Delegates to **ECMAScript 5**'s native `map` if available.
|
||||
_.map = _.collect = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
results[results.length] = iterator.call(context, value, index, list);
|
||||
});
|
||||
if (obj.length === +obj.length) results.length = obj.length;
|
||||
return results;
|
||||
};
|
||||
|
||||
// **Reduce** builds up a single result from a list of values, aka `inject`,
|
||||
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
|
||||
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduce && obj.reduce === nativeReduce) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
|
||||
}
|
||||
each(obj, function(value, index, list) {
|
||||
if (!initial) {
|
||||
memo = value;
|
||||
initial = true;
|
||||
} else {
|
||||
memo = iterator.call(context, memo, value, index, list);
|
||||
}
|
||||
});
|
||||
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
|
||||
return memo;
|
||||
};
|
||||
|
||||
// The right-associative version of reduce, also known as `foldr`.
|
||||
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
|
||||
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
|
||||
}
|
||||
var reversed = _.toArray(obj).reverse();
|
||||
if (context && !initial) iterator = _.bind(iterator, context);
|
||||
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
|
||||
};
|
||||
|
||||
// Return the first value which passes a truth test. Aliased as `detect`.
|
||||
_.find = _.detect = function(obj, iterator, context) {
|
||||
var result;
|
||||
any(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) {
|
||||
result = value;
|
||||
return true;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Return all the elements that pass a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `filter` if available.
|
||||
// Aliased as `select`.
|
||||
_.filter = _.select = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Return all the elements for which a truth test fails.
|
||||
_.reject = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
each(obj, function(value, index, list) {
|
||||
if (!iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Determine whether all of the elements match a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `every` if available.
|
||||
// Aliased as `all`.
|
||||
_.every = _.all = function(obj, iterator, context) {
|
||||
var result = true;
|
||||
if (obj == null) return result;
|
||||
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Determine if at least one element in the object matches a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `some` if available.
|
||||
// Aliased as `any`.
|
||||
var any = _.some = _.any = function(obj, iterator, context) {
|
||||
iterator || (iterator = _.identity);
|
||||
var result = false;
|
||||
if (obj == null) return result;
|
||||
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (result || (result = iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return !!result;
|
||||
};
|
||||
|
||||
// Determine if a given value is included in the array or object using `===`.
|
||||
// Aliased as `contains`.
|
||||
_.include = _.contains = function(obj, target) {
|
||||
var found = false;
|
||||
if (obj == null) return found;
|
||||
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
|
||||
found = any(obj, function(value) {
|
||||
return value === target;
|
||||
});
|
||||
return found;
|
||||
};
|
||||
|
||||
// Invoke a method (with arguments) on every item in a collection.
|
||||
_.invoke = function(obj, method) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return _.map(obj, function(value) {
|
||||
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
|
||||
});
|
||||
};
|
||||
|
||||
// Convenience version of a common use case of `map`: fetching a property.
|
||||
_.pluck = function(obj, key) {
|
||||
return _.map(obj, function(value){ return value[key]; });
|
||||
};
|
||||
|
||||
// Return the maximum element or (element-based computation).
|
||||
_.max = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return -Infinity;
|
||||
var result = {computed : -Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed >= result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Return the minimum element (or element-based computation).
|
||||
_.min = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return Infinity;
|
||||
var result = {computed : Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed < result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Shuffle an array.
|
||||
_.shuffle = function(obj) {
|
||||
var shuffled = [], rand;
|
||||
each(obj, function(value, index, list) {
|
||||
if (index == 0) {
|
||||
shuffled[0] = value;
|
||||
} else {
|
||||
rand = Math.floor(Math.random() * (index + 1));
|
||||
shuffled[index] = shuffled[rand];
|
||||
shuffled[rand] = value;
|
||||
}
|
||||
});
|
||||
return shuffled;
|
||||
};
|
||||
|
||||
// Sort the object's values by a criterion produced by an iterator.
|
||||
_.sortBy = function(obj, iterator, context) {
|
||||
return _.pluck(_.map(obj, function(value, index, list) {
|
||||
return {
|
||||
value : value,
|
||||
criteria : iterator.call(context, value, index, list)
|
||||
};
|
||||
}).sort(function(left, right) {
|
||||
var a = left.criteria, b = right.criteria;
|
||||
return a < b ? -1 : a > b ? 1 : 0;
|
||||
}), 'value');
|
||||
};
|
||||
|
||||
// Groups the object's values by a criterion. Pass either a string attribute
|
||||
// to group by, or a function that returns the criterion.
|
||||
_.groupBy = function(obj, val) {
|
||||
var result = {};
|
||||
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
|
||||
each(obj, function(value, index) {
|
||||
var key = iterator(value, index);
|
||||
(result[key] || (result[key] = [])).push(value);
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Use a comparator function to figure out at what index an object should
|
||||
// be inserted so as to maintain order. Uses binary search.
|
||||
_.sortedIndex = function(array, obj, iterator) {
|
||||
iterator || (iterator = _.identity);
|
||||
var low = 0, high = array.length;
|
||||
while (low < high) {
|
||||
var mid = (low + high) >> 1;
|
||||
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
|
||||
}
|
||||
return low;
|
||||
};
|
||||
|
||||
// Safely convert anything iterable into a real, live array.
|
||||
_.toArray = function(iterable) {
|
||||
if (!iterable) return [];
|
||||
if (iterable.toArray) return iterable.toArray();
|
||||
if (_.isArray(iterable)) return slice.call(iterable);
|
||||
if (_.isArguments(iterable)) return slice.call(iterable);
|
||||
return _.values(iterable);
|
||||
};
|
||||
|
||||
// Return the number of elements in an object.
|
||||
_.size = function(obj) {
|
||||
return _.toArray(obj).length;
|
||||
};
|
||||
|
||||
// Array Functions
|
||||
// ---------------
|
||||
|
||||
// Get the first element of an array. Passing **n** will return the first N
|
||||
// values in the array. Aliased as `head`. The **guard** check allows it to work
|
||||
// with `_.map`.
|
||||
_.first = _.head = function(array, n, guard) {
|
||||
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
|
||||
};
|
||||
|
||||
// Returns everything but the last entry of the array. Especcialy useful on
|
||||
// the arguments object. Passing **n** will return all the values in
|
||||
// the array, excluding the last N. The **guard** check allows it to work with
|
||||
// `_.map`.
|
||||
_.initial = function(array, n, guard) {
|
||||
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
|
||||
};
|
||||
|
||||
// Get the last element of an array. Passing **n** will return the last N
|
||||
// values in the array. The **guard** check allows it to work with `_.map`.
|
||||
_.last = function(array, n, guard) {
|
||||
if ((n != null) && !guard) {
|
||||
return slice.call(array, Math.max(array.length - n, 0));
|
||||
} else {
|
||||
return array[array.length - 1];
|
||||
}
|
||||
};
|
||||
|
||||
// Returns everything but the first entry of the array. Aliased as `tail`.
|
||||
// Especially useful on the arguments object. Passing an **index** will return
|
||||
// the rest of the values in the array from that index onward. The **guard**
|
||||
// check allows it to work with `_.map`.
|
||||
_.rest = _.tail = function(array, index, guard) {
|
||||
return slice.call(array, (index == null) || guard ? 1 : index);
|
||||
};
|
||||
|
||||
// Trim out all falsy values from an array.
|
||||
_.compact = function(array) {
|
||||
return _.filter(array, function(value){ return !!value; });
|
||||
};
|
||||
|
||||
// Return a completely flattened version of an array.
|
||||
_.flatten = function(array, shallow) {
|
||||
return _.reduce(array, function(memo, value) {
|
||||
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
|
||||
memo[memo.length] = value;
|
||||
return memo;
|
||||
}, []);
|
||||
};
|
||||
|
||||
// Return a version of the array that does not contain the specified value(s).
|
||||
_.without = function(array) {
|
||||
return _.difference(array, slice.call(arguments, 1));
|
||||
};
|
||||
|
||||
// Produce a duplicate-free version of the array. If the array has already
|
||||
// been sorted, you have the option of using a faster algorithm.
|
||||
// Aliased as `unique`.
|
||||
_.uniq = _.unique = function(array, isSorted, iterator) {
|
||||
var initial = iterator ? _.map(array, iterator) : array;
|
||||
var result = [];
|
||||
_.reduce(initial, function(memo, el, i) {
|
||||
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
|
||||
memo[memo.length] = el;
|
||||
result[result.length] = array[i];
|
||||
}
|
||||
return memo;
|
||||
}, []);
|
||||
return result;
|
||||
};
|
||||
|
||||
// Produce an array that contains the union: each distinct element from all of
|
||||
// the passed-in arrays.
|
||||
_.union = function() {
|
||||
return _.uniq(_.flatten(arguments, true));
|
||||
};
|
||||
|
||||
// Produce an array that contains every item shared between all the
|
||||
// passed-in arrays. (Aliased as "intersect" for back-compat.)
|
||||
_.intersection = _.intersect = function(array) {
|
||||
var rest = slice.call(arguments, 1);
|
||||
return _.filter(_.uniq(array), function(item) {
|
||||
return _.every(rest, function(other) {
|
||||
return _.indexOf(other, item) >= 0;
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
// Take the difference between one array and a number of other arrays.
|
||||
// Only the elements present in just the first array will remain.
|
||||
_.difference = function(array) {
|
||||
var rest = _.flatten(slice.call(arguments, 1));
|
||||
return _.filter(array, function(value){ return !_.include(rest, value); });
|
||||
};
|
||||
|
||||
// Zip together multiple lists into a single array -- elements that share
|
||||
// an index go together.
|
||||
_.zip = function() {
|
||||
var args = slice.call(arguments);
|
||||
var length = _.max(_.pluck(args, 'length'));
|
||||
var results = new Array(length);
|
||||
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
|
||||
return results;
|
||||
};
|
||||
|
||||
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
|
||||
// we need this function. Return the position of the first occurrence of an
|
||||
// item in an array, or -1 if the item is not included in the array.
|
||||
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
|
||||
// If the array is large and already in sort order, pass `true`
|
||||
// for **isSorted** to use binary search.
|
||||
_.indexOf = function(array, item, isSorted) {
|
||||
if (array == null) return -1;
|
||||
var i, l;
|
||||
if (isSorted) {
|
||||
i = _.sortedIndex(array, item);
|
||||
return array[i] === item ? i : -1;
|
||||
}
|
||||
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
|
||||
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
|
||||
_.lastIndexOf = function(array, item) {
|
||||
if (array == null) return -1;
|
||||
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
|
||||
var i = array.length;
|
||||
while (i--) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Generate an integer Array containing an arithmetic progression. A port of
|
||||
// the native Python `range()` function. See
|
||||
// [the Python documentation](http://docs.python.org/library/functions.html#range).
|
||||
_.range = function(start, stop, step) {
|
||||
if (arguments.length <= 1) {
|
||||
stop = start || 0;
|
||||
start = 0;
|
||||
}
|
||||
step = arguments[2] || 1;
|
||||
|
||||
var len = Math.max(Math.ceil((stop - start) / step), 0);
|
||||
var idx = 0;
|
||||
var range = new Array(len);
|
||||
|
||||
while(idx < len) {
|
||||
range[idx++] = start;
|
||||
start += step;
|
||||
}
|
||||
|
||||
return range;
|
||||
};
|
||||
|
||||
// Function (ahem) Functions
|
||||
// ------------------
|
||||
|
||||
// Reusable constructor function for prototype setting.
|
||||
var ctor = function(){};
|
||||
|
||||
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||
// optionally). Binding with arguments is also known as `curry`.
|
||||
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
|
||||
// We check for `func.bind` first, to fail fast when `func` is undefined.
|
||||
_.bind = function bind(func, context) {
|
||||
var bound, args;
|
||||
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
|
||||
if (!_.isFunction(func)) throw new TypeError;
|
||||
args = slice.call(arguments, 2);
|
||||
return bound = function() {
|
||||
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
|
||||
ctor.prototype = func.prototype;
|
||||
var self = new ctor;
|
||||
var result = func.apply(self, args.concat(slice.call(arguments)));
|
||||
if (Object(result) === result) return result;
|
||||
return self;
|
||||
};
|
||||
};
|
||||
|
||||
// Bind all of an object's methods to that object. Useful for ensuring that
|
||||
// all callbacks defined on an object belong to it.
|
||||
_.bindAll = function(obj) {
|
||||
var funcs = slice.call(arguments, 1);
|
||||
if (funcs.length == 0) funcs = _.functions(obj);
|
||||
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Memoize an expensive function by storing its results.
|
||||
_.memoize = function(func, hasher) {
|
||||
var memo = {};
|
||||
hasher || (hasher = _.identity);
|
||||
return function() {
|
||||
var key = hasher.apply(this, arguments);
|
||||
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
|
||||
};
|
||||
};
|
||||
|
||||
// Delays a function for the given number of milliseconds, and then calls
|
||||
// it with the arguments supplied.
|
||||
_.delay = function(func, wait) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return setTimeout(function(){ return func.apply(func, args); }, wait);
|
||||
};
|
||||
|
||||
// Defers a function, scheduling it to run after the current call stack has
|
||||
// cleared.
|
||||
_.defer = function(func) {
|
||||
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
|
||||
};
|
||||
|
||||
// Returns a function, that, when invoked, will only be triggered at most once
|
||||
// during a given window of time.
|
||||
_.throttle = function(func, wait) {
|
||||
var context, args, timeout, throttling, more;
|
||||
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
|
||||
return function() {
|
||||
context = this; args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
if (more) func.apply(context, args);
|
||||
whenDone();
|
||||
};
|
||||
if (!timeout) timeout = setTimeout(later, wait);
|
||||
if (throttling) {
|
||||
more = true;
|
||||
} else {
|
||||
func.apply(context, args);
|
||||
}
|
||||
whenDone();
|
||||
throttling = true;
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function, that, as long as it continues to be invoked, will not
|
||||
// be triggered. The function will be called after it stops being called for
|
||||
// N milliseconds.
|
||||
_.debounce = function(func, wait) {
|
||||
var timeout;
|
||||
return function() {
|
||||
var context = this, args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
func.apply(context, args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will be executed at most one time, no matter how
|
||||
// often you call it. Useful for lazy initialization.
|
||||
_.once = function(func) {
|
||||
var ran = false, memo;
|
||||
return function() {
|
||||
if (ran) return memo;
|
||||
ran = true;
|
||||
return memo = func.apply(this, arguments);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns the first function passed as an argument to the second,
|
||||
// allowing you to adjust arguments, run code before and after, and
|
||||
// conditionally execute the original function.
|
||||
_.wrap = function(func, wrapper) {
|
||||
return function() {
|
||||
var args = [func].concat(slice.call(arguments, 0));
|
||||
return wrapper.apply(this, args);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that is the composition of a list of functions, each
|
||||
// consuming the return value of the function that follows.
|
||||
_.compose = function() {
|
||||
var funcs = arguments;
|
||||
return function() {
|
||||
var args = arguments;
|
||||
for (var i = funcs.length - 1; i >= 0; i--) {
|
||||
args = [funcs[i].apply(this, args)];
|
||||
}
|
||||
return args[0];
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will only be executed after being called N times.
|
||||
_.after = function(times, func) {
|
||||
if (times <= 0) return func();
|
||||
return function() {
|
||||
if (--times < 1) { return func.apply(this, arguments); }
|
||||
};
|
||||
};
|
||||
|
||||
// Object Functions
|
||||
// ----------------
|
||||
|
||||
// Retrieve the names of an object's properties.
|
||||
// Delegates to **ECMAScript 5**'s native `Object.keys`
|
||||
_.keys = nativeKeys || function(obj) {
|
||||
if (obj !== Object(obj)) throw new TypeError('Invalid object');
|
||||
var keys = [];
|
||||
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
|
||||
return keys;
|
||||
};
|
||||
|
||||
// Retrieve the values of an object's properties.
|
||||
_.values = function(obj) {
|
||||
return _.map(obj, _.identity);
|
||||
};
|
||||
|
||||
// Return a sorted list of the function names available on the object.
|
||||
// Aliased as `methods`
|
||||
_.functions = _.methods = function(obj) {
|
||||
var names = [];
|
||||
for (var key in obj) {
|
||||
if (_.isFunction(obj[key])) names.push(key);
|
||||
}
|
||||
return names.sort();
|
||||
};
|
||||
|
||||
// Extend a given object with all the properties in passed-in object(s).
|
||||
_.extend = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Fill in a given object with default properties.
|
||||
_.defaults = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
if (obj[prop] == null) obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Create a (shallow-cloned) duplicate of an object.
|
||||
_.clone = function(obj) {
|
||||
if (!_.isObject(obj)) return obj;
|
||||
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
|
||||
};
|
||||
|
||||
// Invokes interceptor with the obj, and then returns obj.
|
||||
// The primary purpose of this method is to "tap into" a method chain, in
|
||||
// order to perform operations on intermediate results within the chain.
|
||||
_.tap = function(obj, interceptor) {
|
||||
interceptor(obj);
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Internal recursive comparison function.
|
||||
function eq(a, b, stack) {
|
||||
// Identical objects are equal. `0 === -0`, but they aren't identical.
|
||||
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
|
||||
if (a === b) return a !== 0 || 1 / a == 1 / b;
|
||||
// A strict comparison is necessary because `null == undefined`.
|
||||
if (a == null || b == null) return a === b;
|
||||
// Unwrap any wrapped objects.
|
||||
if (a._chain) a = a._wrapped;
|
||||
if (b._chain) b = b._wrapped;
|
||||
// Invoke a custom `isEqual` method if one is provided.
|
||||
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
|
||||
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
|
||||
// Compare `[[Class]]` names.
|
||||
var className = toString.call(a);
|
||||
if (className != toString.call(b)) return false;
|
||||
switch (className) {
|
||||
// Strings, numbers, dates, and booleans are compared by value.
|
||||
case '[object String]':
|
||||
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
|
||||
// equivalent to `new String("5")`.
|
||||
return a == String(b);
|
||||
case '[object Number]':
|
||||
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
|
||||
// other numeric values.
|
||||
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
|
||||
case '[object Date]':
|
||||
case '[object Boolean]':
|
||||
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
|
||||
// millisecond representations. Note that invalid dates with millisecond representations
|
||||
// of `NaN` are not equivalent.
|
||||
return +a == +b;
|
||||
// RegExps are compared by their source patterns and flags.
|
||||
case '[object RegExp]':
|
||||
return a.source == b.source &&
|
||||
a.global == b.global &&
|
||||
a.multiline == b.multiline &&
|
||||
a.ignoreCase == b.ignoreCase;
|
||||
}
|
||||
if (typeof a != 'object' || typeof b != 'object') return false;
|
||||
// Assume equality for cyclic structures. The algorithm for detecting cyclic
|
||||
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
|
||||
var length = stack.length;
|
||||
while (length--) {
|
||||
// Linear search. Performance is inversely proportional to the number of
|
||||
// unique nested structures.
|
||||
if (stack[length] == a) return true;
|
||||
}
|
||||
// Add the first object to the stack of traversed objects.
|
||||
stack.push(a);
|
||||
var size = 0, result = true;
|
||||
// Recursively compare objects and arrays.
|
||||
if (className == '[object Array]') {
|
||||
// Compare array lengths to determine if a deep comparison is necessary.
|
||||
size = a.length;
|
||||
result = size == b.length;
|
||||
if (result) {
|
||||
// Deep compare the contents, ignoring non-numeric properties.
|
||||
while (size--) {
|
||||
// Ensure commutative equality for sparse arrays.
|
||||
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Objects with different constructors are not equivalent.
|
||||
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
|
||||
// Deep compare objects.
|
||||
for (var key in a) {
|
||||
if (_.has(a, key)) {
|
||||
// Count the expected number of properties.
|
||||
size++;
|
||||
// Deep compare each member.
|
||||
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
|
||||
}
|
||||
}
|
||||
// Ensure that both objects contain the same number of properties.
|
||||
if (result) {
|
||||
for (key in b) {
|
||||
if (_.has(b, key) && !(size--)) break;
|
||||
}
|
||||
result = !size;
|
||||
}
|
||||
}
|
||||
// Remove the first object from the stack of traversed objects.
|
||||
stack.pop();
|
||||
return result;
|
||||
}
|
||||
|
||||
// Perform a deep comparison to check if two objects are equal.
|
||||
_.isEqual = function(a, b) {
|
||||
return eq(a, b, []);
|
||||
};
|
||||
|
||||
// Is a given array, string, or object empty?
|
||||
// An "empty" object has no enumerable own-properties.
|
||||
_.isEmpty = function(obj) {
|
||||
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
|
||||
for (var key in obj) if (_.has(obj, key)) return false;
|
||||
return true;
|
||||
};
|
||||
|
||||
// Is a given value a DOM element?
|
||||
_.isElement = function(obj) {
|
||||
return !!(obj && obj.nodeType == 1);
|
||||
};
|
||||
|
||||
// Is a given value an array?
|
||||
// Delegates to ECMA5's native Array.isArray
|
||||
_.isArray = nativeIsArray || function(obj) {
|
||||
return toString.call(obj) == '[object Array]';
|
||||
};
|
||||
|
||||
// Is a given variable an object?
|
||||
_.isObject = function(obj) {
|
||||
return obj === Object(obj);
|
||||
};
|
||||
|
||||
// Is a given variable an arguments object?
|
||||
_.isArguments = function(obj) {
|
||||
return toString.call(obj) == '[object Arguments]';
|
||||
};
|
||||
if (!_.isArguments(arguments)) {
|
||||
_.isArguments = function(obj) {
|
||||
return !!(obj && _.has(obj, 'callee'));
|
||||
};
|
||||
}
|
||||
|
||||
// Is a given value a function?
|
||||
_.isFunction = function(obj) {
|
||||
return toString.call(obj) == '[object Function]';
|
||||
};
|
||||
|
||||
// Is a given value a string?
|
||||
_.isString = function(obj) {
|
||||
return toString.call(obj) == '[object String]';
|
||||
};
|
||||
|
||||
// Is a given value a number?
|
||||
_.isNumber = function(obj) {
|
||||
return toString.call(obj) == '[object Number]';
|
||||
};
|
||||
|
||||
// Is the given value `NaN`?
|
||||
_.isNaN = function(obj) {
|
||||
// `NaN` is the only value for which `===` is not reflexive.
|
||||
return obj !== obj;
|
||||
};
|
||||
|
||||
// Is a given value a boolean?
|
||||
_.isBoolean = function(obj) {
|
||||
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
|
||||
};
|
||||
|
||||
// Is a given value a date?
|
||||
_.isDate = function(obj) {
|
||||
return toString.call(obj) == '[object Date]';
|
||||
};
|
||||
|
||||
// Is the given value a regular expression?
|
||||
_.isRegExp = function(obj) {
|
||||
return toString.call(obj) == '[object RegExp]';
|
||||
};
|
||||
|
||||
// Is a given value equal to null?
|
||||
_.isNull = function(obj) {
|
||||
return obj === null;
|
||||
};
|
||||
|
||||
// Is a given variable undefined?
|
||||
_.isUndefined = function(obj) {
|
||||
return obj === void 0;
|
||||
};
|
||||
|
||||
// Has own property?
|
||||
_.has = function(obj, key) {
|
||||
return hasOwnProperty.call(obj, key);
|
||||
};
|
||||
|
||||
// Utility Functions
|
||||
// -----------------
|
||||
|
||||
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
|
||||
// previous owner. Returns a reference to the Underscore object.
|
||||
_.noConflict = function() {
|
||||
root._ = previousUnderscore;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Keep the identity function around for default iterators.
|
||||
_.identity = function(value) {
|
||||
return value;
|
||||
};
|
||||
|
||||
// Run a function **n** times.
|
||||
_.times = function (n, iterator, context) {
|
||||
for (var i = 0; i < n; i++) iterator.call(context, i);
|
||||
};
|
||||
|
||||
// Escape a string for HTML interpolation.
|
||||
_.escape = function(string) {
|
||||
return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
|
||||
};
|
||||
|
||||
// Add your own custom functions to the Underscore object, ensuring that
|
||||
// they're correctly added to the OOP wrapper as well.
|
||||
_.mixin = function(obj) {
|
||||
each(_.functions(obj), function(name){
|
||||
addToWrapper(name, _[name] = obj[name]);
|
||||
});
|
||||
};
|
||||
|
||||
// Generate a unique integer id (unique within the entire client session).
|
||||
// Useful for temporary DOM ids.
|
||||
var idCounter = 0;
|
||||
_.uniqueId = function(prefix) {
|
||||
var id = idCounter++;
|
||||
return prefix ? prefix + id : id;
|
||||
};
|
||||
|
||||
// By default, Underscore uses ERB-style template delimiters, change the
|
||||
// following template settings to use alternative delimiters.
|
||||
_.templateSettings = {
|
||||
evaluate : /<%([\s\S]+?)%>/g,
|
||||
interpolate : /<%=([\s\S]+?)%>/g,
|
||||
escape : /<%-([\s\S]+?)%>/g
|
||||
};
|
||||
|
||||
// When customizing `templateSettings`, if you don't want to define an
|
||||
// interpolation, evaluation or escaping regex, we need one that is
|
||||
// guaranteed not to match.
|
||||
var noMatch = /.^/;
|
||||
|
||||
// Within an interpolation, evaluation, or escaping, remove HTML escaping
|
||||
// that had been previously added.
|
||||
var unescape = function(code) {
|
||||
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
|
||||
};
|
||||
|
||||
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||
// and correctly escapes quotes within interpolated code.
|
||||
_.template = function(str, data) {
|
||||
var c = _.templateSettings;
|
||||
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
|
||||
'with(obj||{}){__p.push(\'' +
|
||||
str.replace(/\\/g, '\\\\')
|
||||
.replace(/'/g, "\\'")
|
||||
.replace(c.escape || noMatch, function(match, code) {
|
||||
return "',_.escape(" + unescape(code) + "),'";
|
||||
})
|
||||
.replace(c.interpolate || noMatch, function(match, code) {
|
||||
return "'," + unescape(code) + ",'";
|
||||
})
|
||||
.replace(c.evaluate || noMatch, function(match, code) {
|
||||
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
|
||||
})
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\t/g, '\\t')
|
||||
+ "');}return __p.join('');";
|
||||
var func = new Function('obj', '_', tmpl);
|
||||
if (data) return func(data, _);
|
||||
return function(data) {
|
||||
return func.call(this, data, _);
|
||||
};
|
||||
};
|
||||
|
||||
// Add a "chain" function, which will delegate to the wrapper.
|
||||
_.chain = function(obj) {
|
||||
return _(obj).chain();
|
||||
};
|
||||
|
||||
// The OOP Wrapper
|
||||
// ---------------
|
||||
|
||||
// If Underscore is called as a function, it returns a wrapped object that
|
||||
// can be used OO-style. This wrapper holds altered versions of all the
|
||||
// underscore functions. Wrapped objects may be chained.
|
||||
var wrapper = function(obj) { this._wrapped = obj; };
|
||||
|
||||
// Expose `wrapper.prototype` as `_.prototype`
|
||||
_.prototype = wrapper.prototype;
|
||||
|
||||
// Helper function to continue chaining intermediate results.
|
||||
var result = function(obj, chain) {
|
||||
return chain ? _(obj).chain() : obj;
|
||||
};
|
||||
|
||||
// A method to easily add functions to the OOP wrapper.
|
||||
var addToWrapper = function(name, func) {
|
||||
wrapper.prototype[name] = function() {
|
||||
var args = slice.call(arguments);
|
||||
unshift.call(args, this._wrapped);
|
||||
return result(func.apply(_, args), this._chain);
|
||||
};
|
||||
};
|
||||
|
||||
// Add all of the Underscore functions to the wrapper object.
|
||||
_.mixin(_);
|
||||
|
||||
// Add all mutator Array functions to the wrapper.
|
||||
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
var wrapped = this._wrapped;
|
||||
method.apply(wrapped, arguments);
|
||||
var length = wrapped.length;
|
||||
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
|
||||
return result(wrapped, this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Add all accessor Array functions to the wrapper.
|
||||
each(['concat', 'join', 'slice'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
return result(method.apply(this._wrapped, arguments), this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Start chaining a wrapped Underscore object.
|
||||
wrapper.prototype.chain = function() {
|
||||
this._chain = true;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Extracts the result from a wrapped and chained object.
|
||||
wrapper.prototype.value = function() {
|
||||
return this._wrapped;
|
||||
};
|
||||
|
||||
}).call(this);
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
(function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
|
||||
c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
|
||||
h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
|
||||
b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
|
||||
null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
|
||||
function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
|
||||
e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck=
|
||||
function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
|
||||
return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
|
||||
c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
|
||||
b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
|
||||
return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
|
||||
d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
|
||||
var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
|
||||
c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
|
||||
a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
|
||||
b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
|
||||
1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
|
||||
b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
|
||||
b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a),
|
||||
function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+
|
||||
u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
|
||||
function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
|
||||
true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 345 B |
Binary file not shown.
|
Before Width: | Height: | Size: 345 B |
|
|
@ -1,808 +0,0 @@
|
|||
/*
|
||||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilties for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
$.fn.autogrow = function() {
|
||||
return this.each(function() {
|
||||
var textarea = this;
|
||||
|
||||
$.fn.autogrow.resize(textarea);
|
||||
|
||||
$(textarea)
|
||||
.focus(function() {
|
||||
textarea.interval = setInterval(function() {
|
||||
$.fn.autogrow.resize(textarea);
|
||||
}, 500);
|
||||
})
|
||||
.blur(function() {
|
||||
clearInterval(textarea.interval);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
$.fn.autogrow.resize = function(textarea) {
|
||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
||||
var lines = textarea.value.split('\n');
|
||||
var columns = textarea.cols;
|
||||
var lineCount = 0;
|
||||
$.each(lines, function() {
|
||||
lineCount += Math.ceil(this.length / columns) || 1;
|
||||
});
|
||||
var height = lineHeight * (lineCount + 1);
|
||||
$(textarea).css('height', height);
|
||||
};
|
||||
})(jQuery);
|
||||
|
||||
(function($) {
|
||||
var comp, by;
|
||||
|
||||
function init() {
|
||||
initEvents();
|
||||
initComparator();
|
||||
}
|
||||
|
||||
function initEvents() {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set comp, which is a comparator function used for sorting and
|
||||
* inserting comments into the list.
|
||||
*/
|
||||
function setComparator() {
|
||||
// If the first three letters are "asc", sort in ascending order
|
||||
// and remove the prefix.
|
||||
if (by.substring(0,3) == 'asc') {
|
||||
var i = by.substring(3);
|
||||
comp = function(a, b) { return a[i] - b[i]; };
|
||||
} else {
|
||||
// Otherwise sort in descending order.
|
||||
comp = function(a, b) { return b[by] - a[by]; };
|
||||
}
|
||||
|
||||
// Reset link styles and format the selected sort option.
|
||||
$('a.sel').attr('href', '#').removeClass('sel');
|
||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a comp function. If the user has preferences stored in
|
||||
* the sortBy cookie, use those, otherwise use the default.
|
||||
*/
|
||||
function initComparator() {
|
||||
by = 'rating'; // Default to sort by rating.
|
||||
// If the sortBy cookie is set, use that instead.
|
||||
if (document.cookie.length > 0) {
|
||||
var start = document.cookie.indexOf('sortBy=');
|
||||
if (start != -1) {
|
||||
start = start + 7;
|
||||
var end = document.cookie.indexOf(";", start);
|
||||
if (end == -1) {
|
||||
end = document.cookie.length;
|
||||
by = unescape(document.cookie.substring(start, end));
|
||||
}
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a comment div.
|
||||
*/
|
||||
function show(id) {
|
||||
$('#ao' + id).hide();
|
||||
$('#ah' + id).show();
|
||||
var context = $.extend({id: id}, opts);
|
||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
||||
popup.find('textarea[name="proposal"]').hide();
|
||||
popup.find('a.by' + by).addClass('sel');
|
||||
var form = popup.find('#cf' + id);
|
||||
form.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment(form);
|
||||
});
|
||||
$('#s' + id).after(popup);
|
||||
popup.slideDown('fast', function() {
|
||||
getComments(id);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Hide a comment div.
|
||||
*/
|
||||
function hide(id) {
|
||||
$('#ah' + id).hide();
|
||||
$('#ao' + id).show();
|
||||
var div = $('#sc' + id);
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform an ajax request to get comments for a node
|
||||
* and insert the comments into the comments tree.
|
||||
*/
|
||||
function getComments(id) {
|
||||
$.ajax({
|
||||
type: 'GET',
|
||||
url: opts.getCommentsURL,
|
||||
data: {node: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var ul = $('#cl' + id);
|
||||
var speed = 100;
|
||||
$('#cf' + id)
|
||||
.find('textarea[name="proposal"]')
|
||||
.data('source', data.source);
|
||||
|
||||
if (data.comments.length === 0) {
|
||||
ul.html('<li>No comments yet.</li>');
|
||||
ul.data('empty', true);
|
||||
} else {
|
||||
// If there are comments, sort them and put them in the list.
|
||||
var comments = sortComments(data.comments);
|
||||
speed = data.comments.length * 100;
|
||||
appendComments(comments, ul);
|
||||
ul.data('empty', false);
|
||||
}
|
||||
$('#cn' + id).slideUp(speed + 200);
|
||||
ul.slideDown(speed);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem retrieving the comments.');
|
||||
},
|
||||
dataType: 'json'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a comment via ajax and insert the comment into the comment tree.
|
||||
*/
|
||||
function addComment(form) {
|
||||
var node_id = form.find('input[name="node"]').val();
|
||||
var parent_id = form.find('input[name="parent"]').val();
|
||||
var text = form.find('textarea[name="comment"]').val();
|
||||
var proposal = form.find('textarea[name="proposal"]').val();
|
||||
|
||||
if (text == '') {
|
||||
showError('Please enter a comment.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Disable the form that is being submitted.
|
||||
form.find('textarea,input').attr('disabled', 'disabled');
|
||||
|
||||
// Send the comment to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.addCommentURL,
|
||||
dataType: 'json',
|
||||
data: {
|
||||
node: node_id,
|
||||
parent: parent_id,
|
||||
text: text,
|
||||
proposal: proposal
|
||||
},
|
||||
success: function(data, textStatus, error) {
|
||||
// Reset the form.
|
||||
if (node_id) {
|
||||
hideProposeChange(node_id);
|
||||
}
|
||||
form.find('textarea')
|
||||
.val('')
|
||||
.add(form.find('input'))
|
||||
.removeAttr('disabled');
|
||||
var ul = $('#cl' + (node_id || parent_id));
|
||||
if (ul.data('empty')) {
|
||||
$(ul).empty();
|
||||
ul.data('empty', false);
|
||||
}
|
||||
insertComment(data.comment);
|
||||
var ao = $('#ao' + node_id);
|
||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
||||
if (node_id) {
|
||||
// if this was a "root" comment, remove the commenting box
|
||||
// (the user can get it back by reopening the comment popup)
|
||||
$('#ca' + node_id).slideUp();
|
||||
}
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
form.find('textarea,input').removeAttr('disabled');
|
||||
showError('Oops, there was a problem adding the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively append comments to the main comment list and children
|
||||
* lists, creating the comment tree.
|
||||
*/
|
||||
function appendComments(comments, ul) {
|
||||
$.each(comments, function() {
|
||||
var div = createCommentDiv(this);
|
||||
ul.append($(document.createElement('li')).html(div));
|
||||
appendComments(this.children, div.find('ul.comment-children'));
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
this.children = null;
|
||||
div.data('comment', this);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* After adding a new comment, it must be inserted in the correct
|
||||
* location in the comment tree.
|
||||
*/
|
||||
function insertComment(comment) {
|
||||
var div = createCommentDiv(comment);
|
||||
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
comment.children = null;
|
||||
div.data('comment', comment);
|
||||
|
||||
var ul = $('#cl' + (comment.node || comment.parent));
|
||||
var siblings = getChildren(ul);
|
||||
|
||||
var li = $(document.createElement('li'));
|
||||
li.hide();
|
||||
|
||||
// Determine where in the parents children list to insert this comment.
|
||||
for(i=0; i < siblings.length; i++) {
|
||||
if (comp(comment, siblings[i]) <= 0) {
|
||||
$('#cd' + siblings[i].id)
|
||||
.parent()
|
||||
.before(li.html(div));
|
||||
li.slideDown('fast');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If we get here, this comment rates lower than all the others,
|
||||
// or it is the only comment in the list.
|
||||
ul.append(li.html(div));
|
||||
li.slideDown('fast');
|
||||
}
|
||||
|
||||
function acceptComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.acceptCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
$('#cm' + id).fadeOut('fast');
|
||||
$('#cd' + id).removeClass('moderate');
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem accepting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function deleteComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.deleteCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var div = $('#cd' + id);
|
||||
if (data == 'delete') {
|
||||
// Moderator mode: remove the comment and all children immediately
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
return;
|
||||
}
|
||||
// User mode: only mark the comment as deleted
|
||||
div
|
||||
.find('span.user-id:first')
|
||||
.text('[deleted]').end()
|
||||
.find('div.comment-text:first')
|
||||
.text('[deleted]').end()
|
||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
||||
.remove();
|
||||
var comment = div.data('comment');
|
||||
comment.username = '[deleted]';
|
||||
comment.text = '[deleted]';
|
||||
div.data('comment', comment);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem deleting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function showProposal(id) {
|
||||
$('#sp' + id).hide();
|
||||
$('#hp' + id).show();
|
||||
$('#pr' + id).slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposal(id) {
|
||||
$('#hp' + id).hide();
|
||||
$('#sp' + id).show();
|
||||
$('#pr' + id).slideUp('fast');
|
||||
}
|
||||
|
||||
function showProposeChange(id) {
|
||||
$('#pc' + id).hide();
|
||||
$('#hc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val(textarea.data('source'));
|
||||
$.fn.autogrow.resize(textarea[0]);
|
||||
textarea.slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposeChange(id) {
|
||||
$('#hc' + id).hide();
|
||||
$('#pc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val('').removeAttr('disabled');
|
||||
textarea.slideUp('fast');
|
||||
}
|
||||
|
||||
function toggleCommentMarkupBox(id) {
|
||||
$('#mb' + id).toggle();
|
||||
}
|
||||
|
||||
/** Handle when the user clicks on a sort by link. */
|
||||
function handleReSort(link) {
|
||||
var classes = link.attr('class').split(/\s+/);
|
||||
for (var i=0; i<classes.length; i++) {
|
||||
if (classes[i] != 'sort-option') {
|
||||
by = classes[i].substring(2);
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
// Save/update the sortBy cookie.
|
||||
var expiration = new Date();
|
||||
expiration.setDate(expiration.getDate() + 365);
|
||||
document.cookie= 'sortBy=' + escape(by) +
|
||||
';expires=' + expiration.toUTCString();
|
||||
$('ul.comment-ul').each(function(index, ul) {
|
||||
var comments = getChildren($(ul), true);
|
||||
comments = sortComments(comments);
|
||||
appendComments(comments, $(ul).empty());
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to process a vote when a user clicks an arrow.
|
||||
*/
|
||||
function handleVote(link) {
|
||||
if (!opts.voting) {
|
||||
showError("You'll need to login to vote.");
|
||||
return;
|
||||
}
|
||||
|
||||
var id = link.attr('id');
|
||||
if (!id) {
|
||||
// Didn't click on one of the voting arrows.
|
||||
return;
|
||||
}
|
||||
// If it is an unvote, the new vote value is 0,
|
||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
||||
var value = 0;
|
||||
if (id.charAt(1) != 'u') {
|
||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
||||
}
|
||||
// The data to be sent to the server.
|
||||
var d = {
|
||||
comment_id: id.substring(2),
|
||||
value: value
|
||||
};
|
||||
|
||||
// Swap the vote and unvote links.
|
||||
link.hide();
|
||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
||||
.show();
|
||||
|
||||
// The div the comment is displayed in.
|
||||
var div = $('div#cd' + d.comment_id);
|
||||
var data = div.data('comment');
|
||||
|
||||
// If this is not an unvote, and the other vote arrow has
|
||||
// already been pressed, unpress it.
|
||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
||||
}
|
||||
|
||||
// Update the comments rating in the local data.
|
||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
||||
data.vote = d.value;
|
||||
div.data('comment', data);
|
||||
|
||||
// Change the rating text.
|
||||
div.find('.rating:first')
|
||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
||||
|
||||
// Send the vote information to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.processVoteURL,
|
||||
data: d,
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem casting that vote.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a reply form used to reply to an existing comment.
|
||||
*/
|
||||
function openReply(id) {
|
||||
// Swap out the reply link for the hide link
|
||||
$('#rl' + id).hide();
|
||||
$('#cr' + id).show();
|
||||
|
||||
// Add the reply li to the children ul.
|
||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
||||
$('#cl' + id)
|
||||
.prepend(div)
|
||||
// Setup the submit handler for the reply form.
|
||||
.find('#rf' + id)
|
||||
.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment($('#rf' + id));
|
||||
closeReply(id);
|
||||
})
|
||||
.find('input[type=button]')
|
||||
.click(function() {
|
||||
closeReply(id);
|
||||
});
|
||||
div.slideDown('fast', function() {
|
||||
$('#rf' + id).find('textarea').focus();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the reply form opened with openReply.
|
||||
*/
|
||||
function closeReply(id) {
|
||||
// Remove the reply div from the DOM.
|
||||
$('#rd' + id).slideUp('fast', function() {
|
||||
$(this).remove();
|
||||
});
|
||||
|
||||
// Swap out the hide link for the reply link
|
||||
$('#cr' + id).hide();
|
||||
$('#rl' + id).show();
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively sort a tree of comments using the comp comparator.
|
||||
*/
|
||||
function sortComments(comments) {
|
||||
comments.sort(comp);
|
||||
$.each(comments, function() {
|
||||
this.children = sortComments(this.children);
|
||||
});
|
||||
return comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the children comments from a ul. If recursive is true,
|
||||
* recursively include childrens' children.
|
||||
*/
|
||||
function getChildren(ul, recursive) {
|
||||
var children = [];
|
||||
ul.children().children("[id^='cd']")
|
||||
.each(function() {
|
||||
var comment = $(this).data('comment');
|
||||
if (recursive)
|
||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
||||
children.push(comment);
|
||||
});
|
||||
return children;
|
||||
}
|
||||
|
||||
/** Create a div to display a comment in. */
|
||||
function createCommentDiv(comment) {
|
||||
if (!comment.displayed && !opts.moderator) {
|
||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
||||
+ 'once it is has been approved by a moderator.</div>');
|
||||
}
|
||||
// Prettify the comment rating.
|
||||
comment.pretty_rating = comment.rating + ' point' +
|
||||
(comment.rating == 1 ? '' : 's');
|
||||
// Make a class (for displaying not yet moderated comments differently)
|
||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
||||
// Create a div for this comment.
|
||||
var context = $.extend({}, opts, comment);
|
||||
var div = $(renderTemplate(commentTemplate, context));
|
||||
|
||||
// If the user has voted on this comment, highlight the correct arrow.
|
||||
if (comment.vote) {
|
||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
||||
div.find('#' + direction + 'v' + comment.id).hide();
|
||||
div.find('#' + direction + 'u' + comment.id).show();
|
||||
}
|
||||
|
||||
if (opts.moderator || comment.text != '[deleted]') {
|
||||
div.find('a.reply').show();
|
||||
if (comment.proposal_diff)
|
||||
div.find('#sp' + comment.id).show();
|
||||
if (opts.moderator && !comment.displayed)
|
||||
div.find('#cm' + comment.id).show();
|
||||
if (opts.moderator || (opts.username == comment.username))
|
||||
div.find('#dc' + comment.id).show();
|
||||
}
|
||||
return div;
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
||||
* are not escaped.
|
||||
*/
|
||||
function renderTemplate(template, context) {
|
||||
var esc = $(document.createElement('div'));
|
||||
|
||||
function handle(ph, escape) {
|
||||
var cur = context;
|
||||
$.each(ph.split('.'), function() {
|
||||
cur = cur[this];
|
||||
});
|
||||
return escape ? esc.text(cur || "").html() : cur;
|
||||
}
|
||||
|
||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
||||
});
|
||||
}
|
||||
|
||||
/** Flash an error message briefly. */
|
||||
function showError(message) {
|
||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
||||
.append($(document.createElement('div'))
|
||||
.attr({'class': 'error-message'}).text(message))
|
||||
.appendTo('body')
|
||||
.fadeIn("slow")
|
||||
.delay(2000)
|
||||
.fadeOut("slow");
|
||||
}
|
||||
|
||||
/** Add a link the user uses to open the comments popup. */
|
||||
$.fn.comment = function() {
|
||||
return this.each(function() {
|
||||
var id = $(this).attr('id').substring(1);
|
||||
var count = COMMENT_METADATA[id];
|
||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
||||
var addcls = count == 0 ? ' nocomment' : '';
|
||||
$(this)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-open' + addcls,
|
||||
id: 'ao' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: image,
|
||||
alt: 'comment',
|
||||
title: title
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
show($(this).attr('id').substring(2));
|
||||
})
|
||||
)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-close hidden',
|
||||
id: 'ah' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: opts.closeCommentImage,
|
||||
alt: 'close',
|
||||
title: 'close'
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
})
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
var opts = {
|
||||
processVoteURL: '/_process_vote',
|
||||
addCommentURL: '/_add_comment',
|
||||
getCommentsURL: '/_get_comments',
|
||||
acceptCommentURL: '/_accept_comment',
|
||||
deleteCommentURL: '/_delete_comment',
|
||||
commentImage: '/static/_static/comment.png',
|
||||
closeCommentImage: '/static/_static/comment-close.png',
|
||||
loadingImage: '/static/_static/ajax-loader.gif',
|
||||
commentBrightImage: '/static/_static/comment-bright.png',
|
||||
upArrow: '/static/_static/up.png',
|
||||
downArrow: '/static/_static/down.png',
|
||||
upArrowPressed: '/static/_static/up-pressed.png',
|
||||
downArrowPressed: '/static/_static/down-pressed.png',
|
||||
voting: false,
|
||||
moderator: false
|
||||
};
|
||||
|
||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
||||
}
|
||||
|
||||
var popupTemplate = '\
|
||||
<div class="sphinx-comments" id="sc<%id%>">\
|
||||
<p class="sort-options">\
|
||||
Sort by:\
|
||||
<a href="#" class="sort-option byrating">best rated</a>\
|
||||
<a href="#" class="sort-option byascage">newest</a>\
|
||||
<a href="#" class="sort-option byage">oldest</a>\
|
||||
</p>\
|
||||
<div class="comment-header">Comments</div>\
|
||||
<div class="comment-loading" id="cn<%id%>">\
|
||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
||||
<div id="ca<%id%>">\
|
||||
<p class="add-a-comment">Add a comment\
|
||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
||||
Propose a change ▹\
|
||||
</a>\
|
||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
||||
Propose a change ▿\
|
||||
</a>\
|
||||
</p>\
|
||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
||||
spellcheck="false"></textarea>\
|
||||
<input type="submit" value="Add comment" />\
|
||||
<input type="hidden" name="node" value="<%id%>" />\
|
||||
<input type="hidden" name="parent" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var commentTemplate = '\
|
||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
||||
<div class="vote">\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
||||
<img src="<%upArrow%>" />\
|
||||
</a>\
|
||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
||||
<img src="<%upArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
||||
</a>\
|
||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
||||
<img src="<%downArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
</div>\
|
||||
<div class="comment-content">\
|
||||
<p class="tagline comment">\
|
||||
<span class="user-id"><%username%></span>\
|
||||
<span class="rating"><%pretty_rating%></span>\
|
||||
<span class="delta"><%time.delta%></span>\
|
||||
</p>\
|
||||
<div class="comment-text comment"><#text#></div>\
|
||||
<p class="comment-opts comment">\
|
||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
||||
<span id="cm<%id%>" class="moderation hidden">\
|
||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
||||
</span>\
|
||||
</p>\
|
||||
<pre class="proposal" id="pr<%id%>">\
|
||||
<#proposal_diff#>\
|
||||
</pre>\
|
||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
||||
</div>\
|
||||
<div class="clearleft"></div>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var replyTemplate = '\
|
||||
<li>\
|
||||
<div class="reply-div" id="rd<%id%>">\
|
||||
<form id="rf<%id%>">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<input type="submit" value="Add reply" />\
|
||||
<input type="button" value="Cancel" />\
|
||||
<input type="hidden" name="parent" value="<%id%>" />\
|
||||
<input type="hidden" name="node" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</li>';
|
||||
|
||||
$(document).ready(function() {
|
||||
init();
|
||||
});
|
||||
})(jQuery);
|
||||
|
||||
$(document).ready(function() {
|
||||
// add comment anchors for all paragraphs that are commentable
|
||||
$('.sphinx-has-comment').comment();
|
||||
|
||||
// highlight search words in search results
|
||||
$("div.context").each(function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
||||
var result = $(this);
|
||||
$.each(terms, function() {
|
||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
});
|
||||
|
||||
// directly open comment window if requested
|
||||
var anchor = document.location.hash;
|
||||
if (anchor.substring(0, 9) == '#comment-') {
|
||||
$('#ao' + anchor.substring(9)).click();
|
||||
document.location.hash = '#s' + anchor.substring(9);
|
||||
}
|
||||
});
|
||||
|
|
@ -1,106 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>3. Server/Cluster Deployment and Administration — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="4. Contributing to the BigchainDB Project" href="contributing.html" />
|
||||
<link rel="prev" title="2. Getting Started" href="getting-started.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="server-cluster-deployment-and-administration">
|
||||
<span id="server-cluster-deployment-and-administration"></span><h1>3. Server/Cluster Deployment and Administration<a class="headerlink" href="#server-cluster-deployment-and-administration" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This section covers everything which might concern a BigchainDB server/cluster administrator:</p>
|
||||
<ul class="simple">
|
||||
<li>deployment</li>
|
||||
<li>security</li>
|
||||
<li>monitoring</li>
|
||||
<li>troubleshooting</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="getting-started.html" title="previous chapter">2. Getting Started</a></li>
|
||||
<li>Next: <a href="contributing.html" title="next chapter">4. Contributing to the BigchainDB Project</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/admin.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/admin.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,100 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>4. Contributing to the BigchainDB Project — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="5. Frequently Asked Questions (FAQ)" href="faq.html" />
|
||||
<link rel="prev" title="3. Server/Cluster Deployment and Administration" href="admin.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="contributing-to-the-bigchaindb-project">
|
||||
<span id="contributing-to-the-bigchaindb-project"></span><h1>4. Contributing to the BigchainDB Project<a class="headerlink" href="#contributing-to-the-bigchaindb-project" title="Permalink to this headline">¶</a></h1>
|
||||
<p>If you’re interested in contributing to the BigchainDB project, you can find out how in the <a class="reference external" href="https://github.com/BigchainDB/bigchaindb/blob/master/CONTRIBUTING.md">CONTRIBUTING.md file</a> (in the root directory of the BigchainDB repository).</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="admin.html" title="previous chapter">3. Server/Cluster Deployment and Administration</a></li>
|
||||
<li>Next: <a href="faq.html" title="next chapter">5. Frequently Asked Questions (FAQ)</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/contributing.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/contributing.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,139 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>9. Cryptography — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="10. The Transaction, Block and Vote Models" href="models.html" />
|
||||
<link rel="prev" title="8. The Bigchain Class" href="the-bigchain-class.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="cryptography">
|
||||
<span id="cryptography"></span><h1>9. Cryptography<a class="headerlink" href="#cryptography" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The section documents the cryptographic algorithms and Python implementations that we use.</p>
|
||||
<p>The implementations that we have chosen for now are just for fast prototyping. Some of them are pure Python implementations which may be slow. As future work, we should look at other alternatives.</p>
|
||||
<div class="section" id="hashes">
|
||||
<span id="hashes"></span><h2>9.1. Hashes<a class="headerlink" href="#hashes" title="Permalink to this headline">¶</a></h2>
|
||||
<p>For hashing we are using the sha3-256 algorithm and <a class="reference external" href="https://bitbucket.org/tiran/pykeccak">pysha3</a> as the Python implementation. We store the hex encoded hash in the database. For example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">hashlib</span>
|
||||
<span class="c1"># monkey patch hashlib with sha3 functions</span>
|
||||
<span class="kn">import</span> <span class="nn">sha3</span>
|
||||
|
||||
<span class="n">data</span> <span class="o">=</span> <span class="s2">"message"</span>
|
||||
<span class="n">tx_hash</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha3_256</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="keys">
|
||||
<span id="keys"></span><h2>9.2. Keys<a class="headerlink" href="#keys" title="Permalink to this headline">¶</a></h2>
|
||||
<p>For signing and veryfing signatures we are using the ECDSA with 192bit key lengths and
|
||||
<a class="reference external" href="https://github.com/warner/python-ecdsa">python-ecdsa</a> as the python implementation.</p>
|
||||
<p>The public-key or verification key are converted to string and hex encoded before storing them to the blockchain. For example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">binascii</span>
|
||||
<span class="kn">from</span> <span class="nn">ecdsa</span> <span class="kn">import</span> <span class="n">SigningKey</span>
|
||||
|
||||
<span class="c1"># generate signing key in hex encoded form</span>
|
||||
<span class="n">sk</span> <span class="o">=</span> <span class="n">SigningKey</span><span class="o">.</span><span class="n">generate</span><span class="p">()</span>
|
||||
<span class="n">sk_hex</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">sk</span><span class="o">.</span><span class="n">to_string</span><span class="p">())</span>
|
||||
|
||||
<span class="c1"># get signing key from hex</span>
|
||||
<span class="n">sk</span> <span class="o">=</span> <span class="n">SigningKey</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">unhexlify</span><span class="p">(</span><span class="n">sk_hex</span><span class="p">))</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">9. Cryptography</a><ul>
|
||||
<li><a class="reference internal" href="#hashes">9.1. Hashes</a></li>
|
||||
<li><a class="reference internal" href="#keys">9.2. Keys</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="the-bigchain-class.html" title="previous chapter">8. The Bigchain Class</a></li>
|
||||
<li>Next: <a href="models.html" title="next chapter">10. The Transaction, Block and Vote Models</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/cryptography.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/cryptography.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,121 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>5. Frequently Asked Questions (FAQ) — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="6. Release Notes" href="release-notes.html" />
|
||||
<link rel="prev" title="4. Contributing to the BigchainDB Project" href="contributing.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="frequently-asked-questions-faq">
|
||||
<span id="frequently-asked-questions-faq"></span><h1>5. Frequently Asked Questions (FAQ)<a class="headerlink" href="#frequently-asked-questions-faq" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="questions-about-the-bigchaindb-whitepaper">
|
||||
<span id="questions-about-the-bigchaindb-whitepaper"></span><h2>5.1. Questions About the BigchainDB Whitepaper<a class="headerlink" href="#questions-about-the-bigchaindb-whitepaper" title="Permalink to this headline">¶</a></h2>
|
||||
<p><strong>Question 1?</strong></p>
|
||||
<p>Answer 1.</p>
|
||||
<p><strong>Question 2?</strong></p>
|
||||
<p>Answer 2.</p>
|
||||
</div>
|
||||
<div class="section" id="other-questions">
|
||||
<span id="other-questions"></span><h2>5.2. Other Questions<a class="headerlink" href="#other-questions" title="Permalink to this headline">¶</a></h2>
|
||||
<p><strong>Why do we use blocks and not just create the chain with transactions?</strong></p>
|
||||
<p>With distributed data stores there is no guarantees in the order in which transactions will be commited to the database. Witouth knowing what is previous transactions to be commited to the database we cannot include its hash in the current transaction to build the chain.</p>
|
||||
<p>To solve this problem we decided to use blocks and create the chain with the blocks.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">5. Frequently Asked Questions (FAQ)</a><ul>
|
||||
<li><a class="reference internal" href="#questions-about-the-bigchaindb-whitepaper">5.1. Questions About the BigchainDB Whitepaper</a></li>
|
||||
<li><a class="reference internal" href="#other-questions">5.2. Other Questions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="contributing.html" title="previous chapter">4. Contributing to the BigchainDB Project</a></li>
|
||||
<li>Next: <a href="release-notes.html" title="next chapter">6. Release Notes</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/faq.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/faq.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,92 +0,0 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,100 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>2. Getting Started — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="3. Server/Cluster Deployment and Administration" href="admin.html" />
|
||||
<link rel="prev" title="1. Installing BigchainDB" href="installing.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="getting-started">
|
||||
<span id="getting-started"></span><h1>2. Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Some short examples of using BigchainDB, i.e. short tutorials.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="installing.html" title="previous chapter">1. Installing BigchainDB</a></li>
|
||||
<li>Next: <a href="admin.html" title="next chapter">3. Server/Cluster Deployment and Administration</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/getting-started.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/getting-started.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,177 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>BigchainDB Documentation — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="#" />
|
||||
<link rel="next" title="1. Installing BigchainDB" href="installing.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="bigchaindb-documentation">
|
||||
<h1>BigchainDB Documentation<a class="headerlink" href="#bigchaindb-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="table-of-contents">
|
||||
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Note to reviewers of this documentation: For now, <em>all</em> documentation files (.rst and .md) are at the same level in the Table of Contents heirarchy. Later, we can organize them into a more sensible heirarchy.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installing.html">1. Installing BigchainDB</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">2. Getting Started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="admin.html">3. Server/Cluster Deployment and Administration</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">4. Contributing to the BigchainDB Project</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="faq.html">5. Frequently Asked Questions (FAQ)</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#questions-about-the-bigchaindb-whitepaper">5.1. Questions About the BigchainDB Whitepaper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="faq.html#other-questions">5.2. Other Questions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">6. Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="software-architecture.html">7. BigchainDB Software Architecture</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#bigspool">7.1. bigspool</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#bigchain">7.2. bigchain</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#validator">7.3. validator</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="software-architecture.html#processor">7.4. processor</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="the-bigchain-class.html">8. The Bigchain Class</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cryptography.html">9. Cryptography</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cryptography.html#hashes">9.1. Hashes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cryptography.html#keys">9.2. Keys</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="models.html">10. The Transaction, Block and Vote Models</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="models.html#the-transaction-model">10.1. The Transaction Model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="models.html#the-block-model">10.2. The Block Model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="models.html#the-vote-model">10.3. The Vote Model</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="json-serialization.html">11. JSON Serialization</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="transaction-validation.html">12. Transaction Validation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="transaction-validation.html#generic-validation">12.1. Generic Validation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="transaction-validation.html#specific-validation">12.2. Specific Validation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="rethinkdb-benchmarks.html">13. RethinkDB Benchmarks</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#goal">13.1. Goal</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#terminology">13.2. Terminology</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#settings">13.2.1. Settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#write-units">13.2.2. Write units</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#sharding">13.2.3. Sharding</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#tests">13.3. Tests</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-1">13.3.1. Test 1</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-2">13.3.2. Test 2</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-3">13.3.3. Test 3</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-4">13.3.4. Test 4</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-5">13.3.5. Test 5</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="rethinkdb-benchmarks.html#test-6">13.3.6. Test 6</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="rethinkdb-benchmarks.html#testing-replication">13.4. Testing replication</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="indices-and-tables">
|
||||
<h1>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
|
||||
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="#">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">BigchainDB Documentation</a><ul>
|
||||
<li><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#indices-and-tables">Indices and Tables</a></li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="#">Documentation overview</a><ul>
|
||||
<li>Next: <a href="installing.html" title="next chapter">1. Installing BigchainDB</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/index.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,102 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>1. Installing BigchainDB — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="2. Getting Started" href="getting-started.html" />
|
||||
<link rel="prev" title="BigchainDB Documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="installing-bigchaindb">
|
||||
<span id="installing-bigchaindb"></span><h1>1. Installing BigchainDB<a class="headerlink" href="#installing-bigchaindb" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Link to RethinkDB installation instructions</p>
|
||||
<p>How to install BigchainDB</p>
|
||||
<p>Installing with Docker?</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">BigchainDB Documentation</a></li>
|
||||
<li>Next: <a href="getting-started.html" title="next chapter">2. Getting Started</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/installing.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/installing.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,100 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Introduction — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="Getting Started" href="getting-started.html" />
|
||||
<link rel="prev" title="BigchainDB Documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="introduction">
|
||||
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This section will introduce BigchainDB.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">BigchainDB Documentation</a></li>
|
||||
<li>Next: <a href="getting-started.html" title="next chapter">Getting Started</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/introduction.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/introduction.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,147 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>11. JSON Serialization — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="12. Transaction Validation" href="transaction-validation.html" />
|
||||
<link rel="prev" title="10. The Transaction, Block and Vote Models" href="models.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="json-serialization">
|
||||
<span id="json-serialization"></span><h1>11. JSON Serialization<a class="headerlink" href="#json-serialization" title="Permalink to this headline">¶</a></h1>
|
||||
<p>We needed to clearly define how to serialize a JSON object to calculate the hash.</p>
|
||||
<p>The serialization should produce the same byte output independently of the architecture running the software. If there are diferences in the serialization, hash validations will fail although the transaction is correct.</p>
|
||||
<p>For example, consider the following two methods of serializing <code class="docutils literal"><span class="pre">{'a':</span> <span class="pre">1}</span></code>:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># Use a serializer provided by RethinkDB</span>
|
||||
<span class="n">a</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">expr</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span><span class="o">.</span><span class="n">to_json</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">b</span><span class="o">.</span><span class="n">connection</span><span class="p">)</span>
|
||||
<span class="s1">u'{"a":1}'</span>
|
||||
|
||||
<span class="c1"># Use the serializer in Python's json module</span>
|
||||
<span class="n">b</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">({</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
|
||||
<span class="s1">'{"a": 1}'</span>
|
||||
|
||||
<span class="n">a</span> <span class="o">==</span> <span class="n">b</span>
|
||||
<span class="bp">False</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The results are not the same. We want a serialization and deserialization so that the following is always true:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="n">deserialize</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">data</span><span class="p">))</span> <span class="o">==</span> <span class="n">data</span>
|
||||
<span class="bp">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>After looking at this further, we decided that the python json module is still the best bet because it complies with the RFC. We can specify the encoding, separators used and enforce it to order by the keys to make sure that we obtain maximum interopelability.</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">json</span>
|
||||
|
||||
<span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">skipkeys</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">ensure_ascii</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
|
||||
<span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> <span class="n">separators</span><span class="o">=</span><span class="p">(</span><span class="s1">','</span><span class="p">,</span> <span class="s1">':'</span><span class="p">),</span>
|
||||
<span class="n">sort_keys</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><code class="docutils literal"><span class="pre">skipkeys</span></code>: With skipkeys <code class="docutils literal"><span class="pre">False</span></code> if the provided keys are not a string the serialization will fail. This way we enforce all keys to be strings</li>
|
||||
<li><code class="docutils literal"><span class="pre">ensure_ascii</span></code>: The RFC recommends <code class="docutils literal"><span class="pre">utf-8</span></code> for maximum interoperability. By setting ensure_ascii to <code class="docutils literal"><span class="pre">False</span></code> we allow unicode characters and force the encoding to <code class="docutils literal"><span class="pre">utf-8</span></code>.</li>
|
||||
<li><code class="docutils literal"><span class="pre">separators</span></code>: We need to define a standard separator to use in the serialization. We did not do this different implementations could use different separators for serialization resulting in a still valid transaction but with a different hash e. g. an extra whitespace introduced in the serialization would not still create a valid json object but the hash would be different.</li>
|
||||
</ul>
|
||||
<p>Every time we need to perform some operation on the data like calculating the hash or signing/verifying the transaction, we need to use the previous criteria to serialize the data and then use the <code class="docutils literal"><span class="pre">byte</span></code> representation of the serialized data (if we treat the data as bytes we eliminate possible encoding errors e.g. unicode characters). For example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="c1"># calculate the hash of a transaction</span>
|
||||
<span class="c1"># the transaction is a dictionary</span>
|
||||
<span class="n">tx_serialized</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">tx</span><span class="p">))</span>
|
||||
<span class="n">tx_hash</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha3_256</span><span class="p">(</span><span class="n">tx_serialized</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
|
||||
|
||||
<span class="c1"># signing a transaction</span>
|
||||
<span class="n">tx_serialized</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">tx</span><span class="p">))</span>
|
||||
<span class="n">signature</span> <span class="o">=</span> <span class="n">sk</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">tx_serialized</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># verify signature</span>
|
||||
<span class="n">tx_serialized</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">serialize</span><span class="p">(</span><span class="n">tx</span><span class="p">))</span>
|
||||
<span class="n">vk</span><span class="o">.</span><span class="n">verify</span><span class="p">(</span><span class="n">signature</span><span class="p">,</span> <span class="n">tx_serialized</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="models.html" title="previous chapter">10. The Transaction, Block and Vote Models</a></li>
|
||||
<li>Next: <a href="transaction-validation.html" title="next chapter">12. Transaction Validation</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/json-serialization.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/json-serialization.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,199 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>10. The Transaction, Block and Vote Models — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="11. JSON Serialization" href="json-serialization.html" />
|
||||
<link rel="prev" title="9. Cryptography" href="cryptography.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="the-transaction-block-and-vote-models">
|
||||
<span id="the-transaction-block-and-vote-models"></span><h1>10. The Transaction, Block and Vote Models<a class="headerlink" href="#the-transaction-block-and-vote-models" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Transactions, blocks and votes are represented using JSON documents with the following models (schemas).</p>
|
||||
<div class="section" id="the-transaction-model">
|
||||
<span id="the-transaction-model"></span><h2>10.1. The Transaction Model<a class="headerlink" href="#the-transaction-model" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python"><div class="highlight"><pre>{
|
||||
"id": "<sha3 hash>",
|
||||
"transaction": {
|
||||
"current_owner": "<pub-key>",
|
||||
"new_owner": "<pub-key>",
|
||||
"input": "<sha3 hash>",
|
||||
"operation": "<string>",
|
||||
"timestamp": "<rethinkdb timestamp>",
|
||||
"data": {
|
||||
"hash": "<sha3 hash>",
|
||||
...
|
||||
}
|
||||
},
|
||||
"signature": "<ECDSA signature of the transaction>"
|
||||
}
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A transaction is an operation between the <code class="docutils literal"><span class="pre">current_owner</span></code> and the <code class="docutils literal"><span class="pre">new_owner</span></code> over the digital content described by <code class="docutils literal"><span class="pre">hash</span></code>. For example if could be a transfer of ownership of the digital content <code class="docutils literal"><span class="pre">hash</span></code></p>
|
||||
<ul class="simple">
|
||||
<li><code class="docutils literal"><span class="pre">id</span></code>: sha3 hash of the transaction and rethinkdb primary key. By using the hash of the transaction of the
|
||||
primary key we eliminate the problem of duplicated transactions, if for some reason two nodes decide to create the
|
||||
same transaction</li>
|
||||
<li><code class="docutils literal"><span class="pre">current_owner</span></code>: Public key of the current owner of the digital content with hash <code class="docutils literal"><span class="pre">hash</span></code></li>
|
||||
<li><code class="docutils literal"><span class="pre">new_owner</span></code>: Public key of the new owner of the digital content with hash <code class="docutils literal"><span class="pre">hash</span></code></li>
|
||||
<li><code class="docutils literal"><span class="pre">input</span></code>: 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.</li>
|
||||
<li><code class="docutils literal"><span class="pre">operation</span></code>: String representation of the operation being performed (REGISTER, TRANSFER, ...) this will define how
|
||||
the transactions should be validated</li>
|
||||
<li><code class="docutils literal"><span class="pre">timestamp</span></code>: Time of creation of the transaction in UTC</li>
|
||||
<li><code class="docutils literal"><span class="pre">data</span></code>: Json object describing the asset (digital content). It contains at least the field <code class="docutils literal"><span class="pre">hash</span></code> which is a
|
||||
sha3 hash of the digital content.</li>
|
||||
<li><code class="docutils literal"><span class="pre">signature</span></code>: ECDSA signature of the transaction with the <code class="docutils literal"><span class="pre">current_owner</span></code> private key</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="the-block-model">
|
||||
<span id="the-block-model"></span><h2>10.2. The Block Model<a class="headerlink" href="#the-block-model" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-json"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"<sha3 hash of the list of transactions + timestamp + nodes_pubkeys>"</span><span class="p">,</span>
|
||||
<span class="nt">"block"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"<RethinkDB timestamp>"</span><span class="p">,</span>
|
||||
<span class="nt">"transactions"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"<list of transactions>"</span><span class="p">],</span>
|
||||
<span class="nt">"node_pubkey"</span><span class="p">:</span> <span class="s2">"<public key of the node creating the block>"</span><span class="p">,</span>
|
||||
<span class="nt">"voters"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"<list of federation nodes pulic keys>"</span><span class="p">]</span>
|
||||
<span class="p">},</span>
|
||||
<span class="nt">"signature"</span><span class="p">:</span> <span class="s2">"<signature of the block>"</span><span class="p">,</span>
|
||||
<span class="nt">"votes"</span><span class="p">:</span> <span class="p">[]</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Still to be defined when new blocks are created (after x number of transactions, or after x amount of seconds,
|
||||
or both).
|
||||
A block contains a group of transactions and includes the hash of the hash of the previous block to build the chain.</p>
|
||||
<ul class="simple">
|
||||
<li><code class="docutils literal"><span class="pre">id</span></code>: sha3 hash of the current block. This is also a rethinkdb primary key, this way we make sure that all blocks are unique.</li>
|
||||
<li><code class="docutils literal"><span class="pre">block</span></code>: The actual block<ul>
|
||||
<li><code class="docutils literal"><span class="pre">timestamp</span></code>: timestamp when the block was created</li>
|
||||
<li><code class="docutils literal"><span class="pre">transactions</span></code>: the list of transactions included in the block</li>
|
||||
<li><code class="docutils literal"><span class="pre">node_pubkey</span></code>: the public key of the node that create the block</li>
|
||||
<li><code class="docutils literal"><span class="pre">voters</span></code>: list public keys of the federation nodes. Since the size of the
|
||||
federation may change over time this will tell us how many nodes existed
|
||||
in the federation when the block was created so that in a later point in
|
||||
time we can check that the block received the correct number of votes.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code class="docutils literal"><span class="pre">signature</span></code>: Signature of the block by the node that created the block</li>
|
||||
<li><code class="docutils literal"><span class="pre">votes</span></code>: Initially an empty list. Nodes in the voters list will append to it
|
||||
has they vote on the block</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="the-vote-model">
|
||||
<span id="the-vote-model"></span><h2>10.3. The Vote Model<a class="headerlink" href="#the-vote-model" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This is the structure that each node will append to the block <code class="docutils literal"><span class="pre">votes</span></code> list.</p>
|
||||
<div class="highlight-json"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="nt">"node_pubkey"</span><span class="p">:</span> <span class="s2">"<the pubkey of the voting node>"</span><span class="p">,</span>
|
||||
<span class="nt">"vote"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="nt">"voting_for_block"</span><span class="p">:</span> <span class="s2">"<id of the block the node is voting for>"</span><span class="p">,</span>
|
||||
<span class="nt">"previous_block"</span><span class="p">:</span> <span class="s2">"<id of the block previous to this one>"</span><span class="p">,</span>
|
||||
<span class="nt">"is_block_valid"</span><span class="p">:</span> <span class="s2">"<true|false>"</span><span class="p">,</span>
|
||||
<span class="nt">"invalid_reason"</span><span class="p">:</span> <span class="s2">"<None|DOUBLE_SPEND|TRANSACTIONS_HASH_MISMATCH|NODES_PUBKEYS_MISMATCH"</span><span class="p">,</span>
|
||||
<span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"<rethinkdb timestamp of the voting action>"</span>
|
||||
<span class="p">},</span>
|
||||
<span class="nt">"signature"</span><span class="p">:</span> <span class="s2">"<ECDSA signature of vote block>"</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">10. The Transaction, Block and Vote Models</a><ul>
|
||||
<li><a class="reference internal" href="#the-transaction-model">10.1. The Transaction Model</a></li>
|
||||
<li><a class="reference internal" href="#the-block-model">10.2. The Block Model</a></li>
|
||||
<li><a class="reference internal" href="#the-vote-model">10.3. The Vote Model</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="cryptography.html" title="previous chapter">9. Cryptography</a></li>
|
||||
<li>Next: <a href="json-serialization.html" title="next chapter">11. JSON Serialization</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/models.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/models.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
|
|
@ -1,523 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Reference — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="Release Notes" href="release-notes.html" />
|
||||
<link rel="prev" title="Frequently Asked Questions (FAQ)" href="faq.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="reference">
|
||||
<h1>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This is the reference section of the documentation.</p>
|
||||
<dl class="class">
|
||||
<dt id="bigchain.Bigchain">
|
||||
<em class="property">class </em><code class="descclassname">bigchain.</code><code class="descname">Bigchain</code><span class="sig-paren">(</span><em>host=None</em>, <em>port=None</em>, <em>dbname=None</em>, <em>public_key=None</em>, <em>private_key=None</em>, <em>keyring=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bigchain API</p>
|
||||
<p>Create, read, sign, write transactions to the database</p>
|
||||
<dl class="method">
|
||||
<dt id="bigchain.core.Bigchain.__init__">
|
||||
<code class="descname">__init__</code><span class="sig-paren">(</span><em>host=None</em>, <em>port=None</em>, <em>dbname=None</em>, <em>public_key=None</em>, <em>private_key=None</em>, <em>keyring=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.core.Bigchain.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize the Bigchain instance</p>
|
||||
<p>There are three ways in which the Bigchain instance can get its parameters.
|
||||
The order by which the parameters are chosen are:</p>
|
||||
<blockquote>
|
||||
<div><ol class="arabic simple">
|
||||
<li>Setting them by passing them to the <cite>__init__</cite> method itself.</li>
|
||||
<li>Setting them as environment variables</li>
|
||||
<li>Reading them from the <cite>config.json</cite> file.</li>
|
||||
</ol>
|
||||
</div></blockquote>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><strong>host</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – hostname where the rethinkdb is running.</li>
|
||||
<li><strong>port</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – port in which rethinkb is running (usually 28015).</li>
|
||||
<li><strong>dbname</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the name of the database to connect to (usually bigchain).</li>
|
||||
<li><strong>public_key</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the base58 encoded public key for the ECDSA secp256k1 curve.</li>
|
||||
<li><strong>private_key</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the base58 encoded private key for the ECDSA secp256k1 curve.</li>
|
||||
<li><strong>keyring</strong> (<em>list[str]</em>) – list of base58 encoded public keys of the federation nodes.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.create_transaction">
|
||||
<code class="descname">create_transaction</code><span class="sig-paren">(</span><em>current_owner</em>, <em>new_owner</em>, <em>tx_input</em>, <em>operation</em>, <em>payload=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.create_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.create_transaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new transaction</p>
|
||||
<p>A transaction in the bigchain is a transfer of a digital asset between two entities represented
|
||||
by public keys.</p>
|
||||
<p>Currently the bigchain supports two types of operations:</p>
|
||||
<blockquote>
|
||||
<div><p><cite>CREATE</cite> - Only federation nodes are allowed to use this operation. In a create operation
|
||||
a federation node creates a digital asset in the bigchain and assigns that asset to a public
|
||||
key. The owner of the private key can then decided to transfer this digital asset by using the
|
||||
<cite>transaction id</cite> of the transaction as an input in a <cite>TRANSFER</cite> transaction.</p>
|
||||
<p><cite>TRANSFER</cite> - A transfer operation allows for a transfer of the digital assets between entities.</p>
|
||||
</div></blockquote>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>current_owner</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – base58 encoded public key of the current owner of the asset.</li>
|
||||
<li><strong>new_owner</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – base58 encoded public key of the new owner of the digital asset.</li>
|
||||
<li><strong>tx_input</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – id of the transaction to use as input.</li>
|
||||
<li><strong>operation</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Either <cite>CREATE</cite> or <cite>TRANSFER</cite> operation.</li>
|
||||
<li><strong>payload</strong> (<em>Optional[dict]</em>) – dictionary with information about asset</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">unsigned transaction</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.sign_transaction">
|
||||
<code class="descname">sign_transaction</code><span class="sig-paren">(</span><em>transaction</em>, <em>private_key</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.sign_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.sign_transaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sign a transaction</p>
|
||||
<p>A transaction signed with the <cite>current_owner</cite> corresponding private key.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>transaction</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – transaction to sign.</li>
|
||||
<li><strong>private_key</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – base58 encoded private key to create a signature of the transaction.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">transaction with the <cite>signature</cite> field included.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.verify_signature">
|
||||
<code class="descname">verify_signature</code><span class="sig-paren">(</span><em>signed_transaction</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.verify_signature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.verify_signature" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verify the signature of a transaction</p>
|
||||
<p>A valid transaction should have been signed <cite>current_owner</cite> corresponding private key.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>signed_transaction</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – a transaction with the <cite>signature</cite> included.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the signature is correct, False otherwise.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.write_transaction">
|
||||
<code class="descname">write_transaction</code><span class="sig-paren">(</span><em>signed_transaction</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.write_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.write_transaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Write the transaction to bigchain.</p>
|
||||
<p>When first writing a transaction to the bigchain the transaction will be kept in a backlog until
|
||||
it has been validated by the nodes of the federation.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>singed_transaction</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – transaction with the <cite>signature</cite> included.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">database response</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.get_transaction">
|
||||
<code class="descname">get_transaction</code><span class="sig-paren">(</span><em>txid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.get_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.get_transaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve a transaction with <cite>txid</cite> from bigchain.</p>
|
||||
<p>Queries the bigchain for a transaction that was already included in a block.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>txid</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – transaction id of the transaction to query</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dict with the transaction details if the transaction was found.<p>If no transaction with that <cite>txid</cite> was found it returns <cite>None</cite></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.get_tx_by_payload_hash">
|
||||
<code class="descname">get_tx_by_payload_hash</code><span class="sig-paren">(</span><em>payload_hash</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.get_tx_by_payload_hash"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.get_tx_by_payload_hash" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieves transactions related to a digital asset.</p>
|
||||
<p>When creating a transaction one of the optional arguments is the <cite>payload</cite>. The payload is a generic
|
||||
dict that contains information about the digital asset.</p>
|
||||
<p>To make it easy to query the bigchain for that digital asset we create a sha3-256 hash of the
|
||||
serialized payload and store it with the transaction. This makes it easy for developers to keep track
|
||||
of their digital assets in bigchain.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>payload_hash</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – sha3-256 hash of the serialized payload.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of transactions containing that payload. If no transaction exists with that payload it
|
||||
returns <cite>None</cite></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.get_spent">
|
||||
<code class="descname">get_spent</code><span class="sig-paren">(</span><em>txid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.get_spent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.get_spent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check if a <cite>txid</cite> was already used as an input.</p>
|
||||
<p>A transaction can be used as an input for another transaction. Bigchain needs to make sure that a
|
||||
given <cite>txid</cite> is only used once.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>txid</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – transaction id.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The transaction that used the <cite>txid</cite> as an input if it exists else it returns <cite>None</cite></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.get_owned_ids">
|
||||
<code class="descname">get_owned_ids</code><span class="sig-paren">(</span><em>owner</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.get_owned_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.get_owned_ids" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve a list of <cite>txids</cite> that can we used has inputs.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>owner</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – base58 encoded public key.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of <cite>txids</cite> currently owned by <cite>owner</cite></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)">list</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.validate_transaction">
|
||||
<code class="descname">validate_transaction</code><span class="sig-paren">(</span><em>transaction</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.validate_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.validate_transaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Validate a transaction.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>transaction</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – transaction to validate.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The transaction if the transaction is valid else it raises and exception
|
||||
describing the reason why the transaction is invalid.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.is_valid_transaction">
|
||||
<code class="descname">is_valid_transaction</code><span class="sig-paren">(</span><em>transaction</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.is_valid_transaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.is_valid_transaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check whether a transacion is valid or invalid.</p>
|
||||
<p>Similar to <cite>validate_transaction</cite> but does not raise an exception if the transaction is valid.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>transaction</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – transaction to check.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><cite>True</cite> if the transaction is valid, <cite>False</cite> otherwise</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.create_block">
|
||||
<code class="descname">create_block</code><span class="sig-paren">(</span><em>validated_transactions</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.create_block"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.create_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a block given a list of <cite>validated_transactions</cite>.</p>
|
||||
<p>Note that this method does not validate the transactions. Transactions should be validated before
|
||||
calling create_block.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>validated_transactions</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – list of validated transactions.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">created block.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.validate_block">
|
||||
<code class="descname">validate_block</code><span class="sig-paren">(</span><em>block</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.validate_block"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.validate_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Validate a block.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>block</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – block to validate.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The block if the block is valid else it raises and exception
|
||||
describing the reason why the block is invalid.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.is_valid_block">
|
||||
<code class="descname">is_valid_block</code><span class="sig-paren">(</span><em>block</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.is_valid_block"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.is_valid_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check whether a block is valid or invalid.</p>
|
||||
<p>Similar to <cite>validate_block</cite> but does not raise an exception if the block is invalid.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>block</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – block to check.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><cite>True</cite> if the block is valid, <cite>False</cite> otherwise.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.write_block">
|
||||
<code class="descname">write_block</code><span class="sig-paren">(</span><em>block</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.write_block"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.write_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Write a block to bigchain.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>block</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – block to write to bigchain.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.create_genesis_block">
|
||||
<code class="descname">create_genesis_block</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.create_genesis_block"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.create_genesis_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create the genesis block</p>
|
||||
<p>Block created when bigchain is first initialized.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="bigchain.Bigchain.vote">
|
||||
<code class="descname">vote</code><span class="sig-paren">(</span><em>block</em>, <em>previous_block_id</em>, <em>decision</em>, <em>invalid_reason=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.vote"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.vote" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cast your vote on the block given the previous_block_hash and the decision (valid/invalid)
|
||||
return the block to the updated in the database.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><strong>block</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – Block to vote.</li>
|
||||
<li><strong>previous_block_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – The id of the previous block.</li>
|
||||
<li><strong>decision</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – Whether the block is valid or invalid.</li>
|
||||
<li><strong>invalid_reason</strong> (<em>Optional[str]</em>) – Reason the block is invalid</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="bigchain.Bigchain.serialize">
|
||||
<em class="property">static </em><code class="descname">serialize</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.serialize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.serialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Static method used to serialize a dict into a JSON formatted string.</p>
|
||||
<p>This method enforces rules like the separator and order of keys. This ensures that all dicts
|
||||
are serialized in the same way.</p>
|
||||
<p>This is specially important for hashing data. We need to make sure that everyone serializes their data
|
||||
in the same way so that we do not have hash mismatches for the same structure due to serialization
|
||||
differences.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – dict to serialize</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">JSON formatted string</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="bigchain.Bigchain.deserialize">
|
||||
<em class="property">static </em><code class="descname">deserialize</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.deserialize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.deserialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Static method used to deserialize a JSON formatted string into a dict.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – JSON formatted string.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dict resulting from the serialization of a JSON formatted string.</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="bigchain.Bigchain.timestamp">
|
||||
<em class="property">static </em><code class="descname">timestamp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.timestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.timestamp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Static method to calculate a UTC timestamp with microsecond precision.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">UTC timestamp.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="staticmethod">
|
||||
<dt id="bigchain.Bigchain.generate_keys">
|
||||
<em class="property">static </em><code class="descname">generate_keys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/bigchain/core.html#Bigchain.generate_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bigchain.Bigchain.generate_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates a key pair.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><cite>(private_key, public_key)</cite>. ECDSA key pair using the secp256k1 curve encoded
|
||||
in base58.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)">tuple</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="faq.html" title="previous chapter">Frequently Asked Questions (FAQ)</a></li>
|
||||
<li>Next: <a href="release-notes.html" title="next chapter">Release Notes</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/reference.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/reference.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,100 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>6. Release Notes — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="7. BigchainDB Software Architecture" href="software-architecture.html" />
|
||||
<link rel="prev" title="5. Frequently Asked Questions (FAQ)" href="faq.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="release-notes">
|
||||
<span id="release-notes"></span><h1>6. Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This section has the release notes for each version of BigChainDB.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="faq.html" title="previous chapter">5. Frequently Asked Questions (FAQ)</a></li>
|
||||
<li>Next: <a href="software-architecture.html" title="next chapter">7. BigchainDB Software Architecture</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/release-notes.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/release-notes.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,304 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>13. RethinkDB Benchmarks — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="prev" title="12. Transaction Validation" href="transaction-validation.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="rethinkdb-benchmarks">
|
||||
<span id="rethinkdb-benchmarks"></span><h1>13. RethinkDB Benchmarks<a class="headerlink" href="#rethinkdb-benchmarks" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="goal">
|
||||
<span id="goal"></span><h2>13.1. Goal<a class="headerlink" href="#goal" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The goal was to test RethinkDB scalability properties, to understand its limits, and to see if we could reach a speed of 1M transactions per second.</p>
|
||||
</div>
|
||||
<div class="section" id="terminology">
|
||||
<span id="terminology"></span><h2>13.2. Terminology<a class="headerlink" href="#terminology" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="settings">
|
||||
<span id="settings"></span><h3>13.2.1. Settings<a class="headerlink" href="#settings" title="Permalink to this headline">¶</a></h3>
|
||||
<p>To test the writing performance of rethinkdb we have a process that inserts a
|
||||
block in the database in an infinite loop</p>
|
||||
<p>The block is a valid block with small transactions (transactions without any
|
||||
payload). The entire block has around 900KB</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
|
||||
<span class="n">r</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="n">table</span><span class="p">)</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">(</span><span class="n">BLOCK_SERIALIZED</span><span class="p">),</span> <span class="n">durability</span><span class="o">=</span><span class="s1">'soft'</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>In <code class="docutils literal"><span class="pre">hard</span></code> durability mode, writes are committed to disk before acknowledgments
|
||||
are sent; in <code class="docutils literal"><span class="pre">soft</span></code> mode, writes are acknowledged immediately after being stored
|
||||
in memory.</p>
|
||||
<p>This means that the insert will block until rethinkdb acknowledges that the data
|
||||
was cached. In each server we can start multiple process.</p>
|
||||
</div>
|
||||
<div class="section" id="write-units">
|
||||
<span id="write-units"></span><h3>13.2.2. Write units<a class="headerlink" href="#write-units" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Lets define <code class="docutils literal"><span class="pre">1</span> <span class="pre">write</span> <span class="pre">unit</span></code> as being 1 process. For example in a 32 node cluster
|
||||
with each node running 2 processes we would have <code class="docutils literal"><span class="pre">64</span> <span class="pre">writes</span></code>. This will make it
|
||||
easier to compare different tests.</p>
|
||||
</div>
|
||||
<div class="section" id="sharding">
|
||||
<span id="sharding"></span><h3>13.2.3. Sharding<a class="headerlink" href="#sharding" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Sharding in distributed datastores means partitioning a table so that the data
|
||||
can be evenly distributed between all nodes in the cluster. In rethinkdb and
|
||||
most distributed datastores there is a maximum limit of 32 shards per table.</p>
|
||||
<p>In rethinkdb a <code class="docutils literal"><span class="pre">shard</span></code> is also called a <code class="docutils literal"><span class="pre">primary</span> <span class="pre">replica</span></code>, since by default the
|
||||
replication factor is 1. Increasing the replication factor produces <code class="docutils literal"><span class="pre">secondary</span> <span class="pre">replicas</span></code> that are used for data redundancy (if a node holding a primary replica
|
||||
goes down another node holding a secondary replica of the same data can step up
|
||||
and become the primary replica)</p>
|
||||
<p>For these tests we are using 32 core ec2 instances with SSD storage and 10Gbps
|
||||
network connections (<code class="docutils literal"><span class="pre">c3.8xlarge</span></code>). For the tests we used either 32 or 64 node
|
||||
clusters all running on the same aws region.</p>
|
||||
<p>These tests show rethinkdb performance and what we can expect from the database.
|
||||
This does not show the performance of the bigchain</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="tests">
|
||||
<span id="tests"></span><h2>13.3. Tests<a class="headerlink" href="#tests" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="test-1">
|
||||
<span id="test-1"></span><h3>13.3.1. Test 1<a class="headerlink" href="#test-1" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 32</li>
|
||||
<li><strong>number of processes</strong>: 2 processes per node</li>
|
||||
<li><strong>write units</strong>: 32 x 2 = 64 writes</li>
|
||||
<li><strong>output</strong>: stable 1K writes per second</li>
|
||||
</ul>
|
||||
<p>This was the most successful test. We are able to reach a stable output of 1K
|
||||
blocks per second. The load on the machines is stable and the IO is at an
|
||||
average of 50-60 %.</p>
|
||||
<p>Other tests have shown that increasing the number write units per machine can
|
||||
lead to a stable performance up to 1.5K writes per second but the load on the
|
||||
nodes would increase until the node would eventually fail. This means that we
|
||||
are able to handle bursts for a short amount of time (10-20 min).</p>
|
||||
<p>This test can be used has a baseline for the future in where 64 writes equal 1K
|
||||
transactions per second. Or that each write unit produces an output of
|
||||
<code class="docutils literal"><span class="pre">1000/64</span></code> writes per second, approximately 16 writes per second.</p>
|
||||
</div>
|
||||
<div class="section" id="test-2">
|
||||
<span id="test-2"></span><h3>13.3.2. Test 2<a class="headerlink" href="#test-2" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 32</li>
|
||||
<li><strong>number of processes</strong>:<ul>
|
||||
<li>16 nodes running 2 processes</li>
|
||||
<li>16 nodes running 3 processes</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>write units</strong>: 16 x 3 + 16 x 2 = 80 writes</li>
|
||||
<li><strong>expected output</strong>: 1250 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1.2K writes per second</li>
|
||||
</ul>
|
||||
<p>Increasing a bit the number of write units shows an increase in output close to
|
||||
the expected value but in this case the IO around 90 % close to the limit that
|
||||
the machine can handle.</p>
|
||||
</div>
|
||||
<div class="section" id="test-3">
|
||||
<span id="test-3"></span><h3>13.3.3. Test 3<a class="headerlink" href="#test-3" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 32</li>
|
||||
<li><strong>number of processes</strong>:<ul>
|
||||
<li>16 nodes running 2 processes</li>
|
||||
<li>16 nodes running 4 processes</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>write units</strong>: 16 x 4 + 16 x 2 = 96 writes</li>
|
||||
<li><strong>expected output</strong>: 1500 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1.4K writes per second</li>
|
||||
</ul>
|
||||
<p>These test produces results similar to previous one. The reason why we don’t
|
||||
reach the expected output may be because rethinkdb needs time to cache results
|
||||
and at some point increasing the number of write units will not result in an
|
||||
higher output. Another problem is that as the rethinkdb cache fills (because the
|
||||
rethinkdb is not able to flush the data to disk fast enough due to IO
|
||||
limitations) the performance will decrease because the processes will take more
|
||||
time inserting blocks.</p>
|
||||
</div>
|
||||
<div class="section" id="test-4">
|
||||
<span id="test-4"></span><h3>13.3.4. Test 4<a class="headerlink" href="#test-4" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 64</li>
|
||||
<li><strong>number of processes</strong>: 1 process per node</li>
|
||||
<li><strong>write units</strong>: 64 x 1 = 64 writes</li>
|
||||
<li><strong>expected output</strong>: 1000 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1K writes per second</li>
|
||||
</ul>
|
||||
<p>In this case we are increasing the number of nodes in the cluster by 2x. This
|
||||
won’t have an impact in the write performance because the maximum amount of
|
||||
shards per table in rethinkdb is 32 (rethinkdb will probably increase this limit
|
||||
in the future). What this provides is more CPU power (and storage for replicas,
|
||||
more about replication in the next section). We just halved the amount write
|
||||
units per node maintaining the same output. The IO in the nodes holding the
|
||||
primary replica is the same has test 1.</p>
|
||||
</div>
|
||||
<div class="section" id="test-5">
|
||||
<span id="test-5"></span><h3>13.3.5. Test 5<a class="headerlink" href="#test-5" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 64</li>
|
||||
<li><strong>number of processes</strong>: 2 process per node</li>
|
||||
<li><strong>write units</strong>: 64 x 2 = 128 writes</li>
|
||||
<li><strong>expected output</strong>: 2000 writes per second</li>
|
||||
<li><strong>output</strong>: unstable 2K (peak) writes per second</li>
|
||||
</ul>
|
||||
<p>In this case we are doubling the amount of write units. We are able to reach the
|
||||
expected output but the output performance is unstable due to the fact that we
|
||||
reached the IO limit on the machines.</p>
|
||||
</div>
|
||||
<div class="section" id="test-6">
|
||||
<span id="test-6"></span><h3>13.3.6. Test 6<a class="headerlink" href="#test-6" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><strong>number of nodes</strong>: 64</li>
|
||||
<li><strong>number of processes</strong>:<ul>
|
||||
<li>32 nodes running 1 processes</li>
|
||||
<li>32 nodes running 2 processes</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>write units</strong>: 32 x 2 + 32 x 1 = 96 writes</li>
|
||||
<li><strong>expected output</strong>: 1500 writes per second</li>
|
||||
<li><strong>output</strong>: stable 1.5K writes per second</li>
|
||||
</ul>
|
||||
<p>This test is similar to Test 3. The only difference is that now the write units
|
||||
are distributed between 64 nodes meaning that each node is writing to its local
|
||||
cache and we don’t overload the cache of the nodes like we did with Test 3. This
|
||||
is another advantage of adding more nodes beyond 32.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="testing-replication">
|
||||
<span id="testing-replication"></span><h2>13.4. Testing replication<a class="headerlink" href="#testing-replication" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Replication is used for data redundancy. In rethinkdb we are able to specify the
|
||||
number of shards and replicas per table. Data in secondary replicas is no
|
||||
directly used, its just a mirror of a primary replica and used in case the node
|
||||
holding the primary replica fails.</p>
|
||||
<p>Rethinkdb does a good job trying to distribute data evenly between nodes. We ran
|
||||
some tests to check this.</p>
|
||||
<p>Note that by increasing the number of replicas we also increase the number of
|
||||
writes in the cluster. For a replication factor of 2 we double the amount of
|
||||
writes on the cluster, with a replication factor of 3 we triple the amount of
|
||||
writes and so on.</p>
|
||||
<p>With 64 nodes and since we can only have 32 shards we have 32 nodes holding
|
||||
shards (primary replicas)</p>
|
||||
<p>With a replication factor of 2 we will have 64 replicas (32 primary replicas and
|
||||
32 secondary replicas). Since we already have 32 nodes holding the 32
|
||||
shards/primary replicas rethinkdb uses the other 32 nodes to hold the secondary
|
||||
replicas. So in a 64 node cluster with 32 shards and a replication factor of 2,
|
||||
32 nodes will be holding the primary replicas and the other 32 nodes will be holding
|
||||
the secondary replicas.</p>
|
||||
<p>With this setup if we run Test 4 now that we have a replication factor of 2 we
|
||||
will have twice the amount of writes but a nice result is that the IO in the
|
||||
nodes holding the primary replicas does not increase when compared to Test 4
|
||||
because all of the excess writing is now being done the 32 nodes holding the
|
||||
secondary replicas.</p>
|
||||
<p>Another fact about replication. If I have a 64 node cluster and create a table
|
||||
with 32 shards, 32 nodes will be holding primary replicas and the other nodes do
|
||||
not hold any data. If I create another table with 32 shards rethinkdb will
|
||||
create the shards in the nodes that where not holding any data, evenly
|
||||
distributing the data.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">13. RethinkDB Benchmarks</a><ul>
|
||||
<li><a class="reference internal" href="#goal">13.1. Goal</a></li>
|
||||
<li><a class="reference internal" href="#terminology">13.2. Terminology</a><ul>
|
||||
<li><a class="reference internal" href="#settings">13.2.1. Settings</a></li>
|
||||
<li><a class="reference internal" href="#write-units">13.2.2. Write units</a></li>
|
||||
<li><a class="reference internal" href="#sharding">13.2.3. Sharding</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#tests">13.3. Tests</a><ul>
|
||||
<li><a class="reference internal" href="#test-1">13.3.1. Test 1</a></li>
|
||||
<li><a class="reference internal" href="#test-2">13.3.2. Test 2</a></li>
|
||||
<li><a class="reference internal" href="#test-3">13.3.3. Test 3</a></li>
|
||||
<li><a class="reference internal" href="#test-4">13.3.4. Test 4</a></li>
|
||||
<li><a class="reference internal" href="#test-5">13.3.5. Test 5</a></li>
|
||||
<li><a class="reference internal" href="#test-6">13.3.6. Test 6</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#testing-replication">13.4. Testing replication</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="transaction-validation.html" title="previous chapter">12. Transaction Validation</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/rethinkdb-benchmarks.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/rethinkdb-benchmarks.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
||||
<script type="text/javascript" id="searchindexloader"></script>
|
||||
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1 id="search-documentation">Search</h1>
|
||||
<div id="fallback" class="admonition warning">
|
||||
<script type="text/javascript">$('#fallback').hide();</script>
|
||||
<p>
|
||||
Please activate JavaScript to enable the search
|
||||
functionality.
|
||||
</p>
|
||||
</div>
|
||||
<p>
|
||||
From here you can search these documents. Enter your search
|
||||
words into the box below and click "search". Note that the search
|
||||
function will automatically search for all of the words. Pages
|
||||
containing fewer words won't appear in the result list.
|
||||
</p>
|
||||
<form action="" method="get">
|
||||
<input type="text" name="q" value="" />
|
||||
<input type="submit" value="search" />
|
||||
<span id="search-progress" style="padding-left: 10px"></span>
|
||||
</form>
|
||||
|
||||
<div id="search-results">
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,129 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>7. BigchainDB Software Architecture — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="8. The Bigchain Class" href="the-bigchain-class.html" />
|
||||
<link rel="prev" title="6. Release Notes" href="release-notes.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="bigchaindb-software-architecture">
|
||||
<span id="bigchaindb-software-architecture"></span><h1>7. BigchainDB Software Architecture<a class="headerlink" href="#bigchaindb-software-architecture" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Here we define the components needed for the software implementation of the prototype.</p>
|
||||
<div class="section" id="bigspool">
|
||||
<span id="bigspool"></span><h2>7.1. bigspool<a class="headerlink" href="#bigspool" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Bigchain implementation of the spool protocol</p>
|
||||
</div>
|
||||
<div class="section" id="bigchain">
|
||||
<span id="bigchain"></span><h2>7.2. bigchain<a class="headerlink" href="#bigchain" title="Permalink to this headline">¶</a></h2>
|
||||
<p>API to create, read, and push transactions to the bigchain</p>
|
||||
</div>
|
||||
<div class="section" id="validator">
|
||||
<span id="validator"></span><h2>7.3. validator<a class="headerlink" href="#validator" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Transaction validator. Decides which transactions to include in the bigchain. Each node in the federation will be
|
||||
running this code and the a transaction will be valid as long as more then half the nodes decided that the transaction
|
||||
is valid</p>
|
||||
</div>
|
||||
<div class="section" id="processor">
|
||||
<span id="processor"></span><h2>7.4. processor<a class="headerlink" href="#processor" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Creates the blocks from the transactions and cleans the backlog.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">7. BigchainDB Software Architecture</a><ul>
|
||||
<li><a class="reference internal" href="#bigspool">7.1. bigspool</a></li>
|
||||
<li><a class="reference internal" href="#bigchain">7.2. bigchain</a></li>
|
||||
<li><a class="reference internal" href="#validator">7.3. validator</a></li>
|
||||
<li><a class="reference internal" href="#processor">7.4. processor</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="release-notes.html" title="previous chapter">6. Release Notes</a></li>
|
||||
<li>Next: <a href="the-bigchain-class.html" title="next chapter">8. The Bigchain Class</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/software-architecture.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/software-architecture.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,97 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Test — Bigchain 0.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Bigchain 0.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="test">
|
||||
<h1>Test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This is a test page.</p>
|
||||
<p>This is a test sentence.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/test.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2016, ascribe GmbH.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.5</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
||||
|
||||
|
|
||||
<a href="_sources/test.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue