Skip to content

Commit

Permalink
bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
frozeman committed Jan 26, 2018
1 parent 23aed0f commit dd55daa
Show file tree
Hide file tree
Showing 60 changed files with 567 additions and 392 deletions.
2 changes: 1 addition & 1 deletion .versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
ethereum:web3@1.0.0-beta.27
ethereum:web3@1.0.0-beta.29
meteor@1.8.0
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"namespace": "ethereum",
"name": "web3",
"version": "1.0.0-beta.28",
"version": "1.0.0-beta.29",
"description": "Ethereum JavaScript API",
"license": "LGPL-3.0",
"main": [
Expand Down
16 changes: 8 additions & 8 deletions dist/web3.js
Original file line number Diff line number Diff line change
Expand Up @@ -54651,7 +54651,7 @@ var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol
module.exports = {
"name": "web3",
"namespace": "ethereum",
"version": "1.0.0-beta.28",
"version": "1.0.0-beta.29",
"description": "Ethereum JavaScript API",
"repository": "https://github.com/ethereum/web3.js/tree/master/packages/web3",
"license": "LGPL-3.0",
Expand Down Expand Up @@ -54683,13 +54683,13 @@ var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol
"url": "https://github.com/obscuren"
}],
"dependencies": {
"web3-bzz": "1.0.0-beta.28",
"web3-core": "1.0.0-beta.28",
"web3-eth": "1.0.0-beta.28",
"web3-eth-personal": "1.0.0-beta.28",
"web3-net": "1.0.0-beta.28",
"web3-shh": "1.0.0-beta.28",
"web3-utils": "1.0.0-beta.28"
"web3-bzz": "1.0.0-beta.29",
"web3-core": "1.0.0-beta.29",
"web3-eth": "1.0.0-beta.29",
"web3-eth-personal": "1.0.0-beta.29",
"web3-net": "1.0.0-beta.29",
"web3-shh": "1.0.0-beta.29",
"web3-utils": "1.0.0-beta.29"
}
};
}, {}], "BN": [function (require, module, exports) {
Expand Down
2 changes: 1 addition & 1 deletion dist/web3.min.js

Large diffs are not rendered by default.

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

.. code-block:: javascript

web3.eth.getId()
web3.eth.net.getId()
.then(console.log);
> 1

Expand Down
14 changes: 7 additions & 7 deletions docs/_build/html/_sources/web3-eth-accounts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ web3.eth.accounts

The ``web3.eth.accounts`` contains functions to generate Ethereum accounts and sign transactions and data.

To use this package standalone use:
.. note:: This package has NOT been audited and might potentially be unsafe. Take precautions to clear memory properly, store the private keys safely, and test transaction receiving and sending functionality properly before using in production!

To use this package standalone use:


.. code-block:: javascript
Expand Down Expand Up @@ -39,7 +40,7 @@ Generates an account object with private key and public key.
Parameters
----------

1. ``entropy`` - ``String`` (optional): A random strong to increase entropy. If given it should be at least 32 characters. If none is given a random string will be generated using :ref:`randomhex <randomhex>`.
1. ``entropy`` - ``String`` (optional): A random string to increase entropy. If given it should be at least 32 characters. If none is given a random string will be generated using :ref:`randomhex <randomhex>`.

.. _eth-accounts-create-return:

Expand Down Expand Up @@ -159,8 +160,8 @@ Parameters
- ``to`` - ``String``: (optional) The recevier of the transaction, can be empty when deploying a contract.
- ``data`` - ``String``: (optional) The call data of the transaction, can be empty for simple value transfers.
- ``value`` - ``String``: (optional) The value of the transaction in wei.
- ``gas`` - ``String``: The gas provided by the transaction.
- ``gasPrice`` - ``String``: (optional) The gas price set by this transaction, if empty, it will use :ref:`web3.eth.gasPrice() <eth-gasprice>`
- ``gas`` - ``String``: The gas provided by the transaction.
2. ``privateKey`` - ``String``: The private key to sign with.
3. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.

Expand All @@ -169,14 +170,13 @@ Parameters
Returns
-------

``Promise|Object`` returning ``Object``: The signed data RLP encoded transaction, or if ``returnSignature`` is ``true`` the signature values as follows:
``Promise`` returning ``Object``: The signed data RLP encoded transaction, or if ``returnSignature`` is ``true`` the signature values as follows:
- ``messageHash`` - ``String``: The hash of the given message.
- ``r`` - ``String``: First 32 bytes of the signature
- ``s`` - ``String``: Next 32 bytes of the signature
- ``v`` - ``String``: Recovery value + 27
- ``rawTransaction`` - ``String``: The RLP encoded transaction, ready to be send using :ref:`web3.eth.sendSignedTransaction <eth-sendsignedtransaction>`.

.. note:: If ``nonce``, ``chainId``, ``gas`` and ``gasPrice`` is given, it returns the signed transaction *directly* as ``Object``.

-------
Example
Expand All @@ -198,7 +198,6 @@ Example
rawTransaction: '0xf869808504e3b29200831e848094f0109fc8df283027b6285cc889f5aa624eac1f55843b9aca008025a0c9cf86333bcb065d140032ecaab5d9281bde80f21b9687b3e94161de42d51895a0727a108a0b8d101465414033c3f705a9c7b826e596766046ee1183dbc8aeaa68'
}

// if nonce, chainId, gas and gasPrice is given it returns synchronous
web3.eth.accounts.signTransaction({
to: '0xF0109fC8DF283027b6285cc889F5aA624EaC1F55',
value: '1000000000',
Expand All @@ -207,9 +206,10 @@ Example
nonce: 0,
chainId: 1
}, '0x4c0883a69102937d6231471b5dbb6204fe5129617082792ae468d01a3f362318')
.then(console.log);
> {
messageHash: '0x6893a6ee8df79b0f5d64a180cd1ef35d030f3e296a5361cf04d02ce720d32ec5',
r: '0x09ebb6ca057a0535d6186462bc0b465b561c94a295bdb0621fc19208ab149a9c',
r: '0x9ebb6ca057a0535d6186462bc0b465b561c94a295bdb0621fc19208ab149a9c',
s: '0x440ffd775ce91a833ab410777204d5341a6f9fa91216a6f3ee2c051fea6a0428',
v: '0x25',
rawTransaction: '0xf86a8086d55698372431831e848094f0109fc8df283027b6285cc889f5aa624eac1f55843b9aca008025a009ebb6ca057a0535d6186462bc0b465b561c94a295bdb0621fc19208ab149a9ca0440ffd775ce91a833ab410777204d5341a6f9fa91216a6f3ee2c051fea6a0428'
Expand Down
4 changes: 3 additions & 1 deletion docs/_build/html/_sources/web3-eth-contract.txt
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,7 @@ Parameters
* ``from`` - ``String``: The address the transaction should be sent from.
* ``gasPrice`` - ``String`` (optional): The gas price in wei to use for this transaction.
* ``gas`` - ``Number`` (optional): The maximum gas provided for this transaction (gas limit).
* ``value`` - ``Number|String|BN|BigNumber``(optional): The value transferred for the transaction in wei.
2. ``callback`` - ``Function`` (optional): This callback will be fired first with the "transactionHash", or with an error object as the first argument.

-------
Expand Down Expand Up @@ -606,7 +607,8 @@ Example
},
"MyOtherEvent": {
...
}
},
"MyMultipleEvent":[{...}, {...}] // If there are multiple of the same event, they will be in an array
}
}
})
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/web3-eth-net.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Returns
- ``"main"`` for main network
- ``"morden"`` for the morden test network
- ``"ropsten"`` for the morden test network
- ``"private"`` for un deteacable networks.
- ``"private"`` for undetectable networks.


