Include web3.js in ledgers.js despite size.

We'll wait for web3.js to get their size down.
overhide · May 23, 2021 · d3f8124 · d3f8124
1 parent 3f0c3c1
commit d3f8124
Show file tree

Hide file tree

Showing 9 changed files with 538 additions and 485 deletions.
diff --git a/.babelrc b/.babelrc
@@ -1,8 +1,13 @@
 {
   "presets": [
-    "@babel/preset-env"
+    ["@babel/preset-env", {
+      "useBuiltIns": false
+    }]
   ],
     "plugins": [
-    "@babel/plugin-proposal-class-properties"
+    "@babel/plugin-proposal-class-properties",
+    ["@babel/plugin-transform-runtime", {
+      "regenerator": true
+    }]
   ]  
 }
diff --git a/README.md b/README.md
@@ -72,6 +72,14 @@ This *ledgers.js* library is client-side and abstracts ledgers (see figure above
 
 ### Distributable
 
+> **⚠ Why is it so big?** 
+>
+> We depend on [web3.js](https://github.com/ethereum/web3.js/) which has bloat issues:
+>
+> https://github.com/ChainSafe/web3.js/issues/1178
+>
+> As soon as that gets resolved, this distro will be smaller.
+
 The *ledgers.js* library ['dist' folder](https://github.com/overhide/ledgers.js/blob/master/dist) contains the distributable artifact.
 
 You'll likely want to [import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) the library along with its dependencies ([web3.js](https://github.com/ethereum/web3.js/)).
@@ -105,13 +113,9 @@ You can include *ledgers.js* via CDN:
 
 For a specific version, e.g. version *2.1.4*: `https://cdn.jsdelivr.net/npm/ledgers.js@2.1.4/dist/ledgers.min.js`
 
-> The library depends on [web3.js](https://github.com/ethereum/web3.js/), as such you must include the dependency (see first line in example below).
-
 The library can be loaded straight into your HTML and accessed by its `oh$` property in the globals:
 
 ```
-<script src="https://cdnjs.cloudflare.com/ajax/libs/web3/1.3.4/web3.min.js" integrity="sha512-TTGImODeszogiro9DUvleC9NJVnxO6M0+69nbM3YE9SYcVe4wZp2XYpELtcikuFZO9vjXNPyeoHAhS5DHzX1ZQ==" crossorigin="anonymous"></script>
-
 <script src="`https://cdn.jsdelivr.net/npm/ledgers.js/dist/ledgers.min.js`"></script>
 
 <script>

diff --git a/dist/ledgers.js b/dist/ledgers.js
diff --git a/dist/ledgers.js.map b/dist/ledgers.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ledgers.js",
-  "version": "4.4.6",
+  "version": "4.5.0",
   "description": "JavaScript library for ledger-based authorizations :: abstracting different ledgers to be used in an application's authentication and authorization workflows.",
   "engines": {
     "node": ">=10.13.0"
@@ -24,11 +24,12 @@
   },
   "homepage": "https://github.com/overhide/ledgers.js#readme",
   "dependencies": {
-    "web3": "1.3.4"
+    "web3": "1.3.6"
   },
   "devDependencies": {
     "@babel/core": "^7.13.15",
     "@babel/plugin-proposal-class-properties": "^7.13.0",
+    "@babel/plugin-transform-runtime": "7.14.3",
     "@babel/preset-env": "^7.13.15",
     "babel-loader": "^8.2.2",
     "chai": "4.2.0",

diff --git a/play/index.html b/play/index.html
@@ -4,7 +4,6 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width" />
     <title>ledgers.js API playground</title>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/web3/1.3.4/web3.min.js" integrity="sha512-TTGImODeszogiro9DUvleC9NJVnxO6M0+69nbM3YE9SYcVe4wZp2XYpELtcikuFZO9vjXNPyeoHAhS5DHzX1ZQ==" crossorigin="anonymous"></script>    
     <script type="text/javascript" src="../dist/ledgers.js"></script>
 
     <!-- ignore below :: code pane / logging  pane setup -->

diff --git a/test/html/index.html b/test/html/index.html
@@ -8,7 +8,6 @@
 </head>
 
 <body>
-  <script src="https://cdnjs.cloudflare.com/ajax/libs/web3/1.3.4/web3.min.js" integrity="sha512-TTGImODeszogiro9DUvleC9NJVnxO6M0+69nbM3YE9SYcVe4wZp2XYpELtcikuFZO9vjXNPyeoHAhS5DHzX1ZQ==" crossorigin="anonymous"></script>
   <script src="../../dist/ledgers.js"></script>
   <script src="https://unpkg.com/chai/chai.js"></script>
 </body>

diff --git a/webpack.config.js b/webpack.config.js
@@ -18,14 +18,6 @@ module.exports = {
   plugins: [
     new HardSourceWebpackPlugin()
   ],   
-  externals: {
-    "web3": {
-      commonjs: "web3",
-      commonjs2: "web3",
-      amd: "web3",
-      root: "Web3"
-    }
-  },
   module: {
     rules: [
       {
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,6 @@ @@
     </head>
     <body>
-      <script src="https://cdnjs.cloudflare.com/ajax/libs/web3/1.3.4/web3.min.js" integrity="sha512-TTGImODeszogiro9DUvleC9NJVnxO6M0+69nbM3YE9SYcVe4wZp2XYpELtcikuFZO9vjXNPyeoHAhS5DHzX1ZQ==" crossorigin="anonymous"></script>
       <script src="../../dist/ledgers.js"></script>
       <script src="https://unpkg.com/chai/chai.js"></script>
     </body>
@@ Expand Down @@