Force unorm shim when String.prototype.normalize is broken (#338).

_version.d.ts

@@ -1 +1 @@
-export declare const version = "4.0.8";
+export declare const version = "4.0.9";

_version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = "4.0.8";
+exports.version = "4.0.9";

dist/ethers.js

@@ -1,7 +1,7 @@
 (function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.ethers = f()}})(function(){var define,module,exports;return (function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = "4.0.8";
+exports.version = "4.0.9";
 
 },{}],2:[function(require,module,exports){
 "use strict";

dist/ethers.types.txt

@@ -261,7 +261,7 @@ declare module 'ethers/utils/shims' {
 }
 
 declare module 'ethers/_version' {
-    export const version = "4.0.8";
+    export const version = "4.0.9";
 }
 
 declare module 'ethers/utils/bignumber' {

gulpfile.js

@@ -152,7 +152,9 @@ function taskBundle(name, options) {
         if (options.minify) {
             result = result.pipe(buffer())
             .pipe(sourcemaps.init({ loadMaps: true }))
-            .pipe(uglify())
+            .pipe(uglify({
+                output: { ascii_only: true }
+            }))
             .pipe(sourcemaps.write('./'))
         }
 
@@ -174,6 +176,30 @@ taskBundle("minified", { filename: "ethers.min.js", dest: 'dist', minify: true }
 // Creates dist/ethers.min.js
 taskBundle("minified-test", { filename: "ethers.min.js", dest: 'tests/dist', minify: true });
 
+gulp.task('shims', function () {
+
+        var result = browserify({
+            basedir: '.',
+            debug: false,
+            entries: [ './tests/shims/index.js' ],
+            cache: { },
+            packageCache: {},
+            standalone: "_shims",
+            insertGlobalVars: {
+               process: function() { return; },
+            }
+        })
+        .bundle()
+        .pipe(source('shims.js'))
+        .pipe(buffer())
+        .pipe(uglify({
+            output: { ascii_only: true }
+        }))
+        .pipe(gulp.dest('dist'));
+
+        return result;
+});
+
 /*
 // Dump the TypeScript definitions to dist/types/
 gulp.task("types", function() {
@@ -265,7 +291,9 @@ function taskLang(locale) {
         .bundle()
         .pipe(source("wordlist-" + locale + ".js"))
         .pipe(buffer())
-        .pipe(uglify())
+        .pipe(uglify({
+            output: { ascii_only: true }
+        }))
         .pipe(gulp.dest("dist"));
     });
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ethers",
-  "version": "4.0.8",
+  "version": "4.0.9",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -69,9 +69,9 @@
       "integrity": "sha512-8TqvB0ReZWwtcd3LXq3YSrBoLyXFgBX/sBZfGye9+YS8zH7/g+i6QRIuiDmwBoTzcQ/pk89nZYTYU4c5akKkzw=="
     },
     "JSONStream": {
-      "version": "1.3.3",
-      "resolved": "https://registry.npmjs.org/JSONStream/-/JSONStream-1.3.3.tgz",
-      "integrity": "sha512-3Sp6WZZ/lXl+nTDoGpGWHEpTnnC6X5fnkolYZR6nwIfzbxxvA8utPWe1gCt7i0m9uVGsSz2IS8K8mJ7HmlduMg==",
+      "version": "1.3.5",
+      "resolved": "https://registry.npmjs.org/JSONStream/-/JSONStream-1.3.5.tgz",
+      "integrity": "sha512-E+iruNOY8VV9s4JEbe1aNEm6MiszPRr/UfcHMz0TQh1BXSxHK+ASV1R6W4HpjBhSeS+54PIsAMCBmwD06LLsqQ==",
       "dev": true,
       "requires": {
         "jsonparse": "^1.2.0",
@@ -95,13 +95,10 @@
       "dev": true
     },
     "acorn-dynamic-import": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/acorn-dynamic-import/-/acorn-dynamic-import-3.0.0.tgz",
-      "integrity": "sha512-zVWV8Z8lislJoOKKqdNMOB+s6+XV5WERty8MnKBeFgwA+19XJjJHs2RP5dzM57FftIs+jQnRToLiWazKr6sSWg==",
-      "dev": true,
-      "requires": {
-        "acorn": "^5.0.0"
-      }
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/acorn-dynamic-import/-/acorn-dynamic-import-4.0.0.tgz",
+      "integrity": "sha512-d3OEjQV4ROpoflsnUA8HozoIR504TFxNivYEUi6uwz0IYhBkTDXGuWlNdMtybRt3nqVx/L6XqMt0FxkXuWKZhw==",
+      "dev": true
     },
     "acorn-jsx": {
       "version": "4.1.1",
@@ -113,16 +110,31 @@
       }
     },
     "acorn-node": {
-      "version": "1.5.2",
-      "resolved": "https://registry.npmjs.org/acorn-node/-/acorn-node-1.5.2.tgz",
-      "integrity": "sha512-krFKvw/d1F17AN3XZbybIUzEY4YEPNiGo05AfP3dBlfVKrMHETKpgjpuZkSF8qDNt9UkQcqj7am8yJLseklCMg==",
+      "version": "1.6.2",
+      "resolved": "https://registry.npmjs.org/acorn-node/-/acorn-node-1.6.2.tgz",
+      "integrity": "sha512-rIhNEZuNI8ibQcL7ANm/mGyPukIaZsRNX9psFNQURyJW0nu6k8wjSDld20z6v2mDBWqX13pIEnk9gGZJHIlEXg==",
       "dev": true,
       "requires": {
-        "acorn": "^5.7.1",
-        "acorn-dynamic-import": "^3.0.0",
+        "acorn": "^6.0.2",
+        "acorn-dynamic-import": "^4.0.0",
+        "acorn-walk": "^6.1.0",
         "xtend": "^4.0.1"
+      },
+      "dependencies": {
+        "acorn": {
+          "version": "6.0.4",
+          "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.0.4.tgz",
+          "integrity": "sha512-VY4i5EKSKkofY2I+6QLTbTTN/UvEQPCo6eiwzzSaSWfpaDhOmStMCMod6wmuPciNq+XS0faCglFu2lHZpdHUtg==",
+          "dev": true
+        }
       }
     },
+    "acorn-walk": {
+      "version": "6.1.0",
+      "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-6.1.0.tgz",
+      "integrity": "sha512-ugTb7Lq7u4GfWSqqpwE0bGyoBZNMTok/zDBXxfEG0QM50jNlGhIWjRC1pPN7bvV1anhF+bs+/gNcRw+o55Evbg==",
+      "dev": true
+    },
     "aes-js": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/aes-js/-/aes-js-3.0.0.tgz",
@@ -783,9 +795,9 @@
       "dev": true
     },
     "browserify": {
-      "version": "16.2.2",
-      "resolved": "https://registry.npmjs.org/browserify/-/browserify-16.2.2.tgz",
-      "integrity": "sha512-fMES05wq1Oukts6ksGUU2TMVHHp06LyQt0SIwbXIHm7waSrQmNBZePsU0iM/4f94zbvb/wHma+D1YrdzWYnF/A==",
+      "version": "16.2.3",
+      "resolved": "https://registry.npmjs.org/browserify/-/browserify-16.2.3.tgz",
+      "integrity": "sha512-zQt/Gd1+W+IY+h/xX2NYMW4orQWhqSwyV+xsblycTtpOuB27h1fZhhNQuipJ4t79ohw4P4mMem0jp/ZkISQtjQ==",
       "dev": true,
       "requires": {
         "JSONStream": "^1.0.3",
@@ -927,9 +939,9 @@
       }
     },
     "buffer": {
-      "version": "5.2.0",
-      "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.2.0.tgz",
-      "integrity": "sha512-nUJyfChH7PMJy75eRDCCKtszSEFokUNXC1hNVSe+o+VdcgvDPLs20k3v8UXI8ruRYAJiYtyRea8mYyqPxoHWDw==",
+      "version": "5.2.1",
+      "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.2.1.tgz",
+      "integrity": "sha512-c+Ko0loDaFfuPWiL02ls9Xd3GO3cPVmUobQ6t3rXNUk304u6hGq+8N/kFi+QEIKhzK3uwolVhLzszmfLmMLnqg==",
       "dev": true,
       "requires": {
         "base64-js": "^1.0.2",
@@ -996,9 +1008,9 @@
       }
     },
     "cached-path-relative": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/cached-path-relative/-/cached-path-relative-1.0.1.tgz",
-      "integrity": "sha1-0JxLUoAKpMB44t2BqGmqyQ0uVOc=",
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/cached-path-relative/-/cached-path-relative-1.0.2.tgz",
+      "integrity": "sha512-5r2GqsoEb4qMTTN9J+WzXfjov+hjxT+j3u5K+kIVNIwAd99DLCJE9pBIMP1qVeybV6JiijL385Oz0DcYxfbOIg==",
       "dev": true
     },
     "caller-path": {
@@ -5288,9 +5300,9 @@
       }
     },
     "pbkdf2": {
-      "version": "3.0.16",
-      "resolved": "https://registry.npmjs.org/pbkdf2/-/pbkdf2-3.0.16.tgz",
-      "integrity": "sha512-y4CXP3thSxqf7c0qmOF+9UeOTrifiVTIM+u7NWlq+PRsHbr7r7dpCmvzrZxa96JJUNi0Y5w9VqG5ZNeCVMoDcA==",
+      "version": "3.0.17",
+      "resolved": "https://registry.npmjs.org/pbkdf2/-/pbkdf2-3.0.17.tgz",
+      "integrity": "sha512-U/il5MsrZp7mGg3mSQfn742na2T+1/vHDCG5/iTI3X9MKUuYUZVLQhyRsg06mCgDBTd57TxzgZt7P+fYfjRLtA==",
       "dev": true,
       "requires": {
         "create-hash": "^1.1.2",
@@ -5392,16 +5404,17 @@
       }
     },
     "public-encrypt": {
-      "version": "4.0.2",
-      "resolved": "https://registry.npmjs.org/public-encrypt/-/public-encrypt-4.0.2.tgz",
-      "integrity": "sha512-4kJ5Esocg8X3h8YgJsKAuoesBgB7mqH3eowiDzMUPKiRDDE7E/BqqZD1hnTByIaAFiwAw246YEltSq7tdrOH0Q==",
+      "version": "4.0.3",
+      "resolved": "https://registry.npmjs.org/public-encrypt/-/public-encrypt-4.0.3.tgz",
+      "integrity": "sha512-zVpa8oKZSz5bTMTFClc1fQOnyyEzpl5ozpi1B5YcvBrdohMjH2rfsBtyXcuNuwjsDIXmBYlF2N5FlJYhR29t8Q==",
       "dev": true,
       "requires": {
         "bn.js": "^4.1.0",
         "browserify-rsa": "^4.0.0",
         "create-hash": "^1.1.0",
         "parse-asn1": "^5.0.0",
-        "randombytes": "^2.0.1"
+        "randombytes": "^2.0.1",
+        "safe-buffer": "^5.1.2"
       }
     },
     "pump": {

package.json

@@ -1,14 +1,14 @@
 {
   "name": "ethers",
-  "version": "4.0.8",
+  "version": "4.0.9",
   "description": "Ethereum wallet library.",
   "main": "./index.js",
   "types": "./index.d.ts",
   "scripts": {
     "build": "npm run dist-version && tsc -p ./tsconfig.json",
     "auto-build": "npm run build -- -w",
-    "dist": "npm run dist-version && npm run build && gulp default minified && npm run dist-types",
-    "dist-test": "gulp default-test minified-test",
+    "dist": "npm run dist-version && npm run build && gulp default minified shims && npm run dist-types",
+    "dist-test": "gulp default-test minified-test shims",
     "dist-bip39": "gulp bip39-es bip39-fr bip39-it bip39-ja bip39-ko bip39-zh",
     "dist-types": "dts-bundle --name ethers --main ./index.d.ts --out ./dist/ethers.types.txt",
     "dist-version": "node -e \"let v = require('./package.json').version; require('fs').writeFileSync('./src.ts/_version.ts', 'export const version = \\\"' + v +'\\\";\\n')\"",
@@ -31,7 +31,7 @@
     "xmlhttprequest": "1.8.0"
   },
   "devDependencies": {
-    "browserify": "^16.2.2",
+    "browserify": "^16.2.3",
     "browserify-zlib": "^0.2.0",
     "dts-bundle": "^0.7.3",
     "eslint": "^5.0.1",

src.ts/_version.ts

@@ -1 +1 @@
-export const version = "4.0.8";
+export const version = "4.0.9";

src.ts/errors.ts

@@ -122,3 +122,13 @@ export function setCensorship(censorship: boolean, permanent?: boolean): void {
     _censorErrors = !!censorship;
     _permanentCensorErrors = !!permanent;
 }
+
+export function checkNormalize(): void {
+    try {
+        if (String.fromCharCode(0xe9).normalize('NFD') !== String.fromCharCode(0x65, 0x0301)) {
+            throw new Error('broken')
+        }
+    } catch (error) {
+        throwError('platform missing String.prototype.normalize', UNSUPPORTED_OPERATION, { operation: 'String.prototype.normalize' });
+    }
+}

src.ts/utils/hdnode.ts

@@ -201,6 +201,8 @@ export function mnemonicToSeed(mnemonic: string, password?: string): string {
 export function mnemonicToEntropy(mnemonic: string, wordlist?: Wordlist): string {
     if (!wordlist) { wordlist = langEn; }
 
+    errors.checkNormalize();
+        
     var words = wordlist.split(mnemonic);
     if ((words.length % 3) !== 0) { throw new Error('invalid mnemonic'); }
 

src.ts/utils/utf8.ts

@@ -1,7 +1,7 @@
 'use strict';
 
 import { HashZero } from '../constants';
-
+import { checkNormalize } from '../errors';
 import { arrayify, concat, hexlify } from './bytes';
 
 ///////////////////////////////
@@ -23,6 +23,7 @@ export enum UnicodeNormalizationForm {
 export function toUtf8Bytes(str: string, form: UnicodeNormalizationForm = UnicodeNormalizationForm.current): Uint8Array {
 
     if (form != UnicodeNormalizationForm.current) {
+        checkNormalize();
         str = str.normalize(form);
     }
 

src.ts/wordlists/lang-ja.ts

@@ -132,9 +132,7 @@ class LangJa extends Wordlist {
     }
 
     split(mnemonic: string): Array<string> {
-        if (!mnemonic.normalize) {
-            errors.throwError('Japanese is unsupported on this platform; missing String.prototype.normalize', errors.UNSUPPORTED_OPERATION, { operation: 'String.prototype.normalize' });
-        }
+        errors.checkNormalize();
         return mnemonic.split(/(?:\u3000| )+/g);
     }
 

tests/shims/base64.js

@@ -0,0 +1,99 @@
+/**
+ * See: https://github.com/MaxArt2501/base64-js
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014 MaxArt2501
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+(function (root, factory) {
+    if (typeof define === 'function' && define.amd) {
+        // AMD. Register as an anonymous module.
+        define([], function() {factory(root);});
+    } else factory(root);
+// node.js has always supported base64 conversions, while browsers that support
+// web workers support base64 too, but you may never know.
+})(typeof exports !== "undefined" ? exports : this, function(root) {
+    if (root.atob) {
+        // Some browsers' implementation of atob doesn't support whitespaces
+        // in the encoded string (notably, IE). This wraps the native atob
+        // in a function that strips the whitespaces.
+        // The original function can be retrieved in atob.original
+        try {
+            root.atob(" ");
+        } catch(e) {
+            root.atob = (function(atob) {
+                var func = function(string) {
+                    return atob(String(string).replace(/[\t\n\f\r ]+/g, ""));
+                };
+                func.original = atob;
+                return func;
+            })(root.atob);
+        }
+        return;
+    }
+
+        // base64 character set, plus padding character (=)
+    var b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=",
+        // Regular expression to check formal correctness of base64 encoded strings
+        b64re = /^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/;
+
+    root.btoa = function(string) {
+        string = String(string);
+        var bitmap, a, b, c,
+            result = "", i = 0,
+            rest = string.length % 3; // To determine the final padding
+
+        for (; i < string.length;) {
+            if ((a = string.charCodeAt(i++)) > 255
+                    || (b = string.charCodeAt(i++)) > 255
+                    || (c = string.charCodeAt(i++)) > 255)
+                throw new TypeError("Failed to execute 'btoa' on 'Window': The string to be encoded contains characters outside of the Latin1 range.");
+
+            bitmap = (a << 16) | (b << 8) | c;
+            result += b64.charAt(bitmap >> 18 & 63) + b64.charAt(bitmap >> 12 & 63)
+                    + b64.charAt(bitmap >> 6 & 63) + b64.charAt(bitmap & 63);
+        }
+
+        // If there's need of padding, replace the last 'A's with equal signs
+        return rest ? result.slice(0, rest - 3) + "===".substring(rest) : result;
+    };
+
+    root.atob = function(string) {
+        // atob can work with strings with whitespaces, even inside the encoded part,
+        // but only \t, \n, \f, \r and ' ', which can be stripped.
+        string = String(string).replace(/[\t\n\f\r ]+/g, "");
+        if (!b64re.test(string))
+            throw new TypeError("Failed to execute 'atob' on 'Window': The string to be decoded is not correctly encoded.");
+
+        // Adding the padding if missing, for semplicity
+        string += "==".slice(2 - (string.length & 3));
+        var bitmap, result = "", r1, r2, i = 0;
+        for (; i < string.length;) {
+            bitmap = b64.indexOf(string.charAt(i++)) << 18 | b64.indexOf(string.charAt(i++)) << 12
+                    | (r1 = b64.indexOf(string.charAt(i++))) << 6 | (r2 = b64.indexOf(string.charAt(i++)));
+
+            result += r1 === 64 ? String.fromCharCode(bitmap >> 16 & 255)
+                    : r2 === 64 ? String.fromCharCode(bitmap >> 16 & 255, bitmap >> 8 & 255)
+                    : String.fromCharCode(bitmap >> 16 & 255, bitmap >> 8 & 255, bitmap & 255);
+        }
+        return result;
+    };
+});

tests/shims/index.js

@@ -0,0 +1,39 @@
+'use strict';
+
+// Shim String.prototype.normalize
+try {
+    // Some platforms have a native normalize, but it is broken; so we force our shim
+    if (String.fromCharCode(0xe9).normalize('NFD') !== String.fromCharCode(0x65, 0x0301)) {
+        throw new Error('bad normalize');
+    }
+} catch (error) {
+    var unorm = require('./unorm.js');
+    console.log("Broken String.prototype.normalize... Forcing shim.");
+    String.prototype.normalize = function(form) {
+        var func = unorm[(form || 'NFC').toLowerCase()];
+        if (!func) { throw new RangeError('invalid form - ' + form); }
+        return func(this);
+    }
+}
+
+// Shim atob and btoa
+var base64 = require('./base64.js');
+if (!global.atob) { global.atob = base64.atob; }
+if (!global.btoa) { global.btoa = base64.btoa; }
+
+// Shim Promise
+var promise = require('./es6-promise.auto.js');
+
+// Shim ArrayBuffer.isView
+if (!ArrayBuffer.isView) {
+    ArrayBuffer.isView = function(obj) {
+        // @TODO: This should probably check various instanceof aswell
+        return !!(obj.buffer);
+    }
+}
+
+// Shim nextTick
+if (!global.nextTick) {
+    global.nextTick = function (callback) { setTimeout(callback, 0); }
+}
+

tests/test.html

@@ -11,37 +11,7 @@
     <body>
         <div id="mocha"></div>
         <script src="../node_modules/mocha/mocha.js"></script>
-
-        <!--
-           Shim for PhantomJS: Promise
-           See: https://github.com/stefanpenner/es6-promise
-        -->
-        <script src="./dist/es6-promise.auto.js"></script>
-
-        <!--
-           Shim for String.prototype.normalize
-           See: https://github.com/walling/unorm
-        -->
-        <script src="./dist/unorm.js"></script>
-
-        <!--
-           Shims for PhantomJS
-        -->
-        <script type="text/javascript">
-
-            // ArrayBuffer.isView
-            if (!ArrayBuffer.isView) {
-                 ArrayBuffer.isView = function(obj) {
-                     // @TODO: This should probably check various instanceof aswell
-                     return !!(obj.buffer);
-                 }
-            }
-
-            // nextTick
-            if (!window.nextTick) {
-                window.nextTick = function (callback) { setTimeout(callback, 0); }
-            }
-        </script>
+        <script src="../dist/shims.js"></script>
 
         <!-- Inject the mocha describe and it functions -->
         <script type="text/javascript">