-------
Expand Down
46 changes: 43 additions & 3 deletions docs/_build/html/_sources/web3-eth-personal.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Parameters
Returns
-------

``Promise`` returns ``Boolean``: ``true`` if the account was created, otherwise ``false``.
``Promise`` returns ``String``: The address of the newly created account.

-------
Example
Expand All @@ -70,7 +70,7 @@ Example

web3.eth.personal.newAccount('!@superpassword')
.then(console.log);
> true
> '0x1234567891011121314151617181920212223456'

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

Expand Down Expand Up @@ -124,6 +124,46 @@ Example

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


ecRecover
=====================

.. code-block:: javascript

web3.eth.personal.ecRecover(dataThatWasSigned, signature [, callback])

Recovers the account that signed the data.

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


1. ``String`` - Data that was signed. If String it will be converted using :ref:`web3.utils.utf8ToHex <utils-utf8tohex>`.
2. ``String`` - The signature.
3. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.


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


``Promise`` returns ``String`` - The account.


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


.. code-block:: javascript

web3.eth.personal.ecRecover("Hello world", "0x30755ed65396facf86c53e6217c52b4daebe72aa4941d89635409de4c9c7f9466d4e9aaec7977f05e923889b33c0d0dd27d7226b6e6f56ce737465c5cfd04be400").then(console.log);
> "0x11f4d0A3c12e86B4b5F39B213F7E19D048276DAe"

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

