status-im/web3.js
2
0
Fork 0
mirror of https://github.com/status-im/web3.js.git synced 2025-02-23 03:28:07 +00:00
Code Issues Projects Releases Wiki Activity

changed format of docs

Browse Source
This commit is contained in:
Fabian Vogelsteller 2017-03-02 09:43:43 +01:00
parent 7b8b8c433b
commit 5bcf9a85f7
No known key found for this signature in database
GPG Key ID: E51EADA77F1A4124
7 changed files with 227 additions and 218 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/web3-bzz.rst
View File

@ -49,7 +49,7 @@ Parameters
1. ``String`` - ``localfspath``: The file or directory to upload. 1. ``String`` - ``localfspath``: The file or directory to upload.
2. ``String`` - ``defaultfile``: The default to use when no file on the manifest path could be mapped. For JavaScript Dapps that is normally an ``index.html``. 2. ``String`` - ``defaultfile``: The default to use when no file on the manifest path could be mapped. For JavaScript Dapps that is normally an ``index.html``.
3. ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second. 3. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
------- -------
Returns Returns
@ -84,9 +84,9 @@ Downloads files and folders from swarm.
Parameters Parameters
---------- ----------
1. ``String`` - ``bzzHash``: The file or directory to download. 1. ``bzzHash`` - ``String``: The file or directory to download.
2. ``String`` - ``localdirpath``: The local folder to download the content into. 2. ``localdirpath`` - ``String``: The local folder to download the content into.
3. ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second. 3. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
------- -------
Returns Returns
@ -123,9 +123,9 @@ Creates a manifest with an entry. This entry has the empty path and specifies th
Parameters Parameters
---------- ----------
1. ``String`` - ``content``: The data blob to store. 1. ``content`` - ``String``: The data blob to store.
2. ``String`` - ``contentType``: The MIME content type to assign for that data. 2. ``contentType`` - ``String``: The MIME content type to assign for that data.
3. ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second. 3. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
------- -------
Returns Returns
@ -159,8 +159,8 @@ Description missing.
Parameters Parameters
---------- ----------
1. ``String`` - ``bzzHash``: The path to a file, it will then download its manifest JSON file. 1. ``bzzHash`` - ``String``: The path to a file, it will then download its manifest JSON file.
2. ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second. 2. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
------- -------
Returns Returns

137
docs/web3-eth-contract.rst
View File

