Merge branch '1.x' into reviewAndReleaseGuidelines

.github/PULL_REQUEST_TEMPLATE.md

@@ -25,7 +25,7 @@ Fixes #(issue)
 - [ ] Any dependent changes have been merged and published in downstream modules.
 - [ ] I ran `npm run dtslint` with success and extended the tests and types if necessary.
 - [ ] I ran `npm run test:unit` with success.
-- [ ] I have executed `npm run test:cov` and my test cases cover all the lines and branches of the added code.
-- [ ] I ran `npm run build-all` and tested the resulting files from  `dist` folder in a browser.
+- [ ] I ran `npm run test:cov` and my test cases cover all the lines and branches of the added code.
+- [ ] I ran `npm run build-all` and tested the resulting files from `dist` folder in a browser.
 - [ ] I have updated the `CHANGELOG.md` file in the root folder.
 - [ ] I have tested my code on the live network.

.github/workflows/build.yml

@@ -49,6 +49,9 @@ jobs:
             CI: true
             DISPLAY: :99.0
             PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
+            SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
+            SURGE_LOGIN: ${{ secrets.SURGE_LOGIN }}
+            BUNDLESIZE_GITHUB_TOKEN: ${{ secrets.BUNDLESIZE_GITHUB_TOKEN }}
         steps:
             - uses: actions/setup-node@v1
               with:
@@ -57,7 +60,7 @@ jobs:
 
             - run: bash ./scripts/install.sh
             - run: bash ./scripts/ci.sh
-              continue-on-error: ${{ matrix.testCmd == 'e2e_ganache' || matrix.testCmd == 'e2e_mosiac' }}
+              continue-on-error: ${{ matrix.testCmd == 'e2e_ganache' || matrix.testCmd == 'e2e_mosaic' }}
 
             - name: Send coverage reports to Coveralls
               if: env.TEST == 'unit_and_e2e_clients'

CHANGELOG.md

@@ -178,12 +178,14 @@ Released with 1.0.0-beta.37 code base.
 
 ### Added
 
