Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate shh and bzz #3909

Merged
merged 20 commits into from
Mar 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,3 +371,11 @@ Released with 1.0.0-beta.37 code base.
- Bump `elliptic` from `6.5.3` to `6.5.4` for `web3-bzz` (#3940)
- Bump `elliptic` from `6.5.3` to `6.5.4` for `web3-core-requestmanager` (#3945)
- Rewrite `web3-eth-iban` in ES6 (#3955)

## [Unreleased]

## [3.0.0]

### Removed

- removed bzz and shh api
spacesailor24 marked this conversation as resolved.
Show resolved Hide resolved
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ let web3 = new Web3('ws://localhost:8546');
console.log(web3);
> {
eth: ... ,
shh: ... ,
utils: ...,
...
}
Expand Down
2 changes: 0 additions & 2 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Getting Started
The web3.js library is a collection of modules that contain functionality for the ethereum ecosystem.

- ``web3-eth`` is for the ethereum blockchain and smart contracts.
- ``web3-shh`` is for the whisper protocol, to communicate p2p and broadcast.
- ``web3-bzz`` is for the swarm protocol, the decentralized file storage.
- ``web3-utils`` contains useful helper functions for Dapp developers.


Expand Down
15 changes: 1 addition & 14 deletions docs/include_package-core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ setProvider

web3.setProvider(myProvider)
web3.eth.setProvider(myProvider)
web3.shh.setProvider(myProvider)
web3.bzz.setProvider(myProvider)
...

Will change the provider for its module.

.. note::
When called on the umbrella package ``web3`` it will also set the provider for all sub modules ``web3.eth``, ``web3.shh``, etc. EXCEPT ``web3.bzz`` which needs a separate provider at all times.
When called on the umbrella package ``web3`` it will also set the provider for all sub modules

----------
Parameters
Expand Down Expand Up @@ -72,8 +70,6 @@ providers

web3.providers
web3.eth.providers
web3.shh.providers
web3.bzz.providers
...

Contains the current available :ref:`providers <web3-providers>`.
Expand Down Expand Up @@ -192,8 +188,6 @@ givenProvider

web3.givenProvider
web3.eth.givenProvider
web3.shh.givenProvider
web3.bzz.givenProvider
...

When using web3.js in an Ethereum compatible browser, it will set with the current native provider by that browser.
Expand Down Expand Up @@ -223,8 +217,6 @@ currentProvider

web3.currentProvider
web3.eth.currentProvider
web3.shh.currentProvider
web3.bzz.currentProvider
...

Will return the current provider, otherwise ``null``.
Expand Down Expand Up @@ -254,8 +246,6 @@ BatchRequest

new web3.BatchRequest()
new web3.eth.BatchRequest()
new web3.shh.BatchRequest()
new web3.bzz.BatchRequest()

Class to create and execute batch requests.

Expand Down Expand Up @@ -297,8 +287,6 @@ extend

web3.extend(methods)
web3.eth.extend(methods)
web3.shh.extend(methods)
web3.bzz.extend(methods)
...

Allows extending the web3 modules.
Expand Down Expand Up @@ -362,7 +350,6 @@ Example
},
directCall: function(){},
eth: Eth {...},
bzz: Bzz {...},
...
}

Expand Down
6 changes: 0 additions & 6 deletions docs/include_package-net.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ getId
.. code-block:: javascript

web3.eth.net.getId([callback])
web3.bzz.net.getId([callback])
web3.shh.net.getId([callback])

Gets the current network ID.

Expand Down Expand Up @@ -43,8 +41,6 @@ isListening
.. code-block:: javascript

web3.eth.net.isListening([callback])
web3.bzz.net.isListening([callback])
web3.shh.net.isListening([callback])

Checks if the node is listening for peers.

Expand Down Expand Up @@ -78,8 +74,6 @@ getPeerCount
.. code-block:: javascript

web3.eth.net.getPeerCount([callback])
web3.bzz.net.getPeerCount([callback])
web3.shh.net.getPeerCount([callback])

Get the number of peers connected to.

Expand Down
2 changes: 0 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ Contents:
web3-eth-iban
web3-eth-abi
web3-net
web3-bzz
web3-shh
web3-utils
web3-admin

Expand Down
Loading