rebuild docs

Author: frozeman

docs/_build/doctrees/environment.pickle

@@ -15,15 +15,10 @@ To use this package standalone use:
 .. code-block:: javascript
 
     var Accounts = require('web3-eth-accounts');
-    var Eth = require('web3-eth');
-    var eth = new Eth('ws://localhost:8546');
 
     // Passing in the eth or web3 package is necessary to allow retrieving chainId, gasPrice and nonce automatically
     // for accounts.signTransaction().
-    var accounts = new Accounts(eth);
-
-    // If nonce, chainId and gasPrice will be always given you don't need to pass in the Eth, or web3 package.
-    var accounts = new Accounts();
+    var accounts = new Accounts('ws://localhost:8546');
 
 
 
@@ -612,7 +607,7 @@ Adds an account using a private key or account object to the wallet.
 Parameters
 ----------
 
-1. ``account`` - ``String|Object``: A private key or account object created with :ref:`web3.eth.accounts.new() <accounts-create>`.
+1. ``account`` - ``String|Object``: A private key or account object created with :ref:`web3.eth.accounts.create() <accounts-create>`.
 
 
 -------

docs/_build/doctrees/getting-started.doctree

@@ -12,6 +12,21 @@ and web3 will auto convert all calls into low level ABI calls over RPC for you.
 
 This allows you to interact with smart contracts as if they were JavaScript objects.
 
+To use it standalone:
+
+.. code-block:: javascript
+    var Contract = require('web3-eth-contract');
+
+    // set provider for all later instances to use
+    Contract.setProvider('ws://localhost:8546');
+
+    var contract = new Contract(jsonInterface, address);
+
+    contract.methods.somFunc().send({from: ....})
+    .on('receipt', function(){
+        ...
+    });
+
 
 ------------------------------------------------------------------------------
 
@@ -581,6 +596,7 @@ Example
                         topics: ['0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7', '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385']
                     },
                     event: 'MyEvent',
+                    signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
                     logIndex: 0,
                     transactionIndex: 0,
                     transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
@@ -744,6 +760,7 @@ Example
             topics: ['0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7', '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385']
         },
         event: 'MyEvent',
+        signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
         logIndex: 0,
         transactionIndex: 0,
         transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
@@ -792,6 +809,7 @@ Returns
 The structure of the returned event ``Object`` looks as follows:
 
 - ``event`` - ``String``: The event name.
+- ``signature`` - ``String|Null``: The event signature, ``null`` if its an anonymous event.
 - ``address`` - ``String``: From which this event originated from.
 - ``returnValues`` - ``Object``: The return values coming from the event, e.g. ``{myVar: 1, myVar2: '0x234...'}``.
 - ``logIndex`` - ``Number``: Integer of the event index position in the block.
@@ -832,6 +850,7 @@ Example
             topics: ['0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7', '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385']
         },
         event: 'MyEvent',
+        signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
         logIndex: 0,
         transactionIndex: 0,
         transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
@@ -913,6 +932,7 @@ Example
             topics: ['0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7', '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385']
         },
         event: 'MyEvent',
+        signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
         logIndex: 0,
         transactionIndex: 0,
         transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',

docs/_build/doctrees/include_package-net.doctree

@@ -93,7 +93,8 @@ Parameters
 
 1. ``String`` - Data to sign. If String it will be converted using :ref:`web3.utils.utf8ToHex <utils-utf8tohex>`.
 2. ``String`` - Address to sign data with.
-3. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
+3. ``String`` - The password of the account to sign data with.
+4. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
 
 
 -------

docs/_build/doctrees/web3-eth-accounts.doctree

@@ -217,7 +217,7 @@ sha3
 
 Will calculate the sha3 of the input.
 
-.. note::  To mimick the sha3 behaviour of solidity use :ref:`soliditySah3 <utils-soliditysha3>`
+.. note::  To mimic the sha3 behaviour of solidity use :ref:`soliditySah3 <utils-soliditysha3>`
 
 ----------
 Parameters
