Wyatt/1.3.5 merge conflicts (#3971)

* Rename tsc to compile (#3957) (#3958) * Change 'tsc' command in scripts & lerna run to 'compile' * Update changelog * Undo incorrect rename * Checking if e2e test is deterministic Co-authored-by: Sam Hodak <slhodak@gmail.com> Co-authored-by: Sam Hodak <slhodak@gmail.com> * Debugging failing tests (#3959) (#3960) * Remote node provider edits * remote node provider documentation edits Co-authored-by: smudgil <38195323+smudgil@users.noreply.github.com> Co-authored-by: smudgil <38195323+smudgil@users.noreply.github.com> * Clarify commitment to semantic versioning (#3961) (#3962) see discussion in the issue #3758 Co-authored-by: LudwikJaniuk <ludvig.janiuk@gmail.com> Co-authored-by: LudwikJaniuk <ludvig.janiuk@gmail.com> * Feature/web3 eth iban es6 (#3964) (#3965) * Feature/web3 eth iban es6 (#3964) * web3-eth-iban es6 rewrite - replace `var` with `const` and `let` * web3-eth-iban es6 rewrite - replace object prototype with class * web3-eth-iban code style fix Co-authored-by: Loredana <loredana.cirstea@gmail.com> * Update changelog Co-authored-by: Loredana <loredana.cirstea@gmail.com> * Update changelog for PR 3961 * Built lib Co-authored-by: Sam Hodak <slhodak@gmail.com> Co-authored-by: smudgil <38195323+smudgil@users.noreply.github.com> Co-authored-by: LudwikJaniuk <ludvig.janiuk@gmail.com> Co-authored-by: Loredana <loredana.cirstea@gmail.com>
web3 · Mar 23, 2021 · 42a2d92 · 42a2d92
1 parent 1ea7732
commit 42a2d92
Show file tree

Hide file tree

Showing 30 changed files with 229 additions and 209 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -354,18 +354,22 @@ Released with 1.0.0-beta.37 code base.
 ### Added
 
 - Github action for running tests for `web3-eth2-core` and `web3-eth2-beaconchain` packages (#3892)
+- Added description to documentation on how to connect using a remote node provider (#3884)
 - Added Security risk warning to docs for `web3.utils.soliditySha3` (#3908)
 - `.nvmrc` file using Node.js version `v.14.15.1` (#3817)
+- Add commitment to semantic versioning since version `1.3.0` and onwards (#3961)
 
 ### Changed
 
 - Unified babel compiler for `web3-eth2-core` and `web3-eth2-beaconchain` (#3892)
+- Renamed the `tsc` script in all packages to `compile`; updates the corresponding `lerna run` usage in the main `package.json` (#3894)
 - moved deprecation warnings to postinstall scripts (#3917)
 - Upgrade `@chainsafe/geth-dev-assistant` from `0.1.5` to `0.1.9` (#3950)
 - Replaced hardcoded infura link with Github Secret for some tests (#3943)
 - Bump `elliptic` from `6.5.3` to `6.5.4` for `web3-eth-accounts` (#3941)
 - 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]
 

diff --git a/README.md b/README.md
@@ -185,3 +185,7 @@ This project adheres to the [Release Guidelines](./REVIEW.md).
 [netlify-url]: https://app.netlify.com/sites/web3-staging/deploys
 [stackexchange-image]: https://img.shields.io/badge/web3js-stackexchange-brightgreen
 [stackexchange-url]: https://ethereum.stackexchange.com/questions/tagged/web3js
+
+## Semantic versioning
+
+This project follows [semver](https://semver.org/) as closely as possible **from version 1.3.0 onwards**. Earlier minor version bumps [might](https://github.com/ethereum/web3.js/issues/3758) have included breaking behavior changes.
diff --git a/dist/web3.min.js b/dist/web3.min.js
diff --git a/dist/web3.min.js.map b/dist/web3.min.js.map
diff --git a/docs/include_package-core.rst b/docs/include_package-core.rst
@@ -29,7 +29,7 @@ Returns
 ``Boolean``
 
 -------
-Example
+Example: Local Geth Node
 -------
 
 .. code-block:: javascript
@@ -52,6 +52,16 @@ Example
     // on windows the path is: "\\\\.\\pipe\\geth.ipc"
     // on linux the path is: "/users/myuser/.ethereum/geth.ipc"
 
+-------
+Example: Remote Node Provider
+-------
+
+.. code-block:: javascript
+
+    // Using a remote node provider, like Alchemy (https://www.alchemyapi.io/supernode), is simple.
+    var Web3 = require('web3');
+    var web3 = new Web3("https://eth-mainnet.alchemyapi.io/v2/your-api-key");
+
 
 ------------------------------------------------------------------------------
 

diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
     "scripts": {
         "version": "npm run build",
         "postinstall": "npm run bootstrap",
-        "build": "npm run bootstrap && lerna run tsc && webpack && cp -r ./dist ./packages/web3",
+        "build": "npm run bootstrap && lerna run compile && webpack && cp -r ./dist ./packages/web3",
         "publish": "lerna publish",
         "bootstrap": "lerna bootstrap --hoist",
         "lint": "jshint *.js packages",

diff --git a/packages/web3-bzz/package.json b/packages/web3-bzz/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types",
         "postinstall": "echo \"WARNING: the web3-bzz api will be deprecated in the next version\""
     },

diff --git a/packages/web3-core-helpers/package.json b/packages/web3-core-helpers/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-core-method/package.json b/packages/web3-core-method/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-core-promievent/package.json b/packages/web3-core-promievent/package.json
@@ -9,7 +9,7 @@
     },
     "main": "lib/index.js",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json"
+        "compile": "tsc -b tsconfig.json"
     },
     "dependencies": {
         "eventemitter3": "4.0.4"

diff --git a/packages/web3-core-requestmanager/package.json b/packages/web3-core-requestmanager/package.json
@@ -9,7 +9,7 @@
     },
     "main": "lib/index.js",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json"
+        "compile": "tsc -b tsconfig.json"
     },
     "dependencies": {
         "underscore": "1.9.1",

diff --git a/packages/web3-core-subscriptions/package.json b/packages/web3-core-subscriptions/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-core/package.json b/packages/web3-core/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-eth-abi/package.json b/packages/web3-eth-abi/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-eth-accounts/package.json b/packages/web3-eth-accounts/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib  types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-eth-contract/package.json b/packages/web3-eth-contract/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-eth-ens/package.json b/packages/web3-eth-ens/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib  types"
     },
     "main": "lib/index.js",

diff --git a/packages/web3-eth-iban/package.json b/packages/web3-eth-iban/package.json
@@ -9,7 +9,7 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
-        "tsc": "tsc -b tsconfig.json",
+        "compile": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
     "main": "lib/index.js",