@ -29,13 +29,13 @@ Creates a new contract instance with all its methods and events defined in its :
Parameters Parameters
---------- ----------
1. ``Object`` - ``jsonInterface``: The json interface for the contract to instantiate 1. ``jsonInterface`` - ``Object``: The json interface for the contract to instantiate
2. ``String`` - ``address`` (optional): The address of the smart contract to call, can be added later using ``myContract.options.address = '0x1234..'`` 2. ``address`` - ``String`` (optional): The address of the smart contract to call, can be added later using ``myContract.options.address = '0x1234..'``
3. ``Object`` - ``options`` (optional): The options of the contract. Some are used as fallbacks for calls and transactions: 3. ``options`` - ``Object`` (optional): The options of the contract. Some are used as fallbacks for calls and transactions:
* ``String`` - ``from``: The address transactions should be made from. * ``from`` - ``String``: The address transactions should be made from.
* ``String`` - ``gasPrice``: The gas price in wei to use for transactions. * ``gasPrice`` - ``String``: The gas price in wei to use for transactions.
* ``Number`` - ``gas``: The maximum gas provided for a transaction (gas limit). * ``gas`` - ``Number``: The maximum gas provided for a transaction (gas limit).
* ``String`` - ``data``: The byte code of the contract. Used when the contract gets :ref:`deployed <contract-deploy>`. * ``data`` - ``String``: The byte code of the contract. Used when the contract gets :ref:`deployed <contract-deploy>`.
------- -------
Returns Returns
@ -80,12 +80,12 @@ Properties
``Object`` - options: ``Object`` - options:
- ``String`` - ``address``: The address where the contract is deployed. See :ref:`options.address <contract-address>`. - ``address`` - ``String``: The address where the contract is deployed. See :ref:`options.address <contract-address>`.
- ``Array`` - ``jsonInterface``: The json interface of the contract. See :ref:`options.jsonInterface <contract-json-interface>`. - ``jsonInterface`` - ``Array``: The json interface of the contract. See :ref:`options.jsonInterface <contract-json-interface>`.
- ``String`` - ``data``: The byte code of the contract. Used when the contract gets :ref:`deployed <contract-deploy>`. - ``data`` - ``String``: The byte code of the contract. Used when the contract gets :ref:`deployed <contract-deploy>`.
- ``String`` - ``from``: The address transactions should be made from. - ``from`` - ``String``: The address transactions should be made from.
- ``String`` - ``gasPrice``: The gas price in wei to use for transactions. - ``gasPrice`` - ``String``: The gas price in wei to use for transactions.
- ``Number`` - ``gas``: The maximum gas provided for a transaction (gas limit). - ``gas`` - ``Number``: The maximum gas provided for a transaction (gas limit).
------- -------
@ -129,7 +129,7 @@ The address will be stored in lowercase.
Property Property
------- -------
``String|null`` - address: The address for this contract, or ``null`` if its not yet set. ``address`` - ``String|null``: The address for this contract, or ``null`` if its not yet set.
------- -------
@ -163,7 +163,7 @@ The :ref:`json interface <glossary-json-interface>` object derived from the `ABI
Property Property
------- -------
``Array`` - jsonInterface: The :ref:`json interface <glossary-json-interface>` for this contract. Re-setting this will regenerate the methods and events of the contract instance. ``jsonInterface`` - ``Array``: The :ref:`json interface <glossary-json-interface>` for this contract. Re-setting this will regenerate the methods and events of the contract instance.
------- -------
@ -254,9 +254,9 @@ After successfull deployment the promise will resolve with a new contract instan
Parameters Parameters
---------- ----------
1. ``Object`` - ``options``: The options used for deployemnt. 1. ``options`` - ``Object``: The options used for deployemnt.
* ``String`` - ``data``: The byte code of the contract. * ``data`` - ``String``: The byte code of the contract.
* ``Array``` - ``arguments`` (optional): The arguments which get passed to the constructor on deployment. * ``arguments`` - ``Array`` (optional): The arguments which get passed to the constructor on deployment.
------- -------
Returns Returns
@ -387,7 +387,7 @@ Example
// or sending and using a promise // or sending and using a promise
myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'}) myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'})
.then(function(receipt){ .then(function(receipt){
... // receipt can also be a new contract instance, when coming from a "contract.deploy({...}).send()"
}); });
// or sending and using the events // or sending and using the events
@ -399,7 +399,9 @@ Example
.on('receipt', function(receipt){ .on('receipt', function(receipt){
... ...
}) })
.on('confirmation', function(confirmationNumber, receipt){ ... }) .on('confirmation', function(confirmationNumber, receipt){
...
})
.on('error', console.error); .on('error', console.error);
@ -421,11 +423,11 @@ Will call a "constant" method and execute its smart contract method in the EVM w
Parameters Parameters
---------- ----------
1. ``Object`` - ``options`` (optional): The options used for calling. 1. ``options`` - ``Object`` (optional): The options used for calling.
* ``String`` - ``from`` (optional): The address the call "transaction" should be made from. * ``from`` - ``String`` (optional): The address the call "transaction" should be made from.
* ``String`` - ``gasPrice`` (optional): The gas price in wei to use for this call "transaction". * ``gasPrice`` - ``String`` (optional): The gas price in wei to use for this call "transaction".
* ``Number`` - ``gas`` (optional): The maximum gas provided for this call "transaction" (gas limit). * ``gas`` - ``Number`` (optional): The maximum gas provided for this call "transaction" (gas limit).
2. ``Function`` - ``callback`` (optional): This callback will be fired with the result of the smart contract method execution as the second argument, or with an error object as the first argument. 2. ``callback`` - ``Function`` (optional): This callback will be fired with the result of the smart contract method execution as the second argument, or with an error object as the first argument.
------- -------
Returns Returns
@ -472,11 +474,11 @@ Will send a transaction to the smart contract and execute its method. Note this
Parameters Parameters
---------- ----------
1. ``Object`` - ``options``: The options used for sending. 1. ``options`` - ``Object``: The options used for sending.
* ``String`` - ``from``: The address the transaction should be send from. * ``from`` - ``String``: The address the transaction should be send from.
* ``String`` - ``gasPrice`` (optional): The gas price in wei to use for this transaction. * ``gasPrice`` - ``String`` (optional): The gas price in wei to use for this transaction.
* ``Number`` - ``gas`` (optional): The maximum gas provided for this transaction (gas limit). * ``gas`` - ``Number`` (optional): The maximum gas provided for this transaction (gas limit).
2. ``Function`` - ``callback`` (optional): This callback will be fired first with the "transactionHash", or with an error object as the first argument. 2. ``callback`` - ``Function`` (optional): This callback will be fired first with the "transactionHash", or with an error object as the first argument.
------- -------
Returns Returns
@ -484,7 +486,7 @@ Returns
The **callback** will return the 32 bytes transaction hash. The **callback** will return the 32 bytes transaction hash.
``PromiEvent``: A :ref:`promise combined event emitter <promiEvent>`. Will be resolved when the transaction *receipt* is available. If this ``send()`` is is called from a ``someContract.deploy()`` then the promise will resolve with the *new contract instance*. Additionally the following events are available: ``PromiEvent``: A :ref:`promise combined event emitter <promiEvent>`. Will be resolved when the transaction *receipt* is available, OR If this ``send()`` is is called from a ``someContract.deploy()`` then the promise will resolve with the *new contract instance*. Additionally the following events are available:
- ``"transactionHash"`` returns ``String``: is fired right after the transaction is send and a transaction hash is available. - ``"transactionHash"`` returns ``String``: is fired right after the transaction is send and a transaction hash is available.
- ``"receipt"`` returns ``Object``: is fired when the transaction receipt is available. - ``"receipt"`` returns ``Object``: is fired when the transaction receipt is available.
@ -499,14 +501,14 @@ Example
.. code-block:: javascript .. code-block:: javascript
// using the callback // using the callback
myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'}, function(error, hash){ myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'}, function(error, transactionHash){
... ...
}); });
// using the promise // using the promise
myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'}) myContract.methods.myMethod(123).send({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'})
.then(function(receipt){ .then(function(receipt){
... // receipt can also be a new contract instance, when coming from a "contract.deploy({...}).send()"
}); });
@ -518,7 +520,9 @@ Example
.on('receipt', function(receipt){ .on('receipt', function(receipt){
... ...
}) })
.on('confirmation', function(confirmationNumber, receipt){ ... }) .on('confirmation', function(confirmationNumber, receipt){
...
})
.on('error', console.error); // If a out of gas error, the second parameter is the receipt. .on('error', console.error); // If a out of gas error, the second parameter is the receipt.
@ -541,10 +545,10 @@ The estimation can differ from the actual gas used when later sending a transact
Parameters Parameters
---------- ----------
1. ``Object`` - ``options`` (optional): The options used for calling. 1. ``options`` - ``Object`` (optional): The options used for calling.
* ``String`` - ``from`` (optional): The address the call "transaction" should be made from. * ``from`` - ``String`` (optional): The address the call "transaction" should be made from.
* ``Number`` - ``gas`` (optional): The maximum gas provided for this call "transaction" (gas limit). Setting a specific value helps to detect out of gas errors. If all gas is used it will return the same number. * ``gas`` - ``Number`` (optional): The maximum gas provided for this call "transaction" (gas limit). Setting a specific value helps to detect out of gas errors. If all gas is used it will return the same number.
2. ``Function`` - ``callback`` (optional): This callback will be fired with the result of the gas estimation as the second argument, or with an error object as the first argument. 2. ``callback`` - ``Function`` (optional): This callback will be fired with the result of the gas estimation as the second argument, or with an error object as the first argument.
------- -------
Returns Returns
@ -568,6 +572,9 @@ Example
myContract.methods.myMethod(123).estimateGas({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'}) myContract.methods.myMethod(123).estimateGas({from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'})
.then(function(gasAmount){ .then(function(gasAmount){
... ...
})
.catch(function(error){
...
}); });
@ -631,13 +638,13 @@ Gets past events for this contract.
Parameters Parameters
---------- ----------
1. ``String`` - ``event``: The name of the event in the contract, or ``"allEvents"`` to get all events. 1. ``event`` - ``String``: The name of the event in the contract, or ``"allEvents"`` to get all events.
2. ``Object`` - ``options`` (optional): The options used for deployment. 2. ``options`` - ``Object`` (optional): The options used for deployment.
* ``Object`` - ``filter`` (optional): Let you filter events by indexed parameters, e.g. ``{filter: {myNumber: [12,13]}}`` means all events where "myNumber" is 12 or 13. * ``filter`` - ``Object`` (optional): Let you filter events by indexed parameters, e.g. ``{filter: {myNumber: [12,13]}}`` means all events where "myNumber" is 12 or 13.
* ``Number`` - ``fromBlock`` (optional): The block number from which to get events on. * ``fromBlock`` - ``Number`` (optional): The block number from which to get events on.
* ``Number`` - ``toBlock`` (optional): The block number until events to get (Defaults to ``"latest"``). * ``toBlock`` - ``Number`` (optional): The block number until events to get (Defaults to ``"latest"``).
* ``Array`` - ``topics`` (optional): This allows to manually set the topics for the event filter. If given the filter property and event signature (topic[0]) will not be set automatically. * ``topics`` - ``Array`` (optional): This allows to manually set the topics for the event filter. If given the filter property and event signature (topic[0]) will not be set automatically.
3. ``Function`` - ``callback`` (optional): This callback will be fired with an array of event logs as the second argument, or an error as the first argument. 3. ``callback`` - ``Function`` (optional): This callback will be fired with an array of event logs as the second argument, or an error as the first argument.
.. _contract-getPastEvents-return: .. _contract-getPastEvents-return:
@ -650,16 +657,16 @@ Returns
The structure of the returned event ``Object`` in the ``Array`` looks as follows: The structure of the returned event ``Object`` in the ``Array`` looks as follows:
- ``Object`` - ``returnValues``: The return values coming from the event, e.g. ``{myVar: 1, myVar2: '0x234...'}``. - ``event`` - ``String``: The event name.
- ``String`` - ``event``: The event name. - ``address`` - ``String``: From which this event originated from.
- ``String`` - ``address``: From which this event originated from. - ``returnValues`` - ``Object``: The return values coming from the event, e.g. ``{myVar: 1, myVar2: '0x234...'}``.
- ``String`` - ``raw.data``: The data containing non-indexed log parameter. - ``logIndex`` - ``Number``: Integer of the event index position in the block.
- ``Array`` - ``raw.topics``: An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the event. - ``transactionIndex`` - ``Number``: Integer of the transaction's index position, the event was created in.
- ``Number`` - ``logIndex``: Integer of the event index position in the block. - ``transactionHash`` 32 Bytes - ``String``: Hash of the transaction this event was created in.
- ``Number`` - ``transactionIndex``: Integer of the transaction's index position, the event was created in. - ``blockHash`` 32 Bytes - ``String``: Hash of the block where this event was created in. ``null`` when its still pending.
- ``String`` 32 Bytes - ``transactionHash``: Hash of the transaction this event was created in. - ``blockNumber`` - ``Number``: The block number where this log was created in. ``null`` when still pending.
- ``String`` 32 Bytes - ``blockHash``: Hash of the block where this event was created in. ``null`` when its still pending. - ``raw.data`` - ``String``: The data containing non-indexed log parameter.
- ``Number`` - ``blockNumber``: The block number where this log was created in. ``null`` when still pending. - ``raw.topics`` - ``Array``: An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the event.
------- -------
Example Example
@ -714,11 +721,11 @@ Subscribes to an event, and unsubscribes immediately after the first event or er
Parameters Parameters
---------- ----------
1. ``String`` - ``event``: The name of the event in the contract, or ``"allEvents"`` to get all events. 1. ``event`` - ``String``: The name of the event in the contract, or ``"allEvents"`` to get all events.
2. ``Object`` - ``options`` (optional): The options used for deployment. 2. ``options`` - ``Object`` (optional): The options used for deployment.
* ``Object`` - ``filter`` (optional): Let you filter events by indexed parameters, e.g. ``{filter: {myNumber: [12,13]}}`` means all events where "myNumber" is 12 or 13. * ``filter`` - ``Object`` (optional): Let you filter events by indexed parameters, e.g. ``{filter: {myNumber: [12,13]}}`` means all events where "myNumber" is 12 or 13.
* ``Array`` - ``topics`` (optional): This allows to manually set the topics for the event filter. If given the filter property and event signature (topic[0]) will not be set automatically. * ``topics`` - ``Array`` (optional): This allows to manually set the topics for the event filter. If given the filter property and event signature (topic[0]) will not be set automatically.
3. ``Function`` - ``callback``: This callback will be fired for the first event as the second argument, or an error as the first argument. 3. ``callback`` - ``Function``: This callback will be fired for the first event as the second argument, or an error as the first argument.
------- -------
Returns Returns
@ -775,11 +782,11 @@ Subscribe to a event
Parameters Parameters
---------- ----------
1. ``Object`` - ``options`` (optional): The options used for deployment. 1. ``options`` - ``Object`` (optional): The options used for deployment.
* ``Object`` - ``filter`` (optional): Let you filter events by indexed parameters, e.g. ``{filter: {myNumber: [12,13]}}`` means all events where "myNumber" is 12 or 13. * ``filter`` - ``Object`` (optional): Let you filter events by indexed parameters, e.g. ``{filter: {myNumber: [12,13]}}`` means all events where "myNumber" is 12 or 13.
* ``Number`` - ``fromBlock`` (optional): The block number from which to get events on. * ``fromBlock`` - ``Number`` (optional): The block number from which to get events on.
* ``Array`` - ``topics`` (optional): This allows to manually set the topics for the event filter. If given the filter property and event signature (topic[0]) will not be set automatically. * ``topics`` - ``Array`` (optional): This allows to manually set the topics for the event filter. If given the filter property and event signature (topic[0]) will not be set automatically.
2. ``Function`` - ``callback`` (optional): This callback will be fired for each event as the second argument, or an error as the first argument. 2. ``callback`` - ``Function`` (optional): This callback will be fired for each event as the second argument, or an error as the first argument.
------- -------
Returns Returns