@@ -265,6 +265,7 @@ soliditySha3
     web3.utils.soliditySha3(param1 [, param2, ...])
 
 Will calculate the sha3 of given input parameters in the same way solidity would.
+This means arguments will be ABI converted and tightly packed before being hashed.
 
 ----------
 Parameters

docs/_build/doctrees/web3-eth-contract.doctree

@@ -11,13 +11,18 @@ The web3.js object is a umbrella package to house all ethereum related modules.
 
     var Web3 = require('web3');
 
+    > Web3.utils
+    > Web3.version
+    > Web3.modules
+
     // "Web3.providers.givenProvider" will be set if in an Ethereum supported browser.
     var web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546');
 
     > web3.eth
     > web3.shh
     > web3.bzz
     > web3.utils
+    > web3.version
 
 
 
@@ -29,6 +34,7 @@ version
 
 .. code-block:: javascript
 
+    Web3.version
     web3.version
 
 Contains the version of the ``web3`` container object.
@@ -49,11 +55,6 @@ Example
     > "1.0.0"
 
 
-------------------------------------------------------------------------------
-
-
-.. include:: package-core.rst
-
 
 ------------------------------------------------------------------------------
 
@@ -63,6 +64,7 @@ modules
 
 .. code-block:: javascript
 
+    Web3.modules
     web3.modules
 
 Will return an object with the classes of all major sub modules, to be able to instantiate them manually.
@@ -98,6 +100,22 @@ Example
 ------------------------------------------------------------------------------
 
 
+utils
+=====================
+
+.. code-block:: javascript
+
+    Web3.utils
+    web3.utils
+
+Utility functions are also exposes on the ``Web3`` class object directly.
+
+See :ref:`web3.utils <utils>` for more.
+
+
+------------------------------------------------------------------------------
+
+
 .. include:: include_package-core.rst
 
 

docs/_build/doctrees/web3-eth-personal.doctree

@@ -79,6 +79,7 @@ <h1>web3.js - Ethereum JavaScript API<a class="headerlink" href="#web3-js-ethere
 <li class="toctree-l1"><a class="reference internal" href="web3.html">web3</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#version">version</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#modules">modules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="web3.html#utils">utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#setprovider">setProvider</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#providers">providers</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#givenprovider">givenProvider</a></li>

docs/_build/doctrees/web3-utils.doctree

@@ -60,15 +60,10 @@ <h1>web3.eth.accounts<a class="headerlink" href="#web3-eth-accounts" title="Perm
 <p>The <code class="docutils literal"><span class="pre">web3.eth.accounts</span></code> contains functions to generate Ethereum accounts and sign transactions and data.</p>
 <p>To use this package standalone use:</p>
 <div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="kd">var</span> <span class="nx">Accounts</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;web3-eth-accounts&#39;</span><span class="p">);</span>
