separated tx decode classes and types into separate files

5 files changed, 100 insertions, 95 deletions

diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
index de32557fc..c0f15f2ab 100644
--- a/packages/utils/src/index.ts
+++ b/packages/utils/src/index.ts
@@ -11,4 +11,6 @@ export { errorUtils } from './error_utils';
 export { fetchAsync } from './fetch_async';
 export { signTypedDataUtils } from './sign_typed_data_utils';
 export import AbiEncoder = require('./abi_encoder');
-export { ZeroExTransactionDecoder } from './calldata_decoder';
+export * from './types';
+export { TransactionDecoder } from './transaction_decoder';
+export { ZeroExTransactionDecoder } from './zeroex_transaction_decoder';
diff --git a/packages/utils/src/calldata_decoder.ts b/packages/utils/src/transaction_decoder.ts
index 36016c7bc..85d92d553 100644
--- a/packages/utils/src/calldata_decoder.ts
+++ b/packages/utils/src/transaction_decoder.ts
@@ -1,44 +1,7 @@
-// Decodes any 0x transaction
-
-import * as ContractArtifacts from '@0x/contract-artifacts';
-import { SimpleContractArtifact } from '@0x/types';
-import { AbiDefinition, ContractAbi, MethodAbi } from 'ethereum-types';
+import { AbiDefinition, MethodAbi } from 'ethereum-types';
 import * as _ from 'lodash';
 import { AbiEncoder } from '.';
-import { getContractAddressesForNetworkOrThrow, NetworkId } from '@0x/contract-addresses';
-
-export interface FunctionInfo {
-    functionSignature: string;
-    contractName?: string;
-    contractAddress?: string;
-    networkId?: number;
-    abiEncoder?: AbiEncoder.Method;
-}
-
-interface FunctionInfoBySelector {
-    [index: string]: FunctionInfo[];
-}
-
-export interface DecodedCalldata {
-    functionName: string;
-    functionSignature: string;
-    functionArguments: any;
-}
-
-interface TransactionProperties {
-    contractName?: string;
-    contractAddress?: string;
-    networkId?: number;
-}
-
-interface DeployedContractInfo {
-    contractAddress: string;
-    networkId: number;
-}
-
-interface DeployedContractInfoByName {
-    [index: string]: DeployedContractInfo[];
-}
+import { FunctionInfoBySelector, TransactionData, TransactionProperties, DeployedContractInfo } from './types';
 
 export class TransactionDecoder {
     private _functionInfoBySelector: FunctionInfoBySelector = {};
@@ -86,10 +49,9 @@ export class TransactionDecoder {
         });
     }
 
