diff options
-rw-r--r-- | packages/utils/src/transaction_decoder.ts | 48 | ||||
-rw-r--r-- | packages/utils/src/zeroex_transaction_decoder.ts | 55 | ||||
-rw-r--r-- | packages/utils/test/transaction_decoder_test.ts | 5 |
3 files changed, 62 insertions, 46 deletions
diff --git a/packages/utils/src/transaction_decoder.ts b/packages/utils/src/transaction_decoder.ts index 85d92d553..35a889a4e 100644 --- a/packages/utils/src/transaction_decoder.ts +++ b/packages/utils/src/transaction_decoder.ts @@ -1,26 +1,27 @@ import { AbiDefinition, MethodAbi } from 'ethereum-types'; import * as _ from 'lodash'; + import { AbiEncoder } from '.'; -import { FunctionInfoBySelector, TransactionData, TransactionProperties, DeployedContractInfo } from './types'; +import { DeployedContractInfo, FunctionInfoBySelector, TransactionData, TransactionProperties } from './types'; export class TransactionDecoder { - private _functionInfoBySelector: FunctionInfoBySelector = {}; - - private static getFunctionSelector(calldata: string): string { - if (!calldata.startsWith('0x') || calldata.length < 10) { - throw new Error(`Malformed calldata. Must include hex prefix '0x' and 4-byte function selector. Got '${calldata}'`); + private readonly _functionInfoBySelector: FunctionInfoBySelector = {}; + + private static _getFunctionSelector(calldata: string): string { + const functionSelectorLength = 10; + if (!calldata.startsWith('0x') || calldata.length < functionSelectorLength) { + throw new Error( + `Malformed calldata. Must include hex prefix '0x' and 4-byte function selector. Got '${calldata}'`, + ); } - const functionSelector = calldata.substr(0, 10); + const functionSelector = calldata.substr(0, functionSelectorLength); return functionSelector; } public addABI(abiArray: AbiDefinition[], contractName: string, deploymentInfos?: DeployedContractInfo[]): void { - if (_.isEmpty(abiArray)) { - return; - } - const functionAbis = _.filter(abiArray, abiEntry => { + const functionAbis: MethodAbi[] = _.filter(abiArray, abiEntry => { return abiEntry.type === 'function'; - }) as MethodAbi[]; + }); _.each(functionAbis, functionAbi => { const abiEncoder = new AbiEncoder.Method(functionAbi); const functionSelector = abiEncoder.getSelector(); @@ -50,21 +51,27 @@ export class TransactionDecoder { } public decode(calldata: string, txProperties_?: TransactionProperties): TransactionData { - const functionSelector = TransactionDecoder.getFunctionSelector(calldata); + 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}'`); } - const functionInfo = _.find(candidateFunctionInfos, (txDecoder) => { - return (_.isUndefined(txProperties.contractName) || _.toLower(txDecoder.contractName) === _.toLower(txProperties.contractName)) && - (_.isUndefined(txProperties.contractAddress) || txDecoder.contractAddress === txProperties.contractAddress) && - (_.isUndefined(txProperties.networkId) || txDecoder.networkId === txProperties.networkId); + const functionInfo = _.find(candidateFunctionInfos, txDecoder => { + return ( + (_.isUndefined(txProperties.contractName) || + _.toLower(txDecoder.contractName) === _.toLower(txProperties.contractName)) && + (_.isUndefined(txProperties.contractAddress) || + txDecoder.contractAddress === txProperties.contractAddress) && + (_.isUndefined(txProperties.networkId) || txDecoder.networkId === txProperties.networkId) + ); }); if (_.isUndefined(functionInfo)) { throw new Error(`No function registered with properties: ${JSON.stringify(txProperties)}.`); } else if (_.isUndefined(functionInfo.abiEncoder)) { - throw new Error(`Function ABI Encoder is not defined, for function with properties: ${JSON.stringify(txProperties)}.`); + throw new Error( + `Function ABI Encoder is not defined, for function with properties: ${JSON.stringify(txProperties)}.`, + ); } const functionName = functionInfo.abiEncoder.getDataItem().name; const functionSignature = functionInfo.abiEncoder.getSignatureType(); @@ -72,9 +79,8 @@ export class TransactionDecoder { const decodedCalldata = { functionName, functionSignature, - functionArguments - } + functionArguments, + }; return decodedCalldata; } } - diff --git a/packages/utils/src/zeroex_transaction_decoder.ts b/packages/utils/src/zeroex_transaction_decoder.ts index 049596770..f236257cb 100644 --- a/packages/utils/src/zeroex_transaction_decoder.ts +++ b/packages/utils/src/zeroex_transaction_decoder.ts @@ -1,16 +1,31 @@ -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'; +import { TransactionDecoder } from './transaction_decoder'; +import { DeployedContractInfo, DeployedContractInfoByName, TransactionData, TransactionProperties } from './types'; + export class ZeroExTransactionDecoder extends TransactionDecoder { - private readonly _deployedContractInfoByName = {} as DeployedContractInfoByName; private static _instance: ZeroExTransactionDecoder; - private static getInstance(): ZeroExTransactionDecoder { + 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; + } + + private static _getInstance(): ZeroExTransactionDecoder { if (!ZeroExTransactionDecoder._instance) { ZeroExTransactionDecoder._instance = new ZeroExTransactionDecoder(); } @@ -20,16 +35,21 @@ export class ZeroExTransactionDecoder extends TransactionDecoder { private constructor() { super(); // Load addresses by contract name + const deployedContractInfoByName: DeployedContractInfoByName = {}; _.each(NetworkId, (networkId: any) => { - if (typeof networkId !== 'number') return; - const networkIdAsNumber = networkId as number; - const contractAddressesForNetwork = getContractAddressesForNetworkOrThrow(networkIdAsNumber); + if (typeof networkId !== 'number') { + return; + } + const contractAddressesForNetwork = getContractAddressesForNetworkOrThrow(networkId); _.each(contractAddressesForNetwork, (contractAddress: string, contractName: string) => { const contractNameLowercase = _.toLower(contractName); - if (_.isUndefined(this._deployedContractInfoByName[contractNameLowercase])) { - this._deployedContractInfoByName[contractNameLowercase] = []; + if (_.isUndefined(deployedContractInfoByName[contractNameLowercase])) { + deployedContractInfoByName[contractNameLowercase] = []; } - this._deployedContractInfoByName[contractNameLowercase].push({contractAddress, networkId: networkIdAsNumber}); + deployedContractInfoByName[contractNameLowercase].push({ + contractAddress, + networkId, + }); }); }); // Load contract artifacts @@ -38,18 +58,7 @@ export class ZeroExTransactionDecoder extends TransactionDecoder { const contractName = conractArtifact.contractName; const contractNameLowercase = _.toLower(contractName); const contractAbi: ContractAbi = conractArtifact.compilerOutput.abi; - this.addABI(contractAbi, contractName, this._deployedContractInfoByName[contractNameLowercase]); + this.addABI(contractAbi, contractName, 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/transaction_decoder_test.ts b/packages/utils/test/transaction_decoder_test.ts index b360876b4..eee712e98 100644 --- a/packages/utils/test/transaction_decoder_test.ts +++ b/packages/utils/test/transaction_decoder_test.ts @@ -12,8 +12,9 @@ describe.only('TransactionDecoder', () => { it('should successfull decode fillOrder calldata', async () => { //const cancelCalldata = '0xd46b02c3000000000000000000000000000000000000000000000000000000000000002000000000000000000000000056178a0d5f301baf6cf3e1cd53d9863437345bf90000000000000000000000000000000000000000000000000000000000000000000000000000000000000000a258b39954cef5cb142fd567a46cddb31a6701240000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000071d75ab9b9204fffc40000000000000000000000000000000000000000000000011c6e19c53d35b66200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c50f2ed000000000000000000000000000000000000000000000000000001689c2bc812000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b000000000000000000000000089d24a6b4ccb1b6faa2625fe562bdd9a23260359000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc200000000000000000000000000000000000000000000000000000000'; //const marketBuycalldata = '0xe5fa431b0000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000012309ce5400000000000000000000000000000000000000000000000000000000000000002e0000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000008c26348f63f9e008f0dd09a0ce1ed7caf6c1366b00000000000000000000000000000000000000000000000000000000000000000000000000000000000000005e150a33ffa97a8d22f59c77ae5487b089ef62e90000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000001323e717ba3800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006ea9bd19a0c4b5533ac98f58db0558a96e15ec5f71d64b6070cea4b5df10b7fb35424035000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b00000000000000000000000006cb262679c522c4f0834041a6248e8feb35f0337000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000421c750cedbf0eef0914c09b296f08462c363527f454bcf2dfaaf2f772e290d0ee5b0417d8b95837cbe501494195edc2a5a48c664d2ef74a340e40213c05db8767fa03000000000000000000000000000000000000000000000000000000000000'; - const calldata = '0x3c28d861000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000002c000000000000000000000000000000000000000000000000000000000000004800000000000000000000000000000000000000000000000000000000000000500000000000000000000000000da912ecc847b3d98ca882e396e693e485deed5180000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d640000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008bb6a7394e2f000000000000000000000000000000000000000000000000868cab59cce788000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c51035008197e43b4d84439ec534b62670eaaaf4a46f50ff37ff62f6d1c1fbe8b036d3c000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000503f9794d6a6bb0df8fbb19a2b3e2aeab35339ad000000000000000000000000000000000000000000000000000000000000000000000000000000003997d0f55d1daa549e95c240bc6353636f4cf9740000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d6400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000871bcc4c32c9d66800000000000000000000000000000000000000000000000000008a70a4d2d2100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c510350c20e53540c9b2c9207ad9a04e472e2224af211f08efc2f0eec15d7e1cfbf2109000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c8f294b2728c269a9d01a1b58fe7cae2ef7895bd2de48cc3101eb47464d96594340924793fc8325db26a3abd5602605806a82ca77e810494c5ecab58b03449de80300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c372d6daa8e6ce2c696e51b6e1e33f10fd2b41b403cd88c311a617c3656ea02fe454e51cddf4682751bea9a02ce725cf364d1107f27be427d5157adbdcca2609b03000000000000000000000000000000000000000000000000000000000000'; - const decodedTxData = ZeroExTransactionDecoder.decode(calldata, {contractName: "Dutchauction"});//{networkId: 1, contractAddress: '0x4f833a24e1f95d70f028921e27040ca56e09ab0b'}); + const calldata = + '0x3c28d861000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000002c000000000000000000000000000000000000000000000000000000000000004800000000000000000000000000000000000000000000000000000000000000500000000000000000000000000da912ecc847b3d98ca882e396e693e485deed5180000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d640000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008bb6a7394e2f000000000000000000000000000000000000000000000000868cab59cce788000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c51035008197e43b4d84439ec534b62670eaaaf4a46f50ff37ff62f6d1c1fbe8b036d3c000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000503f9794d6a6bb0df8fbb19a2b3e2aeab35339ad000000000000000000000000000000000000000000000000000000000000000000000000000000003997d0f55d1daa549e95c240bc6353636f4cf9740000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d6400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000871bcc4c32c9d66800000000000000000000000000000000000000000000000000008a70a4d2d2100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c510350c20e53540c9b2c9207ad9a04e472e2224af211f08efc2f0eec15d7e1cfbf2109000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c8f294b2728c269a9d01a1b58fe7cae2ef7895bd2de48cc3101eb47464d96594340924793fc8325db26a3abd5602605806a82ca77e810494c5ecab58b03449de80300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c372d6daa8e6ce2c696e51b6e1e33f10fd2b41b403cd88c311a617c3656ea02fe454e51cddf4682751bea9a02ce725cf364d1107f27be427d5157adbdcca2609b03000000000000000000000000000000000000000000000000000000000000'; + const decodedTxData = ZeroExTransactionDecoder.decode(calldata, { contractName: 'Dutchauction' }); //{networkId: 1, contractAddress: '0x4f833a24e1f95d70f028921e27040ca56e09ab0b'}); console.log(decodedTxData); }); }); |