Skip to content

Commit

Permalink
Merge branch '1.0' into issue/2612
Browse files Browse the repository at this point in the history
  • Loading branch information
nivida committed Apr 1, 2019
2 parents 45b29e2 + 26987f6 commit 6c351d4
Show file tree
Hide file tree
Showing 7 changed files with 147 additions and 67 deletions.
62 changes: 38 additions & 24 deletions docs/web3-eth-ens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,11 @@ Example
web3.eth.ens.registry;
> {
ens: Ens,
contract: Contract,
owner: Function(name),
resolve: Function(name)
resolverContract: Contract | null,
setProvider(provider: provider, net?: net.Socket): boolean,
owner(name: string, callback?: (error: Error, address: string) => void): Promise<string>,
resolver(name: string): Promise<Contract>,
checkNetwork(): Promise<string>,
}
------------------------------------------------------------------------------
Expand Down Expand Up @@ -94,7 +96,7 @@ supportsInterface

.. code-block:: javascript
web3.eth.ens.supportsInterface(ENSName, interfaceId);
web3.eth.ens.supportsInterface(ENSName, interfaceId, [callback]);
Checks if the current resolver does support the desired interface.

Expand All @@ -104,12 +106,13 @@ Parameters

1. ``ENSName`` - ``String``: The Ens name to resolve.
2. ``interfaceId`` - ``String``: A defined ENS interfaceId.
3. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

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

``Boolean`` - Returns true if the given interfaceId is supported by the resolver.
``Promise<boolean>`` - Returns true if the given interfaceId is supported by the resolver.

-------
Example
Expand All @@ -129,7 +132,7 @@ getAddress

.. code-block:: javascript
web3.eth.ens.getAddress(ENSName);
web3.eth.ens.getAddress(ENSName, [callback]);
Resolves an Ens name to an Ethereum address.

Expand All @@ -138,12 +141,13 @@ Parameters
----------

1. ``ENSName`` - ``String``: The Ens name to resolve.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

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

``String`` - The Ethereum address of the given name.
``Promise<string>`` - The Ethereum address of the given name.

-------
Example
Expand All @@ -163,7 +167,7 @@ setAddress

.. code-block:: javascript
web3.eth.ens.setAddress(ENSName, address, options);
web3.eth.ens.setAddress(ENSName, address, options, [callback]);
Sets the address of an Ens name in his resolver.

Expand All @@ -177,6 +181,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).
4. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

Emits an ``AddrChanged`` event.

Expand Down Expand Up @@ -242,7 +247,7 @@ getPubkey

.. code-block:: javascript
web3.eth.ens.getPubkey(ENSName);
web3.eth.ens.getPubkey(ENSName, [callback]);
Returns the X and Y coordinates of the curve point for the public key.

Expand All @@ -251,6 +256,7 @@ Parameters
----------

1. ``ENSName`` - ``String``: The Ens name.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

-------
Returns
Expand Down Expand Up @@ -281,7 +287,7 @@ setPubkey

.. code-block:: javascript
web3.eth.ens.setPubkey(ENSName, x, y, options);
web3.eth.ens.setPubkey(ENSName, x, y, options, [callback]);
Sets the SECP256k1 public key associated with an Ens node

Expand All @@ -296,6 +302,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).
5. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.


Emits an ``PubkeyChanged`` event.
Expand Down Expand Up @@ -364,7 +371,7 @@ getText

.. code-block:: javascript
web3.eth.ens.getText(ENSName, key);
web3.eth.ens.getText(ENSName, key, [callback]);
Returns the text by the given key.

Expand All @@ -373,14 +380,14 @@ Parameters
----------

1. ``ENSName`` - ``String``: The Ens name.
1. ``key`` - ``String``: The key of the array.
2. ``key`` - ``String``: The key of the array.
3. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

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

``String`` - The ENS name.
``String`` - The key.
``Promise<string>``

-------
Example
Expand All @@ -400,7 +407,7 @@ setText

.. code-block:: javascript
web3.eth.ens.setText(ENSName, key, value, options);
web3.eth.ens.setText(ENSName, key, value, options, [callback]);
Sets the content hash associated with an Ens node.

Expand All @@ -415,6 +422,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).
4. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.


Emits an ``TextChanged`` event.
Expand Down Expand Up @@ -483,7 +491,7 @@ getContent

.. code-block:: javascript
web3.eth.ens.getContent(ENSName);
web3.eth.ens.getContent(ENSName, [callback]);
Returns the content hash associated with an Ens node.

Expand All @@ -492,12 +500,13 @@ Parameters
----------

1. ``ENSName`` - ``String``: The Ens name.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

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

``String`` - The content hash associated with an Ens node.
``Promise<string>`` - The content hash associated with an Ens node.

-------
Example
Expand All @@ -517,7 +526,7 @@ setContent

.. code-block:: javascript
web3.eth.ens.setContent(ENSName, hash, options);
web3.eth.ens.setContent(ENSName, hash, options, [callback]);
Sets the content hash associated with an Ens node.

Expand All @@ -531,6 +540,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).
4. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.


Emits an ``ContentChanged`` event.
Expand Down Expand Up @@ -597,7 +607,7 @@ getMultihash

.. code-block:: javascript
web3.eth.ens.getMultihash(ENSName);
web3.eth.ens.getMultihash(ENSName, [callback]);
Returns the multihash associated with an Ens node.

Expand All @@ -606,12 +616,13 @@ Parameters
----------

1. ``ENSName`` - ``String``: The Ens name.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

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

``String`` - The associated multihash.
``Promise<string>`` - The associated multihash.

-------
Example
Expand All @@ -631,7 +642,7 @@ setMultihash

.. code-block:: javascript
web3.eth.ens.setMultihash(ENSName, hash, options);
web3.eth.ens.setMultihash(ENSName, hash, options, [callback]);
Sets the multihash associated with an Ens node.

Expand All @@ -645,6 +656,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).
4. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.


Emits an ``MultihashChanged``event.
Expand Down Expand Up @@ -696,7 +708,7 @@ getContenthash
.. code-block:: javascript
web3.eth.ens.getContenthash(ENSName);
web3.eth.ens.getContenthash(ENSName, [callback]);
Returns the contenthash associated with an Ens node.
Expand All @@ -705,12 +717,13 @@ Parameters
----------
1. ``ENSName`` - ``String``: The Ens name.
2. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.

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

``String`` - The associated contenthash.
``Promise<string>`` - The associated contenthash.

-------
Example
Expand All @@ -730,7 +743,7 @@ setContenthash

.. code-block:: javascript
web3.eth.ens.setContenthash(ENSName, hash, options);
web3.eth.ens.setContenthash(ENSName, hash, options, [callback]);
Sets the contenthash associated with an Ens node.

Expand All @@ -744,6 +757,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).
4. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.


Emits an ``ContenthashChanged``event.
Expand Down
2 changes: 2 additions & 0 deletions packages/web3-eth-accounts/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ export class Wallet {
length: number;
defaultKeyName: string;

[key: number]: Account;

create(numberOfAccounts: number, entropy?: string): Wallet;

add(account: string | AddAccount): AddedAccount;
Expand Down
3 changes: 3 additions & 0 deletions packages/web3-eth-accounts/types/tests/accounts-tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@ accounts.decrypt(
// $ExpectType Wallet
accounts.wallet.create(2);

// $ExpectType Account
accounts.wallet[0];

// $ExpectType Wallet
accounts.wallet.create(2, '54674321§3456764321§345674321§3453647544±±±§±±±!!!43534534534534');

Expand Down
Loading

0 comments on commit 6c351d4

Please sign in to comment.