-    public decode(calldata: string, txProperties_?: TransactionProperties): DecodedCalldata {
+    public decode(calldata: string, txProperties_?: TransactionProperties): TransactionData {
         const functionSelector = TransactionDecoder.getFunctionSelector(calldata);
         const txProperties = _.isUndefined(txProperties_) ? {} : txProperties_;
-        
         const candidateFunctionInfos = this._functionInfoBySelector[functionSelector];
         if (_.isUndefined(candidateFunctionInfos)) {
             throw new Error(`No functions registered for selector '${functionSelector}'`);
@@ -116,50 +78,3 @@ export class TransactionDecoder {
     }
 }
 
-export class ZeroExTransactionDecoder extends TransactionDecoder {
-    private readonly _deployedContractInfoByName = {} as DeployedContractInfoByName;
-    private static _instance: ZeroExTransactionDecoder;
-
-    private static getInstance(): ZeroExTransactionDecoder {
-        if (!ZeroExTransactionDecoder._instance) {
-            ZeroExTransactionDecoder._instance = new ZeroExTransactionDecoder();
-        }
-        return ZeroExTransactionDecoder._instance;
-    }
-
-    private constructor() {
-        super();
-        // Load addresses by contract name
-        _.each(NetworkId, (networkId: any) => {
-            if (typeof networkId !== 'number') return;
-            const networkIdAsNumber = networkId as number;
-            const contractAddressesForNetwork = getContractAddressesForNetworkOrThrow(networkIdAsNumber);
-            _.each(contractAddressesForNetwork, (contractAddress: string, contractName: string) => {
-                const contractNameLowercase = _.toLower(contractName);
-                if (_.isUndefined(this._deployedContractInfoByName[contractNameLowercase])) {
-                    this._deployedContractInfoByName[contractNameLowercase] = [];
-                }
-                this._deployedContractInfoByName[contractNameLowercase].push({contractAddress, networkId: networkIdAsNumber});
-            });
-        });
-        // Load contract artifacts
-        _.each(ContractArtifacts, (contractArtifactAsJson: any) => {
-            const conractArtifact = contractArtifactAsJson as SimpleContractArtifact;
-            const contractName = conractArtifact.contractName;
-            const contractNameLowercase = _.toLower(contractName);
-            const contractAbi: ContractAbi = conractArtifact.compilerOutput.abi;
-             this.addABI(contractAbi, contractName, this._deployedContractInfoByName[contractNameLowercase]);
-        });
-    }
-
-    public static addABI(abiArray: AbiDefinition[], contractName: string, deploymentInfos?: DeployedContractInfo[]): void {
-        const instance = ZeroExTransactionDecoder.getInstance();
-        instance.addABI(abiArray, contractName, deploymentInfos);
-    }
-
-    public static decode(calldata: string, txProperties?: TransactionProperties): DecodedCalldata {   
-        const instance = ZeroExTransactionDecoder.getInstance();
-        const decodedCalldata = instance.decode(calldata, txProperties);
-        return decodedCalldata;
-    }
-}
diff --git a/packages/utils/src/types.ts b/packages/utils/src/types.ts
new file mode 100644
index 000000000..2510a9ec2
--- /dev/null
+++ b/packages/utils/src/types.ts
@@ -0,0 +1,34 @@
+import { AbiEncoder } from '.';
+
+export interface FunctionInfo {
+    functionSignature: string;
+    contractName?: string;
+    contractAddress?: string;
+    networkId?: number;
+    abiEncoder?: AbiEncoder.Method;
+}
+
+export interface FunctionInfoBySelector {
+    [index: string]: FunctionInfo[];
+}
+
+export interface TransactionData {
+    functionName: string;
+    functionSignature: string;
+    functionArguments: any;
+}
+
+export interface TransactionProperties {
+    contractName?: string;
+    contractAddress?: string;
+    networkId?: number;
+}
+
+export interface DeployedContractInfo {
+    contractAddress: string;
+    networkId: number;
+}
+
+export interface DeployedContractInfoByName {
+    [index: string]: DeployedContractInfo[];
+}
diff --git a/packages/utils/src/zeroex_transaction_decoder.ts b/packages/utils/src/zeroex_transaction_decoder.ts
new file mode 100644
index 000000000..049596770
--- /dev/null
+++ b/packages/utils/src/zeroex_transaction_decoder.ts
@@ -0,0 +1,55 @@
+import { TransactionDecoder } from './transaction_decoder';
+import { getContractAddressesForNetworkOrThrow, NetworkId } from '@0x/contract-addresses';
+import * as ContractArtifacts from '@0x/contract-artifacts';
+import { SimpleContractArtifact } from '@0x/types';
+import { AbiDefinition, ContractAbi } from 'ethereum-types';
+import { TransactionData, DeployedContractInfo, DeployedContractInfoByName, TransactionProperties } from './types';
+import * as _ from 'lodash';
+
+export class ZeroExTransactionDecoder extends TransactionDecoder {
+    private readonly _deployedContractInfoByName = {} as DeployedContractInfoByName;
+    private static _instance: ZeroExTransactionDecoder;
+
+    private static getInstance(): ZeroExTransactionDecoder {
+        if (!ZeroExTransactionDecoder._instance) {
+            ZeroExTransactionDecoder._instance = new ZeroExTransactionDecoder();
+        }
+        return ZeroExTransactionDecoder._instance;
+    }
+
+    private constructor() {
+        super();
+        // Load addresses by contract name
+        _.each(NetworkId, (networkId: any) => {
+            if (typeof networkId !== 'number') return;
+            const networkIdAsNumber = networkId as number;
+            const contractAddressesForNetwork = getContractAddressesForNetworkOrThrow(networkIdAsNumber);
+            _.each(contractAddressesForNetwork, (contractAddress: string, contractName: string) => {
+                const contractNameLowercase = _.toLower(contractName);
+                if (_.isUndefined(this._deployedContractInfoByName[contractNameLowercase])) {
+                    this._deployedContractInfoByName[contractNameLowercase] = [];
+                }
+                this._deployedContractInfoByName[contractNameLowercase].push({contractAddress, networkId: networkIdAsNumber});
+            });
+        });
+        // Load contract artifacts
+        _.each(ContractArtifacts, (contractArtifactAsJson: any) => {
+            const conractArtifact = contractArtifactAsJson as SimpleContractArtifact;
+            const contractName = conractArtifact.contractName;
+            const contractNameLowercase = _.toLower(contractName);
+            const contractAbi: ContractAbi = conractArtifact.compilerOutput.abi;
+             this.addABI(contractAbi, contractName, this._deployedContractInfoByName[contractNameLowercase]);
+        });
+    }
+
+    public static addABI(abiArray: AbiDefinition[], contractName: string, deploymentInfos?: DeployedContractInfo[]): void {
+        const instance = ZeroExTransactionDecoder.getInstance();
+        instance.addABI(abiArray, contractName, deploymentInfos);
+    }
+
+    public static decode(calldata: string, txProperties?: TransactionProperties): TransactionData {   
+        const instance = ZeroExTransactionDecoder.getInstance();
+        const decodedCalldata = instance.decode(calldata, txProperties);
+        return decodedCalldata;
+    }
+}
\ No newline at end of file
diff --git a/packages/utils/test/calldata_decoder_test.ts b/packages/utils/test/transaction_decoder_test.ts
index a7eafed70..b360876b4 100644
--- a/packages/utils/test/calldata_decoder_test.ts
+++ b/packages/utils/test/transaction_decoder_test.ts
@@ -7,15 +7,14 @@ import { chaiSetup } from './utils/chai_setup';
 chaiSetup.configure();
 const expect = chai.expect;
 
-describe.only('CalldataDecoder', () => {
-    describe.only('decodeCalldata', () => {
-        it.only('should successfull decode fillOrder calldata', async () => {
+describe.only('TransactionDecoder', () => {
+    describe('decode', () => {
+        it('should successfull decode fillOrder calldata', async () => {
             //const cancelCalldata = '0xd46b02c3000000000000000000000000000000000000000000000000000000000000002000000000000000000000000056178a0d5f301baf6cf3e1cd53d9863437345bf90000000000000000000000000000000000000000000000000000000000000000000000000000000000000000a258b39954cef5cb142fd567a46cddb31a6701240000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000071d75ab9b9204fffc40000000000000000000000000000000000000000000000011c6e19c53d35b66200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c50f2ed000000000000000000000000000000000000000000000000000001689c2bc812000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b000000000000000000000000089d24a6b4ccb1b6faa2625fe562bdd9a23260359000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc200000000000000000000000000000000000000000000000000000000';
             //const marketBuycalldata = '0xe5fa431b0000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000012309ce5400000000000000000000000000000000000000000000000000000000000000002e0000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000008c26348f63f9e008f0dd09a0ce1ed7caf6c1366b00000000000000000000000000000000000000000000000000000000000000000000000000000000000000005e150a33ffa97a8d22f59c77ae5487b089ef62e90000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000001323e717ba3800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006ea9bd19a0c4b5533ac98f58db0558a96e15ec5f71d64b6070cea4b5df10b7fb35424035000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b00000000000000000000000006cb262679c522c4f0834041a6248e8feb35f0337000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000421c750cedbf0eef0914c09b296f08462c363527f454bcf2dfaaf2f772e290d0ee5b0417d8b95837cbe501494195edc2a5a48c664d2ef74a340e40213c05db8767fa03000000000000000000000000000000000000000000000000000000000000';
             const calldata = '0x3c28d861000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000002c000000000000000000000000000000000000000000000000000000000000004800000000000000000000000000000000000000000000000000000000000000500000000000000000000000000da912ecc847b3d98ca882e396e693e485deed5180000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d640000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008bb6a7394e2f000000000000000000000000000000000000000000000000868cab59cce788000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c51035008197e43b4d84439ec534b62670eaaaf4a46f50ff37ff62f6d1c1fbe8b036d3c000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000503f9794d6a6bb0df8fbb19a2b3e2aeab35339ad000000000000000000000000000000000000000000000000000000000000000000000000000000003997d0f55d1daa549e95c240bc6353636f4cf9740000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d6400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000871bcc4c32c9d66800000000000000000000000000000000000000000000000000008a70a4d2d2100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c510350c20e53540c9b2c9207ad9a04e472e2224af211f08efc2f0eec15d7e1cfbf2109000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c8f294b2728c269a9d01a1b58fe7cae2ef7895bd2de48cc3101eb47464d96594340924793fc8325db26a3abd5602605806a82ca77e810494c5ecab58b03449de80300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c372d6daa8e6ce2c696e51b6e1e33f10fd2b41b403cd88c311a617c3656ea02fe454e51cddf4682751bea9a02ce725cf364d1107f27be427d5157adbdcca2609b03000000000000000000000000000000000000000000000000000000000000';
-            const decodedCalldata = ZeroExTransactionDecoder.decode(calldata, {networkId: 1, contractAddress: '0x4f833a24e1f95d70f028921e27040ca56e09ab0b'});
-            console.log(JSON.stringify(decodedCalldata, null, 4));
-            expect(5).to.be.equal(5);
+            const decodedTxData = ZeroExTransactionDecoder.decode(calldata, {contractName: "Dutchauction"});//{networkId: 1, contractAddress: '0x4f833a24e1f95d70f028921e27040ca56e09ab0b'});
+            console.log(decodedTxData);
         });
     });
 });