-<span class="kd">var</span> <span class="nx">Eth</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;web3-eth&#39;</span><span class="p">);</span>
-<span class="kd">var</span> <span class="nx">eth</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Eth</span><span class="p">(</span><span class="s1">&#39;ws://localhost:8546&#39;</span><span class="p">);</span>
 
 <span class="c1">// Passing in the eth or web3 package is necessary to allow retrieving chainId, gasPrice and nonce automatically</span>
 <span class="c1">// for accounts.signTransaction().</span>
-<span class="kd">var</span> <span class="nx">accounts</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Accounts</span><span class="p">(</span><span class="nx">eth</span><span class="p">);</span>
-
-<span class="c1">// If nonce, chainId and gasPrice will be always given you don&#39;t need to pass in the Eth, or web3 package.</span>
-<span class="kd">var</span> <span class="nx">accounts</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Accounts</span><span class="p">();</span>
+<span class="kd">var</span> <span class="nx">accounts</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Accounts</span><span class="p">(</span><span class="s1">&#39;ws://localhost:8546&#39;</span><span class="p">);</span>
 </pre></div>
 </div>
 <hr class="docutils" />
@@ -563,7 +558,7 @@ <h2>wallet.add<a class="headerlink" href="#wallet-add" title="Permalink to this
 <div class="section" id="id29">
 <h3>Parameters<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3>
 <ol class="arabic simple">
-<li><code class="docutils literal"><span class="pre">account</span></code> - <code class="docutils literal"><span class="pre">String|Object</span></code>: A private key or account object created with <a class="reference internal" href="#accounts-create"><span class="std std-ref">web3.eth.accounts.new()</span></a>.</li>
+<li><code class="docutils literal"><span class="pre">account</span></code> - <code class="docutils literal"><span class="pre">String|Object</span></code>: A private key or account object created with <a class="reference internal" href="#accounts-create"><span class="std std-ref">web3.eth.accounts.create()</span></a>.</li>
 </ol>
 </div>
 <div class="section" id="id30">

docs/_build/doctrees/web3.doctree

@@ -61,6 +61,7 @@ <h1>web3.eth.Contract<a class="headerlink" href="#web3-eth-contract" title="Perm
 When you create a new contract object you give it the json interface of the respective smart contract
 and web3 will auto convert all calls into low level ABI calls over RPC for you.</p>
 <p>This allows you to interact with smart contracts as if they were JavaScript objects.</p>
+<p>To use it standalone:</p>
 <hr class="docutils" />
 <div class="section" id="new-contract">
 <h2>new contract<a class="headerlink" href="#new-contract" title="Permalink to this headline">¶</a></h2>
@@ -547,6 +548,7 @@ <h3>Example<a class="headerlink" href="#id21" title="Permalink to this headline"
                     <span class="nx">topics</span><span class="o">:</span> <span class="p">[</span><span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">]</span>
                 <span class="p">},</span>
                 <span class="nx">event</span><span class="o">:</span> <span class="s1">&#39;MyEvent&#39;</span><span class="p">,</span>
+                <span class="nx">signature</span><span class="o">:</span> <span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span>
                 <span class="nx">logIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
                 <span class="nx">transactionIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
                 <span class="nx">transactionHash</span><span class="o">:</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">,</span>
@@ -688,6 +690,7 @@ <h3>Example<a class="headerlink" href="#id30" title="Permalink to this headline"
         <span class="nx">topics</span><span class="o">:</span> <span class="p">[</span><span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">]</span>
     <span class="p">},</span>
     <span class="nx">event</span><span class="o">:</span> <span class="s1">&#39;MyEvent&#39;</span><span class="p">,</span>
+    <span class="nx">signature</span><span class="o">:</span> <span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span>
     <span class="nx">logIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
     <span class="nx">transactionIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
     <span class="nx">transactionHash</span><span class="o">:</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">,</span>
@@ -734,6 +737,7 @@ <h3>Parameters<a class="headerlink" href="#id32" title="Permalink to this headli
 <p>The structure of the returned event <code class="docutils literal"><span class="pre">Object</span></code> looks as follows:</p>
 <ul class="simple">
 <li><code class="docutils literal"><span class="pre">event</span></code> - <code class="docutils literal"><span class="pre">String</span></code>: The event name.</li>
+<li><code class="docutils literal"><span class="pre">signature</span></code> - <code class="docutils literal"><span class="pre">String|Null</span></code>: The event signature, <code class="docutils literal"><span class="pre">null</span></code> if its an anonymous event.</li>
 <li><code class="docutils literal"><span class="pre">address</span></code> - <code class="docutils literal"><span class="pre">String</span></code>: From which this event originated from.</li>
 <li><code class="docutils literal"><span class="pre">returnValues</span></code> - <code class="docutils literal"><span class="pre">Object</span></code>: The return values coming from the event, e.g. <code class="docutils literal"><span class="pre">{myVar:</span> <span class="pre">1,</span> <span class="pre">myVar2:</span> <span class="pre">'0x234...'}</span></code>.</li>
 <li><code class="docutils literal"><span class="pre">logIndex</span></code> - <code class="docutils literal"><span class="pre">Number</span></code>: Integer of the event index position in the block.</li>
@@ -771,6 +775,7 @@ <h3>Example<a class="headerlink" href="#id34" title="Permalink to this headline"
         <span class="nx">topics</span><span class="o">:</span> <span class="p">[</span><span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">]</span>
     <span class="p">},</span>
     <span class="nx">event</span><span class="o">:</span> <span class="s1">&#39;MyEvent&#39;</span><span class="p">,</span>
+    <span class="nx">signature</span><span class="o">:</span> <span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span>
     <span class="nx">logIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
     <span class="nx">transactionIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
     <span class="nx">transactionHash</span><span class="o">:</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">,</span>
@@ -845,6 +850,7 @@ <h3>Example<a class="headerlink" href="#id37" title="Permalink to this headline"
         <span class="nx">topics</span><span class="o">:</span> <span class="p">[</span><span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">]</span>
     <span class="p">},</span>
     <span class="nx">event</span><span class="o">:</span> <span class="s1">&#39;MyEvent&#39;</span><span class="p">,</span>
+    <span class="nx">signature</span><span class="o">:</span> <span class="s1">&#39;0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7&#39;</span><span class="p">,</span>
     <span class="nx">logIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
     <span class="nx">transactionIndex</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
     <span class="nx">transactionHash</span><span class="o">:</span> <span class="s1">&#39;0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385&#39;</span><span class="p">,</span>

docs/_build/html/_sources/web3-eth-accounts.txt

@@ -373,6 +373,7 @@ <h3>Parameters<a class="headerlink" href="#id15" title="Permalink to this headli
 <ol class="arabic simple">
 <li><code class="docutils literal"><span class="pre">String</span></code> - Data to sign. If String it will be converted using <a class="reference internal" href="web3-utils.html#utils-utf8tohex"><span class="std std-ref">web3.utils.utf8ToHex</span></a>.</li>
 <li><code class="docutils literal"><span class="pre">String</span></code> - Address to sign data with.</li>
+<li><code class="docutils literal"><span class="pre">String</span></code> - The password of the account to sign data with.</li>
 <li><code class="docutils literal"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
 </ol>
 </div>

docs/_build/html/_sources/web3-eth-contract.txt

@@ -215,7 +215,7 @@ <h2>sha3<a class="headerlink" href="#sha3" title="Permalink to this headline">¶
 <p>Will calculate the sha3 of the input.</p>
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
-<p class="last">To mimick the sha3 behaviour of solidity use <a class="reference internal" href="#utils-soliditysha3"><span class="std std-ref">soliditySah3</span></a></p>
+<p class="last">To mimic the sha3 behaviour of solidity use <a class="reference internal" href="#utils-soliditysha3"><span class="std std-ref">soliditySah3</span></a></p>
 </div>
 <div class="section" id="id12">
 <h3>Parameters<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
@@ -253,7 +253,8 @@ <h3>Example<a class="headerlink" href="#id14" title="Permalink to this headline"
 <div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">soliditySha3</span><span class="p">(</span><span class="nx">param1</span> <span class="p">[,</span> <span class="nx">param2</span><span class="p">,</span> <span class="p">...])</span>
 </pre></div>
 </div>
-<p>Will calculate the sha3 of given input parameters in the same way solidity would.</p>
+<p>Will calculate the sha3 of given input parameters in the same way solidity would.
+This means arguments will be ABI converted and tightly packed before being hashed.</p>
 <div class="section" id="id15">
 <h3>Parameters<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
 <ol class="arabic">