Skip to content

Commit

Permalink
Merge 8d017d3 into 67ea9d0
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanio committed Mar 31, 2020
2 parents 67ea9d0 + 8d017d3 commit c3893df
Show file tree
Hide file tree
Showing 22 changed files with 186 additions and 24 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

# web3.js - Ethereum JavaScript API

[![Gitter][gitter-image]][gitter-url] [![StackExchange][stackexchange-image]][stackexchange-url] [![NPM Package][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] [![Coverage Status][coveralls-image]][coveralls-url]
[![Lerna][lerna-image]][lerna-url]
[![Gitter][gitter-image]][gitter-url] [![StackExchange][stackexchange-image]][stackexchange-url] [![NPM Package][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Lerna][lerna-image]][lerna-url]

This is the Ethereum [JavaScript API][docs]
which connects to the [Generic JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) spec.
Expand Down Expand Up @@ -167,10 +166,8 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md)
[npm-url]: https://npmjs.org/package/web3
[travis-image]: https://travis-ci.org/ethereum/web3.js.svg?branch=1.x
[travis-url]: https://travis-ci.org/ethereum/web3.js?branch=1.x
[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg
[deps-url]: https://david-dm.org/ethereum/web3.js/1.x
[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/#info=devDependencies
[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x?type=dev
[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
Expand Down
8 changes: 8 additions & 0 deletions packages/web3-bzz/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-bzz

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the swarm package.
Expand Down Expand Up @@ -39,3 +41,9 @@ All the typescript typings are placed in the types folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-core-helpers/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-core-helpers

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

Helper functions used in [web3.js][repo] packages.
Expand All @@ -26,7 +28,13 @@ helpers.errors;

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-core-method/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-core-method

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

The Method package used within most [web3.js][repo] packages.
Expand Down Expand Up @@ -43,7 +45,13 @@ myCoolLib.sendTransaction({...}, function(){ ... });

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
[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
9 changes: 8 additions & 1 deletion packages/web3-core-promievent/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-core-promievent

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the PromiEvent package is used to return a EventEmitter mixed with a Promise to allow multiple final states as well as chaining.
Expand Down Expand Up @@ -52,5 +54,10 @@ myFunc()

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js

[npm-image]: https://img.shields.io/npm/dm/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

9 changes: 8 additions & 1 deletion packages/web3-core-requestmanager/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-core-requestmanager

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

The requestmanager package is used by most [web3.js][repo] packages.
Expand Down Expand Up @@ -38,5 +40,10 @@ var requestManager = new Web3RequestManager(new Web3WsProvider('ws://localhost:8

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js

[npm-image]: https://img.shields.io/npm/dm/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

9 changes: 8 additions & 1 deletion packages/web3-core-subscriptions/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 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]

This is a sub package of [web3.js][repo]

The subscriptions package used within some [web3.js][repo] packages.
Expand Down Expand Up @@ -54,5 +56,10 @@ myCoolLib.subscribe('newBlockHeaders', function(){ ... });

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js

[npm-image]: https://img.shields.io/npm/dm/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

10 changes: 9 additions & 1 deletion packages/web3-core/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-core

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

The core package contains core functions for [web3.js][repo] packages.
Expand Down Expand Up @@ -40,7 +42,13 @@ CoolLib.extend();

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-eth-abi/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-eth-abi

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the abi package to be used in the `web3-eth` package.
Expand Down Expand Up @@ -36,7 +38,13 @@ Web3EthAbi.encodeFunctionSignature('myMethod(uint256,string)');

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
8 changes: 8 additions & 0 deletions packages/web3-eth-accounts/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-eth-accounts

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the accounts package to be used in the `web3-eth` package.
Expand Down Expand Up @@ -47,3 +49,9 @@ All the typescript typings are placed in the types folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-eth-contract/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-eth-contract

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the contract package to be used in the `web3-eth` package.
Expand Down Expand Up @@ -45,7 +47,13 @@ contract.methods.somFunc().send({from: ....})

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-eth-ens/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-eth-ens

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the contract package to be used in the `web3-eth` package.
Expand Down Expand Up @@ -37,7 +39,13 @@ ens.getAddress('ethereum.eth').then(function(result) {

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-eth-iban/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-eth-iban

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the IBAN package to be used in the `web3-eth` package.
Expand Down Expand Up @@ -39,7 +41,13 @@ iban.toAddress() > '0xa94f5374Fce5edBC8E2a8697C15331677e6EbF0B';

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-eth-personal/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-eth-personal

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the personal package to be used in the `web3-eth` package.
Expand Down Expand Up @@ -35,7 +37,13 @@ var personal = new Web3EthPersonal('ws://localhost:8546');

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
12 changes: 10 additions & 2 deletions packages/web3-eth/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-eth

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the Eth package to be used [web3.js][repo].
Expand Down Expand Up @@ -35,7 +37,13 @@ var eth = new Web3Eth('ws://localhost:8546');

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[repo]: https://github.com/ethereum/web3-eth.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-net/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-net

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is the net package to be used in other web3.js packages.
Expand Down Expand Up @@ -35,7 +37,13 @@ var net = new Web3Net('ws://localhost:8546');

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
10 changes: 9 additions & 1 deletion packages/web3-providers-http/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-providers-http

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

_This is a sub package of [web3.js][repo]_

This is a HTTP provider for [web3.js][repo].
Expand Down Expand Up @@ -44,7 +46,13 @@ var provider = new Web3HttpProvider('http://localhost:8545', options);

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[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
10 changes: 9 additions & 1 deletion packages/web3-providers-ipc/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# web3-providers-ipc

[![NPM Package][npm-image]][npm-url] [![Dependency Status][deps-image]][deps-url] [![Dev Dependency Status][deps-dev-image]][deps-dev-url]

This is a sub package of [web3.js][repo]

This is a IPC provider for [web3.js][repo].
Expand Down Expand Up @@ -36,7 +38,13 @@ var ipc = new Web3IpcProvider('/Users/me/Library/Ethereum/geth.ipc', net);

## Types

All the typescript typings are placed in the types folder.
All the TypeScript typings are placed in the `types` folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js
[npm-image]: https://img.shields.io/npm/dm/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
Loading

0 comments on commit c3893df

Please sign in to comment.