Merge branch 'miner-documentation' of https://github.com/princesinha1…

…8/web3.js into miner-methods
princesinha19 · Apr 15, 2019 · 17f94a6 · 17f94a6
2 parents 97963f2 + 93f965e
commit 17f94a6
Show file tree

Hide file tree

Showing 10 changed files with 249 additions and 18 deletions.
diff --git a/docs/web3-eth-abi.rst b/docs/web3-eth-abi.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-=========
+============
 web3.eth.abi
-=========
+============
 
 The ``web3-eth-abi`` package allows you to de- and encode parameters from a ABI (Application Binary Interface).
 This will be used for calling functions of a deployed smart-contract.

diff --git a/docs/web3-eth-ens.rst b/docs/web3-eth-ens.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-=========
+============
 web3.eth.ens
-=========
+============
 
 The ``web3.eth.ens`` functions let you interacting with the Ens smart contracts.
 

diff --git a/docs/web3-eth-iban.rst b/docs/web3-eth-iban.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-=========
+=============
 web3.eth.Iban
-=========
+=============
 
 The ``web3.eth.Iban`` function lets convert Ethereum addresses from and to IBAN and BBAN.
 

diff --git a/docs/web3-eth-miner.rst b/docs/web3-eth-miner.rst
@@ -0,0 +1,231 @@
+.. _eth-miner:
+
+.. include:: include_announcement.rst
+
+==============
+web3.eth.miner
+==============
+
+
+The ``web3-eth-miner`` package allows you to remote control the node's mining operation and set various mining specific settings.
+
+
+.. code-block:: javascript
+
+    import Web3 from 'web3';
+    import {Miner} from 'web3-eth-miner';
+
+    // "Web3.givenProvider" will be set if in an Ethereum supported browser.
+    const miner = new Miner(Web3.givenProvider || 'ws://some.local-or-remote.node:8546', null, options);
+
+
+    // or using the web3 umbrella package
+    const web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546', null, options);
+
+    // -> web3.eth.miner
+
+
+------------------------------------------------------------------------------
+
+
+.. include:: include_package-core.rst
+
+
+
+------------------------------------------------------------------------------
+
+
+setExtra
+========
+
+.. code-block:: javascript
+
+    web3.eth.miner.setExtra(extraData, [, callback])
+
+This method allows miner to set extra data during mining the block.
+
+----------
+Parameters
+----------
+
+1. ``extraData`` - ``String``: Extra data which is to be set.
+2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
+
+-------
+Returns
+-------
+
+``Promise<boolean>`` - True if successful.
+
+-------
+Example
+-------
+
+.. code-block:: javascript
+
+    web3.eth.miner.setExtra('Hello').then(console.log);
+    > true
+
+------------------------------------------------------------------------------
+
+
+setGasPrice
+===========
+
+.. code-block:: javascript
+
+    web3.eth.miner.setGasPrice(gasPrice, [, callback])
+
+This method allows to set minimal accepted gas price during mining transactions. Any transactions that are below this limit will get excluded from the mining process.
+
+----------
+Parameters
+----------
+
+
+1. ``number | hex`` - Gas price.
+2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
+
+
+-------
+Returns
+-------
+
+
+``Promise<boolean>`` - True if successful.
+
+
+-------
+Example
+-------
+
+
+.. code-block:: javascript
+
+    web3.eth.miner.setGasPrice("0x4a817c800").then(console.log);
+    > true
+
+    web3.eth.miner.setGasPrice(20000000000).then(console.log);
+    > true
+
+
+------------------------------------------------------------------------------
+
+
+setEtherBase
+============
+
+.. code-block:: javascript
+
+    web3.eth.miner.setEtherBase(address, [, callback])
+
+Sets etherbase, where mining reward will go.
+
+----------
+Parameters
+----------
+
+
+1. ``String`` - address where mining reward will go.
+2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
+
+
+-------
+Returns
+-------
+
+
+``Promise<boolean>`` - True if successful.
+
+
+-------
+Example
+-------
+
+
+.. code-block:: javascript
+
+    web3.eth.miner.setEtherBase("0x3d80b31a78c30fc628f20b2c89d7ddbf6e53cedc").then(console.log);
+    > true
+
+------------------------------------------------------------------------------
+
+
+start
+=====
+
+.. code-block:: javascript
+
+    web3.eth.miner.start(miningThread, [, callback])
+
+Start the CPU mining process with the given number of threads.
+
+----------
+Parameters
+----------
+
+
+1. ``hex | number`` - Mining threads.
+2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
+
+
+-------
+Returns
+-------
+
+
+``Promise<boolean>`` - True if successful.
+
+
+-------
+Example
+-------
+
+
+.. code-block:: javascript
+
+    web3.eth.miner.start('0x1').then(console.log);
+    > true
+
+    web3.eth.miner.start(1).then(console.log);
+    > true
+
+------------------------------------------------------------------------------
+
+
+stop
+====
+
+.. code-block:: javascript
+
+    web3.eth.miner.stop([callback])
+
+Stop the CPU mining process.
+
+----------
+Parameters
+----------
+
+
+1. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
+
+
+-------
+Returns
+-------
+
+
+``Promise<boolean>`` - True if successful.
+
+
+-------
+Example
+-------
+
+
+.. code-block:: javascript
+
+    web3.eth.miner.stop().then(console.log);
+    > true
+
+------------------------------------------------------------------------------
diff --git a/docs/web3-eth-net.rst b/docs/web3-eth-net.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-=========
+============
 web3.eth.net
-=========
+============
 
 
 Functions to receive details about the current connected network.

diff --git a/docs/web3-eth-personal.rst b/docs/web3-eth-personal.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-========
+=================
 web3.eth.personal
-========
+=================
 
 
 The ``web3-eth-personal`` package allows you to interact with the Ethereum node's accounts.

diff --git a/docs/web3-eth-subscribe.rst b/docs/web3-eth-subscribe.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-=========
+==================
 web3.eth.subscribe
-=========
+==================
 
 The ``web3.eth.subscribe`` function lets you subscribe to specific events in the blockchain.
 

diff --git a/docs/web3-net.rst b/docs/web3-net.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-========
+==========
 web3.*.net
-========
+==========
 
 
 The ``web3-net`` package allows you to interact with the Ethereum nodes network properties.

diff --git a/docs/web3-utils.rst b/docs/web3-utils.rst
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-========
+==========
 web3.utils
-========
+==========
 
 This package provides utility functions for Ethereum dapps and other web3.js packages.
 

diff --git a/docs/web3.rst b/docs/web3.rst
@@ -1,9 +1,9 @@
 
 .. include:: include_announcement.rst
 
-=====================
+====
 Web3
-=====================
+====
 
     The Web3 class is a wrapper to house all Ethereum related modules.