Skip to content

Commit

Permalink
Merge branch '1.0' into 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
moeadham authored Sep 26, 2017
2 parents c316db6 + e633406 commit dca85ec
Show file tree
Hide file tree
Showing 55 changed files with 998 additions and 282 deletions.
2 changes: 1 addition & 1 deletion .versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
ethereum:[email protected].20
ethereum:[email protected].22
[email protected]
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"namespace": "ethereum",
"name": "web3",
"version": "1.0.0-beta.20",
"version": "1.0.0-beta.22",
"description": "Ethereum JavaScript API",
"license": "LGPL-3.0",
"main": [
Expand Down
1 change: 1 addition & 0 deletions dist/web3.min.js

Large diffs are not rendered by default.

Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/glossary.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/web3-eth-accounts.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/web3-eth-contract.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/web3-utils.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/web3-eth-accounts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ decrypt

web3.eth.accounts.decrypt(keystoreJsonV3, password);

Decrypts a keysore v3 JSON, and creates the account.
Decrypts a keystore v3 JSON, and creates the account.

----------
Parameters
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/_sources/web3-eth-contract.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Example
.. code-block:: javascript

var myContract = new web3.eth.Contract([...], '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe', {
from: '0x1234567890123456789012345678901234567891' // default from address
gasPrice: '20000000000000' // default gas price in wei
from: '0x1234567890123456789012345678901234567891', // default from address
gasPrice: '20000000000' // default gas price in wei, 20 gwei in this case
});


Expand Down
67 changes: 57 additions & 10 deletions docs/_build/html/_sources/web3-utils.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1144,12 +1144,12 @@ Example

------------------------------------------------------------------------------

leftPad
padLeft
=====================

.. code-block:: javascript

web3.utils.leftPad(string, characterAmount [, sign])
web3.utils.padLeft(string, characterAmount [, sign])
web3.utils.leftPad(string, characterAmount [, sign]) // ALIAS


Expand All @@ -1176,23 +1176,23 @@ Example

.. code-block:: javascript

web3.utils.leftPad('0x3456ff', 20);
web3.utils.padLeft('0x3456ff', 20);
> "0x000000000000003456ff"

web3.utils.leftPad(0x3456ff, 20);
web3.utils.padLeft(0x3456ff, 20);
> "0x000000000000003456ff"

web3.utils.leftPad('Hello', 20, 'x');
web3.utils.padLeft('Hello', 20, 'x');
> "xxxxxxxxxxxxxxxHello"

------------------------------------------------------------------------------

rightPad
padRight
=====================

.. code-block:: javascript

web3.utils.rightPad(string, characterAmount [, sign])
web3.utils.padRight(string, characterAmount [, sign])
web3.utils.rightPad(string, characterAmount [, sign]) // ALIAS


Expand All @@ -1219,11 +1219,58 @@ Example

.. code-block:: javascript

web3.utils.rightPad('0x3456ff', 20);
web3.utils.padRight('0x3456ff', 20);
> "0x3456ff00000000000000"

web3.utils.rightPad(0x3456ff, 20);
web3.utils.padRight(0x3456ff, 20);
> "0x3456ff00000000000000"

web3.utils.rightPad('Hello', 20, 'x');
web3.utils.padRight('Hello', 20, 'x');
> "Helloxxxxxxxxxxxxxxx"

------------------------------------------------------------------------------

toTwosComplement
=====================

.. code-block:: javascript

web3.utils.toTwosComplement(number)


Conversta negative numer into a twos complement.


----------
Parameters
----------

1. ``number`` - ``Number|String|BigNumber``: The number to convert.

-------
Returns
-------

``String``: The converted hex string.

-------
Example
-------

.. code-block:: javascript

web3.utils.toTwosComplement('-1');
> "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"

web3.utils.toTwosComplement(-1);
> "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"

web3.utils.toTwosComplement('0x1');
> "0x0000000000000000000000000000000000000000000000000000000000000001"

web3.utils.toTwosComplement(-15);
> "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1"

web3.utils.toTwosComplement('-0x1');
> "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"

5 changes: 3 additions & 2 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,8 +304,9 @@ <h1>web3.js - Ethereum JavaScript API<a class="headerlink" href="#web3-js-ethere
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#towei">toWei</a></li>
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#fromwei">fromWei</a></li>
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#unitmap">unitMap</a></li>
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#leftpad">leftPad</a></li>
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#rightpad">rightPad</a></li>
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#padleft">padLeft</a></li>
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#padright">padRight</a></li>
<li class="toctree-l2"><a class="reference internal" href="web3-utils.html#totwoscomplement">toTwosComplement</a></li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_build/html/web3-eth-accounts.html
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ <h2>decrypt<a class="headerlink" href="#decrypt" title="Permalink to this headli
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">accounts</span><span class="p">.</span><span class="nx">decrypt</span><span class="p">(</span><span class="nx">keystoreJsonV3</span><span class="p">,</span> <span class="nx">password</span><span class="p">);</span>
</pre></div>
</div>
<p>Decrypts a keysore v3 JSON, and creates the account.</p>
<p>Decrypts a keystore v3 JSON, and creates the account.</p>
<div class="section" id="id22">
<h3>Parameters<a class="headerlink" href="#id22" title="Permalink to this headline"></a></h3>
<ol class="arabic simple">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/web3-eth-contract.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ <h3>Returns<a class="headerlink" href="#returns" title="Permalink to this headli
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline"></a></h3>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="kd">var</span> <span class="nx">myContract</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">Contract</span><span class="p">([...],</span> <span class="s1">&#39;0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe&#39;</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">from</span><span class="o">:</span> <span class="s1">&#39;0x1234567890123456789012345678901234567891&#39;</span> <span class="c1">// default from address</span>
<span class="nx">gasPrice</span><span class="o">:</span> <span class="s1">&#39;20000000000000&#39;</span> <span class="c1">// default gas price in wei</span>
<span class="nx">from</span><span class="o">:</span> <span class="s1">&#39;0x1234567890123456789012345678901234567891&#39;</span><span class="p">,</span> <span class="c1">// default from address</span>
<span class="nx">gasPrice</span><span class="o">:</span> <span class="s1">&#39;20000000000&#39;</span> <span class="c1">// default gas price in wei, 20 gwei in this case</span>
<span class="p">});</span>
</pre></div>
</div>
Expand Down
71 changes: 57 additions & 14 deletions docs/_build/html/web3-utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -988,9 +988,9 @@ <h3>Example<a class="headerlink" href="#id85" title="Permalink to this headline"
</div>
</div>
<hr class="docutils" />
<div class="section" id="leftpad">
<h2>leftPad<a class="headerlink" href="#leftpad" title="Permalink to this headline"></a></h2>
<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">leftPad</span><span class="p">(</span><span class="nx">string</span><span class="p">,</span> <span class="nx">characterAmount</span> <span class="p">[,</span> <span class="nx">sign</span><span class="p">])</span>
<div class="section" id="padleft">
<h2>padLeft<a class="headerlink" href="#padleft" title="Permalink to this headline"></a></h2>
<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">padLeft</span><span class="p">(</span><span class="nx">string</span><span class="p">,</span> <span class="nx">characterAmount</span> <span class="p">[,</span> <span class="nx">sign</span><span class="p">])</span>
<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">leftPad</span><span class="p">(</span><span class="nx">string</span><span class="p">,</span> <span class="nx">characterAmount</span> <span class="p">[,</span> <span class="nx">sign</span><span class="p">])</span> <span class="c1">// ALIAS</span>
</pre></div>
</div>
Expand All @@ -1009,22 +1009,22 @@ <h3>Returns<a class="headerlink" href="#id87" title="Permalink to this headline"
</div>
<div class="section" id="id88">
<h3>Example<a class="headerlink" href="#id88" title="Permalink to this headline"></a></h3>
<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">leftPad</span><span class="p">(</span><span class="s1">&#39;0x3456ff&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<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">padLeft</span><span class="p">(</span><span class="s1">&#39;0x3456ff&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0x000000000000003456ff&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">leftPad</span><span class="p">(</span><span class="mh">0x3456ff</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">padLeft</span><span class="p">(</span><span class="mh">0x3456ff</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0x000000000000003456ff&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">leftPad</span><span class="p">(</span><span class="s1">&#39;Hello&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="s1">&#39;x&#39;</span><span class="p">);</span>
<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">padLeft</span><span class="p">(</span><span class="s1">&#39;Hello&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="s1">&#39;x&#39;</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;xxxxxxxxxxxxxxxHello&quot;</span>
</pre></div>
</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="rightpad">
<h2>rightPad<a class="headerlink" href="#rightpad" title="Permalink to this headline"></a></h2>
<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">rightPad</span><span class="p">(</span><span class="nx">string</span><span class="p">,</span> <span class="nx">characterAmount</span> <span class="p">[,</span> <span class="nx">sign</span><span class="p">])</span>
<div class="section" id="padright">
<h2>padRight<a class="headerlink" href="#padright" title="Permalink to this headline"></a></h2>
<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">padRight</span><span class="p">(</span><span class="nx">string</span><span class="p">,</span> <span class="nx">characterAmount</span> <span class="p">[,</span> <span class="nx">sign</span><span class="p">])</span>
<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">rightPad</span><span class="p">(</span><span class="nx">string</span><span class="p">,</span> <span class="nx">characterAmount</span> <span class="p">[,</span> <span class="nx">sign</span><span class="p">])</span> <span class="c1">// ALIAS</span>
</pre></div>
</div>
Expand All @@ -1043,18 +1043,55 @@ <h3>Returns<a class="headerlink" href="#id90" title="Permalink to this headline"
</div>
<div class="section" id="id91">
<h3>Example<a class="headerlink" href="#id91" title="Permalink to this headline"></a></h3>
<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">rightPad</span><span class="p">(</span><span class="s1">&#39;0x3456ff&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<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">padRight</span><span class="p">(</span><span class="s1">&#39;0x3456ff&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0x3456ff00000000000000&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">rightPad</span><span class="p">(</span><span class="mh">0x3456ff</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">padRight</span><span class="p">(</span><span class="mh">0x3456ff</span><span class="p">,</span> <span class="mi">20</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0x3456ff00000000000000&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">rightPad</span><span class="p">(</span><span class="s1">&#39;Hello&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="s1">&#39;x&#39;</span><span class="p">);</span>
<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">padRight</span><span class="p">(</span><span class="s1">&#39;Hello&#39;</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="s1">&#39;x&#39;</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;Helloxxxxxxxxxxxxxxx&quot;</span>
</pre></div>
</div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="totwoscomplement">
<h2>toTwosComplement<a class="headerlink" href="#totwoscomplement" title="Permalink to this headline"></a></h2>
<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">toTwosComplement</span><span class="p">(</span><span class="nx">number</span><span class="p">)</span>
</pre></div>
</div>
<p>Conversta negative numer into a twos complement.</p>
<div class="section" id="id92">
<h3>Parameters<a class="headerlink" href="#id92" title="Permalink to this headline"></a></h3>
<ol class="arabic simple">
<li><code class="docutils literal"><span class="pre">number</span></code> - <code class="docutils literal"><span class="pre">Number|String|BigNumber</span></code>: The number to convert.</li>
</ol>
</div>
<div class="section" id="id93">
<h3>Returns<a class="headerlink" href="#id93" title="Permalink to this headline"></a></h3>
<p><code class="docutils literal"><span class="pre">String</span></code>: The converted hex string.</p>
</div>
<div class="section" id="id94">
<h3>Example<a class="headerlink" href="#id94" title="Permalink to this headline"></a></h3>
<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">toTwosComplement</span><span class="p">(</span><span class="s1">&#39;-1&#39;</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">toTwosComplement</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">toTwosComplement</span><span class="p">(</span><span class="s1">&#39;0x1&#39;</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0x0000000000000000000000000000000000000000000000000000000000000001&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">toTwosComplement</span><span class="p">(</span><span class="o">-</span><span class="mi">15</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff1&quot;</span>

<span class="nx">web3</span><span class="p">.</span><span class="nx">utils</span><span class="p">.</span><span class="nx">toTwosComplement</span><span class="p">(</span><span class="s1">&#39;-0x1&#39;</span><span class="p">);</span>
<span class="o">&gt;</span> <span class="s2">&quot;0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff&quot;</span>
</pre></div>
</div>
</div>
</div>
</div>


Expand Down Expand Up @@ -1213,18 +1250,24 @@ <h3><a href="index.html">Table Of Contents</a></h3>
<li><a class="reference internal" href="#id85">Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#leftpad">leftPad</a><ul>
<li><a class="reference internal" href="#padleft">padLeft</a><ul>
<li><a class="reference internal" href="#id86">Parameters</a></li>
<li><a class="reference internal" href="#id87">Returns</a></li>
<li><a class="reference internal" href="#id88">Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#rightpad">rightPad</a><ul>
<li><a class="reference internal" href="#padright">padRight</a><ul>
<li><a class="reference internal" href="#id89">Parameters</a></li>
<li><a class="reference internal" href="#id90">Returns</a></li>
<li><a class="reference internal" href="#id91">Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#totwoscomplement">toTwosComplement</a><ul>
<li><a class="reference internal" href="#id92">Parameters</a></li>
<li><a class="reference internal" href="#id93">Returns</a></li>
<li><a class="reference internal" href="#id94">Example</a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/web3-eth-accounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ decrypt
web3.eth.accounts.decrypt(keystoreJsonV3, password);
Decrypts a keysore v3 JSON, and creates the account.
Decrypts a keystore v3 JSON, and creates the account.

----------
Parameters
Expand Down
Loading

0 comments on commit dca85ec

Please sign in to comment.