// TODO

getAccounts, unlockAccount, lockAccount, sendTransaction, ecRecover
getAccounts, unlockAccount, lockAccount, sendTransaction
18 changes: 10 additions & 8 deletions docs/_build/html/_sources/web3-eth-subscribe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Returns
- ``subscription.arguments``: The subscription arguments, used when re-subscribing.
- ``on("data")`` returns ``Object``: Fires on each incoming log with the log object as argument.
- ``on("changed")`` returns ``Object``: Fires on each log which was removed from the blockchain. The log will have the additional property ``"removed: true"``.
- ``on("error")`` returns ``Object``: Fires when an error in the subscription occours.
- ``on("error")`` returns ``Object``: Fires when an error in the subscription occurs.

----------------
Notification returns
Expand Down Expand Up @@ -133,7 +133,7 @@ Returns
``EventEmitter``: An :ref:`subscription instance <eth-subscription-return>` as an event emitter with the following events:

- ``"data"`` returns ``Object``: Fires on each incoming pending transaction.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occours.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occurs.

For the structure of the returned object see :ref:`web3.eth.getTransaction() return values <eth-gettransaction-return>`.

Expand All @@ -153,9 +153,10 @@ Example

var subscription = web3.eth.subscribe('pendingTransactions', function(error, result){
if (!error)
console.log(transaction);
console.log(result);
})
.on("data", function(transaction){
console.log(transaction);
});

// unsubscribes the subscription
Expand Down Expand Up @@ -191,7 +192,7 @@ Returns
``EventEmitter``: An :ref:`subscription instance <eth-subscription-return>` as an event emitter with the following events:

- ``"data"`` returns ``Object``: Fires on each incoming block header.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occours.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occurs.

The structure of a returned block header is as follows:

Expand Down Expand Up @@ -264,7 +265,7 @@ Returns

- ``"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``.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occours.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occurs.

For the structure of a returned event ``Object`` see :ref:`web3.eth.isSyncing return values <eth-issyncing-return>`.

Expand Down Expand Up @@ -322,7 +323,7 @@ Parameters
1. ``"logs"`` - ``String``, the type of the subscription.
2. ``Object`` - The subscription options
- ``fromBlock`` - ``Number``: The number of the earliest block. By default ``null``.
- ``address`` - ``String``: An address or a list of addresses to only get logs from particular account(s).
- ``address`` - ``String|Array``: An address or a list of addresses to only get logs from particular account(s).
- ``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. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second. Will be called for each incoming subscription.