-- Introduce review and release guidelines: `REVIEW.md` and `RELEASE.md`
+- Introduce review and release guidelines. (#3460)
 
 ### Changed
 
 - Change CI provider from Travis to Github Actions. (#3468)
+- Improve code clarity of HttpProvider keepAlive option setting. (#3463)
 
 ### Fixed
 
-- Fix intermittent CI build issues with `dtslint`. (#3479)
+- Fix intermittent CI build issues with `dtslint`. (#3479)
+- Fix provider "error" / "end" events not fired when Websocket provider disconnects (#3485)

docs/web3-eth.rst

@@ -1969,12 +1969,12 @@ Example
             "0xf90211a0395d87a95873cd98c21cf1df9421af03f7247880a2554e20738eec2c7507a494a0bcf6546339a1e7e14eb8fb572a968d217d2a0d1f3bc4257b22ef5333e9e4433ca012ae12498af8b2752c99efce07f3feef8ec910493be749acd63822c3558e6671a0dbf51303afdc36fc0c2d68a9bb05dab4f4917e7531e4a37ab0a153472d1b86e2a0ae90b50f067d9a2244e3d975233c0a0558c39ee152969f6678790abf773a9621a01d65cd682cc1be7c5e38d8da5c942e0a73eeaef10f387340a40a106699d494c3a06163b53d956c55544390c13634ea9aa75309f4fd866f312586942daf0f60fb37a058a52c1e858b1382a8893eb9c1f111f266eb9e21e6137aff0dddea243a567000a037b4b100761e02de63ea5f1fcfcf43e81a372dafb4419d126342136d329b7a7ba032472415864b08f808ba4374092003c8d7c40a9f7f9fe9cc8291f62538e1cc14a074e238ff5ec96b810364515551344100138916594d6af966170ff326a092fab0a0d31ac4eef14a79845200a496662e92186ca8b55e29ed0f9f59dbc6b521b116fea090607784fe738458b63c1942bba7c0321ae77e18df4961b2bc66727ea996464ea078f757653c1b63f72aff3dcc3f2a2e4c8cb4a9d36d1117c742833c84e20de994a0f78407de07f4b4cb4f899dfb95eedeb4049aeb5fc1635d65cf2f2f4dfd25d1d7a0862037513ba9d45354dd3e36264aceb2b862ac79d2050f14c95657e43a51b85c80",
             "0xf90171a04ad705ea7bf04339fa36b124fa221379bd5a38ffe9a6112cb2d94be3a437b879a08e45b5f72e8149c01efcb71429841d6a8879d4bbe27335604a5bff8dfdf85dcea00313d9b2f7c03733d6549ea3b810e5262ed844ea12f70993d87d3e0f04e3979ea0b59e3cdd6750fa8b15164612a5cb6567cdfb386d4e0137fccee5f35ab55d0efda0fe6db56e42f2057a071c980a778d9a0b61038f269dd74a0e90155b3f40f14364a08538587f2378a0849f9608942cf481da4120c360f8391bbcc225d811823c6432a026eac94e755534e16f9552e73025d6d9c30d1d7682a4cb5bd7741ddabfd48c50a041557da9a74ca68da793e743e81e2029b2835e1cc16e9e25bd0c1e89d4ccad6980a041dda0a40a21ade3a20fcd1a4abb2a42b74e9a32b02424ff8db4ea708a5e0fb9a09aaf8326a51f613607a8685f57458329b41e938bb761131a5747e066b81a0a16808080a022e6cef138e16d2272ef58434ddf49260dc1de1f8ad6dfca3da5d2a92aaaadc58080",
             "0xf851808080a009833150c367df138f1538689984b8a84fc55692d3d41fe4d1e5720ff5483a6980808080808080808080a0a319c1c415b271afc0adcb664e67738d103ac168e0bc0b7bd2da7966165cb9518080"
-            ],
-            "balance": 0,
-            "codeHash": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
-            "nonce": 0,
-            "storageHash": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
-            "storageProof": [
+        ],
+        "balance": 0,
+        "codeHash": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
+        "nonce": 0,
+        "storageHash": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
+        "storageProof": [
             {
                 "key": "0x0000000000000000000000000000000000000000000000000000000000000000",
                 "value": '0',

gulpfile.js

@@ -119,6 +119,7 @@ var ugliyOptions = {
     }
 };
 
+// Apply lerna.json version to root package.json
 gulp.task('version', function() {
     if (!lernaJSON.version) {
         throw new Error('version property is missing from lerna.json');
@@ -143,6 +144,7 @@ gulp.task('lint', function() {
         .pipe(jshint.reporter('default'));
 });
 
+// Delete dist folder
 gulp.task('clean', gulp.series('lint', function(cb) {
     del([DEST]).then(cb.bind(null, null));
 }));

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.5",
+  "version": "1.2.7",
   "lerna": "2.0.0",
   "command": {
     "init": {

package.json

@@ -1,7 +1,7 @@
 {
-    "name": "web3",
+    "name": "web3.js",
     "private": true,
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "Ethereum JavaScript API wrapper repository",
     "license": "LGPL-3.0",
     "engines": {
@@ -20,10 +20,11 @@
         }
     ],
     "scripts": {
+        "version": "npm run build-all",
         "postinstall": "lerna bootstrap",
-        "build": "gulp",
-        "build-all": "gulp all",
-        "release": "lerna bootstrap; lerna publish",
+        "build": "lerna bootstrap && gulp",
+        "build-all": "lerna bootstrap && gulp all",
+        "publish": "lerna publish",
         "bootstrap": "lerna bootstrap",
         "watch": "gulp watch",
         "docs": "cd docs; make html;",
@@ -132,7 +133,7 @@
         "karma-firefox-launcher": "^1.2.0",
         "karma-mocha": "^1.3.0",
         "karma-spec-reporter": "0.0.32",
-        "lerna": "^3.18.3",
+        "lerna": "^3.20.2",
         "mocha": "^6.2.1",
         "nyc": "^14.1.1",
         "pify": "^4.0.1",

packages/web3-bzz/package.json

@@ -1,6 +1,6 @@
 {
     "name": "web3-bzz",
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "Web3 module to interact with the Swarm network.",
     "repository": "https://github.com/ethereum/web3.js/tree/1.x/packages/web3-bzz",
     "license": "LGPL-3.0",

packages/web3-core-helpers/package.json

@@ -1,6 +1,6 @@
 {
     "name": "web3-core-helpers",
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "Web3 core tools helper for sub packages. This is an internal package.",
     "repository": "https://github.com/ethereum/web3.js/tree/1.x/packages/web3-core-helpers",
     "license": "LGPL-3.0",
@@ -14,8 +14,8 @@
     "main": "src/index.js",
     "dependencies": {
         "underscore": "1.9.1",
-        "web3-eth-iban": "1.2.6",
-        "web3-utils": "1.2.6"
+        "web3-eth-iban": "1.2.7",
+        "web3-utils": "1.2.7"
     },
     "devDependencies": {
         "@types/node": "^12.12.5",

packages/web3-core-method/package.json

@@ -1,6 +1,6 @@
 {
     "name": "web3-core-method",
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "Creates the methods on the web3 modules. This is an internal package.",
     "repository": "https://github.com/ethereum/web3.js/tree/1.x/packages/web3-core-method",
     "license": "LGPL-3.0",
@@ -14,10 +14,10 @@
     "main": "src/index.js",
     "dependencies": {
         "underscore": "1.9.1",
-        "web3-core-helpers": "1.2.6",
-        "web3-core-promievent": "1.2.6",
-        "web3-core-subscriptions": "1.2.6",
-        "web3-utils": "1.2.6"
+        "web3-core-helpers": "1.2.7",
+        "web3-core-promievent": "1.2.7",
+        "web3-core-subscriptions": "1.2.7",
+        "web3-utils": "1.2.7"
     },
     "devDependencies": {
         "dtslint": "^3.4.1",

packages/web3-core-promievent/package.json

@@ -1,6 +1,6 @@
 {
     "name": "web3-core-promievent",
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "This package extends the EventEmitter with the Promise class to allow chaining as well as multiple final states of a function.",
     "repository": "https://github.com/ethereum/web3.js/tree/1.x/packages/web3-core-promievent",
     "license": "LGPL-3.0",

packages/web3-core-requestmanager/package.json

@@ -1,6 +1,6 @@
 {
     "name": "web3-core-requestmanager",
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "Web3 module to handle requests to external providers.",
     "repository": "https://github.com/ethereum/web3.js/tree/1.x/packages/web3-core-requestmanager",
     "license": "LGPL-3.0",
@@ -10,9 +10,9 @@
     "main": "src/index.js",
     "dependencies": {
         "underscore": "1.9.1",
-        "web3-core-helpers": "1.2.6",
-        "web3-providers-http": "1.2.6",
-        "web3-providers-ipc": "1.2.6",
-        "web3-providers-ws": "1.2.6"
+        "web3-core-helpers": "1.2.7",
+        "web3-providers-http": "1.2.7",
+        "web3-providers-ipc": "1.2.7",
+        "web3-providers-ws": "1.2.7"
     }
 }

packages/web3-core-requestmanager/src/index.js

@@ -130,6 +130,13 @@ RequestManager.prototype.setProvider = function (provider, net) {
                     subscription.callback(errors.ConnectionCloseError(event));
                     _this.subscriptions.delete(subscription.subscription.id);
                 });
+
+                if(_this.provider && _this.provider.emit){
+                    _this.provider.emit('error', errors.ConnectionCloseError(event));
+                }
+            }
+            if(_this.provider && _this.provider.emit){
+                _this.provider.emit('end', event);
             }
         });
 

packages/web3-core-subscriptions/package.json

@@ -1,6 +1,6 @@
 {
     "name": "web3-core-subscriptions",
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "Manages web3 subscriptions. This is an internal package.",
     "repository": "https://github.com/ethereum/web3.js/tree/1.x/packages/web3-core-subscriptions",
     "license": "LGPL-3.0",
@@ -15,7 +15,7 @@
     "dependencies": {
         "eventemitter3": "3.1.2",
         "underscore": "1.9.1",
-        "web3-core-helpers": "1.2.6"
+        "web3-core-helpers": "1.2.7"
     },
     "devDependencies": {
         "dtslint": "^3.4.1",