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

EthereumProvider and the related refactoring #2000

Merged
merged 1,091 commits into from
Jan 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1091 commits
Select commit Hold shift + click to select a range
62ce66a
web3-eth final types changed
joshstevens19 Dec 18, 2018
2d4ade8
web3-eth types
joshstevens19 Dec 18, 2018
967ff3b
use `Transaction` from web3-core
joshstevens19 Dec 18, 2018
1dff51d
web3-eth-contract types
joshstevens19 Dec 18, 2018
19f6feb
import generic types from web3-core
joshstevens19 Dec 18, 2018
de023c2
web3-provider types
joshstevens19 Dec 18, 2018
864c270
web3-utils types
joshstevens19 Dec 18, 2018
95b1e5b
fix PR template wordings
joshstevens19 Dec 18, 2018
254e8da
move dependencies into dev
joshstevens19 Dec 18, 2018
f7a607d
Merge pull request #2133 from joshstevens19/types-final-PR
nivida Dec 18, 2018
e18b49e
errors removed from index.js in core-helpers
Dec 18, 2018
15164c8
Merge branch 'ethereumProvider' of github.com:ethereum/web3.js into e…
Dec 18, 2018
c32847c
run all dtslint tests using `lerna`
joshstevens19 Dec 18, 2018
bc26c50
fix broken test i just seen
joshstevens19 Dec 18, 2018
860d868
code style improved and json-rpc batch possibility added to providers
Dec 18, 2018
33d17a5
codestyle improvements and index.js updated
Dec 18, 2018
86a0344
providers handling updated on all web3 modules
Dec 18, 2018
c8d5af2
ProviderAdapterResolver => ProviderResolver naming fixed
Dec 18, 2018
32acfd0
code style improvements and the EthereumProviderAdapter implemented
Dec 18, 2018
c5c9241
Update README.md
joshstevens19 Dec 18, 2018
c6b700b
Merge pull request #2134 from joshstevens19/run-all-types-tests
nivida Dec 18, 2018
b59eeac
EthereumProviderAdapter renamed to EthereumProvider, validation added…
Dec 19, 2018
ddb5ede
Merge branch 'ethereumProvider' of github.com:ethereum/web3.js into e…
Dec 19, 2018
bc1b0dd
order of resolve() and removeAllListeners() changed in socket providers
Dec 19, 2018
ebfd991
removeAllListeners fixed
Dec 19, 2018
319742a
onOpen => onReady
Dec 19, 2018
dfe02bd
Added getSignatureParameters utility
aalok05 Dec 19, 2018
93049ff
unnecessary 'if' removed in socket providers
Dec 19, 2018
075cd54
added documentation for getSignatureParameters
aalok05 Dec 19, 2018
db004ad
fixed a silly mistake
aalok05 Dec 19, 2018
3b549cf
code style improvements
Dec 19, 2018
9106523
networkChanged and accountsChanged event added to EthereumProvider
Dec 19, 2018
ddbf5c8
events added to readme in providers module
Dec 19, 2018
86492fd
typo fixed in readme
Dec 19, 2018
fe4d9eb
added missing npm packages
aalok05 Dec 19, 2018
a68cb6b
types updated, code cleaned up and code style improved
Dec 19, 2018
dc09e7d
self => this
Dec 19, 2018
e6b9f80
funcDocs improved in providers module
Dec 19, 2018
22d93b2
dependencies updated in package.json
Dec 19, 2018
10c6a9f
code style improvements and onMessage updated in socket providers.
Dec 19, 2018
1dfb3a0
POC websocket reconnecting and resubscribing
Dec 20, 2018
a3af233
getSubscriptionKey renamed to getSubscriptionEvent
Dec 20, 2018
b3e2dc0
providers cleaned up and reconnect method updated
Dec 20, 2018
f496b8b
this.constructor => this.connection.constructor in reconnect method o…
Dec 20, 2018
730a18b
naming improved in AbstractSocketProvider and reconnect method remove…
Dec 20, 2018
ff53a2d
onError and onClose listener in WebsocketProvider fixed
Dec 20, 2018
361b86d
code style improvements in the provider objects
Dec 20, 2018
7898948
funcDoc updated in AbstractSocketProvider and reconnect test cases in…
Dec 20, 2018
793bcb3
onConnect fixed in AbstractSocketProvider.
Dec 20, 2018
e16f462
HttpProvider refactored to be able to mock the XMLHttpRequest object …
Dec 20, 2018
858e396
Default values for the HttpProvider constructor parameters and also f…
Dec 20, 2018
38035bd
missing imports added
Dec 20, 2018
005a56d
onMessage fixed in EthereumProvider and improved in AbstractSocketPro…
Dec 20, 2018
4aae169
Error handling removed in AbstractSubscription because it will never …
Dec 20, 2018
f920f1c
handleSubscriptionResponse method removed in AbstractSubscription bec…
Dec 20, 2018
0dcd582
code style improvements, started with fixing of the BatchRequestTest …
Dec 20, 2018
5c83023
RequestAccountsMethod implemented
Dec 20, 2018
5a548c3
Provider check added to RequestAccountsMethod
Dec 20, 2018
996ad56
RequestAccountsMethod provider check improved
Dec 20, 2018
5e160ab
BatchRequestTest fixed
Dec 20, 2018
2e485dc
ProviderModuleFactoryTest fixed
Dec 20, 2018
b58c0b2
AbstractSocketProviderTest created
Dec 20, 2018
99410d9
EthereumProvider test created
Dec 21, 2018
05269e7
Merge remote-tracking branch 'upstream/ethereumProvider' into ethereu…
aalok05 Dec 21, 2018
f3ea658
IpcProviderTest created
Dec 21, 2018
0207369
HttpProviderTest created
Dec 21, 2018
ee80d3a
WebsockerProviderTest created
Dec 21, 2018
c7024a5
providers improved and provider tests in the providers module finishe…
Dec 21, 2018
6ff2070
All existing tests in the web3-providers module fixed (coverage of 98%)
Dec 21, 2018
0cb65c4
AbstractWeb3ModuleTest fixed
Dec 23, 2018
66a2a58
AbstractMethodFactoryTest fixed
Dec 27, 2018
1b30f70
AbstractCallMethodTest fixed
Dec 27, 2018
93298d9
AbstractSendMethodTest fixed
Dec 27, 2018
c4c1687
AbstractSendMethodTest fixed
Dec 27, 2018
af4b646
core-method tests fixed
Dec 27, 2018
253114d
core-subscriptions tests fixed
Dec 27, 2018
0ecbc7d
started with unit testing of the eth-contract module
Dec 27, 2018
e0f330b
EventLogDecodeTest created
Dec 28, 2018
f0d1144
unused dependency removed in EventLogDecoder
Dec 28, 2018
0e30837
AllEventsLogDecoderTest created
Dec 28, 2018
632c576
EventFilterEncoderTest created
Dec 28, 2018
4ee71de
MethodEncoderTest created
Dec 28, 2018
a493eeb
AllEventsFilterEncoderTest created
Dec 28, 2018
352af45
ContractModuleFactoryTest created
Jan 3, 2019
ae6c565
EventSubscriptionFactoryTest created
Jan 3, 2019
e8bd2c7
MethodFactoryTest created
Jan 3, 2019
2cbd2ca
AbiMapper test created
Jan 3, 2019
bbc9292
AllEventsOptionsMapperTest created
Jan 3, 2019
7ac21d4
EventOptionsMapperTest created
Jan 3, 2019
34ac838
MethodOptionsMapper test created
Jan 3, 2019
6ddd086
CallContractMethodTest created
Jan 3, 2019
e9e662e
ContractDeployMethodTest created
Jan 3, 2019
88987e7
PastEventLogsMethodTest created
Jan 3, 2019
b5d32f4
SendContractMethodTest created
Jan 3, 2019
74aea4c
Abi models moved into the root models folder because there are no oth…
Jan 3, 2019
fab7494
AbiItemModelTest created
Jan 3, 2019
64f0fbd
AbiModelTest created
Jan 3, 2019
ce58bb9
TODO's added because of the PromiEvnt I just noticed that the promiev…
Jan 3, 2019
f5d3cb3
MethodsProxyTest created
Jan 3, 2019
091f959
uncommented code removed and MethodsProxyTest improved
Jan 3, 2019
f9d3ef5
paths fixed in tests because I've moved the ABI models
Jan 3, 2019
949371c
EventSubscriptionsProxyTest created
Jan 3, 2019
812589d
AllEventslLogSubscriptionTest created
Jan 3, 2019
deb4796
EventLogSubscriptionTest created
Jan 3, 2019
8d7a3ce
MethodOptionsValidatorTest created
Jan 3, 2019
35e3b08
Template prepared for AbstractContractTest
Jan 3, 2019
070cc27
eth-contract module tests created with 99% coverage
Jan 4, 2019
f71164c
eth-ens module updated
Jan 4, 2019
79ec083
RegistryTest created
Jan 4, 2019
81e10d9
EnsModuleFactoryTest created
Jan 4, 2019
838a56f
EnsTest created
Jan 4, 2019
4fe56f6
Resolver calls fixed in ENS module
Jan 4, 2019
67dbbb5
EnsTest updated
Jan 4, 2019
e5a6373
EthModuleFactoryTest created
Jan 4, 2019
38e766e
Eth module tests finished with 89% coverage
Jan 4, 2019
f442755
WIP: AbiCoderTest
Jan 4, 2019
0af425a
AbiCoderTest created
Jan 7, 2019
edace2e
AccountsModuleFactoryTest created
Jan 7, 2019
cea1835
AccountsTest created
Jan 7, 2019
0ef7f2f
EthTest improved and AbstractWeb3Module fixed
Jan 7, 2019
fb40e21
IbanTest created
Jan 7, 2019
c48a0ba
PersonalModuleFactoryTest created
Jan 7, 2019
8e51dce
Method naming improved in personal module
Jan 7, 2019
3b169d9
PersonalTest created
Jan 7, 2019
b24b721
NetworkModuleFactoryTest created
Jan 7, 2019
c1d086a
NetworkTest created
Jan 7, 2019
af1bc8a
ShhModuleFactoryTest created
Jan 7, 2019
d41e007
ShhTest created
Jan 7, 2019
ead36ab
Web3Test created
Jan 8, 2019
15992fb
accessors in Eth object improved and test fixed
Jan 8, 2019
5b5f2f5
Return values extended in detect() method of the ProviderDetector
Jan 8, 2019
db8e25b
web3-eth-contract tests fixed
Jan 8, 2019
0e078f5
Rollup root config changed for the web3 module this will be undone later
Jan 8, 2019
bacd0ae
test script to root package.json added and started the tests over tth…
Jan 8, 2019
c1562c1
Old tests ported to jest (UtilsTest and BloomFilterTest created
Jan 8, 2019
867d6ac
SoliditySha3Test created
Jan 8, 2019
e7fdcf5
npm install added to travis.yml
Jan 8, 2019
c6a9e03
Empty test removed from bzz module it needs a complete refactoring an…
Jan 8, 2019
7243efe
import fixed in NetworkTest
Jan 8, 2019
48cd6fa
missing devDependency added to eth-contract module
Jan 8, 2019
24d07ec
AccountsTest fixed for older node versions
Jan 8, 2019
3bc547b
invalid hex fix for tests
Jan 8, 2019
a4366c8
test:coverage command added for generating a summary over all coverag…
Jan 8, 2019
819178b
npm test command in travis.yml updated updated ('test' => 'test:cover…
Jan 8, 2019
63f54b5
invalid hex in AccountsTest fixed for node v6/7 build on travis
Jan 8, 2019
3d06ac6
coveralls added
Jan 8, 2019
655ee2c
travis.yml updated
Jan 8, 2019
3e480cc
node version 11 added to travis ci build
Jan 8, 2019
b9d0de1
Linter executed and added to travis ci
Jan 9, 2019
7857990
dtslint updated
Jan 9, 2019
f069501
lodash added and underscore removed
Jan 9, 2019
5c4c547
Build fixed, dependency handling fixed and ENS improved
Jan 9, 2019
19d8203
EnsTest fixed
Jan 9, 2019
b9d210d
EthTest fixed
Jan 9, 2019
b58063e
GetBalanceMethod tested and method handling fixed
Jan 9, 2019
4987949
JsonRpcResponseValidatorTest fixed
Jan 9, 2019
5c68b79
core-method module tests fixed
Jan 9, 2019
14ac307
eslint errors fixed
Jan 9, 2019
d7a216b
import fixed in web3-utils module
Jan 9, 2019
8047e63
providers response handling fixed
Jan 9, 2019
fc8496a
Merge remote-tracking branch 'upstream/ethereumProvider' into ethereu…
aalok05 Jan 10, 2019
343a175
fixed multiple exports of the same name error
aalok05 Jan 10, 2019
e0e5023
added test for getSignatureParameters
aalok05 Jan 10, 2019
1265000
TypeError fix
aalok05 Jan 10, 2019
d13b866
fixed failing test, added check fo hex string
aalok05 Jan 10, 2019
99e508e
test fix
aalok05 Jan 10, 2019
e1a4580
funcDoc fixed
Jan 10, 2019
c131c6c
ethers.js updated
Jan 10, 2019
b3ca0b4
fixed a bunch of broken imports
aalok05 Jan 10, 2019
bb585ee
added missing exports
aalok05 Jan 10, 2019
842284c
added missing exports from utils
aalok05 Jan 10, 2019
fc2ba30
Merge branch 'ethereumProvider' into addMissingExports
aalok05 Jan 10, 2019
f9ba355
socket provider event handling and subscriptions fixed
Jan 10, 2019
2a4d2d0
providers module tests fixed
Jan 10, 2019
b14a175
Merge remote-tracking branch 'upstream/ethereumProvider' into addMiss…
aalok05 Jan 11, 2019
3a1fd82
Contract handling fixed and tested in the browser
Jan 14, 2019
a24a9bc
Contract events fixed and LogSubscription will now just get past even…
Jan 14, 2019
52cce26
SendTransactionMethod fixed
Jan 14, 2019
59b4da5
Contract event subscriptions fixed and WebsocketProvider improved
Jan 15, 2019
cf4bb35
Contract allEvents tested and fixed
Jan 15, 2019
6403ca9
WebsocketProvider reconnecting and subscriptions resubscribing tested…
Jan 15, 2019
7277c59
Contract deploy method tested and the deployment workflow fixed
Jan 15, 2019
26ab943
LogSubscription improved and LogSubscriptionTest extended
Jan 15, 2019
73f5892
wcore-subscriptions module tests fixed
Jan 15, 2019
f3fa5da
core-method module tests fixed
Jan 15, 2019
1900b5d
eth-contract module tests updated
Jan 15, 2019
eec73c3
eslint run
Jan 15, 2019
cfd9130
Web3 static utils and version method removed otherwise the utils and …
Jan 15, 2019
838eb08
module versions in package.json updated
Jan 15, 2019
4877c10
Readme files simplified a class reference will replace the removed in…
Jan 15, 2019
9967646
version updated in root package.json
Jan 15, 2019
d482824
root readme file updated
Jan 15, 2019
1ba3669
version in lerna.json updated
Jan 15, 2019
046c556
Merge remote-tracking branch 'upstream/ethereumProvider' into addMiss…
aalok05 Jan 16, 2019
e509702
web3 module typing tests fixed
Jan 17, 2019
0cf1b1f
web3-core types updated
Jan 17, 2019
bb98dcc
core-helpers type tests created and typings improved
Jan 17, 2019
a5f5715
core-method module types improved and test created
Jan 17, 2019
3247b75
eth module types updated and test fixed
Jan 17, 2019
528668a
personal module types updated and the test improved
Jan 17, 2019
762bcd6
providers module types updated and tests fixed
Jan 17, 2019
a56391a
shh module types updated
Jan 17, 2019
04f2343
eth-contract module types updated and fixed
Jan 17, 2019
ed4cd07
dtslint added to the travis.yml file and providers module tests fixed
Jan 17, 2019
748649c
ens module types created
Jan 17, 2019
54e29f6
travis script command created in package.json and core-method module …
Jan 17, 2019
7c641fc
provider.constructor.name comparsion added because of node
Jan 17, 2019
000c68b
Fix - allow web3 to work in iframes with third party cookies turned off
joshstevens19 Jan 21, 2019
0610c89
Merge pull request #2178 from aalok05/addMissingExports
nivida Jan 21, 2019
d516d5e
Merge pull request #2203 from joshstevens19/fix/allow-web3-to-work-in…
nivida Jan 21, 2019
78d048c
syntax fixed in index.d.ts file
Jan 21, 2019
b457dea
Merge branch '1.0' into ethereumProvider
Jan 21, 2019
70fad75
eslint run
Jan 21, 2019
b171eb8
lowercase file removed from git history
Jan 21, 2019
543d39e
EIP-1577 implemented
Jan 21, 2019
4d27a01
todo added
Jan 21, 2019
364100a
supportsInterface implemented in eth-ens module
Jan 21, 2019
c1ce248
ENS documentation updated, getText & setText implemented, Resolver AB…
Jan 21, 2019
3e2480b
MetamaskInpageProvider created
Jan 21, 2019
d78d032
ProviderResolverr and ProvidersModuleFactory updated. Code style impr…
Jan 21, 2019
5906cac
MetamaskInpageProvder finished and the test for it created
Jan 21, 2019
cffd792
MetamaskInpageProvider sendPayload method fixed and test updated
Jan 21, 2019
9a31efc
MistEthereumProvider implemented
Jan 21, 2019
3ca7bbf
ProviderResolver updated for the MistEthereumProvider
Jan 21, 2019
6795c06
PMetamaskInpageProviderTest improved and MistEthereumProviderTest cre…
Jan 21, 2019
dee860d
eslint error fixed
Jan 21, 2019
08afc78
fix: fix utils.hexToBytes
Keith-CY Jan 22, 2019
36eb68f
Merge pull request #2207 from Keith-CY/ethereumProvider
nivida Jan 22, 2019
79a165a
lodash imports improved and deep cloning of methods and subscription…
Jan 22, 2019
fc52292
Merge pull request #2209 from ethereum/feature/deep-cloned-arguments
nivida Jan 22, 2019
9bcfaef
BatchRequest tested and fixed
Jan 22, 2019
bd46041
AbstractMethodTest updated
Jan 22, 2019
b45baa7
typings of AbstractMethod updated
Jan 22, 2019
aaa4fe6
eslint executed
Jan 22, 2019
81fc2f5
arguments handling fixed in MethodProxy
Jan 22, 2019
4cab56b
optional paramters fixed for eth methods
Jan 22, 2019
ebc03e8
missing import added
Jan 22, 2019
6b8f274
Subscriptiions handling with MetamaskInpageProvider fixed
Jan 22, 2019
c7094b0
methods tests updated inn core-method module
Jan 22, 2019
b72b3d9
AbstractSocketProviderTest updated
Jan 22, 2019
e4979bd
requestAccounts method added in web3-eth.rst
Jan 23, 2019
854911d
typo in web3-eth.rst
Jan 23, 2019
955b995
formatting of promise return value improved in web3-eth.rst and IsSyn…
Jan 23, 2019
c3d347c
Error removed in the RequestAccountsMethod
Jan 23, 2019
110d0e9
methods tests improved an eth-personal documentation updated
Jan 23, 2019
cdf3abc
IsSyncingMethodTest updated and GetAccountsMethodTest fixed
Jan 23, 2019
347d137
fixes from the truffle team implemented
Jan 25, 2019
5fbbbb9
AbiCoderTest updated
Jan 25, 2019
ecc2be5
web3 documentation improvements
Jan 25, 2019
3dd6251
console.log removed
Jan 25, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 0 additions & 5 deletions .bowerrc

This file was deleted.

11 changes: 11 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
node_modules
coverage
test
docs/_build
dist
package.js
rollup.config.js
jest.config.js
jest.preprocessor.js
W3cWebsocket.js
packages/**/rollup.config.js
62 changes: 62 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{
"parser": "babel-eslint",
"env": {
"browser": true,
"commonjs": true,
"es6": true,
"node": true,
"jest/globals": true
},
"extends": [
"standard",
"plugin:unicorn/recommended",
"plugin:jest/recommended",
"prettier",
"prettier/standard",
"prettier/unicorn"
],
"parserOptions": {
"ecmaVersion": 2017,
"sourceType": "module"
},
"plugins": [
"prettier",
"standard",
"unicorn",
"jest"
],
"rules": {
"no-useless-constructor": 0,
"no-new": 0,
"standard/no-callback-literal": 0,
"unicorn/filename-case": [
"error",
{
"case": "pascalCase"
}
],
"prettier/prettier": "error",
"indent": [
"error",
4,
{
"SwitchCase": 1
}
],
"linebreak-style": [
"error",
"unix"
],
"quotes": [
"error",
"single",
{
"avoidEscape": true
}
],
"semi": [
"error",
"always"
]
}
}
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dist/
.DS_Store
*.swp
*/**/*un~
Expand All @@ -8,10 +9,9 @@ npm-debug.log
/coverage
/tmp
node_modules
bower_components
/bower
.idea/
.npm/
.vscode/
dist/
!./dist/web3.min.js
coverage/
lerna-debug.log
.eslintcache
2 changes: 0 additions & 2 deletions .jshintignore

This file was deleted.

19 changes: 0 additions & 19 deletions .jshintrc

This file was deleted.

10 changes: 0 additions & 10 deletions .npmignore

This file was deleted.

11 changes: 11 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"printWidth": 120,
"tabWidth": 4,
"useTabs": false,
"semi": true,
"singleQuote": true,
"trailingComma": "none",
"bracketSpacing": false,
"arrowParens": "always",
"proseWrap": "never"
}
8 changes: 5 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ node_js:
- "6"
- "7"
- "8"
- "9"
- "10"
- "11"
env:
- CXX=g++-4.8
addons:
Expand All @@ -20,9 +22,9 @@ before_script:
- sh -e /etc/init.d/xvfb start
install:
- npm install
- npm run bootstrap
script:
- npm run-script build
- npm run-script test-coveralls
- npm run travis
after_script:
- cd test/node && npm install && node app.js
- npm run coveralls

2 changes: 0 additions & 2 deletions .versions

This file was deleted.

8 changes: 4 additions & 4 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Steps before creating an issue:

1. I've read the documentation.
2. I was looking for an solution on stackoverflow or something else.
3. I was looking for an identical issue.
1. I have read the documentation.
2. I was looking for an solution on stackoverflow or somewhere else.
3. I checked the issue list if an identical issue already exists.

-->

Expand All @@ -18,7 +18,7 @@ Steps before creating an issue:
2. [Second step]
3. [and so on...]

#### Logs
#### Error Logs

#### Versions
[NPM, Node, Web3.js, OS, device...]
12 changes: 7 additions & 5 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,20 @@ Fixes #(issue)

<!--- Please delete options that are not relevant. -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change

## Checklist:

- [ ] I have selected the correct base branch.
- [ ] I have performed a self-review of my own code.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.
- [ ] My changes generate no warnings.
- [ ] I have updated or added types for all modules I've changed
- [ ] Any dependent changes have been merged and published in downstream modules.
- [ ] I ran ```npm run test``` with success and extended the tests if necessary.
- [ ] I ran ```npm run build``` and tested the resulting file from ```dist``` folder in a browser.
- [ ] I ran ```npm run build``` and tested it in the browser and with node.
- [ ] I ran ```npm run-script dtslint``` and tested that all my types are correct
- [ ] I have tested my code on the live network.
92 changes: 24 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
**PREVIEW RELEASE** This is a beta preview release with breaking changes! The current stable version is 0.20.0

<img src="https://github.com/ethereum/web3.js/raw/1.0/web3js.jpg" width=200 />
![Web3.js logo](assets/web3js.svg)

# web3.js - Ethereum JavaScript API

[![npm](https://img.shields.io/npm/dm/web3.svg)](https://www.npmjs.com/package/web3) [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url]
[![Join the chat at https://gitter.im/ethereum/web3.js](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ethereum/web3.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![npm](https://img.shields.io/npm/dm/web3.svg)](https://www.npmjs.com/package/web3) [![Build Status][travis-image]][travis-url] [![dependency status][dep-image]][dep-url] [![dev dependency status][dep-dev-image]][dep-dev-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Stories in Ready][waffle-image]][waffle-url]

This is the Ethereum [JavaScript API][docs]
which connects to the [Generic JSON RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) spec.


You need to run a local or remote Ethereum node to use this library.

Please read the [documentation][docs] for more.
Expand All @@ -30,33 +28,12 @@ npm install web3
yarn add web3
```

### Meteor

*Note*: works only in the Browser for now. (PR welcome).

```bash
meteor add ethereum:web3
```

### In the Browser

Use the prebuild ``dist/web3.min.js``, or
build using the [web3.js][repo] repository:

```bash
npm run-script build
```

Then include `dist/web3.js` in your html file.
This will expose `Web3` on the window object.

## Usage

```js
// in node.js
var Web3 = require('web3');
import Web3 from 'web3';

var web3 = new Web3('ws://localhost:8546');
const web3 = new Web3('ws://localhost:8546');
console.log(web3);
> {
eth: ... ,
Expand All @@ -83,78 +60,57 @@ web3.eth.getAccounts()

### Usage with TypeScript

Type definitions are maintained at [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) by others. You can install them with
We do support types within the repo itself. Please open an issue here if you find any wrong types.

```bash
npm install --dev @types/web3.js
```

You might need to install type definitions for `bignumber.js` and `lodash` too.

And then use `web3.js` as follows:
You can use `web3.js` as follows:

```typescript
import Web3 = require("web3"); // Note the special syntax! Copy this line when in doubt!
import Web3 from 'web3';
const web3 = new Web3("ws://localhost:8546");
```

**Please note:** We do not support TypeScript ourselves. If you have any issue with TypeScript and `web3.js` do not create an issue here. Go over to DefinitelyTyped and do it there.

## Documentation

Documentation can be found at [read the docs][docs]


## Building
## Contributing

### Requirements

* [Node.js](https://nodejs.org)
* npm

### Commands
```bash
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
```

### Building (gulp)
npm run clean // removes all the node_modules folders in all modules
npm run bootstrap // install all dependencies and symlinks the internal modules for all modules
npm run test // runs all tests
npm run build // runs rollup
npm run dev // runs rollup with a watcher

Build only the web3.js package

```bash
npm run-script build
```

Or build all sub packages as well

```bash
npm run-script build-all
```

This will put all the browser build files into the `dist` folder.


### Testing (mocha)

```bash
npm test
```

### Contributing

- All contributions have to go into develop, or the 1.0 branch
- All contributions have to go into develop (0.20.x), or the 1.0 branch
- Please follow the code style of the other files, we use 4 spaces as tabs.

### Support

![chrome](https://img.shields.io/badge/chrome-latest%202%20versions-green.svg)
![firefox](https://img.shields.io/badge/firefox-latest%202%20versions-green.svg)
![opera](https://img.shields.io/badge/opera-latest%202%20versions-green.svg)
![node](https://img.shields.io/badge/node->=6-green.svg)

### Community
- [Gitter](https://gitter.im/ethereum/web3.js?source=orgpage)
- [Forum](https://forum.ethereum.org/categories/ethereum-js)


### Similar libraries in other languages
- Python [Web3.py](https://github.com/pipermerriam/web3.py)
- Haskell [hs-web3](https://github.com/airalab/hs-web3) - Haskell [hs-web3](https://github.com/airalab/hs-web3)
- Java [web3j](https://github.com/web3j/web3j) - Java [web3j](https://github.com/web3j/web3j)
- Haskell [hs-web3](https://github.com/airalab/hs-web3)
- Java [web3j](https://github.com/web3j/web3j)
- Scala [web3j-scala](https://github.com/mslinn/web3j-scala)
- Purescript [purescript-web3](https://github.com/f-o-a-m/purescript-web3)
- PHP [web3.php](https://github.com/sc0Vu/web3.php)
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes
Loading