From f93cd1bb48c9ae977822a274033f02fab737f64a Mon Sep 17 00:00:00 2001 From: Greg Hysen Date: Wed, 30 Jan 2019 12:28:09 -0800 Subject: Can query decoder by contract address / network id OR contract name --- packages/utils/src/calldata_decoder.ts | 129 ++++++++++++++------------- packages/utils/test/calldata_decoder_test.ts | 2 +- 2 files changed, 68 insertions(+), 63 deletions(-) (limited to 'packages') diff --git a/packages/utils/src/calldata_decoder.ts b/packages/utils/src/calldata_decoder.ts index 0279aa030..bbd67fd2c 100644 --- a/packages/utils/src/calldata_decoder.ts +++ b/packages/utils/src/calldata_decoder.ts @@ -11,15 +11,26 @@ export interface DecodedCalldata { functionName: string; functionSignature: string; functionArguments: any; - contractName: string; - deployedAddress?: string; - deployedNeworkId?: string; } interface AbiEncoderBySelectorElement { abiEncoder: AbiEncoder.Method; contractName?: string; contractAddress?: string; + networkId?: number; +} + +interface TransactionDecoderInfo { + abiEncoder: AbiEncoder.Method; + contractName?: string; + contractAddress?: string; + networkId?: number; +} + +interface TransactionProperties { + contractName?: string; + contractAddress?: string; + networkId?: number; } interface AbiEncoderByNeworkId { @@ -30,17 +41,23 @@ interface AbiEncoderBySelector { [index: string]: AbiEncoderByNeworkId; } -interface DeployedContractInfoByNetwork { - [index: number]: string; +interface DeployedContractInfo { + contractAddress?: string; + networkId?: number; } interface DeployedContractInfoByName { - [index: string]: DeployedContractInfoByNetwork; + [index: string]: DeployedContractInfo[]; +} + +interface TransactionDecodersBySelector { + [index: string]: TransactionDecoderInfo[]; } export class CalldataDecoder { private readonly _deployedContractInfoByName = {} as DeployedContractInfoByName; private readonly _abiEncoderBySelector: AbiEncoderBySelector = {}; + private readonly _txDecoders: TransactionDecodersBySelector = {}; private static _instance: CalldataDecoder; public static getInstance(): CalldataDecoder { @@ -52,15 +69,23 @@ export class CalldataDecoder { private constructor() { // Load addresses by contract name - _.each(NetworkId, (networkId: NetworkId) => { - const contractAddressesForNetwork = getContractAddressesForNetworkOrThrow(networkId); + _.each(NetworkId, (networkId: any) => { + if (typeof networkId !== 'number') return; + const networkIdAsNumber = networkId as number; + const contractAddressesForNetwork = getContractAddressesForNetworkOrThrow(networkIdAsNumber); _.each(contractAddressesForNetwork, (contractAddress: string, contractName: string) => { - this._deployedContractInfoByName[contractName][networkId as number] = contractAddress; + 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; const functionAbis = _.filter(contractAbi, (abiEntry) => {return abiEntry.type === 'function'}) as MethodAbi[]; _.each(functionAbis, (functionAbi) => { @@ -69,15 +94,27 @@ export class CalldataDecoder { if (_.has(this._abiEncoderBySelector, functionSelector)) { return; } - this._abiEncoderBySelector[functionSelector][conractArtifact.contractName] = {abiEncoder}; + if (!(functionSelector in this._txDecoders)) this._txDecoders[functionSelector] = []; + // Recored deployed versions of this decoder + _.each(this._deployedContractInfoByName[contractNameLowercase], (deployedContract) => { + this._txDecoders[functionSelector].push({ + abiEncoder, + contractName, + contractAddress: deployedContract.contractAddress, + networkId: deployedContract.networkId, + }); + }); + // If there isn't a deployed version of this contract, record it without address/network id + if (_.isUndefined(this._deployedContractInfoByName[contractNameLowercase])) { + this._txDecoders[functionSelector].push({ + abiEncoder, + contractName, + }); + } }); }); } - public static registerContractAbi(contractArtifact: SimpleContractArtifact, deployedAddress?: string, deployedNeworkId?: number) { - - } - 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}'`); @@ -86,62 +123,30 @@ export class CalldataDecoder { return functionSelector; } - public static decodeWithContractAddress(calldata: string, contractAddress: string, networkId?: number): DecodedCalldata { + public static decode(calldata: string, txProperties_?: TransactionProperties): DecodedCalldata { const functionSelector = CalldataDecoder.getFunctionSelector(calldata); + const txProperties = _.isUndefined(txProperties_) ? {} : txProperties_; const instance = CalldataDecoder.getInstance(); - const contractName = _.findKey(instance._deployedContractInfoByName, (info: DeployedContractInfoByNetwork) => { - return (!_.isUndefined(networkId) && info[networkId] === contractAddress) || (_.isUndefined(networkId) && contractAddress in info); - }); - if (_.isUndefined(contractName)) { - throw new Error(`Could not find contract name: ${contractName}`); - } - const abiEncoder = instance._abiEncoderBySelector[functionSelector][contractName]; - if (_.isUndefined(abiEncoder)) { - throw new Error(`Could not find matching abi encoder for selector '${functionSelector}'`); - } - - } - - public static decodeWithContractName(calldata: string, contractName: string): DecodedCalldata { - const functionSelector = CalldataDecoder.getFunctionSelector(calldata); - const instance = CalldataDecoder.getInstance(); - const abiEncoder = instance._abiEncoderBySelector[functionSelector][contractName]; - if (_.isUndefined(abiEncoder)) { - throw new Error(`Could not find matching abi encoder for selector '${functionSelector}'`); + const txDecodersByFunctionSelector = instance._txDecoders[functionSelector]; + if (_.isUndefined(txDecodersByFunctionSelector)) { + throw new Error(`No decoder registered for function selector '${functionSelector}'`); } - } - - public static decodeWithoutContractInfo(calldata: string): DecodedCalldata { - const functionSelector = CalldataDecoder.getFunctionSelector(calldata); - const instance = CalldataDecoder.getInstance(); - const abiEncoder = _.find(instance._abiEncoderBySelector[functionSelector], () => {return true}); - if (_.isUndefined(abiEncoder)) { - throw new Error(`Could not find matching abi encoder for selector '${functionSelector}'`); + const txDecoderWithProperties = _.find(txDecodersByFunctionSelector, (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(txDecoderWithProperties)) { + throw new Error(`No decoder registered with properties: ${JSON.stringify(txProperties)}.`); } - return { - functionName: string; - functionSignature: string; - functionArguments: any; - contractName: string; - deployedAddress?: string; - deployedNeworkId?: string; - }; - } - - public static decode(calldata: string, contractName?: string, contractAddress?: string, networkId?: number, rules?: AbiEncoder.DecodingRules): DecodedCalldata { - - - - - /* - const functionName = abiEncoder.getDataItem().name; - const functionSignature = abiEncoder.getSignatureType(); - const functionArguments = abiEncoder.decode(calldata, rules); + const functionName = txDecoderWithProperties.abiEncoder.getDataItem().name; + const functionSignature = txDecoderWithProperties.abiEncoder.getSignatureType(); + const functionArguments = txDecoderWithProperties.abiEncoder.decode(calldata); const decodedCalldata = { functionName, functionSignature, functionArguments } - return decodedCalldata;*/ + return decodedCalldata; } } \ No newline at end of file diff --git a/packages/utils/test/calldata_decoder_test.ts b/packages/utils/test/calldata_decoder_test.ts index a3ff02a59..7d5cc9fd9 100644 --- a/packages/utils/test/calldata_decoder_test.ts +++ b/packages/utils/test/calldata_decoder_test.ts @@ -13,7 +13,7 @@ describe.only('CalldataDecoder', () => { //const cancelCalldata = '0xd46b02c3000000000000000000000000000000000000000000000000000000000000002000000000000000000000000056178a0d5f301baf6cf3e1cd53d9863437345bf90000000000000000000000000000000000000000000000000000000000000000000000000000000000000000a258b39954cef5cb142fd567a46cddb31a6701240000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000071d75ab9b9204fffc40000000000000000000000000000000000000000000000011c6e19c53d35b66200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c50f2ed000000000000000000000000000000000000000000000000000001689c2bc812000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b000000000000000000000000089d24a6b4ccb1b6faa2625fe562bdd9a23260359000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc200000000000000000000000000000000000000000000000000000000'; //const marketBuycalldata = '0xe5fa431b0000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000012309ce5400000000000000000000000000000000000000000000000000000000000000002e0000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000008c26348f63f9e008f0dd09a0ce1ed7caf6c1366b00000000000000000000000000000000000000000000000000000000000000000000000000000000000000005e150a33ffa97a8d22f59c77ae5487b089ef62e90000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000001323e717ba3800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006ea9bd19a0c4b5533ac98f58db0558a96e15ec5f71d64b6070cea4b5df10b7fb35424035000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b00000000000000000000000006cb262679c522c4f0834041a6248e8feb35f0337000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000421c750cedbf0eef0914c09b296f08462c363527f454bcf2dfaaf2f772e290d0ee5b0417d8b95837cbe501494195edc2a5a48c664d2ef74a340e40213c05db8767fa03000000000000000000000000000000000000000000000000000000000000'; const calldata = '0x3c28d861000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000002c000000000000000000000000000000000000000000000000000000000000004800000000000000000000000000000000000000000000000000000000000000500000000000000000000000000da912ecc847b3d98ca882e396e693e485deed5180000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d640000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008bb6a7394e2f000000000000000000000000000000000000000000000000868cab59cce788000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c51035008197e43b4d84439ec534b62670eaaaf4a46f50ff37ff62f6d1c1fbe8b036d3c000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001e00000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000024f47261b0000000000000000000000000503f9794d6a6bb0df8fbb19a2b3e2aeab35339ad000000000000000000000000000000000000000000000000000000000000000000000000000000003997d0f55d1daa549e95c240bc6353636f4cf9740000000000000000000000000681e844593a051e2882ec897ecd5444efe19ff20000000000000000000000008124071f810d533ff63de61d0c98db99eeb99d6400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000871bcc4c32c9d66800000000000000000000000000000000000000000000000000008a70a4d2d2100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c510350c20e53540c9b2c9207ad9a04e472e2224af211f08efc2f0eec15d7e1cfbf2109000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000001a00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c8f294b2728c269a9d01a1b58fe7cae2ef7895bd2de48cc3101eb47464d96594340924793fc8325db26a3abd5602605806a82ca77e810494c5ecab58b03449de80300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000421c372d6daa8e6ce2c696e51b6e1e33f10fd2b41b403cd88c311a617c3656ea02fe454e51cddf4682751bea9a02ce725cf364d1107f27be427d5157adbdcca2609b03000000000000000000000000000000000000000000000000000000000000'; - const decodedCalldata = CalldataDecoder.decode(calldata); + const decodedCalldata = CalldataDecoder.decode(calldata, {networkId: 1, contractAddress: '0x4f833a24e1f95d70f028921e27040ca56e09ab0b'}); console.log(JSON.stringify(decodedCalldata, null, 4)); expect(5).to.be.equal(5); }); -- cgit v1.2.3