\n\n# ethereum-input-data-decoder\n\n> Ethereum smart contract transaction input data decoder\n\n[](https://raw.githubusercontent.com/miguelmota/ethereum-input-data-decoder/master/LICENSE)\n[](https://travis-ci.org/miguelmota/ethereum-input-data-decoder)\n[](https://david-dm.org/miguelmota/ethereum-input-data-decoder)\n[](http://badge.fury.io/js/ethereum-input-data-decoder)\n[](#contributing)\n\n## Demo\n\n[https://lab.miguelmota.com/ethereum-input-data-decoder](https://lab.miguelmota.com/ethereum-input-data-decoder)\n\n## Install\n\n```bash\nnpm install ethereum-input-data-decoder\n```\n\n## Getting started\n\nPass [ABI](https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI) file path to decoder constructor:\n\n```javascript\nconst InputDataDecoder = require('ethereum-input-data-decoder');\nconst decoder = new InputDataDecoder(`${__dirname}/abi.json`);\n```\n\nAlternatively, you can pass ABI array object to constructor;\n\n```javascript\nconst abi = [{ ... }]\nconst decoder = new InputDataDecoder(abi);\n```\n\n[example abi](./test/abi.json)\n\nThen you can decode input data:\n\n```javascript\nconst data = `0x67043cae0000000000000000000000005a9dac9315fdd1c3d13ef8af7fdfeb522db08f020000000000000000000000000000000000000000000000000000000058a20230000000000000000000000000000000000000000000000000000000000040293400000000000000000000000000000000000000000000000000000000000000a0f3df64775a2dfb6bc9e09dced96d0816ff5055bf95da13ce5b6c3f53b97071c800000000000000000000000000000000000000000000000000000000000000034254430000000000000000000000000000000000000000000000000000000000`;\n\nconst result = decoder.decodeData(data);\n\nconsole.log(result);\n```\n\n```text\n{\n \"method\": \"registerOffChainDonation\",\n \"types\": [\n \"address\",\n \"uint256\",\n \"uint256\",\n \"string\",\n \"bytes32\"\n ],\n \"inputs\": [\n ,\n ,\n ,\n \"BTC\",\n \n ],\n \"names\": [\n \"addr\",\n \"timestamp\",\n \"chfCents\",\n \"currency\",\n \"memo\"\n ]\n}\n```\n\nExample using input response from [web3.getTransaction](https://github.com/ethereum/wiki/wiki/JavaScript-API#web3ethgettransaction):\n\n```javascript\nweb3.eth.getTransaction(txHash, (error, txResult) => {\n const result = decoder.decodeData(txResult.input);\n console.log(result);\n});\n```\n\n### Decoding tuple and tuple[] types\n\nWhere `OrderData` is\n\n```solidity\nstruct OrderData {\n uint256 amount;\n address buyer;\n}\n```\n\nDecoding input to a method `someMethod(address,OrderData,OrderData[])` returns data in format\n\n```js\n{\n method: 'someMethod',\n types: ['address', '(uint256,address)', '(uint256,address)[]'],\n inputs: [\n '0x81c55017F7Ce6E72451cEd49FF7bAB1e3DF64d0C',\n [100, '0xA37dE6790861B5541b0dAa7d0C0e651F44c6f4D9']\n [[274, '0xea674fdde714fd979de3edf0f56aa9716b898ec8']]\n ],\n names: ['sender', ['order', ['amount', 'buyer']], ['allOrders', ['amount', 'buyer']]]\n}\n```\n\n- In the `types` field, tuples are represented as a string containing types contained in the tuple\n- In the `inputs` field, tuples are represented as an array containing values contained in the tuple\n- In the `names` field, tuples are represented as an array with 2 items. Item 1 is the name of the tuple, item 2 is an array containing the names of the values contained in the tuple.\n\n### Decoding Big Numbers\n\nAll numbers are returned in [big number](https://github.com/indutny/bn.js) format to preserve precision.\n\nHere's an example of how to convert the big number to a human readable format.\n\n```js\nconsole.log(result.inputs[0].toString(10)) // \"5\"\nconsole.log(result.inputs[0].toNumber()) // 55\n```\n\nPlease keep in mind that JavaScript only supports numbers up to 64 bits. Solidity numbers can be up to 256 bits, so you run the risk of truncation when casting or having the big number library error out when trying to parse a large number to a JavaScript Number type.\n\n```js\nconst n = new BN(\"543534254523452352345234523455\")\nconsole.log(n.toString(10)) // \"543534254523452352345234523455\"\nconsole.log(n.toNumber()) // ERROR!\n```\n\n## CLI\n\n## Install\n\n```bash\nnpm install -g ethereum-input-data-decoder\n```\n\n### Usage\n\n```bash\n$ ethereum_input_data_decoder --help\n\n Ethereum smart contract transaction input data decoder\n\n Usage\n $ ethereum_input_data_decoder [flags] [input]\n\n Options\n --abi, -a ABI file path\n --input, -i Input data file path\n\n Examples\n $ ethereum_input_data_decoder --abi token.abi --input data.txt\n $ ethereum_input_data_decoder --abi token.abi \"0x23b872dd...\"\n```\n\n### Example\n\nPass ABI file and input data as file:\n\n```bash\n$ ethereum_input_data_decoder --abi abi.json --input data.tx\n\nmethod registerOffChainDonation\n\naddress addr 0x5a9dac9315fdd1c3d13ef8af7fdfeb522db08f02\nuint256 timestamp 1487012400\nuint256 chfCents 4204852\nstring currency BTC\nbytes32 memo 0xf3df64775a2dfb6bc9e09dced96d0816ff5055bf95da13ce5b6c3f53b97071c8\n```\n\nPass ABI file and input data as string:\n\n```bash\n$ ethereum_input_data_decoder --abi abi.json 0x67043cae0...000000\n\nmethod registerOffChainDonation\n\naddress addr 0x5a9dac9315fdd1c3d13ef8af7fdfeb522db08f02\nuint256 timestamp 1487012400\nuint256 chfCents 4204852\nstring currency BTC\nbytes32 memo 0xf3df64775a2dfb6bc9e09dced96d0816ff5055bf95da13ce5b6c3f53b97071c8\n```\n\nYou can also pipe the input data:\n\n```bash\n$ cat data.txt | ethereum_input_data_decoder --abi abi.json\n\nmethod registerOffChainDonation\n\naddress addr 0x5a9dac9315fdd1c3d13ef8af7fdfeb522db08f02\nuint256 timestamp 1487012400\nuint256 chfCents 4204852\nstring currency BTC\nbytes32 memo 0xf3df64775a2dfb6bc9e09dced96d0816ff5055bf95da13ce5b6c3f53b97071c8\n```\n\n## Test\n\n```bash\nnpm test\n```\n\n## Development\n\n1. Clone repository:\n\n ```bash\n git clone git@github.com:miguelmota/ethereum-input-data-decoder.git\n\n cd ethereum-input-data-decoder/\n ```\n\n2. Install dependencies:\n\n ```bash\n npm install\n ```\n\n3. Make changes.\n\n4. Run tests:\n\n ```bash\n npm test\n ```\n\n5. Run linter:\n\n ```bash\n npm run lint\n ```\n\n5. Build:\n\n ```bash\n npm run build\n ```\n\n## Contributing\n\nPull requests are welcome!\n\nFor contributions please create a new branch and submit a pull request for review.\n\nMany thanks to all the [contributors](https://github.com/miguelmota/ethereum-input-data-decoder/graphs/contributors) for making this a better library for everyone 🙏\n\n## FAQ\n\n- Q: How can I retrieve the ABI?\n\n - A: You can generate the ABI from the solidity source files using the [Solidity Compiler](http://solidity.readthedocs.io/en/develop/installing-solidity.html).\n\n ```bash\n solc --abi MyContract.sol -o build\n ```\n\n- Q: Can this library decode contract creation input data?\n\n - A: Yes, it can decode contract creation input data.\n\n- Q: Does this library support ABIEncoderV2?\n\n - A: Yes, but it's buggy. Please submit a [bug report](https://github.com/miguelmota/ethereum-input-data-decoder/issues/new) if you encounter issues.\n\n## License\n\n[MIT](LICENSE)\n","maintainers":[{"name":"miguelmota","email":"hello@miguelmota.com"}],"time":{"modified":"2022-07-30T06:48:02.903Z","created":"2017-03-02T05:50:58.956Z","0.0.1":"2017-03-02T05:50:58.956Z","0.0.2":"2017-03-02T08:35:10.957Z","0.0.3":"2017-09-08T17:30:07.084Z","0.0.4":"2018-05-01T02:06:38.625Z","0.0.5":"2018-05-18T21:05:42.947Z","0.0.6":"2018-05-18T21:26:52.091Z","0.0.7":"2018-06-15T11:12:12.803Z","0.0.8":"2018-06-15T11:17:45.414Z","0.0.9":"2018-06-15T12:18:38.283Z","0.0.10":"2018-06-15T12:22:58.759Z","0.0.11":"2018-06-18T04:57:42.036Z","0.0.12":"2018-07-03T13:58:26.911Z","0.0.13":"2019-01-13T08:54:16.023Z","0.0.14":"2019-01-20T02:01:42.005Z","0.0.15":"2019-01-20T02:02:14.258Z","0.0.16":"2019-01-26T22:20:35.217Z","0.0.17":"2019-01-26T22:33:04.681Z","0.1.0":"2019-01-27T00:12:29.754Z","0.1.1":"2019-01-27T00:18:35.198Z","0.1.2":"2019-04-12T06:18:05.970Z","0.1.3":"2019-04-12T07:13:46.663Z","0.1.4":"2019-04-22T04:49:14.143Z","0.1.5":"2019-04-22T04:57:46.806Z","0.1.6":"2019-04-26T21:39:56.378Z","0.2.0":"2019-04-26T22:14:59.334Z","0.2.1":"2019-10-12T23:53:35.632Z","0.3.0":"2019-12-23T06:05:09.331Z","0.3.1":"2020-07-23T19:55:04.994Z","0.3.2":"2021-03-31T08:45:10.852Z","0.3.4":"2021-08-22T09:22:57.531Z","0.3.5":"2021-09-11T10:06:15.758Z","0.4.0":"2022-02-10T08:17:52.379Z","0.4.1":"2022-03-16T04:33:40.474Z","0.4.2":"2022-07-30T06:48:02.832Z"},"homepage":"https://github.com/miguelmota/ethereum-input-data-decoder","repository":{"type":"git","url":"git+https://github.com/miguelmota/ethereum-input-data-decoder.git"},"author":{"name":"Miguel Mota","email":"hello@miguelmota.com","url":"https://miguelmota.com/"},"bugs":{"url":"https://github.com/miguelmota/ethereum-input-data-decoder/issues"},"license":{"type":"MIT","url":"https://github.com/miguelmota/ethereum-input-data-decoder/blob/master/LICENSE"},"readmeFilename":"README.md","keywords":["ethereum","decoder","abi","smart","contracts"]}
![\"logo\"](\"https://user-images.githubusercontent.com/168240/39537094-61c30484-4ded-11e8-8c93-410ba0510cf4.png\")
\n