diff --git a/README.md b/README.md index f9b1c008421..344f84e2a10 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ # web3.js - Ethereum JavaScript API -[![Discord][discord-image]][discord-url] [![StackExchange][stackexchange-image]][stackexchange-url] [![NPM Package Version][npm-image-version]][npm-url] [![NPM Package Downloads][npm-image-downloads]][npm-url] [![Build Status][actions-image]][actions-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Lerna][lerna-image]][lerna-url] [![Netlify Status][netlify-image]][netlify-url] [![GitPOAP Badge][gitpoap-image]][gitpoap-url] +[![NPM Package Downloads][npm-image-downloads]][npm-url] [![cdnhits][cdnhits-image]][cdnhits-url] [![Discord][discord-image]][discord-url] [![StackExchange][stackexchange-image]][stackexchange-url] [![NPM Package Version][npm-image-version]][npm-url] [![Build Status][actions-image]][actions-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Lerna][lerna-image]][lerna-url] [![Netlify Status][netlify-image]][netlify-url] [![GitPOAP Badge][gitpoap-image]][gitpoap-url] + +##### [Web3.js 4.x][4x-release] has been released. Checkout 4.x [API documentation and migration guide][4xdoc] for testing, early feedback and contributions. This is the Ethereum [JavaScript API][docs] which connects to the [Generic JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) spec. @@ -290,10 +292,6 @@ This project adheres to the [Release Guidelines](./REVIEW.md). [npm-url]: https://npmjs.org/package/web3 [actions-image]: https://github.com/ethereum/web3.js/workflows/Build/badge.svg [actions-url]: https://github.com/ethereum/web3.js/actions -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev -[dep-dev-image]: https://david-dm.org/ethereum/web3.js/dev-status.svg -[dep-dev-url]: https://david-dm.org/ethereum/web3.js#info=devDependencies [coveralls-image]: https://coveralls.io/repos/ethereum/web3.js/badge.svg?branch=1.x [coveralls-url]: https://coveralls.io/r/ethereum/web3.js?branch=1.x [waffle-image]: https://badge.waffle.io/ethereum/web3.js.svg?label=ready&title=Ready @@ -308,6 +306,10 @@ This project adheres to the [Release Guidelines](./REVIEW.md). [stackexchange-url]: https://ethereum.stackexchange.com/questions/tagged/web3js [gitpoap-image]: https://public-api.gitpoap.io/v1/repo/ChainSafe/web3.js/badge [gitpoap-url]: https://www.gitpoap.io/gh/ChainSafe/web3.js +[4x-release]: https://github.com/ChainSafe/web3.js/releases/tag/v4.0.0-alpha.0 +[4xdoc]: https://docs.web3js.org/ +[cdnhits-image]: https://data.jsdelivr.com/v1/package/npm/web3/badge +[cdnhits-url]: https://www.jsdelivr.com/package/npm/web3 ## Semantic versioning diff --git a/docs/index.rst b/docs/index.rst index b1f3bbff733..0848d34ddba 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,8 @@ web3.js is a collection of libraries that allow you to interact with a local or The following documentation will guide you through :ref:`installing and running web3.js ` as well as providing an :ref:`API reference documentation <#id1>` with examples. +.. note:: `Web3.js 4.x `_ has been released. Checkout 4.x `API documentation and migration guide `_ for testing, early feedback and contributions. + Contents: :ref:`Keyword Index `, :ref:`Search Page ` diff --git a/packages/web3-bzz/README.md b/packages/web3-bzz/README.md index 383dfddc7c3..904f4f0bb66 100644 --- a/packages/web3-bzz/README.md +++ b/packages/web3-bzz/README.md @@ -1,6 +1,6 @@ # web3-bzz -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -32,7 +32,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-bzz.svg [npm-url]: https://npmjs.org/package/web3-bzz -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-bzz -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-bzz -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-bzz -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-bzz + diff --git a/packages/web3-core-helpers/README.md b/packages/web3-core-helpers/README.md index 777ba872783..8ae21c1fa99 100644 --- a/packages/web3-core-helpers/README.md +++ b/packages/web3-core-helpers/README.md @@ -1,6 +1,6 @@ # web3-core-helpers -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo] with useful helper functions. @@ -32,7 +32,3 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-core-helpers.svg [npm-url]: https://npmjs.org/package/web3-core-helpers -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-helpers -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-helpers -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-helpers -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-helpers \ No newline at end of file diff --git a/packages/web3-core-method/README.md b/packages/web3-core-method/README.md index c7394b92fad..05d1b6c01bb 100644 --- a/packages/web3-core-method/README.md +++ b/packages/web3-core-method/README.md @@ -1,6 +1,6 @@ # web3-core-method -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -40,7 +40,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-core-method.svg [npm-url]: https://npmjs.org/package/web3-core-method -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-method -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-method -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-method -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-method + diff --git a/packages/web3-core-promievent/README.md b/packages/web3-core-promievent/README.md index 0f43a02bc4e..7454fa5e969 100644 --- a/packages/web3-core-promievent/README.md +++ b/packages/web3-core-promievent/README.md @@ -1,6 +1,6 @@ # web3-core-promievent -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -42,7 +42,4 @@ myFunc() [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-core-promievent.svg [npm-url]: https://npmjs.org/package/web3-core-promievent -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-promievent -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-promievent -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-promievent -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-promievent + diff --git a/packages/web3-core-requestmanager/README.md b/packages/web3-core-requestmanager/README.md index 7ca0d9288e9..9f88751821e 100644 --- a/packages/web3-core-requestmanager/README.md +++ b/packages/web3-core-requestmanager/README.md @@ -1,6 +1,6 @@ # web3-core-requestmanager -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -29,8 +29,5 @@ const requestManager = new Web3RequestManager(new Web3WsProvider('ws://localhost [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-core-requestmanager.svg [npm-url]: https://npmjs.org/package/web3-core-requestmanager -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-requestmanager -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-requestmanager -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-requestmanager -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-requestmanager + diff --git a/packages/web3-core-subscriptions/README.md b/packages/web3-core-subscriptions/README.md index c41b3ded74f..97fc335551b 100644 --- a/packages/web3-core-subscriptions/README.md +++ b/packages/web3-core-subscriptions/README.md @@ -1,6 +1,6 @@ # web3-core-subscriptions -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]tus][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo] @@ -45,8 +45,5 @@ myCoolLib.subscribe('newBlockHeaders', function(){ ... }); [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-core-subscriptions.svg [npm-url]: https://npmjs.org/package/web3-core-subscriptions -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core-subscriptions -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core-subscriptions -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core-subscriptions -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core-subscriptions + diff --git a/packages/web3-core/README.md b/packages/web3-core/README.md index 7b1269b67e9..b1be332d9fe 100644 --- a/packages/web3-core/README.md +++ b/packages/web3-core/README.md @@ -1,6 +1,6 @@ # web3-core -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -42,7 +42,3 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-core.svg [npm-url]: https://npmjs.org/package/web3-core -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-core -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-core -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-core -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-core diff --git a/packages/web3-eth-abi/README.md b/packages/web3-eth-abi/README.md index 46deccdc39b..0b9b90d80ec 100644 --- a/packages/web3-eth-abi/README.md +++ b/packages/web3-eth-abi/README.md @@ -1,6 +1,6 @@ # web3-eth-abi -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -33,7 +33,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-eth-abi.svg [npm-url]: https://npmjs.org/package/web3-eth-abi -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-abi -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-abi -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-abi -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-abi + diff --git a/packages/web3-eth-accounts/README.md b/packages/web3-eth-accounts/README.md index 6abe8e4cfa1..7727d3dcad3 100644 --- a/packages/web3-eth-accounts/README.md +++ b/packages/web3-eth-accounts/README.md @@ -1,6 +1,6 @@ # web3-eth-accounts -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -40,7 +40,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-eth-accounts.svg [npm-url]: https://npmjs.org/package/web3-eth-accounts -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-accounts -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-accounts -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-accounts -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-accounts + diff --git a/packages/web3-eth-contract/README.md b/packages/web3-eth-contract/README.md index c738ac33254..8ee1f535ef2 100644 --- a/packages/web3-eth-contract/README.md +++ b/packages/web3-eth-contract/README.md @@ -1,6 +1,6 @@ # web3-eth-contract -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -42,7 +42,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-eth-contract.svg [npm-url]: https://npmjs.org/package/web3-eth-contract -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-contract -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-contract -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-contract -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-contract + diff --git a/packages/web3-eth-ens/README.md b/packages/web3-eth-ens/README.md index b96d2b458b4..1b22f38e699 100644 --- a/packages/web3-eth-ens/README.md +++ b/packages/web3-eth-ens/README.md @@ -1,6 +1,6 @@ # web3-eth-ens -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -35,7 +35,3 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-eth-ens.svg [npm-url]: https://npmjs.org/package/web3-eth-ens -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-ens -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-ens -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-ens -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-ens \ No newline at end of file diff --git a/packages/web3-eth-iban/README.md b/packages/web3-eth-iban/README.md index 79dfdcca83d..d540ab07ccc 100644 --- a/packages/web3-eth-iban/README.md +++ b/packages/web3-eth-iban/README.md @@ -1,6 +1,6 @@ # web3-eth-iban -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub package of [web3.js][repo] @@ -36,7 +36,3 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-eth-iban.svg [npm-url]: https://npmjs.org/package/web3-eth-iban -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-iban -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-iban -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-iban -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=web3-eth-iban diff --git a/packages/web3-eth-personal/README.md b/packages/web3-eth-personal/README.md index 1ff2a56a424..855e8e2f758 100644 --- a/packages/web3-eth-personal/README.md +++ b/packages/web3-eth-personal/README.md @@ -1,6 +1,6 @@ # web3-eth-personal -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -32,7 +32,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-eth-personal.svg [npm-url]: https://npmjs.org/package/web3-eth-personal -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth-personal -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth-personal -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth-personal -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth-personal + diff --git a/packages/web3-eth/README.md b/packages/web3-eth/README.md index c229af4e846..6d8607f0a26 100644 --- a/packages/web3-eth/README.md +++ b/packages/web3-eth/README.md @@ -1,6 +1,6 @@ # web3-eth -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -32,7 +32,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3-eth.js [npm-image]: https://img.shields.io/npm/v/web3-eth.svg [npm-url]: https://npmjs.org/package/web3-eth -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-eth -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-eth -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-eth -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-eth + diff --git a/packages/web3-net/README.md b/packages/web3-net/README.md index 22d4dec312f..9e38edc38f6 100644 --- a/packages/web3-net/README.md +++ b/packages/web3-net/README.md @@ -1,6 +1,6 @@ # web3-net -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -32,7 +32,3 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-net.svg [npm-url]: https://npmjs.org/package/web3-net -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-net -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-net -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-net -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-net diff --git a/packages/web3-providers-http/README.md b/packages/web3-providers-http/README.md index 0262087f305..7b0c21b02cd 100644 --- a/packages/web3-providers-http/README.md +++ b/packages/web3-providers-http/README.md @@ -1,6 +1,6 @@ # web3-providers-http -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a HTTP provider sub-package for [web3.js][repo]. @@ -39,7 +39,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/dm/web3-providers-http.svg [npm-url]: https://npmjs.org/package/web3-providers-http -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-http -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-http -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-providers-http -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-providers-http + diff --git a/packages/web3-providers-ipc/README.md b/packages/web3-providers-ipc/README.md index 23b7ddffce4..2181d142612 100644 --- a/packages/web3-providers-ipc/README.md +++ b/packages/web3-providers-ipc/README.md @@ -1,7 +1,6 @@ # web3-providers-ipc -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] - +[![NPM Package][npm-image]][npm-url] This is an IPC provider sub-package for [web3.js][repo]. Please read the [documentation][docs] for more. @@ -31,7 +30,3 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-providers-ipc.svg [npm-url]: https://npmjs.org/package/web3-providers-ipc -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-ipc -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-ipc -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-providers-ipc -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-providers-ipc diff --git a/packages/web3-providers-ws/README.md b/packages/web3-providers-ws/README.md index cac2c7fd470..3fae66713bb 100644 --- a/packages/web3-providers-ws/README.md +++ b/packages/web3-providers-ws/README.md @@ -1,6 +1,6 @@ # web3-providers-ws -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a websocket provider sub-package for [web3.js][repo]. @@ -59,7 +59,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-providers-ws.svg [npm-url]: https://npmjs.org/package/web3-providers-ws -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-providers-ws -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-providers-ws -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-providers-ws -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-providers-ws + diff --git a/packages/web3-shh/README.md b/packages/web3-shh/README.md index b940a8dc9a9..9b8b255f562 100644 --- a/packages/web3-shh/README.md +++ b/packages/web3-shh/README.md @@ -1,6 +1,6 @@ # web3-shh -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo] @@ -32,7 +32,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-shh.svg [npm-url]: https://npmjs.org/package/web3-shh -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-shh -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-shh -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-shh -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-shh + diff --git a/packages/web3-utils/README.md b/packages/web3-utils/README.md index d541723f10e..51a6c6b950d 100644 --- a/packages/web3-utils/README.md +++ b/packages/web3-utils/README.md @@ -1,6 +1,6 @@ # web3-utils -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +[![NPM Package][npm-image]][npm-url] This is a sub-package of [web3.js][repo]. @@ -37,7 +37,4 @@ All the TypeScript typings are placed in the `types` folder. [repo]: https://github.com/ethereum/web3.js [npm-image]: https://img.shields.io/npm/v/web3-utils.svg [npm-url]: https://npmjs.org/package/web3-utils -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3-utils -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3-utils -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3-utils -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3-utils + diff --git a/packages/web3/README.md b/packages/web3/README.md index 613671f037e..287a403405d 100644 --- a/packages/web3/README.md +++ b/packages/web3/README.md @@ -1,6 +1,8 @@ # web3 -[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] +##### [Web3.js 4.x][4x-release] has been released. Checkout 4.x [API documentation and migration guide][4xdoc] for testing, early feedback and contributions. + +[![NPM Package][npm-image]][npm-url] This is the main package of [web3.js][repo]. @@ -23,7 +25,5 @@ All the TypeScript typings are placed in the `types` folder. [repo-readme]: https://github.com/ethereum/web3.js/blob/1.x/README.md [npm-image]: https://img.shields.io/npm/v/web3.svg [npm-url]: https://npmjs.org/package/web3 -[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg?path=packages/web3 -[deps-url]: https://david-dm.org/ethereum/web3.js/1.x?path=packages/web3 -[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg?path=packages/web3 -[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev&path=packages/web3 \ No newline at end of file +[4x-release]: https://github.com/ChainSafe/web3.js/releases/tag/v4.0.0-alpha.0 +[4xdoc]: https://docs.web3js.org/ \ No newline at end of file diff --git a/packages/web3/package.json b/packages/web3/package.json index b7298e1a007..2180c1c8fd5 100644 --- a/packages/web3/package.json +++ b/packages/web3/package.json @@ -22,7 +22,7 @@ "scripts": { "compile": "tsc -b tsconfig.json", "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types", - "postinstall": "echo \"WARNING: the web3-shh and web3-bzz api will be deprecated in the next version\"" + "postinstall": "echo \"Web3.js 4.x alpha has been released for early testing and feedback. Checkout doc at https://docs.web3js.org/ \"" }, "authors": [ {