mirror of
https://github.com/embarklabs/web3.js.git
synced 2026-08-31 14:41:17 +00:00
1820 lines
161 KiB
HTML
1820 lines
161 KiB
HTML
|
||
<!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="X-UA-Compatible" content="IE=Edge" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<title>web3.eth — web3.js 1.0.0 documentation</title>
|
||
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
|
||
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="web3.eth.subscribe" href="web3-eth-subscribe.html" />
|
||
<link rel="prev" title="Web3" href="web3.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="web3-eth-subscribe.html" title="web3.eth.subscribe"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="web3.html" title="Web3"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">web3.js 1.0.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="admonition note" id="eth">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">This documentation is work in progress and web3.js 1.0 stable is not yet released! You can find the current documentation for web3 0.x.x at <a class="reference external" href="https://github.com/ethereum/wiki/wiki/JavaScript-API">github.com/ethereum/wiki/wiki/JavaScript-API</a>.</p>
|
||
</div>
|
||
<div class="section" id="web3-eth">
|
||
<h1>web3.eth<a class="headerlink" href="#web3-eth" title="Permalink to this headline">¶</a></h1>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">web3-eth</span></code> package allows you to interact with an Ethereum blockchain and Ethereum smart contracts.</p>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">import</span> <span class="nx">Web3</span> <span class="nx">from</span> <span class="s1">'web3'</span><span class="p">;</span>
|
||
<span class="kr">import</span> <span class="p">{</span><span class="nx">Eth</span><span class="p">}</span> <span class="nx">from</span> <span class="s1">'web3-eth'</span><span class="p">;</span>
|
||
|
||
<span class="c1">// "Web3.givenProvider" will be set if in an Ethereum supported browser.</span>
|
||
<span class="kr">const</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="nx">Web3</span><span class="p">.</span><span class="nx">givenProvider</span> <span class="o">||</span> <span class="s1">'ws://some.local-or-remote.node:8546'</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span>
|
||
|
||
|
||
<span class="c1">// or using the web3 umbrella package</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="nx">Web3</span><span class="p">.</span><span class="nx">givenProvider</span> <span class="o">||</span> <span class="s1">'ws://some.local-or-remote.node:8546'</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span>
|
||
|
||
<span class="c1">// -> web3.eth</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="section" id="note-on-checksum-addresses">
|
||
<h2>Note on checksum addresses<a class="headerlink" href="#note-on-checksum-addresses" title="Permalink to this headline">¶</a></h2>
|
||
<p>All Ethereum addresses returned by functions of this package are returned as checksum addresses.
|
||
This means some letters are uppercase and some are lowercase.
|
||
Based on that it will calculate a checksum for the address and prove its correctness.
|
||
Incorrect checksum addresses will throw an error when passed into functions.
|
||
If you want to circumvent the checksum check you can make an address all lower- or uppercase.</p>
|
||
<div class="section" id="example">
|
||
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getAccounts</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="p">[</span><span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span> <span class="p">,</span><span class="s2">"0x85F43D8a49eeB85d32Cf465507DD71d507100C1d"</span><span class="p">]</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="subscribe">
|
||
<h2>subscribe<a class="headerlink" href="#subscribe" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.subscribe</span></code> see the <a class="reference internal" href="web3-eth-subscribe.html#eth-subscribe"><span class="std std-ref">Subscribe reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="contract">
|
||
<h2>Contract<a class="headerlink" href="#contract" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.Contract</span></code> see the <a class="reference internal" href="web3-eth-contract.html#eth-contract"><span class="std std-ref">Contract reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="iban">
|
||
<h2>Iban<a class="headerlink" href="#iban" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.Iban</span></code> see the <a class="reference internal" href="web3-eth-iban.html#eth-iban"><span class="std std-ref">Iban reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="personal">
|
||
<h2>personal<a class="headerlink" href="#personal" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.personal</span></code> see the <a class="reference internal" href="web3-eth-personal.html#eth-personal"><span class="std std-ref">personal reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="accounts">
|
||
<h2>accounts<a class="headerlink" href="#accounts" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.accounts</span></code> see the <a class="reference internal" href="web3-eth-accounts.html#eth-accounts"><span class="std std-ref">accounts reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="ens">
|
||
<h2>ens<a class="headerlink" href="#ens" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.ens</span></code> see the <a class="reference internal" href="web3-eth-ens.html#eth-ens"><span class="std std-ref">Ens reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="abi">
|
||
<h2>abi<a class="headerlink" href="#abi" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.abi</span></code> see the <a class="reference internal" href="web3-eth-abi.html#eth-abi"><span class="std std-ref">ABI reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="net">
|
||
<h2>net<a class="headerlink" href="#net" title="Permalink to this headline">¶</a></h2>
|
||
<p>For <code class="docutils literal notranslate"><span class="pre">web3.eth.net</span></code> see the <a class="reference internal" href="web3-eth-net.html#eth-net"><span class="std std-ref">net reference documentation</span></a></p>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="options">
|
||
<h2>options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
|
||
<p>An Web3 module does provide several options for configuring the transaction confirmation worklfow or for defining default values.
|
||
These are the currently available option properties on a Web3 module:</p>
|
||
<div class="section" id="module-options">
|
||
<h3>Module Options<a class="headerlink" href="#module-options" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference internal" href="web3-shh.html#web3-module-defaultaccount"><span class="std std-ref">defaultAccount</span></a></p>
|
||
<p><a class="reference internal" href="web3-shh.html#web3-module-defaultblock"><span class="std std-ref">defaultBlock</span></a></p>
|
||
<p><a class="reference internal" href="web3-shh.html#web3-module-defaultgas"><span class="std std-ref">defaultGas</span></a></p>
|
||
<p><a class="reference internal" href="web3-shh.html#web3-module-defaultaccount"><span class="std std-ref">defaultGasPrice</span></a></p>
|
||
<p><a class="reference internal" href="web3-shh.html#web3-module-transactionblocktimeout"><span class="std std-ref">transactionBlockTimeout</span></a></p>
|
||
<p><a class="reference internal" href="web3-shh.html#web3-module-transactionconfirmationblocks"><span class="std std-ref">transactionConfirmationBlocks</span></a></p>
|
||
<p><a class="reference internal" href="web3-shh.html#web3-module-transactionpollingtimeout"><span class="std std-ref">transactionPollingTimeout</span></a></p>
|
||
</div>
|
||
<div class="section" id="id1">
|
||
<h3>Example<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">import</span> <span class="nx">Web3</span> <span class="nx">from</span> <span class="s1">'web3'</span><span class="p">;</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">options</span> <span class="o">=</span> <span class="p">{</span>
|
||
<span class="nx">defaultAccount</span><span class="o">:</span> <span class="s1">'0x0'</span><span class="p">,</span>
|
||
<span class="nx">defaultBlock</span><span class="o">:</span> <span class="s1">'latest'</span><span class="p">,</span>
|
||
<span class="nx">defaultGas</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nx">defaultGasPrice</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="nx">transactionBlockTimeout</span><span class="o">:</span> <span class="mi">50</span><span class="p">,</span>
|
||
<span class="nx">transactionConfirmationBlocks</span><span class="o">:</span> <span class="mi">24</span><span class="p">,</span>
|
||
<span class="nx">transactionPollingTimeout</span><span class="o">:</span> <span class="mi">480</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="s1">'http://localhost:8545'</span><span class="p">,</span> <span class="nx">options</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="defaultblock">
|
||
<span id="web3-module-defaultblock"></span><h2>defaultBlock<a class="headerlink" href="#defaultblock" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">defaultBlock</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">defaultBlock</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">defaultBlock</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The default block which will be used for a requests.</p>
|
||
<div class="section" id="returns">
|
||
<h3>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">string|number</span></code>: The current value of the defaultBlock property.</p>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="defaultaccount">
|
||
<span id="web3-module-defaultaccount"></span><h2>defaultAccount<a class="headerlink" href="#defaultaccount" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">defaultAccount</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">defaultAccount</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">defaultAccount</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The default account which will be used for a requests.</p>
|
||
<div class="section" id="id2">
|
||
<h3>Returns<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">null|string</span></code>: The current value of the defaultAccount property.</p>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="defaultgasprice">
|
||
<span id="web3-module-defaultgasprice"></span><h2>defaultGasPrice<a class="headerlink" href="#defaultgasprice" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">defaultGasPrice</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">defaultGasPrice</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">defaultGasPrice</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The default gas price which will be used for a request.</p>
|
||
<div class="section" id="id3">
|
||
<h3>Returns<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">string|number</span></code>: The current value of the defaultGasPrice property.</p>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="defaultgas">
|
||
<span id="web3-module-defaultgas"></span><h2>defaultGas<a class="headerlink" href="#defaultgas" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">defaultGas</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">defaultGas</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">defaultGas</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The default gas which will be used for a request.</p>
|
||
<div class="section" id="id4">
|
||
<h3>Returns<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">string|number</span></code>: The current value of the defaultGas property.</p>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="transactionblocktimeout">
|
||
<span id="web3-module-transactionblocktimeout"></span><h2>transactionBlockTimeout<a class="headerlink" href="#transactionblocktimeout" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">transactionBlockTimeout</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">transactionBlockTimeout</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">transactionBlockTimeout</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This can be used with a socket provider and defines the number of blocks until the PromiEvent
|
||
rejects with a timeout error.</p>
|
||
<div class="section" id="id5">
|
||
<h3>Returns<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">number</span></code>: The current value of transactionBlockTimeout</p>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="transactionconfirmationblocks">
|
||
<span id="web3-module-transactionconfirmationblocks"></span><h2>transactionConfirmationBlocks<a class="headerlink" href="#transactionconfirmationblocks" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">transactionConfirmationBlocks</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">transactionConfirmationBlocks</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">transactionConfirmationBlocks</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This defines the number of blocks it requires until a transaction will be handled as confirmed.
|
||
The PromiEvent will resolve with the desired receipt when enough confirmations happened.</p>
|
||
<div class="section" id="id6">
|
||
<h3>Returns<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">number</span></code>: The current value of transactionConfirmationBlocks</p>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="transactionpollingtimeout">
|
||
<span id="web3-module-transactionpollingtimeout"></span><h2>transactionPollingTimeout<a class="headerlink" href="#transactionpollingtimeout" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">transactionPollingTimeout</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">transactionPollingTimeout</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">transactionPollingTimeout</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This defines the polling cycles amount when you send a transaction with the HttpProvider.
|
||
The PromiEvent rejects with a timeout error when the timeout got exceeded. (1 cycle == 1sec.).</p>
|
||
<div class="section" id="id7">
|
||
<h3>Returns<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">number</span></code>: The current value of transactionPollingTimeout</p>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="setprovider">
|
||
<h2>setProvider<a class="headerlink" href="#setprovider" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="nx">myProvider</span><span class="p">)</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="nx">myProvider</span><span class="p">)</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="nx">myProvider</span><span class="p">)</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">bzz</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="nx">myProvider</span><span class="p">)</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Will change the provider for its module.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">When called on the umbrella package <code class="docutils literal notranslate"><span class="pre">web3</span></code> it will also set the provider for all sub modules <code class="docutils literal notranslate"><span class="pre">web3.eth</span></code>, <code class="docutils literal notranslate"><span class="pre">web3.shh</span></code>, etc EXCEPT <code class="docutils literal notranslate"><span class="pre">web3.bzz</span></code> which needs a separate provider at all times.</p>
|
||
</div>
|
||
<div class="section" id="parameters">
|
||
<h3>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object|String</span></code> - <code class="docutils literal notranslate"><span class="pre">provider</span></code>: a valid provider</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Net</span></code> - <code class="docutils literal notranslate"><span class="pre">net</span></code>: (optional) the node.js Net package. This is only required for the IPC provider.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id8">
|
||
<h3>Returns<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Boolean</span></code></p>
|
||
</div>
|
||
<div class="section" id="id9">
|
||
<h3>Example<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">import</span> <span class="nx">Web3</span> <span class="nx">from</span> <span class="s1">'web3'</span><span class="p">;</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="s1">'http://localhost:8545'</span><span class="p">);</span>
|
||
|
||
<span class="c1">// or</span>
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="k">new</span> <span class="nx">Web3</span><span class="p">.</span><span class="nx">providers</span><span class="p">.</span><span class="nx">HttpProvider</span><span class="p">(</span><span class="s1">'http://localhost:8545'</span><span class="p">));</span>
|
||
|
||
<span class="c1">// change provider</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="s1">'ws://localhost:8546'</span><span class="p">);</span>
|
||
<span class="c1">// or</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="k">new</span> <span class="nx">Web3</span><span class="p">.</span><span class="nx">providers</span><span class="p">.</span><span class="nx">WebsocketProvider</span><span class="p">(</span><span class="s1">'ws://localhost:8546'</span><span class="p">));</span>
|
||
|
||
<span class="c1">// Using the IPC provider in node.js</span>
|
||
<span class="kr">const</span> <span class="nx">net</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'net'</span><span class="p">);</span>
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="s1">'/Users/myuser/Library/Ethereum/geth.ipc'</span><span class="p">,</span> <span class="nx">net</span><span class="p">);</span> <span class="c1">// mac os path</span>
|
||
|
||
<span class="c1">// or</span>
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="k">new</span> <span class="nx">Web3</span><span class="p">.</span><span class="nx">providers</span><span class="p">.</span><span class="nx">IpcProvider</span><span class="p">(</span><span class="s1">'/Users/myuser/Library/Ethereum/geth.ipc'</span><span class="p">,</span> <span class="nx">net</span><span class="p">));</span> <span class="c1">// mac os path</span>
|
||
<span class="c1">// on windows the path is: '\\\\.\\pipe\\geth.ipc'</span>
|
||
<span class="c1">// on linux the path is: '/users/myuser/.ethereum/geth.ipc'</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="providers">
|
||
<h2>providers<a class="headerlink" href="#providers" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">Web3</span><span class="p">.</span><span class="nx">providers</span>
|
||
<span class="nx">Eth</span><span class="p">.</span><span class="nx">providers</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Contains the current available providers.</p>
|
||
<div class="section" id="value">
|
||
<h3>Value<a class="headerlink" href="#value" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Object</span></code> with the following providers:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - <code class="docutils literal notranslate"><span class="pre">HttpProvider</span></code>: The HTTP provider is <strong>deprecated</strong>, as it won’t work for subscriptions.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - <code class="docutils literal notranslate"><span class="pre">WebsocketProvider</span></code>: The Websocket provider is the standard for usage in legacy browsers.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - <code class="docutils literal notranslate"><span class="pre">IpcProvider</span></code>: The IPC provider is used node.js dapps when running a local node. Gives the most secure connection.</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="id10">
|
||
<h3>Example<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">const</span> <span class="nx">Web3</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'web3'</span><span class="p">);</span>
|
||
<span class="c1">// use the given Provider, e.g in Mist, or instantiate a new websocket provider</span>
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="nx">Web3</span><span class="p">.</span><span class="nx">givenProvider</span> <span class="o">||</span> <span class="s1">'ws://localhost:8546'</span><span class="p">);</span>
|
||
<span class="c1">// or</span>
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="nx">Web3</span><span class="p">.</span><span class="nx">givenProvider</span> <span class="o">||</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">.</span><span class="nx">providers</span><span class="p">.</span><span class="nx">WebsocketProvider</span><span class="p">(</span><span class="s1">'ws://localhost:8546'</span><span class="p">));</span>
|
||
|
||
<span class="c1">// Using the IPC provider in node.js</span>
|
||
<span class="kr">const</span> <span class="nx">net</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'net'</span><span class="p">);</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="s1">'/Users/myuser/Library/Ethereum/geth.ipc'</span><span class="p">,</span> <span class="nx">net</span><span class="p">);</span> <span class="c1">// mac os path</span>
|
||
<span class="c1">// or</span>
|
||
<span class="kr">const</span> <span class="nx">web3</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Web3</span><span class="p">(</span><span class="k">new</span> <span class="nx">Web3</span><span class="p">.</span><span class="nx">providers</span><span class="p">.</span><span class="nx">IpcProvider</span><span class="p">(</span><span class="s1">'/Users/myuser/Library/Ethereum/geth.ipc'</span><span class="p">,</span> <span class="nx">net</span><span class="p">));</span> <span class="c1">// mac os path</span>
|
||
<span class="c1">// on windows the path is: '\\\\.\\pipe\\geth.ipc'</span>
|
||
<span class="c1">// on linux the path is: '/users/myuser/.ethereum/geth.ipc'</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="givenprovider">
|
||
<h2>givenProvider<a class="headerlink" href="#givenprovider" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">Web3</span><span class="p">.</span><span class="nx">givenProvider</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">givenProvider</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">givenProvider</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">bzz</span><span class="p">.</span><span class="nx">givenProvider</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When using web3.js in an Ethereum compatible browser, it will set with the current native provider by that browser.
|
||
Will return the given provider by the (browser) environment, otherwise <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p>
|
||
<div class="section" id="id11">
|
||
<h3>Returns<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Object</span></code>: The given provider set or <code class="docutils literal notranslate"><span class="pre">null</span></code>;</p>
|
||
</div>
|
||
<div class="section" id="id12">
|
||
<h3>Example<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="nx">Web3</span><span class="p">.</span><span class="nx">givenProvider</span> <span class="o">||</span> <span class="s1">'ws://localhost:8546'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="currentprovider">
|
||
<h2>currentProvider<a class="headerlink" href="#currentprovider" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">web3</span><span class="p">.</span><span class="nx">currentProvider</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">currentProvider</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">currentProvider</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">bzz</span><span class="p">.</span><span class="nx">currentProvider</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Will return the current provider, otherwise <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p>
|
||
<div class="section" id="id13">
|
||
<h3>Returns<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Object</span></code>: The current provider set or <code class="docutils literal notranslate"><span class="pre">null</span></code>;</p>
|
||
</div>
|
||
<div class="section" id="id14">
|
||
<h3>Example<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">if</span><span class="p">(</span><span class="o">!</span><span class="nx">web3</span><span class="p">.</span><span class="nx">currentProvider</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">setProvider</span><span class="p">(</span><span class="s1">'http://localhost:8545'</span><span class="p">);</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="batchrequest">
|
||
<h2>BatchRequest<a class="headerlink" href="#batchrequest" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">new</span> <span class="nx">web3</span><span class="p">.</span><span class="nx">BatchRequest</span><span class="p">()</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">BatchRequest</span><span class="p">()</span>
|
||
<span class="k">new</span> <span class="nx">web3</span><span class="p">.</span><span class="nx">shh</span><span class="p">.</span><span class="nx">BatchRequest</span><span class="p">()</span>
|
||
<span class="p">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Class to create and execute batch requests.</p>
|
||
<div class="section" id="id15">
|
||
<h3>Parameters<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
|
||
<p>none</p>
|
||
</div>
|
||
<div class="section" id="id16">
|
||
<h3>Returns<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Object</span></code>: With the following methods:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">add(request)</span></code>: To add a request object to the batch call.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">execute()</span></code>: Will execute the batch request.</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="id17">
|
||
<h3>Example<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">const</span> <span class="nx">contract</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="nx">abi</span><span class="p">,</span> <span class="nx">address</span><span class="p">);</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">batch</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">web3</span><span class="p">.</span><span class="nx">BatchRequest</span><span class="p">();</span>
|
||
<span class="nx">batch</span><span class="p">.</span><span class="nx">add</span><span class="p">(</span><span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">getBalance</span><span class="p">.</span><span class="nx">request</span><span class="p">(</span><span class="s1">'0x0000000000000000000000000000000000000000'</span><span class="p">,</span> <span class="s1">'latest'</span><span class="p">,</span> <span class="nx">callback</span><span class="p">));</span>
|
||
<span class="nx">batch</span><span class="p">.</span><span class="nx">add</span><span class="p">(</span><span class="nx">contract</span><span class="p">.</span><span class="nx">methods</span><span class="p">.</span><span class="nx">balance</span><span class="p">(</span><span class="nx">address</span><span class="p">).</span><span class="nx">call</span><span class="p">.</span><span class="nx">request</span><span class="p">({</span><span class="nx">from</span><span class="o">:</span> <span class="s1">'0x0000000000000000000000000000000000000000'</span><span class="p">},</span> <span class="nx">callback2</span><span class="p">));</span>
|
||
<span class="nx">batch</span><span class="p">.</span><span class="nx">execute</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="eth-defaultaccount">
|
||
<span id="id18"></span><h2>defaultAccount<a class="headerlink" href="#eth-defaultaccount" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">defaultAccount</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This default address is used as the default <code class="docutils literal notranslate"><span class="pre">"from"</span></code> property, if no <code class="docutils literal notranslate"><span class="pre">"from"</span></code> property is specified in for the following methods:</p>
|
||
<ul class="simple">
|
||
<li><a class="reference internal" href="#eth-sendtransaction"><span class="std std-ref">web3.eth.sendTransaction()</span></a></li>
|
||
<li><a class="reference internal" href="#eth-call"><span class="std std-ref">web3.eth.call()</span></a></li>
|
||
<li><a class="reference internal" href="web3-eth-contract.html#contract-call"><span class="std std-ref">new web3.eth.Contract() -> myContract.methods.myMethod().call()</span></a></li>
|
||
<li><a class="reference internal" href="web3-eth-contract.html#contract-send"><span class="std std-ref">new web3.eth.Contract() -> myContract.methods.myMethod().send()</span></a></li>
|
||
</ul>
|
||
<div class="section" id="property">
|
||
<h3>Property<a class="headerlink" href="#property" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">String</span></code> - 20 Bytes: Any ethereum address. You should have the private key for that address in your node or keystore. (Default is <code class="docutils literal notranslate"><span class="pre">undefined</span></code>)</p>
|
||
</div>
|
||
<div class="section" id="id19">
|
||
<h3>Example<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">defaultAccount</span><span class="p">;</span>
|
||
<span class="o">></span> <span class="kc">undefined</span>
|
||
|
||
<span class="c1">// set the default account</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">defaultAccount</span> <span class="o">=</span> <span class="s1">'0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe'</span><span class="p">;</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="eth-defaultblock">
|
||
<span id="id20"></span><h2>defaultBlock<a class="headerlink" href="#eth-defaultblock" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">defaultBlock</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The default block is used for certain methods. You can override it by passing in the defaultBlock as last parameter.
|
||
The default value is “latest”.</p>
|
||
<ul class="simple">
|
||
<li><a class="reference internal" href="#eth-getbalance"><span class="std std-ref">web3.eth.getBalance()</span></a></li>
|
||
<li><span class="xref std std-ref">web3.eth.getCode()</span></li>
|
||
<li><a class="reference internal" href="#eth-gettransactioncount"><span class="std std-ref">web3.eth.getTransactionCount()</span></a></li>
|
||
<li><a class="reference internal" href="#eth-getstorageat"><span class="std std-ref">web3.eth.getStorageAt()</span></a></li>
|
||
<li><a class="reference internal" href="#eth-call"><span class="std std-ref">web3.eth.call()</span></a></li>
|
||
<li><a class="reference internal" href="web3-eth-contract.html#contract-call"><span class="std std-ref">new web3.eth.Contract() -> myContract.methods.myMethod().call()</span></a></li>
|
||
</ul>
|
||
<div class="section" id="id21">
|
||
<h3>Property<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3>
|
||
<p>Default block parameters can be one of the following:</p>
|
||
<ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number</span></code>: A block number</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">"genesis"</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The genesis block</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">"latest"</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The latest block (current head of the blockchain)</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">"pending"</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The currently mined block (including pending transactions)</li>
|
||
</ul>
|
||
<p>Default is <code class="docutils literal notranslate"><span class="pre">"latest"</span></code></p>
|
||
</div>
|
||
<div class="section" id="id22">
|
||
<h3>Example<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">defaultBlock</span><span class="p">;</span>
|
||
<span class="o">></span> <span class="s2">"latest"</span>
|
||
|
||
<span class="c1">// set the default block</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">defaultBlock</span> <span class="o">=</span> <span class="mi">231</span><span class="p">;</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="getprotocolversion">
|
||
<h2>getProtocolVersion<a class="headerlink" href="#getprotocolversion" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getProtocolVersion</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns the ethereum protocol version of the node.</p>
|
||
<div class="section" id="id23">
|
||
<h3>Returns<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - The protocol version.</p>
|
||
</div>
|
||
<div class="section" id="id24">
|
||
<h3>Example<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getProtocolVersion</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"63"</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="issyncing">
|
||
<h2>isSyncing<a class="headerlink" href="#issyncing" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">isSyncing</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Checks if the node is currently syncing and returns either a syncing object, or <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||
<div class="section" id="eth-issyncing-return">
|
||
<span id="id25"></span><h3>Returns<a class="headerlink" href="#eth-issyncing-return" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<object|boolean></span></code> - A sync object when the node is currently syncing or <code class="docutils literal notranslate"><span class="pre">false</span></code>:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">startingBlock</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The block number where the sync started.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">currentBlock</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The block number where at which block the node currently synced to already.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">highestBlock</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The estimated block number to sync to.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">knownStates</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The estimated states to download</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">pulledStates</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The already downloaded states</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="id26">
|
||
<h3>Example<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">isSyncing</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
|
||
<span class="o">></span> <span class="p">{</span>
|
||
<span class="nx">startingBlock</span><span class="o">:</span> <span class="mi">100</span><span class="p">,</span>
|
||
<span class="nx">currentBlock</span><span class="o">:</span> <span class="mi">312</span><span class="p">,</span>
|
||
<span class="nx">highestBlock</span><span class="o">:</span> <span class="mi">512</span><span class="p">,</span>
|
||
<span class="nx">knownStates</span><span class="o">:</span> <span class="mi">234566</span><span class="p">,</span>
|
||
<span class="nx">pulledStates</span><span class="o">:</span> <span class="mi">123455</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="getcoinbase">
|
||
<h2>getCoinbase<a class="headerlink" href="#getcoinbase" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">getCoinbase</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns the coinbase address to which mining rewards will go.</p>
|
||
<div class="section" id="id27">
|
||
<h3>Returns<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - The coinbase address set in the node for mining rewards.</p>
|
||
</div>
|
||
<div class="section" id="id28">
|
||
<h3>Example<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getCoinbase</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="ismining">
|
||
<h2>isMining<a class="headerlink" href="#ismining" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">isMining</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Checks whether the node is mining or not.</p>
|
||
<div class="section" id="id29">
|
||
<h3>Returns<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<boolean></span></code> - Returns <code class="docutils literal notranslate"><span class="pre">true</span></code> if the node is mining, otherwise <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||
</div>
|
||
<div class="section" id="id30">
|
||
<h3>Example<a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">isMining</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="kc">true</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="gethashrate">
|
||
<h2>getHashrate<a class="headerlink" href="#gethashrate" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getHashrate</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns the number of hashes per second that the node is mining with.</p>
|
||
<div class="section" id="id31">
|
||
<h3>Returns<a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<number></span></code> - The Number of hashes per second.</p>
|
||
</div>
|
||
<div class="section" id="id32">
|
||
<h3>Example<a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getHashrate</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="mi">493736</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="getgasprice">
|
||
<span id="eth-gasprice"></span><h2>getGasPrice<a class="headerlink" href="#getgasprice" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getGasPrice</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns the current gas price oracle.
|
||
The gas price is determined by the last few blocks median gas price.
|
||
GasPrice is the wei per unit of gas,.</p>
|
||
<div class="section" id="id33">
|
||
<h3>Returns<a class="headerlink" href="#id33" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - Number string of the current gas price in <span class="xref std std-ref">wei</span>.</p>
|
||
<p>See the <a class="reference internal" href="web3-utils.html#utils-bn"><span class="std std-ref">A note on dealing with big numbers in JavaScript</span></a>.</p>
|
||
</div>
|
||
<div class="section" id="id34">
|
||
<h3>Example<a class="headerlink" href="#id34" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getGasPrice</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"20000000000"</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="getaccounts">
|
||
<span id="eth-getaccounts"></span><h2>getAccounts<a class="headerlink" href="#getaccounts" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getAccounts</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns a list of accounts the node controls by using the provider and calling
|
||
the RPC method <code class="docutils literal notranslate"><span class="pre">eth_accounts</span></code>. Using <a class="reference internal" href="web3-eth-accounts.html#accounts-create"><span class="std std-ref">web3.eth.accounts.create()</span></a>
|
||
will not add accounts into this list. For that use
|
||
<a class="reference internal" href="web3-eth-personal.html#personal-newaccount"><span class="std std-ref">web3.eth.personal.newAccount()</span></a>.</p>
|
||
<p>The results are the same as <a class="reference internal" href="web3-eth-personal.html#personal-getaccounts"><span class="std std-ref">web3.eth.personal.getAccounts()</span></a> except that calls
|
||
the RPC method <code class="docutils literal notranslate"><span class="pre">personal_listAccounts</span></code>.</p>
|
||
<div class="section" id="id35">
|
||
<h3>Returns<a class="headerlink" href="#id35" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<Array></span></code> - An array of addresses controlled by node.</p>
|
||
</div>
|
||
<div class="section" id="id36">
|
||
<h3>Example<a class="headerlink" href="#id36" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getAccounts</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="p">[</span><span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">,</span> <span class="s2">"0xDCc6960376d6C6dEa93647383FfB245CfCed97Cf"</span><span class="p">]</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="getblocknumber">
|
||
<h2>getBlockNumber<a class="headerlink" href="#getblocknumber" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getBlockNumber</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns the current block number.</p>
|
||
<div class="section" id="id37">
|
||
<h3>Returns<a class="headerlink" href="#id37" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<number></span></code> - The number of the most recent block.</p>
|
||
</div>
|
||
<div class="section" id="id38">
|
||
<h3>Example<a class="headerlink" href="#id38" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getBlockNumber</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="mi">2744</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="getbalance">
|
||
<span id="eth-getbalance"></span><h2>getBalance<a class="headerlink" href="#getbalance" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getBalance</span><span class="p">(</span><span class="nx">address</span> <span class="p">[,</span> <span class="nx">defaultBlock</span><span class="p">]</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Get the balance of an address at a given block.</p>
|
||
<div class="section" id="id39">
|
||
<h3>Parameters<a class="headerlink" href="#id39" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - The address to get the balance of.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number|String</span></code> - (optional) If you pass this parameter it will not use the default block set with <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">web3.eth.defaultBlock</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id40">
|
||
<h3>Returns<a class="headerlink" href="#id40" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - The current balance for the given address in <span class="xref std std-ref">wei</span>.</p>
|
||
<p>See the <span class="xref std std-ref">A note on dealing with big numbers in JavaScript</span>.</p>
|
||
</div>
|
||
<div class="section" id="id41">
|
||
<h3>Example<a class="headerlink" href="#id41" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getBalance</span><span class="p">(</span><span class="s2">"0x407d73d8a49eeb85d32cf465507dd71d507100c1"</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"1000000000000"</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="getstorageat">
|
||
<span id="eth-getstorageat"></span><h2>getStorageAt<a class="headerlink" href="#getstorageat" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getStorageAt</span><span class="p">(</span><span class="nx">address</span><span class="p">,</span> <span class="nx">position</span> <span class="p">[,</span> <span class="nx">defaultBlock</span><span class="p">]</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Get the storage at a specific position of an address.</p>
|
||
<div class="section" id="id42">
|
||
<h3>Parameters<a class="headerlink" href="#id42" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - The address to get the storage from.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number</span></code> - The index position of the storage.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number|String</span></code> - (optional) If you pass this parameter it will not use the default block set with <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">web3.eth.defaultBlock</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id43">
|
||
<h3>Returns<a class="headerlink" href="#id43" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - The value in storage at the given position.</p>
|
||
</div>
|
||
<div class="section" id="id44">
|
||
<h3>Example<a class="headerlink" href="#id44" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getStorageAt</span><span class="p">(</span><span class="s2">"0x407d73d8a49eeb85d32cf465507dd71d507100c1"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="getcode">
|
||
<span id="eth-code"></span><h2>getCode<a class="headerlink" href="#getcode" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getCode</span><span class="p">(</span><span class="nx">address</span> <span class="p">[,</span> <span class="nx">defaultBlock</span><span class="p">]</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Get the code at a specific address.</p>
|
||
<div class="section" id="id45">
|
||
<h3>Parameters<a class="headerlink" href="#id45" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - The address to get the code from.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number|String</span></code> - (optional) If you pass this parameter it will not use the default block set with <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">web3.eth.defaultBlock</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id46">
|
||
<h3>Returns<a class="headerlink" href="#id46" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - The data at given address <code class="docutils literal notranslate"><span class="pre">address</span></code>.</p>
|
||
</div>
|
||
<div class="section" id="id47">
|
||
<h3>Example<a class="headerlink" href="#id47" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getCode</span><span class="p">(</span><span class="s2">"0xd5677cf67b5aa051bb40496e68ad359eb97cfbf8"</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"0x600160008035811a818181146012578301005b601b6001356025565b8060005260206000f25b600060078202905091905056"</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="getblock">
|
||
<span id="eth-getblock"></span><h2>getBlock<a class="headerlink" href="#getblock" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getBlock</span><span class="p">(</span><span class="nx">blockHashOrBlockNumber</span> <span class="p">[,</span> <span class="nx">returnTransactionObjects</span><span class="p">]</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns a block matching the block number or block hash.</p>
|
||
<div class="section" id="id48">
|
||
<h3>Parameters<a class="headerlink" href="#id48" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String|Number</span></code> - The block number or block hash. Or the string <code class="docutils literal notranslate"><span class="pre">"genesis"</span></code>, <code class="docutils literal notranslate"><span class="pre">"latest"</span></code> or <code class="docutils literal notranslate"><span class="pre">"pending"</span></code> as in the <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">default block parameter</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Boolean</span></code> - (optional, default <code class="docutils literal notranslate"><span class="pre">false</span></code>) If <code class="docutils literal notranslate"><span class="pre">true</span></code>, the returned block will contain all transactions as objects, if <code class="docutils literal notranslate"><span class="pre">false</span></code> it will only contains the transaction hashes.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id49">
|
||
<h3>Returns<a class="headerlink" href="#id49" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<object></span></code> - The block object:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">number</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The block number. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its pending block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">hash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the block. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its pending block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">parentHash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the parent block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">nonce</span></code> 8 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the generated proof-of-work. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its pending block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">sha3Uncles</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: SHA3 of the uncles data in the block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">logsBloom</span></code> 256 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The bloom filter for the logs of the block. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its pending block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">transactionsRoot</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The root of the transaction trie of the block</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">stateRoot</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The root of the final state trie of the block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">receiptsRoot</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Transaction receipts are used to store the state after a transaction has been executed and are kept in an index-keyed trie. The hash of its root is placed in the block header as the receipts root.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">miner</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The address of the beneficiary to whom the mining rewards were given.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">difficulty</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Integer of the difficulty for this block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">totalDifficulty</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Integer of the total difficulty of the chain until this block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">extraData</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The “extra data” field of this block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">size</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Integer the size of this block in bytes.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">gasLimit</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The maximum gas allowed in this block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">gasUsed</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The total used gas by all transactions in this block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">timestamp</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The unix timestamp for when the block was collated.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">transactions</span></code> - <code class="docutils literal notranslate"><span class="pre">Array</span></code>: Array of transaction objects, or 32 Bytes transaction hashes depending on the <code class="docutils literal notranslate"><span class="pre">returnTransactionObjects</span></code> parameter.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">uncles</span></code> - <code class="docutils literal notranslate"><span class="pre">Array</span></code>: Array of uncle hashes.</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="id50">
|
||
<h3>Example<a class="headerlink" href="#id50" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span>web3.eth.getBlock(3150)
|
||
.then(console.log);
|
||
|
||
> {
|
||
"number": 3,
|
||
"hash": "0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46",
|
||
"parentHash": "0x2302e1c0b972d00932deb5dab9eb2982f570597d9d42504c05d9c2147eaf9c88",
|
||
"nonce": "0xfb6e1a62d119228b",
|
||
"sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
|
||
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
|
||
"transactionsRoot": "0x3a1b03875115b79539e5bd33fb00d8f7b7cd61929d5a3c574f507b8acf415bee",
|
||
"stateRoot": "0xf1133199d44695dfa8fd1bcfe424d82854b5cebef75bddd7e40ea94cda515bcb",
|
||
"receiptsRoot: '0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421',
|
||
"miner": "0x8888f1f195afa192cfee860698584c030f4c9db1",
|
||
"difficulty": '21345678965432',
|
||
"totalDifficulty": '324567845321',
|
||
"size": 616,
|
||
"extraData": "0x",
|
||
"gasLimit": 3141592,
|
||
"gasUsed": 21662,
|
||
"timestamp": 1429287689,
|
||
"transactions": [
|
||
"0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b"
|
||
],
|
||
"uncles": []
|
||
}
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="getblocktransactioncount">
|
||
<h2>getBlockTransactionCount<a class="headerlink" href="#getblocktransactioncount" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getBlockTransactionCount</span><span class="p">(</span><span class="nx">blockHashOrBlockNumber</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns the number of transaction in a given block.</p>
|
||
<div class="section" id="id51">
|
||
<h3>Parameters<a class="headerlink" href="#id51" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String|Number</span></code> - The block number or hash. Or the string <code class="docutils literal notranslate"><span class="pre">"genesis"</span></code>, <code class="docutils literal notranslate"><span class="pre">"latest"</span></code> or <code class="docutils literal notranslate"><span class="pre">"pending"</span></code> as in the <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">default block parameter</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id52">
|
||
<h3>Returns<a class="headerlink" href="#id52" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<number></span></code> - The number of transactions in the given block.</p>
|
||
</div>
|
||
<div class="section" id="id53">
|
||
<h3>Example<a class="headerlink" href="#id53" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getBlockTransactionCount</span><span class="p">(</span><span class="s2">"0x407d73d8a49eeb85d32cf465507dd71d507100c1"</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="mi">1</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="getuncle">
|
||
<h2>getUncle<a class="headerlink" href="#getuncle" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getUncle</span><span class="p">(</span><span class="nx">blockHashOrBlockNumber</span><span class="p">,</span> <span class="nx">uncleIndex</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns a blocks uncle by a given uncle index position.</p>
|
||
<div class="section" id="id54">
|
||
<h3>Parameters<a class="headerlink" href="#id54" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String|Number</span></code> - The block number or hash. Or the string <code class="docutils literal notranslate"><span class="pre">"genesis"</span></code>, <code class="docutils literal notranslate"><span class="pre">"latest"</span></code> or <code class="docutils literal notranslate"><span class="pre">"pending"</span></code> as in the <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">default block parameter</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number</span></code> - The index position of the uncle.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id55">
|
||
<h3>Returns<a class="headerlink" href="#id55" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<object></span></code> - The returned uncle. For a return value see <a class="reference internal" href="#eth-getblock"><span class="std std-ref">web3.eth.getBlock()</span></a>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">An uncle doesn’t contain individual transactions.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="id56">
|
||
<h3>Example<a class="headerlink" href="#id56" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getUncle</span><span class="p">(</span><span class="mi">500</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="c1">// see web3.eth.getBlock</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="gettransaction">
|
||
<h2>getTransaction<a class="headerlink" href="#gettransaction" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getTransaction</span><span class="p">(</span><span class="nx">transactionHash</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns a transaction matching the given transaction hash.</p>
|
||
<div class="section" id="id57">
|
||
<h3>Parameters<a class="headerlink" href="#id57" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - The transaction hash.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="eth-gettransaction-return">
|
||
<span id="id58"></span><h3>Returns<a class="headerlink" href="#eth-gettransaction-return" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<object></span></code> - A transaction object its hash <code class="docutils literal notranslate"><span class="pre">transactionHash</span></code>:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">hash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the transaction.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">nonce</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The number of transactions made by the sender prior to this one.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">blockHash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the block where this transaction was in. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its pending.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">blockNumber</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Block number where this transaction was in. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its pending.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">transactionIndex</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Integer of the transactions index position in the block. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its pending.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">from</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Address of the sender.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">to</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Address of the receiver. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its a contract creation transaction.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">value</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Value transferred in <span class="xref std std-ref">wei</span>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">gasPrice</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The wei per unit of gas provided by the sender in <span class="xref std std-ref">wei</span>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">gas</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Gas provided by the sender.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">input</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The data sent along with the transaction.</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="id59">
|
||
<h3>Example<a class="headerlink" href="#id59" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getTransaction</span><span class="p">(</span><span class="s1">'0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b§234'</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
|
||
<span class="o">></span> <span class="p">{</span>
|
||
<span class="s2">"hash"</span><span class="o">:</span> <span class="s2">"0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b"</span><span class="p">,</span>
|
||
<span class="s2">"nonce"</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span>
|
||
<span class="s2">"blockHash"</span><span class="o">:</span> <span class="s2">"0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46"</span><span class="p">,</span>
|
||
<span class="s2">"blockNumber"</span><span class="o">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="s2">"transactionIndex"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="s2">"from"</span><span class="o">:</span> <span class="s2">"0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b"</span><span class="p">,</span>
|
||
<span class="s2">"to"</span><span class="o">:</span> <span class="s2">"0x6295ee1b4f6dd65047762f924ecd367c17eabf8f"</span><span class="p">,</span>
|
||
<span class="s2">"value"</span><span class="o">:</span> <span class="s1">'123450000000000000'</span><span class="p">,</span>
|
||
<span class="s2">"gas"</span><span class="o">:</span> <span class="mi">314159</span><span class="p">,</span>
|
||
<span class="s2">"gasPrice"</span><span class="o">:</span> <span class="s1">'2000000000000'</span><span class="p">,</span>
|
||
<span class="s2">"input"</span><span class="o">:</span> <span class="s2">"0x57cb2fc4"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="gettransactionfromblock">
|
||
<h2>getTransactionFromBlock<a class="headerlink" href="#gettransactionfromblock" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="nx">getTransactionFromBlock</span><span class="p">(</span><span class="nx">hashStringOrNumber</span><span class="p">,</span> <span class="nx">indexNumber</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns a transaction based on a block hash or number and the transactions index position.</p>
|
||
<div class="section" id="id60">
|
||
<h3>Parameters<a class="headerlink" href="#id60" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - A block number or hash. Or the string <code class="docutils literal notranslate"><span class="pre">"genesis"</span></code>, <code class="docutils literal notranslate"><span class="pre">"latest"</span></code> or <code class="docutils literal notranslate"><span class="pre">"pending"</span></code> as in the <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">default block parameter</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number</span></code> - The transactions index position.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id61">
|
||
<h3>Returns<a class="headerlink" href="#id61" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<object></span></code> - A transaction object, see <a class="reference internal" href="#eth-gettransaction-return"><span class="std std-ref">web3.eth.getTransaction</span></a>:</p>
|
||
</div>
|
||
<div class="section" id="id62">
|
||
<h3>Example<a class="headerlink" href="#id62" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">const</span> <span class="nx">transaction</span> <span class="o">=</span> <span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">getTransactionFromBlock</span><span class="p">(</span><span class="s1">'0x4534534534'</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="c1">// see web3.eth.getTransaction</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="gettransactionreceipt">
|
||
<h2>getTransactionReceipt<a class="headerlink" href="#gettransactionreceipt" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getTransactionReceipt</span><span class="p">(</span><span class="nx">hash</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Returns the receipt of a transaction by transaction hash.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">The receipt is not available for pending transactions and returns <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p>
|
||
</div>
|
||
<div class="section" id="id63">
|
||
<h3>Parameters<a class="headerlink" href="#id63" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - The transaction hash.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="eth-gettransactionreceipt-return">
|
||
<span id="id64"></span><h3>Returns<a class="headerlink" href="#eth-gettransactionreceipt-return" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise</span></code> returns <code class="docutils literal notranslate"><span class="pre">Object</span></code> - A transaction receipt object, or <code class="docutils literal notranslate"><span class="pre">null</span></code> when no receipt was found:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">status</span></code> - <code class="docutils literal notranslate"><span class="pre">Boolean</span></code>: <code class="docutils literal notranslate"><span class="pre">TRUE</span></code> if the transaction was successful, <code class="docutils literal notranslate"><span class="pre">FALSE</span></code>, if the EVM reverted the transaction.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">blockHash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the block where this transaction was in.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">blockNumber</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Block number where this transaction was in.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">transactionHash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the transaction.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">transactionIndex</span></code>- <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Integer of the transactions index position in the block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">from</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Address of the sender.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">to</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Address of the receiver. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its a contract creation transaction.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">contractAddress</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The contract address created, if the transaction was a contract creation, otherwise <code class="docutils literal notranslate"><span class="pre">null</span></code>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">cumulativeGasUsed</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The total amount of gas used when this transaction was executed in the block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">gasUsed</span></code>- <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The amount of gas used by this specific transaction alone.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">logs</span></code> - <code class="docutils literal notranslate"><span class="pre">Array</span></code>: Array of log objects, which this transaction generated.</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="id65">
|
||
<h3>Example<a class="headerlink" href="#id65" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">const</span> <span class="nx">receipt</span> <span class="o">=</span> <span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">getTransactionReceipt</span><span class="p">(</span><span class="s1">'0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b'</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
|
||
<span class="o">></span> <span class="p">{</span>
|
||
<span class="s2">"status"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
|
||
<span class="s2">"transactionHash"</span><span class="o">:</span> <span class="s2">"0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b"</span><span class="p">,</span>
|
||
<span class="s2">"transactionIndex"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="s2">"blockHash"</span><span class="o">:</span> <span class="s2">"0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46"</span><span class="p">,</span>
|
||
<span class="s2">"blockNumber"</span><span class="o">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="s2">"contractAddress"</span><span class="o">:</span> <span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">,</span>
|
||
<span class="s2">"cumulativeGasUsed"</span><span class="o">:</span> <span class="mi">314159</span><span class="p">,</span>
|
||
<span class="s2">"gasUsed"</span><span class="o">:</span> <span class="mi">30234</span><span class="p">,</span>
|
||
<span class="s2">"logs"</span><span class="o">:</span> <span class="p">[{</span>
|
||
<span class="c1">// logs as returned by getPastLogs, etc.</span>
|
||
<span class="p">},</span> <span class="p">...]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="gettransactioncount">
|
||
<span id="eth-gettransactioncount"></span><h2>getTransactionCount<a class="headerlink" href="#gettransactioncount" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getTransactionCount</span><span class="p">(</span><span class="nx">address</span> <span class="p">[,</span> <span class="nx">defaultBlock</span><span class="p">]</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Get the numbers of transactions sent from this address.</p>
|
||
<div class="section" id="id66">
|
||
<h3>Parameters<a class="headerlink" href="#id66" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - The address to get the numbers of transactions from.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number|String</span></code> - (optional) If you pass this parameter it will not use the default block set with <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">web3.eth.defaultBlock</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id67">
|
||
<h3>Returns<a class="headerlink" href="#id67" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<number></span></code> - The number of transactions sent from the given address.</p>
|
||
</div>
|
||
<div class="section" id="id68">
|
||
<h3>Example<a class="headerlink" href="#id68" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getTransactionCount</span><span class="p">(</span><span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="mi">1</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="sendtransaction">
|
||
<span id="eth-sendtransaction"></span><h2>sendTransaction<a class="headerlink" href="#sendtransaction" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">sendTransaction</span><span class="p">(</span><span class="nx">transactionObject</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Sends a transaction to the network.</p>
|
||
<div class="section" id="id69">
|
||
<h3>Parameters<a class="headerlink" href="#id69" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - The transaction object to send:</li>
|
||
</ol>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">from</span></code> - <code class="docutils literal notranslate"><span class="pre">String|Number</span></code>: The address for the sending account. Uses the <a class="reference internal" href="#eth-defaultaccount"><span class="std std-ref">web3.eth.defaultAccount</span></a> property, if not specified. Or an address or index of a local wallet in <span class="xref std std-ref">web3.eth.accounts.wallet</span>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">to</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: (optional) The destination address of the message, left undefined for a contract-creation transaction.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">value</span></code> - <code class="docutils literal notranslate"><span class="pre">Number|String|BN|BigNumber</span></code>: (optional) The value transferred for the transaction in <span class="xref std std-ref">wei</span>, also the endowment if it’s a contract-creation transaction.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">gas</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded).</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">gasPrice</span></code> - <code class="docutils literal notranslate"><span class="pre">Number|String|BN|BigNumber</span></code>: (optional) The price of gas for this transaction in <span class="xref std std-ref">wei</span>, defaults to <a class="reference internal" href="#eth-gasprice"><span class="std std-ref">web3.eth.gasPrice</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">data</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: (optional) Either a <a class="reference external" href="http://solidity.readthedocs.io/en/latest/abi-spec.html">ABI byte string</a> containing the data of the function call on a contract, or in the case of a contract-creation transaction the initialisation code.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">nonce</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
<ol class="arabic simple" start="2">
|
||
<li><code class="docutils literal notranslate"><span class="pre">callback</span></code> - <code class="docutils literal notranslate"><span class="pre">Function</span></code>: (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">The <code class="docutils literal notranslate"><span class="pre">from</span></code> property can also be an address or index from the <span class="xref std std-ref">web3.eth.accounts.wallet</span>. It will then sign locally using the private key of that account, and send the transaction via <a class="reference internal" href="#eth-sendsignedtransaction"><span class="std std-ref">web3.eth.sendSignedTransaction()</span></a>.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="eth-sendtransaction-return">
|
||
<span id="id70"></span><h3>Returns<a class="headerlink" href="#eth-sendtransaction-return" title="Permalink to this headline">¶</a></h3>
|
||
<p>The <strong>callback</strong> will return the 32 bytes transaction hash.</p>
|
||
<p><code class="docutils literal notranslate"><span class="pre">PromiEvent</span></code>: A <a class="reference internal" href="callbacks-promises-events.html#promievent"><span class="std std-ref">promise combined event emitter</span></a>. Will be resolved when the transaction <a class="reference internal" href="#eth-gettransactionreceipt-return"><span class="std std-ref">receipt</span></a> is available. Additionally the following events are available:</p>
|
||
<ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">"transactionHash"</span></code> returns <code class="docutils literal notranslate"><span class="pre">String</span></code>: Is fired right after the transaction is sent and a transaction hash is available.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">"receipt"</span></code> returns <code class="docutils literal notranslate"><span class="pre">Object</span></code>: Is fired when the transaction receipt is available.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">"confirmation"</span></code> returns <code class="docutils literal notranslate"><span class="pre">Number</span></code>, <code class="docutils literal notranslate"><span class="pre">Object</span></code>: Is fired for every confirmation up to the 12th confirmation. Receives the confirmation number as the first and the <a class="reference internal" href="#eth-gettransactionreceipt-return"><span class="std std-ref">receipt</span></a> as the second argument. Fired from confirmation 0 on, which is the block where its minded.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">"error"</span></code> returns <code class="docutils literal notranslate"><span class="pre">Error</span></code>: Is fired if an error occurs during sending. If a out of gas error, the second parameter is the receipt.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="id71">
|
||
<h3>Example<a class="headerlink" href="#id71" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="c1">// compiled solidity source code using https://remix.ethereum.org</span>
|
||
<span class="kr">const</span> <span class="nx">code</span> <span class="o">=</span> <span class="s2">"603d80600c6000396000f3007c01000000000000000000000000000000000000000000000000000000006000350463c6888fa18114602d57005b6007600435028060005260206000f3"</span><span class="p">;</span>
|
||
|
||
|
||
<span class="c1">// using the callback</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">sendTransaction</span><span class="p">({</span>
|
||
<span class="nx">from</span><span class="o">:</span> <span class="s1">'0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'</span><span class="p">,</span>
|
||
<span class="nx">data</span><span class="o">:</span> <span class="nx">code</span> <span class="c1">// deploying a contracrt</span>
|
||
<span class="p">},</span> <span class="kd">function</span><span class="p">(</span><span class="nx">error</span><span class="p">,</span> <span class="nx">hash</span><span class="p">){</span>
|
||
<span class="p">...</span>
|
||
<span class="p">});</span>
|
||
|
||
<span class="c1">// using the promise</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">sendTransaction</span><span class="p">({</span>
|
||
<span class="nx">from</span><span class="o">:</span> <span class="s1">'0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'</span><span class="p">,</span>
|
||
<span class="nx">to</span><span class="o">:</span> <span class="s1">'0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe'</span><span class="p">,</span>
|
||
<span class="nx">value</span><span class="o">:</span> <span class="s1">'1000000000000000'</span>
|
||
<span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">receipt</span><span class="p">){</span>
|
||
<span class="p">...</span>
|
||
<span class="p">});</span>
|
||
|
||
|
||
<span class="c1">// using the event emitter</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">sendTransaction</span><span class="p">({</span>
|
||
<span class="nx">from</span><span class="o">:</span> <span class="s1">'0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'</span><span class="p">,</span>
|
||
<span class="nx">to</span><span class="o">:</span> <span class="s1">'0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe'</span><span class="p">,</span>
|
||
<span class="nx">value</span><span class="o">:</span> <span class="s1">'1000000000000000'</span>
|
||
<span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'transactionHash'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">hash</span><span class="p">){</span>
|
||
<span class="p">...</span>
|
||
<span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'receipt'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">receipt</span><span class="p">){</span>
|
||
<span class="p">...</span>
|
||
<span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'confirmation'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">confirmationNumber</span><span class="p">,</span> <span class="nx">receipt</span><span class="p">){</span> <span class="p">...</span> <span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">);</span> <span class="c1">// If a out of gas error, the second parameter is the receipt.</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="sendsignedtransaction">
|
||
<span id="eth-sendsignedtransaction"></span><h2>sendSignedTransaction<a class="headerlink" href="#sendsignedtransaction" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">sendSignedTransaction</span><span class="p">(</span><span class="nx">signedTransactionData</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Sends an already signed transaction, generated for example using <a class="reference internal" href="web3-eth-accounts.html#eth-accounts-signtransaction"><span class="std std-ref">web3.eth.accounts.signTransaction</span></a>.</p>
|
||
<div class="section" id="id72">
|
||
<h3>Parameters<a class="headerlink" href="#id72" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - Signed transaction data in HEX format</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id73">
|
||
<h3>Returns<a class="headerlink" href="#id73" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">PromiEvent</span></code>: A <a class="reference internal" href="callbacks-promises-events.html#promievent"><span class="std std-ref">promise combined event emitter</span></a>. Will be resolved when the transaction <a class="reference internal" href="#eth-gettransactionreceipt-return"><span class="std std-ref">receipt</span></a> is available.</p>
|
||
<p>Please see the return values for <a class="reference internal" href="#eth-sendtransaction-return"><span class="std std-ref">web3.eth.sendTransaction</span></a> for details.</p>
|
||
</div>
|
||
<div class="section" id="id74">
|
||
<h3>Example<a class="headerlink" href="#id74" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kr">const</span> <span class="nx">Tx</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'ethereumjs-tx'</span><span class="p">);</span>
|
||
<span class="kr">const</span> <span class="nx">privateKey</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Buffer</span><span class="p">(</span><span class="s1">'e331b6d69882b4cb4ea581d88e0b604039a3de5967688d3dcffdd2270c0fd109'</span><span class="p">,</span> <span class="s1">'hex'</span><span class="p">)</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">rawTx</span> <span class="o">=</span> <span class="p">{</span>
|
||
<span class="nx">nonce</span><span class="o">:</span> <span class="s1">'0x00'</span><span class="p">,</span>
|
||
<span class="nx">gasPrice</span><span class="o">:</span> <span class="s1">'0x09184e72a000'</span><span class="p">,</span>
|
||
<span class="nx">gasLimit</span><span class="o">:</span> <span class="s1">'0x2710'</span><span class="p">,</span>
|
||
<span class="nx">to</span><span class="o">:</span> <span class="s1">'0x0000000000000000000000000000000000000000'</span><span class="p">,</span>
|
||
<span class="nx">value</span><span class="o">:</span> <span class="s1">'0x00'</span><span class="p">,</span>
|
||
<span class="nx">data</span><span class="o">:</span> <span class="s1">'0x7f7465737432000000000000000000000000000000000000000000000000000000600057'</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">tx</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Tx</span><span class="p">(</span><span class="nx">rawTx</span><span class="p">);</span>
|
||
<span class="nx">tx</span><span class="p">.</span><span class="nx">sign</span><span class="p">(</span><span class="nx">privateKey</span><span class="p">);</span>
|
||
|
||
<span class="kr">const</span> <span class="nx">serializedTx</span> <span class="o">=</span> <span class="nx">tx</span><span class="p">.</span><span class="nx">serialize</span><span class="p">();</span>
|
||
|
||
<span class="c1">// console.log(serializedTx.toString('hex'));</span>
|
||
<span class="c1">// 0xf889808609184e72a00082271094000000000000000000000000000000000000000080a47f74657374320000000000000000000000000000000000000000000000000000006000571ca08a8bbf888cfa37bbf0bb965423625641fc956967b81d12e23709cead01446075a01ce999b56a8a88504be365442ea61239198e23d1fce7d00fcfc5cd3b44b7215f</span>
|
||
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</span><span class="p">.</span><span class="nx">sendSignedTransaction</span><span class="p">(</span><span class="s1">'0x'</span> <span class="o">+</span> <span class="nx">serializedTx</span><span class="p">.</span><span class="nx">toString</span><span class="p">(</span><span class="s1">'hex'</span><span class="p">))</span>
|
||
<span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'receipt'</span><span class="p">,</span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
|
||
<span class="o">></span> <span class="c1">// see eth.getTransactionReceipt() for details</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="sign">
|
||
<h2>sign<a class="headerlink" href="#sign" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">sign</span><span class="p">(</span><span class="nx">dataToSign</span><span class="p">,</span> <span class="nx">address</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Signs data using a specific account. This account needs to be unlocked.</p>
|
||
<div class="section" id="id75">
|
||
<h3>Parameters<a class="headerlink" href="#id75" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><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 notranslate"><span class="pre">String|Number</span></code> - Address to sign data with. Or an address or index of a local wallet in <span class="xref std std-ref">web3.eth.accounts.wallet</span>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">The 2. <code class="docutils literal notranslate"><span class="pre">address</span></code> parameter can also be an address or index from the <span class="xref std std-ref">web3.eth.accounts.wallet</span>. It will then sign locally using the private key of this account.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="id76">
|
||
<h3>Returns<a class="headerlink" href="#id76" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - The signature.</p>
|
||
</div>
|
||
<div class="section" id="id77">
|
||
<h3>Example<a class="headerlink" href="#id77" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">sign</span><span class="p">(</span><span class="s2">"Hello world"</span><span class="p">,</span> <span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400"</span>
|
||
|
||
<span class="c1">// the below is the same</span>
|
||
<span class="nx">web3</span><span class="p">.</span><span class="nx">eth</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">utf8ToHex</span><span class="p">(</span><span class="s2">"Hello world"</span><span class="p">),</span> <span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">)</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400"</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="signtransaction">
|
||
<h2>signTransaction<a class="headerlink" href="#signtransaction" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">signTransaction</span><span class="p">(</span><span class="nx">transactionObject</span> <span class="p">[,</span> <span class="nx">address</span><span class="p">]</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Signs a transaction. This account needs to be unlocked.</p>
|
||
<div class="section" id="id78">
|
||
<h3>Parameters<a class="headerlink" href="#id78" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - The transaction data to sign <a class="reference internal" href="#eth-sendtransaction"><span class="std std-ref">web3.eth.sendTransaction()</span></a> for more.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> - (optional) Address to sign transaction with.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id79">
|
||
<h3>Returns<a class="headerlink" href="#id79" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<object></span></code> - The RLP encoded transaction. The <code class="docutils literal notranslate"><span class="pre">raw</span></code> property can be used to send the transaction using <a class="reference internal" href="#eth-sendsignedtransaction"><span class="std std-ref">web3.eth.sendSignedTransaction</span></a>.</p>
|
||
</div>
|
||
<div class="section" id="id80">
|
||
<h3>Example<a class="headerlink" href="#id80" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">signTransaction</span><span class="p">({</span>
|
||
<span class="nx">from</span><span class="o">:</span> <span class="s2">"0xEB014f8c8B418Db6b45774c326A0E64C78914dC0"</span><span class="p">,</span>
|
||
<span class="nx">gasPrice</span><span class="o">:</span> <span class="s2">"20000000000"</span><span class="p">,</span>
|
||
<span class="nx">gas</span><span class="o">:</span> <span class="s2">"21000"</span><span class="p">,</span>
|
||
<span class="nx">to</span><span class="o">:</span> <span class="s1">'0x3535353535353535353535353535353535353535'</span><span class="p">,</span>
|
||
<span class="nx">value</span><span class="o">:</span> <span class="s2">"1000000000000000000"</span><span class="p">,</span>
|
||
<span class="nx">data</span><span class="o">:</span> <span class="s2">""</span>
|
||
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="p">{</span>
|
||
<span class="nx">raw</span><span class="o">:</span> <span class="s1">'0xf86c808504a817c800825208943535353535353535353535353535353535353535880de0b6b3a76400008025a04f4c17305743700648bc4f6cd3038ec6f6af0df73e31757007b7f59df7bee88da07e1941b264348e80c78c4027afc65a87b0a5e43e86742b8ca0823584c6788fd0'</span><span class="p">,</span>
|
||
<span class="nx">tx</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="nx">nonce</span><span class="o">:</span> <span class="s1">'0x0'</span><span class="p">,</span>
|
||
<span class="nx">gasPrice</span><span class="o">:</span> <span class="s1">'0x4a817c800'</span><span class="p">,</span>
|
||
<span class="nx">gas</span><span class="o">:</span> <span class="s1">'0x5208'</span><span class="p">,</span>
|
||
<span class="nx">to</span><span class="o">:</span> <span class="s1">'0x3535353535353535353535353535353535353535'</span><span class="p">,</span>
|
||
<span class="nx">value</span><span class="o">:</span> <span class="s1">'0xde0b6b3a7640000'</span><span class="p">,</span>
|
||
<span class="nx">input</span><span class="o">:</span> <span class="s1">'0x'</span><span class="p">,</span>
|
||
<span class="nx">v</span><span class="o">:</span> <span class="s1">'0x25'</span><span class="p">,</span>
|
||
<span class="nx">r</span><span class="o">:</span> <span class="s1">'0x4f4c17305743700648bc4f6cd3038ec6f6af0df73e31757007b7f59df7bee88d'</span><span class="p">,</span>
|
||
<span class="nx">s</span><span class="o">:</span> <span class="s1">'0x7e1941b264348e80c78c4027afc65a87b0a5e43e86742b8ca0823584c6788fd0'</span><span class="p">,</span>
|
||
<span class="nx">hash</span><span class="o">:</span> <span class="s1">'0xda3be87732110de6c1354c83770aae630ede9ac308d9f7b399ecfba23d923384'</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</div>
|
||
</div>
|
||
<div class="section" id="call">
|
||
<span id="eth-call"></span><h2>call<a class="headerlink" href="#call" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">call</span><span class="p">(</span><span class="nx">callObject</span> <span class="p">[,</span> <span class="nx">defaultBlock</span><span class="p">]</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Executes a message call transaction, which is directly executed in the VM of the node, but never mined into the blockchain.</p>
|
||
<div class="section" id="id81">
|
||
<h3>Parameters<a class="headerlink" href="#id81" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - A transaction object see <a class="reference internal" href="#eth-sendtransaction-return"><span class="std std-ref">web3.eth.sendTransaction</span></a>, with the difference that for calls the <code class="docutils literal notranslate"><span class="pre">from</span></code> property is optional as well.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Number|String</span></code> - (optional) If you pass this parameter it will not use the default block set with <a class="reference internal" href="#eth-defaultblock"><span class="std std-ref">web3.eth.defaultBlock</span></a>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id82">
|
||
<h3>Returns<a class="headerlink" href="#id82" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<string></span></code> - The returned data of the call, e.g. a smart contract functions return value.</p>
|
||
</div>
|
||
<div class="section" id="id83">
|
||
<h3>Example<a class="headerlink" href="#id83" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">call</span><span class="p">({</span>
|
||
<span class="nx">to</span><span class="o">:</span> <span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">,</span> <span class="c1">// contract address</span>
|
||
<span class="nx">data</span><span class="o">:</span> <span class="s2">"0xc6888fa10000000000000000000000000000000000000000000000000000000000000003"</span>
|
||
<span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"0x000000000000000000000000000000000000000000000000000000000000000a"</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="estimategas">
|
||
<h2>estimateGas<a class="headerlink" href="#estimategas" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">estimateGas</span><span class="p">(</span><span class="nx">callObject</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Executes a message call or transaction and returns the amount of the gas used.</p>
|
||
<div class="section" id="id84">
|
||
<h3>Parameters<a class="headerlink" href="#id84" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - A transaction object see <a class="reference internal" href="#eth-sendtransaction-return"><span class="std std-ref">web3.eth.sendTransaction</span></a>, with the difference that for calls the <code class="docutils literal notranslate"><span class="pre">from</span></code> property is optional as well.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id85">
|
||
<h3>Returns<a class="headerlink" href="#id85" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<number></span></code> - The used gas for the simulated call/transaction.</p>
|
||
</div>
|
||
<div class="section" id="id86">
|
||
<h3>Example<a class="headerlink" href="#id86" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">estimateGas</span><span class="p">({</span>
|
||
<span class="nx">to</span><span class="o">:</span> <span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">,</span>
|
||
<span class="nx">data</span><span class="o">:</span> <span class="s2">"0xc6888fa10000000000000000000000000000000000000000000000000000000000000003"</span>
|
||
<span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="s2">"0x0000000000000000000000000000000000000000000000000000000000000015"</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="getpastlogs">
|
||
<h2>getPastLogs<a class="headerlink" href="#getpastlogs" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getPastLogs</span><span class="p">(</span><span class="nx">options</span> <span class="p">[,</span> <span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Gets past logs, matching the given options.</p>
|
||
<div class="section" id="id87">
|
||
<h3>Parameters<a class="headerlink" href="#id87" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Object</span></code> - The filter options as follows:</li>
|
||
</ol>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">fromBlock</span></code> - <code class="docutils literal notranslate"><span class="pre">Number|String</span></code>: The number of the earliest block (<code class="docutils literal notranslate"><span class="pre">"latest"</span></code> may be given to mean the most recent and <code class="docutils literal notranslate"><span class="pre">"pending"</span></code> currently mining, block). By default <code class="docutils literal notranslate"><span class="pre">"latest"</span></code>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">toBlock</span></code> - <code class="docutils literal notranslate"><span class="pre">Number|String</span></code>: The number of the latest block (<code class="docutils literal notranslate"><span class="pre">"latest"</span></code> may be given to mean the most recent and <code class="docutils literal notranslate"><span class="pre">"pending"</span></code> currently mining, block). By default <code class="docutils literal notranslate"><span class="pre">"latest"</span></code>.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">address</span></code> - <code class="docutils literal notranslate"><span class="pre">String|Array</span></code>: An address or a list of addresses to only get logs from particular account(s).</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">topics</span></code> - <code class="docutils literal notranslate"><span class="pre">Array</span></code>: An array of values which must each appear in the log entries. The order is important, if you want to leave topics out use <code class="docutils literal notranslate"><span class="pre">null</span></code>, e.g. <code class="docutils literal notranslate"><span class="pre">[null,</span> <span class="pre">'0x12...']</span></code>. You can also pass an array for each topic with options for that topic e.g. <code class="docutils literal notranslate"><span class="pre">[null,</span> <span class="pre">['option1',</span> <span class="pre">'option2']]</span></code></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="eth-getpastlogs-return">
|
||
<span id="id88"></span><h3>Returns<a class="headerlink" href="#eth-getpastlogs-return" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<Array></span></code> - Array of log objects.</p>
|
||
<p>The structure of the returned event <code class="docutils literal notranslate"><span class="pre">Object</span></code> in the <code class="docutils literal notranslate"><span class="pre">Array</span></code> looks as follows:</p>
|
||
<ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">address</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: From which this event originated from.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">data</span></code> - <code class="docutils literal notranslate"><span class="pre">String</span></code>: The data containing non-indexed log parameter.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">topics</span></code> - <code class="docutils literal notranslate"><span class="pre">Array</span></code>: An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">logIndex</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Integer of the event index position in the block.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">transactionIndex</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: Integer of the transaction’s index position, the event was created in.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">transactionHash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the transaction this event was created in.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">blockHash</span></code> 32 Bytes - <code class="docutils literal notranslate"><span class="pre">String</span></code>: Hash of the block where this event was created in. <code class="docutils literal notranslate"><span class="pre">null</span></code> when its still pending.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">blockNumber</span></code> - <code class="docutils literal notranslate"><span class="pre">Number</span></code>: The block number where this log was created in. <code class="docutils literal notranslate"><span class="pre">null</span></code> when still pending.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="id89">
|
||
<h3>Example<a class="headerlink" href="#id89" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getPastLogs</span><span class="p">({</span>
|
||
<span class="nx">address</span><span class="o">:</span> <span class="s2">"0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"</span><span class="p">,</span>
|
||
<span class="nx">topics</span><span class="o">:</span> <span class="p">[</span><span class="s2">"0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"</span><span class="p">]</span>
|
||
<span class="p">})</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
|
||
<span class="o">></span> <span class="p">[{</span>
|
||
<span class="nx">data</span><span class="o">:</span> <span class="s1">'0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385'</span><span class="p">,</span>
|
||
<span class="nx">topics</span><span class="o">:</span> <span class="p">[</span><span class="s1">'0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7'</span><span class="p">,</span> <span class="s1">'0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385'</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">'0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385'</span><span class="p">,</span>
|
||
<span class="nx">blockHash</span><span class="o">:</span> <span class="s1">'0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7'</span><span class="p">,</span>
|
||
<span class="nx">blockNumber</span><span class="o">:</span> <span class="mi">1234</span><span class="p">,</span>
|
||
<span class="nx">address</span><span class="o">:</span> <span class="s1">'0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'</span>
|
||
<span class="p">},{...}]</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="getwork">
|
||
<h2>getWork<a class="headerlink" href="#getwork" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">getWork</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Gets work for miners to mine on. Returns the hash of the current block, the seedHash, and the boundary condition to be met (“target”).</p>
|
||
<div class="section" id="id90">
|
||
<h3>Parameters<a class="headerlink" href="#id90" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id91">
|
||
<h3>Returns<a class="headerlink" href="#id91" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<Array></span></code> - The mining work with the following structure:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> 32 Bytes - at <strong>index 0</strong>: current block header pow-hash</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> 32 Bytes - at <strong>index 1</strong>: the seed hash used for the DAG.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> 32 Bytes - at <strong>index 2</strong>: the boundary condition (“target”), 2^256 / difficulty.</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="id92">
|
||
<h3>Example<a class="headerlink" href="#id92" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">getWork</span><span class="p">()</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="p">[</span>
|
||
<span class="s2">"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"</span><span class="p">,</span>
|
||
<span class="s2">"0x5EED00000000000000000000000000005EED0000000000000000000000000000"</span><span class="p">,</span>
|
||
<span class="s2">"0xd1ff1c01710000000000000000000000d1ff1c01710000000000000000000000"</span>
|
||
<span class="p">]</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="submitwork">
|
||
<h2>submitWork<a class="headerlink" href="#submitwork" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">submitWork</span><span class="p">(</span><span class="nx">nonce</span><span class="p">,</span> <span class="nx">powHash</span><span class="p">,</span> <span class="nx">digest</span><span class="p">,</span> <span class="p">[</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Used for submitting a proof-of-work solution.</p>
|
||
<div class="section" id="id93">
|
||
<h3>Parameters<a class="headerlink" href="#id93" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> 8 Bytes: The nonce found (64 bits)</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> 32 Bytes: The header’s pow-hash (256 bits)</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">String</span></code> 32 Bytes: The mix digest (256 bits)</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id94">
|
||
<h3>Returns<a class="headerlink" href="#id94" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<boolean></span></code> - Returns <code class="docutils literal notranslate"><span class="pre">true</span></code> if the provided solution is valid, otherwise false.</p>
|
||
</div>
|
||
<div class="section" id="id95">
|
||
<h3>Example<a class="headerlink" href="#id95" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">submitWork</span><span class="p">([</span>
|
||
<span class="s2">"0x0000000000000001"</span><span class="p">,</span>
|
||
<span class="s2">"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"</span><span class="p">,</span>
|
||
<span class="s2">"0xD1FE5700000000000000000000000000D1FE5700000000000000000000000000"</span>
|
||
<span class="p">])</span>
|
||
<span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="kc">true</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
<div class="section" id="requestaccounts">
|
||
<h2>requestAccounts<a class="headerlink" href="#requestaccounts" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-javascript notranslate"><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">requestAccounts</span><span class="p">([</span><span class="nx">callback</span><span class="p">])</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This method will request/enable the accounts from the current environment it is running (Metamask, Status or Mist).
|
||
It doesn’t work if you’re connected to a node with a default Web3.js provider. (WebsocketProvider, HttpProvidder and IpcProvider)
|
||
This method will only work if you’re using the injected provider from a application like Status, Mist or Metamask.</p>
|
||
<p>For further information about the behavior of this method please read the EIP of it: <a class="reference external" href="https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1102.md">EIP-1102</a></p>
|
||
<div class="section" id="id96">
|
||
<h3>Parameters<a class="headerlink" href="#id96" title="Permalink to this headline">¶</a></h3>
|
||
<ol class="arabic simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">Function</span></code> - (optional) Optional callback, returns an error object as first parameter and the result as second.</li>
|
||
</ol>
|
||
</div>
|
||
<div class="section" id="id97">
|
||
<h3>Returns<a class="headerlink" href="#id97" title="Permalink to this headline">¶</a></h3>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Promise<Array></span></code> - Returns an array of enabled accounts.</p>
|
||
</div>
|
||
<div class="section" id="id98">
|
||
<h3>Example<a class="headerlink" href="#id98" title="Permalink to this headline">¶</a></h3>
|
||
<div class="highlight-javascript notranslate"><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">requestAccounts</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">);</span>
|
||
<span class="o">></span> <span class="p">[</span><span class="s1">'0aae0B295369a9FD31d5F28D9Ec85E40f4cb692BAf'</span><span class="p">,</span> <span class="mh">0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe</span><span class="p">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</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="#">web3.eth</a><ul>
|
||
<li><a class="reference internal" href="#note-on-checksum-addresses">Note on checksum addresses</a><ul>
|
||
<li><a class="reference internal" href="#example">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#subscribe">subscribe</a></li>
|
||
<li><a class="reference internal" href="#contract">Contract</a></li>
|
||
<li><a class="reference internal" href="#iban">Iban</a></li>
|
||
<li><a class="reference internal" href="#personal">personal</a></li>
|
||
<li><a class="reference internal" href="#accounts">accounts</a></li>
|
||
<li><a class="reference internal" href="#ens">ens</a></li>
|
||
<li><a class="reference internal" href="#abi">abi</a></li>
|
||
<li><a class="reference internal" href="#net">net</a></li>
|
||
<li><a class="reference internal" href="#options">options</a><ul>
|
||
<li><a class="reference internal" href="#module-options">Module Options</a></li>
|
||
<li><a class="reference internal" href="#id1">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#defaultblock">defaultBlock</a><ul>
|
||
<li><a class="reference internal" href="#returns">Returns</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#defaultaccount">defaultAccount</a><ul>
|
||
<li><a class="reference internal" href="#id2">Returns</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#defaultgasprice">defaultGasPrice</a><ul>
|
||
<li><a class="reference internal" href="#id3">Returns</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#defaultgas">defaultGas</a><ul>
|
||
<li><a class="reference internal" href="#id4">Returns</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#transactionblocktimeout">transactionBlockTimeout</a><ul>
|
||
<li><a class="reference internal" href="#id5">Returns</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#transactionconfirmationblocks">transactionConfirmationBlocks</a><ul>
|
||
<li><a class="reference internal" href="#id6">Returns</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#transactionpollingtimeout">transactionPollingTimeout</a><ul>
|
||
<li><a class="reference internal" href="#id7">Returns</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#setprovider">setProvider</a><ul>
|
||
<li><a class="reference internal" href="#parameters">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id8">Returns</a></li>
|
||
<li><a class="reference internal" href="#id9">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#providers">providers</a><ul>
|
||
<li><a class="reference internal" href="#value">Value</a></li>
|
||
<li><a class="reference internal" href="#id10">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#givenprovider">givenProvider</a><ul>
|
||
<li><a class="reference internal" href="#id11">Returns</a></li>
|
||
<li><a class="reference internal" href="#id12">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#currentprovider">currentProvider</a><ul>
|
||
<li><a class="reference internal" href="#id13">Returns</a></li>
|
||
<li><a class="reference internal" href="#id14">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#batchrequest">BatchRequest</a><ul>
|
||
<li><a class="reference internal" href="#id15">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id16">Returns</a></li>
|
||
<li><a class="reference internal" href="#id17">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#eth-defaultaccount">defaultAccount</a><ul>
|
||
<li><a class="reference internal" href="#property">Property</a></li>
|
||
<li><a class="reference internal" href="#id19">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#eth-defaultblock">defaultBlock</a><ul>
|
||
<li><a class="reference internal" href="#id21">Property</a></li>
|
||
<li><a class="reference internal" href="#id22">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getprotocolversion">getProtocolVersion</a><ul>
|
||
<li><a class="reference internal" href="#id23">Returns</a></li>
|
||
<li><a class="reference internal" href="#id24">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#issyncing">isSyncing</a><ul>
|
||
<li><a class="reference internal" href="#eth-issyncing-return">Returns</a></li>
|
||
<li><a class="reference internal" href="#id26">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getcoinbase">getCoinbase</a><ul>
|
||
<li><a class="reference internal" href="#id27">Returns</a></li>
|
||
<li><a class="reference internal" href="#id28">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#ismining">isMining</a><ul>
|
||
<li><a class="reference internal" href="#id29">Returns</a></li>
|
||
<li><a class="reference internal" href="#id30">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#gethashrate">getHashrate</a><ul>
|
||
<li><a class="reference internal" href="#id31">Returns</a></li>
|
||
<li><a class="reference internal" href="#id32">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getgasprice">getGasPrice</a><ul>
|
||
<li><a class="reference internal" href="#id33">Returns</a></li>
|
||
<li><a class="reference internal" href="#id34">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getaccounts">getAccounts</a><ul>
|
||
<li><a class="reference internal" href="#id35">Returns</a></li>
|
||
<li><a class="reference internal" href="#id36">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getblocknumber">getBlockNumber</a><ul>
|
||
<li><a class="reference internal" href="#id37">Returns</a></li>
|
||
<li><a class="reference internal" href="#id38">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getbalance">getBalance</a><ul>
|
||
<li><a class="reference internal" href="#id39">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id40">Returns</a></li>
|
||
<li><a class="reference internal" href="#id41">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getstorageat">getStorageAt</a><ul>
|
||
<li><a class="reference internal" href="#id42">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id43">Returns</a></li>
|
||
<li><a class="reference internal" href="#id44">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getcode">getCode</a><ul>
|
||
<li><a class="reference internal" href="#id45">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id46">Returns</a></li>
|
||
<li><a class="reference internal" href="#id47">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getblock">getBlock</a><ul>
|
||
<li><a class="reference internal" href="#id48">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id49">Returns</a></li>
|
||
<li><a class="reference internal" href="#id50">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getblocktransactioncount">getBlockTransactionCount</a><ul>
|
||
<li><a class="reference internal" href="#id51">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id52">Returns</a></li>
|
||
<li><a class="reference internal" href="#id53">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getuncle">getUncle</a><ul>
|
||
<li><a class="reference internal" href="#id54">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id55">Returns</a></li>
|
||
<li><a class="reference internal" href="#id56">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#gettransaction">getTransaction</a><ul>
|
||
<li><a class="reference internal" href="#id57">Parameters</a></li>
|
||
<li><a class="reference internal" href="#eth-gettransaction-return">Returns</a></li>
|
||
<li><a class="reference internal" href="#id59">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#gettransactionfromblock">getTransactionFromBlock</a><ul>
|
||
<li><a class="reference internal" href="#id60">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id61">Returns</a></li>
|
||
<li><a class="reference internal" href="#id62">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#gettransactionreceipt">getTransactionReceipt</a><ul>
|
||
<li><a class="reference internal" href="#id63">Parameters</a></li>
|
||
<li><a class="reference internal" href="#eth-gettransactionreceipt-return">Returns</a></li>
|
||
<li><a class="reference internal" href="#id65">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#gettransactioncount">getTransactionCount</a><ul>
|
||
<li><a class="reference internal" href="#id66">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id67">Returns</a></li>
|
||
<li><a class="reference internal" href="#id68">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#sendtransaction">sendTransaction</a><ul>
|
||
<li><a class="reference internal" href="#id69">Parameters</a></li>
|
||
<li><a class="reference internal" href="#eth-sendtransaction-return">Returns</a></li>
|
||
<li><a class="reference internal" href="#id71">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#sendsignedtransaction">sendSignedTransaction</a><ul>
|
||
<li><a class="reference internal" href="#id72">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id73">Returns</a></li>
|
||
<li><a class="reference internal" href="#id74">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#sign">sign</a><ul>
|
||
<li><a class="reference internal" href="#id75">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id76">Returns</a></li>
|
||
<li><a class="reference internal" href="#id77">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#signtransaction">signTransaction</a><ul>
|
||
<li><a class="reference internal" href="#id78">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id79">Returns</a></li>
|
||
<li><a class="reference internal" href="#id80">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#call">call</a><ul>
|
||
<li><a class="reference internal" href="#id81">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id82">Returns</a></li>
|
||
<li><a class="reference internal" href="#id83">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#estimategas">estimateGas</a><ul>
|
||
<li><a class="reference internal" href="#id84">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id85">Returns</a></li>
|
||
<li><a class="reference internal" href="#id86">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getpastlogs">getPastLogs</a><ul>
|
||
<li><a class="reference internal" href="#id87">Parameters</a></li>
|
||
<li><a class="reference internal" href="#eth-getpastlogs-return">Returns</a></li>
|
||
<li><a class="reference internal" href="#id89">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#getwork">getWork</a><ul>
|
||
<li><a class="reference internal" href="#id90">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id91">Returns</a></li>
|
||
<li><a class="reference internal" href="#id92">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#submitwork">submitWork</a><ul>
|
||
<li><a class="reference internal" href="#id93">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id94">Returns</a></li>
|
||
<li><a class="reference internal" href="#id95">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#requestaccounts">requestAccounts</a><ul>
|
||
<li><a class="reference internal" href="#id96">Parameters</a></li>
|
||
<li><a class="reference internal" href="#id97">Returns</a></li>
|
||
<li><a class="reference internal" href="#id98">Example</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="web3.html"
|
||
title="previous chapter">Web3</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="web3-eth-subscribe.html"
|
||
title="next chapter">web3.eth.subscribe</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/web3-eth.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3>Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<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>
|
||
</div>
|
||
</div>
|
||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="web3-eth-subscribe.html" title="web3.eth.subscribe"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="web3.html" title="Web3"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">web3.js 1.0.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2016, Ethereum.
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
|
||
</div>
|
||
</body>
|
||
</html> |