4
docs/web3-eth-iban.rst
View File

@ -205,8 +205,8 @@ Parameters
---------- ----------
1. ``Object``: the options object as follows: 1. ``Object``: the options object as follows:
- ``String`` - ``institution``: the institution to be assigned - ``institution`` - ``String``: the institution to be assigned
- ``String`` - ``identifier``: the identifier to be assigned - ``identifier`` - ``String``: the identifier to be assigned
------- -------
Returns Returns

42
docs/web3-eth-subscribe.rst
View File

@ -192,20 +192,20 @@ Returns
The structure of a returned block header is as follows: The structure of a returned block header is as follows:
- ``Number`` - ``number``: The block number. ``null`` when its pending block. - ``number`` - ``Number``: The block number. ``null`` when its pending block.
- ``String`` 32 Bytes - ``hash``: Hash of the block. ``null`` when its pending block. - ``hash`` 32 Bytes - ``String``: Hash of the block. ``null`` when its pending block.
- ``String`` 32 Bytes - ``parentHash``: Hash of the parent block. - ``parentHash`` 32 Bytes - ``String``: Hash of the parent block.
- ``String`` 8 Bytes - ``nonce``: Hash of the generated proof-of-work. ``null`` when its pending block. - ``nonce`` 8 Bytes - ``String``: Hash of the generated proof-of-work. ``null`` when its pending block.
- ``String`` 32 Bytes - ``sha3Uncles``: SHA3 of the uncles data in the block. - ``sha3Uncles`` 32 Bytes - ``String``: SHA3 of the uncles data in the block.
- ``String`` 256 Bytes - ``logsBloom``: The bloom filter for the logs of the block. ``null`` when its pending block. - ``logsBloom`` 256 Bytes - ``String``: The bloom filter for the logs of the block. ``null`` when its pending block.
- ``String`` 32 Bytes - ``transactionsRoot``: The root of the transaction trie of the block - ``transactionsRoot`` 32 Bytes - ``String``: The root of the transaction trie of the block
- ``String`` 32 Bytes - ``stateRoot``: The root of the final state trie of the block. - ``stateRoot`` 32 Bytes - ``String``: The root of the final state trie of the block.
- ``String`` 32 Bytes - ``receiptRoot``: The root of the receipts. - ``receiptRoot`` 32 Bytes - ``String``: The root of the receipts.
- ``String`` - ``miner``: The address of the beneficiary to whom the mining rewards were given. - ``miner`` - ``String``: The address of the beneficiary to whom the mining rewards were given.
- ``String`` - ``extraData``: The "extra data" field of this block. - ``extraData`` - ``String``: The "extra data" field of this block.
- ``Number`` - ``gasLimit``: The maximum gas allowed in this block. - ``gasLimit`` - ``Number``: The maximum gas allowed in this block.
- ``Number`` - ``gasUsed``: The total used gas by all transactions in this block. - ``gasUsed`` - ``Number``: The total used gas by all transactions in this block.
- ``Number`` - ``timestamp``: The unix timestamp for when the block was collated. - ``timestamp`` - ``Number``: The unix timestamp for when the block was collated.
---------------- ----------------
Callback returns Callback returns
@ -260,7 +260,7 @@ Returns
``EventEmitter``: An :ref:`subscription instance <eth-subscription-return>` as an event emitter with the following events: ``EventEmitter``: An :ref:`subscription instance <eth-subscription-return>` as an event emitter with the following events:
- ``"data"`` returns ``Object``: Fires on each incoming sync object as argument. - ``"data"`` returns ``Object``: Fires on each incoming sync object as argument.
- ``"changed"`` returns ``Object``: Fires when the synchronisation is started with ``TRUE`` and when finsihed with ``FALSE``. - ``"changed"`` returns ``Object``: Fires when the synchronisation is started with ``true`` and when finsihed with ``false``.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occours. - ``"error"`` returns ``Object``: Fires when an error in the subscription occours.
For the structure of a returned event ``Object`` see :ref:`web3.eth.isSyncing return values <eth-issyncing-return>`. For the structure of a returned event ``Object`` see :ref:`web3.eth.isSyncing return values <eth-issyncing-return>`.
@ -270,7 +270,7 @@ Callback returns
---------------- ----------------
1. ``Object|Null`` - First parameter is an error object if the subscription failed. 1. ``Object|Null`` - First parameter is an error object if the subscription failed.
2. ``Object|Boolean`` - The syncing object, when started it will return ``TRUE`` once or when finished it will return `FALSE` once. 2. ``Object|Boolean`` - The syncing object, when started it will return ``true`` once or when finished it will return `false` once.
------- -------
Example Example
@ -316,12 +316,12 @@ Subscribes to incoming logs, filtered by the given options.
Parameters Parameters
---------- ----------
1. ``String`` - ``"logs"``, the type of the subscription. 1. ``"logs"`` - ``String``, the type of the subscription.
2. ``Object`` - The subscription options 2. ``Object`` - The subscription options
- ``Number`` - ``fromBlock``: The number of the earliest block. By default ``null``. - ``fromBlock`` - ``Number``: The number of the earliest block. By default ``null``.
- ``String`` - ``address``: An address or a list of addresses to only get logs from particular account(s). - ``address`` - ``String``: An address or a list of addresses to only get logs from particular account(s).
- ``Array`` - ``topics``: An array of values which must each appear in the log entries. The order is important, if you want to leave topics out use ``null``, e.g. ``[null, '0x00...']``. You can also pass another array for each topic with options for that topic e.g. ``[null, ['option1', 'option2']]`` - ``topics`` - ``Array``: An array of values which must each appear in the log entries. The order is important, if you want to leave topics out use ``null``, e.g. ``[null, '0x00...']``. You can also pass another array for each topic with options for that topic e.g. ``[null, ['option1', 'option2']]``
3. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second. Will be called for each incoming subscription. 3. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second. Will be called for each incoming subscription.
------- -------
Returns Returns

