Fix spacing in checkArgument errors (#318).

_version.d.ts

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

_version.js

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

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.9";
+exports.version = "4.0.10";
 
 },{}],2:[function(require,module,exports){
 "use strict";
@@ -861,6 +861,17 @@ function setCensorship(censorship, permanent) {
     _permanentCensorErrors = !!permanent;
 }
 exports.setCensorship = setCensorship;
+function checkNormalize() {
+    try {
+        if (String.fromCharCode(0xe9).normalize('NFD') !== String.fromCharCode(0x65, 0x0301)) {
+            throw new Error('broken');
+        }
+    }
+    catch (error) {
+        throwError('platform missing String.prototype.normalize', exports.UNSUPPORTED_OPERATION, { operation: 'String.prototype.normalize' });
+    }
+}
+exports.checkNormalize = checkNormalize;
 
 },{"./_version":1}],6:[function(require,module,exports){
 'use strict';
@@ -13779,6 +13790,7 @@ function mnemonicToEntropy(mnemonic, wordlist) {
     if (!wordlist) {
         wordlist = lang_en_1.langEn;
     }
+    errors.checkNormalize();
     var words = wordlist.split(mnemonic);
     if ((words.length % 3) !== 0) {
         throw new Error('invalid mnemonic');
@@ -15926,6 +15938,7 @@ exports.parseEther = parseEther;
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
 var constants_1 = require("../constants");
+var errors_1 = require("../errors");
 var bytes_1 = require("./bytes");
 ///////////////////////////////
 var UnicodeNormalizationForm;
@@ -15941,6 +15954,7 @@ var UnicodeNormalizationForm;
 function toUtf8Bytes(str, form) {
     if (form === void 0) { form = UnicodeNormalizationForm.current; }
     if (form != UnicodeNormalizationForm.current) {
+        errors_1.checkNormalize();
         str = str.normalize(form);
     }
     var result = [];
@@ -16109,7 +16123,7 @@ function parseBytes32String(bytes) {
 }
 exports.parseBytes32String = parseBytes32String;
 
-},{"../constants":3,"./bytes":62}],84:[function(require,module,exports){
+},{"../constants":3,"../errors":5,"./bytes":62}],84:[function(require,module,exports){
 'use strict';
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;

dist/ethers.types.txt

@@ -188,6 +188,7 @@ declare module 'ethers/errors' {
     export function checkNew(self: any, kind: any): void;
     export function checkArgumentCount(count: number, expectedCount: number, suffix?: string): void;
     export function setCensorship(censorship: boolean, permanent?: boolean): void;
+    export function checkNormalize(): void;
 }
 
 declare module 'ethers/providers' {
@@ -261,7 +262,7 @@ declare module 'ethers/utils/shims' {
 }
 
 declare module 'ethers/_version' {
-    export const version = "4.0.9";
+    export const version = "4.0.10";
 }
 
 declare module 'ethers/utils/bignumber' {

errors.d.ts

@@ -14,3 +14,4 @@ export declare function throwError(message: string, code: string, params: any):
 export declare function checkNew(self: any, kind: any): void;
 export declare function checkArgumentCount(count: number, expectedCount: number, suffix?: string): void;
 export declare function setCensorship(censorship: boolean, permanent?: boolean): void;
+export declare function checkNormalize(): void;

errors.js

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

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ethers",
-  "version": "4.0.9",
+  "version": "4.0.10",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ethers",
-  "version": "4.0.9",
+  "version": "4.0.10",
   "description": "Ethereum wallet library.",
   "main": "./index.js",
   "types": "./index.d.ts",

src.ts/_version.ts

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

src.ts/contract.ts

@@ -799,7 +799,7 @@ export class ContractFactory {
         });
 
         // Make sure the call matches the constructor signature
-        errors.checkArgumentCount(args.length, this.interface.deployFunction.inputs.length, 'in Contract constructor');
+        errors.checkArgumentCount(args.length, this.interface.deployFunction.inputs.length, ' in Contract constructor');
 
         // Set the data to the bytecode + the encoded constructor arguments
         tx.data = this.interface.deployFunction.encode(this.bytecode, args);

src.ts/providers/base-provider.ts

@@ -475,10 +475,21 @@ export class BaseProvider extends Provider {
     private _network: Network;
 
     private _events: Array<_Event>;
-    protected _emitted: any;
+
+    // To help mitigate the eventually conssitent nature of the blockchain
+    // we keep a mapping of events we emit. If we emit an event X, we expect
+    // that a user should be able to query for that event in the callback,
+    // if the node returns null, we stall the response until we get back a
+    // meaningful value, since we may be hitting a re-org, or a node that
+    // has not indexed the event yet.
+    // Events:
+    //   - t:{hash}    - Transaction hash
+    //   - b:{hash}    - BlockHash
+    //   - block       - The most recent emitted block
+    protected _emitted: { [ eventName: string ]: number | 'pending' };
 
     private _pollingInterval: number;
-    private _poller: any; // @TODO: what does TypeScript thing setInterval returns?
+    private _poller: any; // @TODO: what does TypeScript think setInterval returns?
 
     private _lastBlockNumber: number;
 
@@ -532,11 +543,7 @@ export class BaseProvider extends Provider {
 
         this._pollingInterval = 4000;
 
-        // We use this to track recent emitted events; for example, if we emit a "block" of 100
-        // and we get a `getBlock(100)` request which would result in null, we should retry
-        // until we get a response. This provides devs with a consistent view. Similarly for
-        // transaction hashes.
-        this._emitted = { block: this._lastBlockNumber };
+        this._emitted = { block: -2 };
 
         this._fastQueryDate = 0;
     }
@@ -548,24 +555,43 @@ export class BaseProvider extends Provider {
             // If the block hasn't changed, meh.
             if (blockNumber === this._lastBlockNumber) { return; }
 
-            if (this._lastBlockNumber === -2) { this._lastBlockNumber = blockNumber - 1; }
+            // First polling cycle, trigger a "block" events
+            if (this._emitted.block === -2) {
+                this._emitted.block = blockNumber - 1;
+            }
 
             // Notify all listener for each block that has passed
-            for (let i = this._lastBlockNumber + 1; i <= blockNumber; i++) {
-                if (this._emitted.block < i) {
-                    this._emitted.block = i;
+            for (let i = (<number>this._emitted.block) + 1; i <= blockNumber; i++) {
+                this.emit('block', i);
+            }
+
+            // The emitted block was updated, check for obsolete events
+            if ((<number>this._emitted.block) !== blockNumber) {
+                this._emitted.block = blockNumber;
+
+                Object.keys(this._emitted).forEach((key) => {
+                    // The block event does not expire
+                    if (key === 'block') { return; }
+
+                    // The block we were at when we emitted this event
+                    let eventBlockNumber = this._emitted[key];
+
+                    // We cannot garbage collect pending transactions or blocks here
+                    // They should be garbage collected by the Provider when setting
+                    // "pending" events
+                    if (eventBlockNumber === 'pending') { return; }
 
                     // Evict any transaction hashes or block hashes over 12 blocks
                     // old, since they should not return null anyways
-                    Object.keys(this._emitted).forEach((key) => {
-                        if (key === 'block') { return; }
+                    if (blockNumber - eventBlockNumber > 12) {
+                        delete this._emitted[key];
+                    }
+                });
+            }
 
-                        if (this._emitted[key] > i + 12) {
-                            delete this._emitted[key];
-                        }
-                    });
-                }
-                this.emit('block', i);
+            // First polling cycle
+            if (this._lastBlockNumber === -2) {
+                this._lastBlockNumber = blockNumber - 1;
             }
 
             // Sweep balances and remove addresses we no longer have events for
@@ -583,6 +609,7 @@ export class BaseProvider extends Provider {
                             this.emit(hash, receipt);
                             return null;
                         }).catch((error: Error) => { this.emit('error', error); });
+
                         break;
                     }
 
@@ -591,13 +618,15 @@ export class BaseProvider extends Provider {
                         if (this._balances[address]) {
                             newBalances[address] = this._balances[address];
                         }
-                        this.getBalance(address, 'latest').then(function(balance) {
+
+                        this.getBalance(address, 'latest').then((balance) => {
                             let lastBalance = this._balances[address];
                             if (lastBalance && balance.eq(lastBalance)) { return; }
                             this._balances[address] = balance;
                             this.emit(address, balance);
                             return null;
                         }).catch((error: Error) => { this.emit('error', error); });
+
                         break;
                     }
 
@@ -630,12 +659,13 @@ export class BaseProvider extends Provider {
 
             return null;
         }).catch((error: Error) => { });
+
         this.doPoll();
     }
 
     resetEventsBlock(blockNumber: number): void {
-        this._lastBlockNumber = blockNumber;
-        this._doPoll();
+        this._lastBlockNumber = blockNumber - 1;
+        if (this.polling) { this._doPoll(); }
     }
 
     get network(): Network {
@@ -647,8 +677,7 @@ export class BaseProvider extends Provider {
     }
 
     get blockNumber(): number {
-        if (this._lastBlockNumber < 0) { return null; }
-        return this._lastBlockNumber;
+        return this._fastBlockNumber;
     }
 
     get polling(): boolean {
@@ -719,10 +748,12 @@ export class BaseProvider extends Provider {
     //        this will be used once we move to the WebSocket or other alternatives to polling
 
     waitForTransaction(transactionHash: string, confirmations?: number): Promise<TransactionReceipt> {
-        if (!confirmations) { confirmations = 1; }
+        if (confirmations == null) { confirmations = 1; }
         return poll(() => {
             return this.getTransactionReceipt(transactionHash).then((receipt) => {
-                if (receipt == null || receipt.confirmations < confirmations) { return undefined; }
+                if (receipt == null && confirmations !== 0) {
+                    if (receipt.confirmations < confirmations) { return undefined; }
+                }
                 return receipt;
             });
         }, { onceBlock: this });
@@ -832,11 +863,21 @@ export class BaseProvider extends Provider {
             errors.throwError('Transaction hash mismatch from Provider.sendTransaction.', errors.UNKNOWN_ERROR, { expectedHash: tx.hash, returnedHash: hash });
         }
 
-        this._emitted['t:' + tx.hash] = 'pending';
-
         // @TODO: (confirmations? number, timeout? number)
         result.wait = (confirmations?: number) => {
+
+            // We know this transaction *must* exist (whether it gets mined is
+            // another story), so setting an emitted value forces us to
+            // wait even if the node returns null for the receipt
+            if (confirmations !== 0) {
+                this._emitted['t:' + tx.hash] = 'pending';
+            }
+
             return this.waitForTransaction(tx.hash, confirmations).then((receipt) => {
+
+                // No longer pending, allow the polling loop to garbage collect this
+                this._emitted['t:' + tx.hash] = receipt.blockNumber;
+
                 if (receipt.status === 0) {
                     errors.throwError('transaction failed', errors.CALL_EXCEPTION, {
                         transactionHash: tx.hash,
@@ -918,7 +959,7 @@ export class BaseProvider extends Provider {
                     return poll(() => {
                         return this.perform('getBlock', { blockTag: blockTag, includeTransactions: !!includeTransactions }).then((block) => {
                             if (block == null) {
-                                if (blockNumber > this._emitted.block) {
+                                if (blockNumber <= this._emitted.block) {
                                     return undefined;
                                 }
                                 return null;

src.ts/providers/json-rpc-provider.ts

@@ -335,6 +335,7 @@ export class JsonRpcProvider extends BaseProvider {
 
                     var seq = Promise.resolve();
                     hashes.forEach(function(hash) {
+                        // @TODO: This should be garbage collected at some point... How? When?
                         self._emitted['t:' + hash.toLowerCase()] = 'pending';
                         seq = seq.then(function() {
                             return self.getTransaction(hash).then(function(tx) {

src.ts/utils/abi-coder.ts

@@ -844,7 +844,7 @@ class CoderArray extends Coder {
             result = uint256Coder.encode(count);
         }
 
-        errors.checkArgumentCount(count, value.length, 'in coder array' + (this.localName? (" "+ this.localName): ""));
+        errors.checkArgumentCount(count, value.length, ' in coder array' + (this.localName? (" "+ this.localName): ""));
 
         var coders = [];
         for (var i = 0; i < value.length; i++) { coders.push(this.coder); }

src.ts/utils/interface.ts

@@ -103,7 +103,7 @@ class _DeployDescription extends Description implements DeployDescription {
             });
         }
 
-        errors.checkArgumentCount(params.length, this.inputs.length, 'in Interface constructor');
+        errors.checkArgumentCount(params.length, this.inputs.length, ' in Interface constructor');
 
         try {
             return (bytecode + defaultAbiCoder.encode(this.inputs, params).substring(2));
@@ -132,7 +132,7 @@ class _FunctionDescription extends Description implements FunctionDescription {
     readonly gas: BigNumber;
 
     encode(params: Array<any>): string {
-        errors.checkArgumentCount(params.length, this.inputs.length, 'in interface function ' + this.name);
+        errors.checkArgumentCount(params.length, this.inputs.length, ' in interface function ' + this.name);
 
         try {
             return this.sighash + defaultAbiCoder.encode(this.inputs, params).substring(2);

utils/hdnode.js

@@ -166,6 +166,7 @@ function mnemonicToEntropy(mnemonic, wordlist) {
     if (!wordlist) {
         wordlist = lang_en_1.langEn;
     }
+    errors.checkNormalize();
     var words = wordlist.split(mnemonic);
     if ((words.length % 3) !== 0) {
         throw new Error('invalid mnemonic');

utils/utf8.js

@@ -1,6 +1,7 @@
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
 var constants_1 = require("../constants");
+var errors_1 = require("../errors");
 var bytes_1 = require("./bytes");
 ///////////////////////////////
 var UnicodeNormalizationForm;
@@ -16,6 +17,7 @@ var UnicodeNormalizationForm;
 function toUtf8Bytes(str, form) {
     if (form === void 0) { form = UnicodeNormalizationForm.current; }
     if (form != UnicodeNormalizationForm.current) {
+        errors_1.checkNormalize();
         str = str.normalize(form);
     }
     var result = [];

wordlists/lang-ja.js

@@ -131,9 +131,7 @@ var LangJa = /** @class */ (function (_super) {
         return wordlist.indexOf(word);
     };
     LangJa.prototype.split = function (mnemonic) {
-        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);
     };
     LangJa.prototype.join = function (words) {