Expand All @@ -334,7 +335,7 @@ Returns

- ``"data"`` returns ``Object``: Fires on each incoming log with the log object as argument.
- ``"changed"`` returns ``Object``: Fires on each log which was removed from the blockchain. The log will have the additional property ``"removed: true"``.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occours.
- ``"error"`` returns ``Object``: Fires when an error in the subscription occurs.

For the structure of a returned event ``Object`` see :ref:`web3.eth.getPastEvents return values <eth-getpastlogs-return>`.

Expand All @@ -357,9 +358,10 @@ Example
topics: ['0x12345...']
}, function(error, result){
if (!error)
console.log(log);
console.log(result);
})
.on("data", function(log){
console.log(log);
})
.on("changed", function(log){
});
Expand Down
18 changes: 9 additions & 9 deletions docs/_build/html/_sources/web3-eth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -633,7 +633,7 @@ Example

.. code-block:: javascript

web3.eth.getBlock(3150);
web3.eth.getBlock(3150)
.then(console.log);

> {
Expand Down Expand Up @@ -1105,7 +1105,7 @@ Example
// console.log(serializedTx.toString('hex'));
// 0xf889808609184e72a00082271094000000000000000000000000000000000000000080a47f74657374320000000000000000000000000000000000000000000000000000006000571ca08a8bbf888cfa37bbf0bb965423625641fc956967b81d12e23709cead01446075a01ce999b56a8a88504be365442ea61239198e23d1fce7d00fcfc5cd3b44b7215f

web3.eth.sendSignedTransaction(serializedTx.toString('hex'))
web3.eth.sendSignedTransaction('0x' + serializedTx.toString('hex'))
.on('receipt', console.log);

> // see eth.getTransactionReceipt() for details
Expand Down Expand Up @@ -1323,7 +1323,7 @@ Parameters
1. ``Object`` - The filter options as follows:
- ``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"``.
- ``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"``.
- ``address`` - ``String``: An address or a list of addresses to only get logs from particular account(s).
- ``address`` - ``String|Array``: An address or a list of addresses to only get logs from particular account(s).
- ``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']]``


Expand Down Expand Up @@ -1401,7 +1401,7 @@ Example

.. code-block:: javascript

web3.eth.getCompilers();
web3.eth.getCompilers()
.then(console.log);
> ["lll", "solidity", "serpent"]

Expand Down Expand Up @@ -1444,7 +1444,7 @@ Example
" }\n" +
"}\n";

web3.eth.compile.solidity(source);
web3.eth.compile.solidity(source)
.then(console.log);

> {
Expand Down Expand Up @@ -1521,7 +1521,7 @@ Example

var source = "...";

web3.eth.compile.lll(source);
web3.eth.compile.lll(source)
.then(console.log);
> "0x603880600c6000396000f3006001600060e060020a600035048063c6888fa114601857005b6021600435602b565b8060005260206000f35b600081600702905091905056"

Expand Down Expand Up @@ -1556,7 +1556,7 @@ Returns

var source = "...";

var code = web3.eth.compile.serpent(source);
var code = web3.eth.compile.serpent(source)
.then(console.log);
> "0x603880600c6000396000f3006001600060e060020a600035048063c6888fa114601857005b6021600435602b565b8060005260206000f35b600081600702905091905056"

Expand Down Expand Up @@ -1596,7 +1596,7 @@ Example

.. code-block:: javascript

web3.eth.getWork();
web3.eth.getWork()
.then(console.log);
> [
"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
Expand Down Expand Up @@ -1642,7 +1642,7 @@ Example
"0x0000000000000001",
"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"0xD1FE5700000000000000000000000000D1FE5700000000000000000000000000"
]);
])
.then(console.log);
> true

Expand Down
Loading

0 comments on commit dd55daa

Please sign in to comment.