Removed jsonCopy and added deepCopy instead (ethers-io#261).

ricmoo · ricmoo · commit e0927461657f · 2018-08-21T13:11:44.000+02:00
diff --git a/src.ts/contracts/contract.ts b/src.ts/contracts/contract.ts
@@ -7,7 +7,7 @@ import { getAddress, getContractAddress } from '../utils/address';
 import { BigNumber, bigNumberify } from '../utils/bignumber';
 import { hexDataLength, hexDataSlice, isHexString } from '../utils/bytes';
 import { Zero } from '../utils/constants';
-import { defineReadOnly, jsonCopy, shallowCopy } from '../utils/properties';
+import { defineReadOnly, deepCopy, shallowCopy } from '../utils/properties';
 import { poll } from '../utils/web';
 
 import * as errors from '../utils/errors';
@@ -536,7 +536,7 @@ export class Contract {
         let wrappedListener = (log: Log) => {
             let decoded = Array.prototype.slice.call(eventFilter.decode(log));
 
-            let event = jsonCopy(log);
+            let event = deepCopy(log);
             event.args = decoded;
             event.decode = eventFilter.event.decode;
             event.event = eventFilter.event.name;
diff --git a/src.ts/contracts/interface.ts b/src.ts/contracts/interface.ts
@@ -8,7 +8,7 @@ import { BigNumber, bigNumberify } from '../utils/bignumber';
 import { arrayify, concat, hexlify, hexZeroPad, isHexString } from '../utils/bytes';
 import { id } from '../utils/hash';
 import { keccak256 } from '../utils/keccak256';
-import { defineReadOnly, defineFrozen, isType, setType } from '../utils/properties';
+import { deepCopy, defineReadOnly, isType, setType } from '../utils/properties';
 
 import * as errors from '../utils/errors';
 
@@ -83,18 +83,11 @@ class _Indexed implements Indexed {
 
 class Description {
     constructor(info: any) {
+        setType(this, 'Description');
         for (var key in info) {
-            let value = info[key];
-            if (value != null && typeof(value) === 'object') {
-                if (BigNumber.isBigNumber(value)) {
-                    defineReadOnly(this, key, value);
-                } else {
-                    defineFrozen(this, key, value);
-                }
-            } else {
-                defineReadOnly(this, key, value);
-            }
+            defineReadOnly(this, key, deepCopy(info[key], true));
         }
+        Object.freeze(this);
     }
 }
 
@@ -256,7 +249,7 @@ class _EventDescription extends Description implements EventDescription {
             arrayify(data)
         );
 
-        var result = new Result({});
+        var result: any = {};
         var nonIndexedIndex = 0, indexedIndex = 0;
         this.inputs.forEach(function(input, index) {
             if (input.indexed) {
@@ -277,7 +270,7 @@ class _EventDescription extends Description implements EventDescription {
 
         result.length = this.inputs.length;
 
-        return result;
+        return new Result(result);
     }
 }
 
@@ -416,7 +409,7 @@ export class Interface {
             _abi.push(<EventFragment | FunctionFragment>fragment);
         });
 
-        defineFrozen(this, 'abi', _abi);
+        defineReadOnly(this, 'abi', deepCopy(_abi, true));
 
         _abi.forEach(addMethod, this);
 
diff --git a/src.ts/utils/abi-coder.ts b/src.ts/utils/abi-coder.ts
@@ -7,7 +7,7 @@ import { BigNumber, bigNumberify } from './bignumber';
 import { arrayify, concat, hexlify, padZeros } from './bytes';
 import { NegativeOne, Zero, One, MaxUint256 } from '../utils/constants';
 import { toUtf8Bytes, toUtf8String } from './utf8';
-import { defineReadOnly, jsonCopy } from './properties';
+import { deepCopy, defineReadOnly, shallowCopy } from './properties';
 
 import * as errors from './errors';
 
@@ -986,8 +986,9 @@ function getParamCoder(coerceFunc: CoerceFunc, param: ParamType): Coder {
     var match = param.type.match(paramTypeArray);
     if (match) {
         let size = parseInt(match[2] || "-1");
-        param = jsonCopy(param);
+        param = shallowCopy(param);
         param.type = match[1];
+        param = deepCopy(param);
         return new CoderArray(coerceFunc, getParamCoder(coerceFunc, param), size, param.name);
     }
 
@@ -1056,7 +1057,7 @@ export class AbiCoder {
             if (typeof(type) === 'string') {
                 typeObject = parseParam(type);
             } else {
-                typeObject = jsonCopy(type);
+                typeObject = deepCopy(type);
             }
 
             coders.push(getParamCoder(this.coerceFunc, typeObject));
diff --git a/src.ts/utils/index.ts b/src.ts/utils/index.ts
@@ -12,11 +12,11 @@ import { sha256 } from './sha2';
 import { keccak256 as solidityKeccak256, pack as solidityPack, sha256 as soliditySha256 } from './solidity';
 import { randomBytes } from './random-bytes';
 import { getNetwork } from './networks';
-import { defineFrozen, defineReadOnly, resolveProperties, shallowCopy } from './properties';
+import { deepCopy, defineReadOnly, resolveProperties, shallowCopy } from './properties';
 import * as RLP from './rlp';
 import { computePublicKey, verifyMessage } from './secp256k1';
 import { parse as parseTransaction, serialize as serializeTransaction } from './transaction';
-import { toUtf8Bytes, toUtf8String } from './utf8';
+import { formatBytes32String, parseBytes32String, toUtf8Bytes, toUtf8String } from './utf8';
 import { formatEther, parseEther, formatUnits, parseUnits } from './units';
 import { fetchJson } from './web';
 
@@ -32,8 +32,8 @@ export {
     fetchJson,
     getNetwork,
 
+    deepCopy,
     defineReadOnly,
-    defineFrozen,
     resolveProperties,
     shallowCopy,
 
@@ -56,6 +56,9 @@ export {
     toUtf8Bytes,
     toUtf8String,
 
+    formatBytes32String,
+    parseBytes32String,
+
     hashMessage,
     namehash,
     id,
diff --git a/src.ts/utils/properties.ts b/src.ts/utils/properties.ts
@@ -8,14 +8,6 @@ export function defineReadOnly(object: any, name: string, value: any): void {
     });
 }
 
-export function defineFrozen(object: any, name: string, value: any): void {
-    var frozen = JSON.stringify(value);
-    Object.defineProperty(object, name, {
-        enumerable: true,
-        get: function() { return JSON.parse(frozen); }
-    });
-}
-
 // There are some issues with instanceof with npm link, so we use this
 // to ensure types are what we expect.
 
@@ -56,8 +48,43 @@ export function shallowCopy(object: any): any {
     return result;
 }
 
-export function jsonCopy(object: any): any {
-    return JSON.parse(JSON.stringify(object));
+let opaque: { [key: string]: boolean } = { boolean: true, number: true, string: true };
+
+export function deepCopy(object: any, frozen?: boolean): any {
+
+    if (object === undefined || object === null || opaque[typeof(object)]) { return object; }
+
+    if (Array.isArray(object)) {
+        let result: Array<any> = [];
+        object.forEach((item) => {
+            result.push(deepCopy(item, frozen));
+        });
+
+        if (frozen) { Object.freeze(result); }
+
+        return result
+    }
+
+    if (typeof(object) === 'object') {
+
+        // Some internal objects, which are already immutable
+        if (isType(object, 'BigNumber')) { return object; }
+        if (isType(object, 'Description')) { return object; }
+        if (isType(object, 'Indexed')) { return object; }
+
+        let result: { [ key: string ]: any } = {};
+        for (var key in object) {
+            let value = object[key];
+            if (value === undefined) { continue; }
+            defineReadOnly(result, key, deepCopy(value, frozen));
+        }
+
+        if (frozen) { Object.freeze(result); }
+
+        return result;
+    }
+
+    throw new Error('Cannot deepCopy ' + typeof(object));
 }
 
 // See: https://github.com/isaacs/inherits/blob/master/inherits_browser.js