198
docs/web3-eth.rst
View File

@ -151,11 +151,11 @@ Property
Default block parameters can be one of the following: Default block parameters can be one of the following:
- ``Number``: A block number - ``Number``: A block number
- ``String`` - ``"genesis"``: The genesis block - ``"genesis"`` - ``String``: The genesis block
- ``String`` - ``"latest"``: The latest block (current head of the blockchain) - ``"latest"`` - ``String``: The latest block (current head of the blockchain)
- ``String`` - ``"pending"``: The currently mined block (including pending transactions) - ``"pending"`` - ``String``: The currently mined block (including pending transactions)
Default is ``latest`` Default is ``"latest"``
------- -------
@ -220,11 +220,11 @@ Returns
``Promise`` returns ``Object|Boolean`` - A sync object when the node is currently syncing or ``false``: ``Promise`` returns ``Object|Boolean`` - A sync object when the node is currently syncing or ``false``:
- ``Number`` - ``startingBlock``: The block number where the sync started. - ``startingBlock`` - ``Number``: The block number where the sync started.
- ``Number`` - ``currentBlock``: The block number where at which block the node currently synced to already. - ``currentBlock`` - ``Number``: The block number where at which block the node currently synced to already.
- ``Number`` - ``highestBlock``: The estimated block number to sync to. - ``highestBlock`` - ``Number``: The estimated block number to sync to.
- ``Number`` - ``knownStates``: The estimated states to download - ``knownStates`` - ``Number``: The estimated states to download
- ``Number`` - ``pulledStates``: The already downloaded states - ``pulledStates`` - ``Number``: The already downloaded states
------- -------
@ -575,24 +575,24 @@ Returns
``Promise`` returns ``Object`` - The block object: ``Promise`` returns ``Object`` - The block object:
- ``Number`` - ``number``: The block number. ``null`` when its pending block. - ``number`` - ``Number``: The block number. ``null`` when its pending block.
- ``String`` 32 Bytes - ``hash``: Hash of the block. ``null`` when its pending block. - ``hash`` 32 Bytes - ``String``: Hash of the block. ``null`` when its pending block.
- ``String`` 32 Bytes - ``parentHash``: Hash of the parent block. - ``parentHash`` 32 Bytes - ``String``: Hash of the parent block.
- ``String`` 8 Bytes - ``nonce``: Hash of the generated proof-of-work. ``null`` when its pending block. - ``nonce`` 8 Bytes - ``String``: Hash of the generated proof-of-work. ``null`` when its pending block.
- ``String`` 32 Bytes - ``sha3Uncles``: SHA3 of the uncles data in the block. - ``sha3Uncles`` 32 Bytes - ``String``: SHA3 of the uncles data in the block.
- ``String`` 256 Bytes - ``logsBloom``: The bloom filter for the logs of the block. ``null`` when its pending block. - ``logsBloom`` 256 Bytes - ``String``: The bloom filter for the logs of the block. ``null`` when its pending block.
- ``String`` 32 Bytes - ``transactionsRoot``: The root of the transaction trie of the block - ``transactionsRoot`` 32 Bytes - ``String``: The root of the transaction trie of the block
- ``String`` 32 Bytes - ``stateRoot``: The root of the final state trie of the block. - ``stateRoot`` 32 Bytes - ``String``: The root of the final state trie of the block.
- ``String`` - ``miner``: The address of the beneficiary to whom the mining rewards were given. - ``miner`` - ``String``: The address of the beneficiary to whom the mining rewards were given.
- ``String`` - ``difficulty``: Integer of the difficulty for this block. - ``difficulty`` - ``String``: Integer of the difficulty for this block.
- ``String`` - ``totalDifficulty``: Integer of the total difficulty of the chain until this block. - ``totalDifficulty`` - ``String``: Integer of the total difficulty of the chain until this block.
- ``String`` - ``extraData``: The "extra data" field of this block. - ``extraData`` - ``String``: The "extra data" field of this block.
- ``Number`` - ``size``: Integer the size of this block in bytes. - ``size`` - ``Number``: Integer the size of this block in bytes.
- ``Number`` - ``gasLimit``: The maximum gas allowed in this block. - ``gasLimit`` - ``Number``: The maximum gas allowed in this block.
- ``Number`` - ``gasUsed``: The total used gas by all transactions in this block. - ``gasUsed`` - ``Number``: The total used gas by all transactions in this block.
- ``Number`` - ``timestamp``: The unix timestamp for when the block was collated. - ``timestamp`` - ``Number``: The unix timestamp for when the block was collated.
- ``Array`` - ``transactions``: Array of transaction objects, or 32 Bytes transaction hashes depending on the ``returnTransactionObjects`` parameter. - ``transactions`` - ``Array``: Array of transaction objects, or 32 Bytes transaction hashes depending on the ``returnTransactionObjects`` parameter.
- ``Array`` - ``uncles``: Array of uncle hashes. - ``uncles`` - ``Array``: Array of uncle hashes.
------- -------
Example Example
@ -605,26 +605,26 @@ Example
.then(console.log); .then(console.log);
> { > {
"number": 3, "number": 3,
"hash": "0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46", "hash": "0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46",
"parentHash": "0x2302e1c0b972d00932deb5dab9eb2982f570597d9d42504c05d9c2147eaf9c88", "parentHash": "0x2302e1c0b972d00932deb5dab9eb2982f570597d9d42504c05d9c2147eaf9c88",
"nonce": "0xfb6e1a62d119228b", "nonce": "0xfb6e1a62d119228b",
"sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347", "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"transactionsRoot": "0x3a1b03875115b79539e5bd33fb00d8f7b7cd61929d5a3c574f507b8acf415bee", "transactionsRoot": "0x3a1b03875115b79539e5bd33fb00d8f7b7cd61929d5a3c574f507b8acf415bee",
"stateRoot": "0xf1133199d44695dfa8fd1bcfe424d82854b5cebef75bddd7e40ea94cda515bcb", "stateRoot": "0xf1133199d44695dfa8fd1bcfe424d82854b5cebef75bddd7e40ea94cda515bcb",
"miner": "0x8888f1f195afa192cfee860698584c030f4c9db1", "miner": "0x8888f1f195afa192cfee860698584c030f4c9db1",
"difficulty": '21345678965432', "difficulty": '21345678965432',
"totalDifficulty": '324567845321', "totalDifficulty": '324567845321',
"size": 616, "size": 616,
"extraData": "0x", "extraData": "0x",
"gasLimit": 3141592, "gasLimit": 3141592,
"gasUsed": 21662, "gasUsed": 21662,
"timestamp": 1429287689, "timestamp": 1429287689,
"transactions": [ "transactions": [
"0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b" "0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b"
], ],
"uncles": [] "uncles": []
} }
@ -739,17 +739,17 @@ Returns
``Promise`` returns ``Object`` - A transaction object its hash ``transactionHash``: ``Promise`` returns ``Object`` - A transaction object its hash ``transactionHash``:
- ``String`` 32 Bytes - ``hash``: Hash of the transaction. - ``hash`` 32 Bytes - ``String``: Hash of the transaction.
- ``Number`` - ``nonce``: The number of transactions made by the sender prior to this one. - ``nonce`` - ``Number``: The number of transactions made by the sender prior to this one.
- ``String`` 32 Bytes - ``blockHash``: Hash of the block where this transaction was in. ``null`` when its pending. - ``blockHash`` 32 Bytes - ``String``: Hash of the block where this transaction was in. ``null`` when its pending.
- ``Number`` - ``blockNumber``: Block number where this transaction was in. ``null`` when its pending. - ``blockNumber`` - ``Number``: Block number where this transaction was in. ``null`` when its pending.
- ``Number`` - ``transactionIndex``: Integer of the transactions index position in the block. ``null`` when its pending. - ``transactionIndex`` - ``Number``: Integer of the transactions index position in the block. ``null`` when its pending.
- ``String`` - ``from``: Address of the sender. - ``from`` - ``String``: Address of the sender.
- ``String`` - ``to``: Address of the receiver. ``null`` when its a contract creation transaction. - ``to`` - ``String``: Address of the receiver. ``null`` when its a contract creation transaction.
- ``String`` - ``value``: Value transferred in :ref:`wei <what-is-wei>`. - ``value`` - ``String``: Value transferred in :ref:`wei <what-is-wei>`.
- ``String`` - ``gasPrice``: Gas price provided by the sender in :ref:`wei <what-is-wei>`. - ``gasPrice`` - ``String``: Gas price provided by the sender in :ref:`wei <what-is-wei>`.
- ``Number`` - ``gas``: Gas provided by the sender. - ``gas`` - ``Number``: Gas provided by the sender.
- ``String`` - ``input``: The data sent along with the transaction. - ``input`` - ``String``: The data sent along with the transaction.
------- -------
@ -763,17 +763,17 @@ Example
.then(console.log); .then(console.log);
> { > {
"hash": "0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b", "hash": "0x9fc76417374aa880d4449a1f7f31ec597f00b1f6f3dd2d66f4c9c6c445836d8b",
"nonce": 2, "nonce": 2,
"blockHash": "0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46", "blockHash": "0xef95f2f1ed3ca60b048b4bf67cde2195961e0bba6f70bcbea9a2c4e133e34b46",
"blockNumber": 3, "blockNumber": 3,
"transactionIndex": 0, "transactionIndex": 0,
"from": "0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "from": "0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b",
"to": "0x6295ee1b4f6dd65047762f924ecd367c17eabf8f", "to": "0x6295ee1b4f6dd65047762f924ecd367c17eabf8f",
"value": '123450000000000000', "value": '123450000000000000',
"gas": 314159, "gas": 314159,
"gasPrice": '2000000000000', "gasPrice": '2000000000000',
"input": "0x57cb2fc4" "input": "0x57cb2fc4"
} }
@ -851,16 +851,16 @@ Returns
``Promise`` returns ``Object`` - A transaction receipt object, or ``null`` when no receipt was found: ``Promise`` returns ``Object`` - A transaction receipt object, or ``null`` when no receipt was found:
- ``String`` 32 Bytes - ``blockHash``: Hash of the block where this transaction was in. - ``blockHash`` 32 Bytes - ``String``: Hash of the block where this transaction was in.
- ``Number`` - ``blockNumber``: Block number where this transaction was in. - ``blockNumber`` - ``Number``: Block number where this transaction was in.
- ``String`` 32 Bytes - ``transactionHash``: Hash of the transaction. - ``transactionHash`` 32 Bytes - ``String``: Hash of the transaction.
- ``Number``- ``transactionIndex``: Integer of the transactions index position in the block. - ``transactionIndex``- ``Number``: Integer of the transactions index position in the block.
- ``String`` - ``from``: Address of the sender. - ``from`` - ``String``: Address of the sender.
- ``String`` - ``to``: Address of the receiver. ``null`` when its a contract creation transaction. - ``to`` - ``String``: Address of the receiver. ``null`` when its a contract creation transaction.
- ``String`` - ``contractAddress``: The contract address created, if the transaction was a contract creation, otherwise ``null``. - ``contractAddress`` - ``String``: The contract address created, if the transaction was a contract creation, otherwise ``null``.
- ``Number`` - ``cumulativeGasUsed``: The total amount of gas used when this transaction was executed in the block. - ``cumulativeGasUsed`` - ``Number``: The total amount of gas used when this transaction was executed in the block.
- ``Number``- ``gasUsed``: The amount of gas used by this specific transaction alone. - ``gasUsed``- ``Number``: The amount of gas used by this specific transaction alone.
- ``Array`` - ``logs``: Array of log objects, which this transaction generated. - ``logs`` - ``Array``: Array of log objects, which this transaction generated.
------- -------
Example Example
@ -942,14 +942,14 @@ Parameters
1. ``Object`` - The transaction object to send: 1. ``Object`` - The transaction object to send:
- ``String`` - ``from``: The address for the sending account. Uses the :ref:`web3.eth.defaultAccount <eth-defaultaccount>` property, if not specified. - ``from`` - ``String``: The address for the sending account. Uses the :ref:`web3.eth.defaultAccount <eth-defaultaccount>` property, if not specified.
- ``String`` - ``to``: (optional) The destination address of the message, left undefined for a contract-creation transaction. - ``to`` - ``String``: (optional) The destination address of the message, left undefined for a contract-creation transaction.
- ``Number|String`` - ``value``: (optional) The value transferred for the transaction in :ref:`wei <what-is-wei>`, also the endowment if it's a contract-creation transaction. - ``value`` - ``Number|String|BN|BigNumber``: (optional) The value transferred for the transaction in :ref:`wei <what-is-wei>`, also the endowment if it's a contract-creation transaction.
- ``Number`` - ``gas``: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded). - ``gas`` - ``Number``: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded).
- ``Number|String`` - ``gasPrice``: (optional, default: To-Be-Determined) The price of gas for this transaction in :ref:`wei <what-is-wei>`, defaults to the mean network gas price. - ``gasPrice`` - ``Number|String|BN|BigNumber``: (optional, default: To-Be-Determined) The price of gas for this transaction in :ref:`wei <what-is-wei>`, defaults to the mean network gas price.
- ``String`` - ``data``: (optional) Either a `ABI byte string <https://github.com/ethereum/wiki/wiki/Solidity,-Docs-and-ABI`_ containing the data of the function call on a contract, or in the case of a contract-creation transaction the initialisation code. - ``data`` - ``String``: (optional) Either a `ABI byte string <https://github.com/ethereum/wiki/wiki/Solidity,-Docs-and-ABI`_ containing the data of the function call on a contract, or in the case of a contract-creation transaction the initialisation code.
- ``Number`` -``nonce``: (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce. - ``nonce`` - ``Number``: (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second. 2. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
.. _eth-sendtransaction-return: .. _eth-sendtransaction-return:
@ -1224,10 +1224,10 @@ Parameters
---------- ----------
1. ``Object`` - The filter options as follows: 1. ``Object`` - The filter options as follows:
- ``Number|String`` - ``fromBlock``: The number of the earliest block (`latest` may be given to mean the most recent and `pending` currently mining, block). By default `latest`. - ``fromBlock`` - ``Number|String``: The number of the earliest block (``"latest"`` may be given to mean the most recent and ``"pending"`` currently mining, block). By default ``"latest"``.
- ``Number|String`` - ``toBlock``: The number of the latest block (`latest` may be given to mean the most recent and `pending` currently mining, block). By default `latest`. - ``toBlock`` - ``Number|String``: The number of the latest block (``"latest"`` may be given to mean the most recent and ``"pending"`` currently mining, block). By default ``"latest"``.
- ``String`` - ``address``: An address or a list of addresses to only get logs from particular account(s). - ``address`` - ``String``: An address or a list of addresses to only get logs from particular account(s).
- ``Array`` - ``topics``: An array of values which must each appear in the log entries. The order is important, if you want to leave topics out use `null`, e.g. `[null, '0x12...']`. You can also pass an array for each topic with options for that topic e.g. `[null, ['option1', 'option2']]` - ``topics`` - ``Array``: An array of values which must each appear in the log entries. The order is important, if you want to leave topics out use ``null``, e.g. ``[null, '0x12...']``. You can also pass an array for each topic with options for that topic e.g. ``[null, ['option1', 'option2']]``
.. _eth-getpastlogs-return: .. _eth-getpastlogs-return:
@ -1240,14 +1240,14 @@ Returns
The structure of the returned event ``Object`` in the ``Array`` looks as follows: The structure of the returned event ``Object`` in the ``Array`` looks as follows:
- ``String`` - ``address``: From which this event originated from. - ``address`` - ``String``: From which this event originated from.
- ``String`` - ``data``: The data containing non-indexed log parameter. - ``data`` - ``String``: The data containing non-indexed log parameter.
- ``Array`` - ``topics``: An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log. - ``topics`` - ``Array``: An array with max 4 32 Byte topics, topic 1-3 contains indexed parameters of the log.
- ``Number`` - ``logIndex``: Integer of the event index position in the block. - ``logIndex`` - ``Number``: Integer of the event index position in the block.
- ``Number`` - ``transactionIndex``: Integer of the transaction's index position, the event was created in. - ``transactionIndex`` - ``Number``: Integer of the transaction's index position, the event was created in.
- ``String`` 32 Bytes - ``transactionHash``: Hash of the transaction this event was created in. - ``transactionHash`` 32 Bytes - ``String``: Hash of the transaction this event was created in.
- ``String`` 32 Bytes - ``blockHash``: Hash of the block where this event was created in. ``null`` when its still pending. - ``blockHash`` 32 Bytes - ``String``: Hash of the block where this event was created in. ``null`` when its still pending.
- ``Number`` - ``blockNumber``: The block number where this log was created in. ``null`` when still pending. - ``blockNumber`` - ``Number``: The block number where this log was created in. ``null`` when still pending.
------- -------
Example Example

44
docs/web3-shh.rst
View File

@ -48,12 +48,12 @@ Parameters
---------- ----------
1. ``Object`` - The post object: 1. ``Object`` - The post object:
- ``String`` 60 Bytes - ``from`` (optional): The identity of the sender. - ``from`` 60 Bytes - ``String`` (optional): The identity of the sender.
- ``String`` 60 Bytes - ``to`` (optional): The identity of the receiver. When present whisper will encrypt the message so that only the receiver can decrypt it. - ``to`` 60 Bytes - ``String`` (optional): The identity of the receiver. When present whisper will encrypt the message so that only the receiver can decrypt it.
- ``Array`` - ``topics``: Array of topics ``Strings``, for the receiver to identify messages. - ``topics`` - ``Array``: Array of topics ``Strings``, for the receiver to identify messages.
- ``String|Number|Object`` - ``payload``: The payload of the message. Will be autoconverted to a HEX string before. - ``payload`` - ``String|Number|Object``: The payload of the message. Will be autoconverted to a HEX string before. (?)
- ``Number`` - ``ttl``: Integer of the time to live in seconds. - ``ttl`` - ``Number``: Integer of the time to live in seconds.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second. 2. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
------- -------
Returns Returns
@ -175,14 +175,14 @@ Watch for incoming whisper messages.
Parameters Parameters
---------- ----------
1. ``String``: Type ``"messages"``. 1. ``"messages"`` - ``String``: Type of the subscription.
1. ``Object`` - The filter options: 2. ``Object`` - The filter options:
- ``Array``- ``topics``: Filters messages by this topic(s). You can use the following combinations: - ``topics``- ``Array``: Filters messages by this topic(s). You can use the following combinations:
- `['topic1', 'topic2'] == 'topic1' && 'topic2'` - ``['topic1', 'topic2'] == 'topic1' && 'topic2'``
- `['topic1', ['topic2', 'topic3']] == 'topic1' && ('topic2' || 'topic3')` - ``['topic1', ['topic2', 'topic3']] == 'topic1' && ('topic2' || 'topic3')``
- `[null, 'topic1', 'topic2'] == ANYTHING && 'topic1' && 'topic2'` -> ``null`` works as a wildcard - ``[null, 'topic1', 'topic2'] == ANYTHING && 'topic1' && 'topic2'`` -> ``null`` works as a wildcard
- ``String`` - ``to``: Filter by identity of the message receiver. If provided and the node has this identity, it will decrypt the incoming encrypted messages. - ``to`` - ``String``: Filter by identity of the message receiver. If provided and the node has this identity, it will decrypt the incoming encrypted messages.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second. 3. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
---------- ----------
@ -191,14 +191,14 @@ Callback Return
``Object`` - The incoming message: ``Object`` - The incoming message:
- ``String`` 60 Bytes - ``from``: The sender of the message, if a sender was specified. - ``from`` - 60 Bytes ``String``: The sender of the message, if a sender was specified.
- ``String`` 60 Bytes - ``to``: The receiver of the message, if a receiver was specified. - ``to`` - 60 Bytes ``String``: The receiver of the message, if a receiver was specified.
- ``Number`` - ``expiry``: Integer of the time in seconds when this message should expire (?). - ``expiry`` - ``Number``: Integer of the time in seconds when this message should expire (?).
- ``Number`` - ``ttl``: Integer of the time the message should float in the system in seconds (?). - ``ttl`` - ``Number``: Integer of the time the message should float in the system in seconds (?).
- ``Number`` - ``sent``: Integer of the unix timestamp when the message was sent. - ``sent`` - ``Number``: Integer of the unix timestamp when the message was sent.
- ``Array`` - ``topics``: topic ``Strings`` for the message. - ``topics`` - ``Array``: topic ``Strings`` for the message.
- ``String`` - ``payload``: The payload of the message. - ``payload`` - ``String``: The payload of the message.
- ``Number`` - ``workProved``: Integer of the work this message required before it was send (?). - ``workProved`` - ``Number``: Integer of the work this message required before it was send (?).
---------- ----------

2
packages/web3-eth-contract/src/index.js
View File

@ -548,6 +548,8 @@ Contract.prototype.once = function(event, options, callback) {
callback(err, res, sub); callback(err, res, sub);
} }
}); });
return undefined;
}; };
/** /**