{"_id":"eth-revert-reason","_rev":"4-ea3e1c94392bd91534f6c7ae0e639653","name":"eth-revert-reason","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"eth-revert-reason","version":"1.0.0","description":"Get the revert reason from an Ethereum transaction hash","main":"index.js","types":"index.d.ts","scripts":{"publish-module":"npm publish --access public","dist-tag":"npm dist-tag add \"eth-revert-reason@$(jq -r .version Get the revert reason from a tx hash on Ethereum\n\n[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/authereum/eth-revert-reason/master/LICENSE)\n[![NPM version](https://badge.fury.io/js/eth-revert-reason.svg)](http://badge.fury.io/js/eth-revert-reason)\n\n## Install\n\n```bash\nnpm install eth-revert-reason\n```\n\n## Notes\n1. For now, this works consistently with the [Infura](https://infura.io/) and [Alchemy](https://docs.alchemyapi.io/) providers. Any other providers that you pass in may not work.\n2. There are rare cases where a revert reason may be 'x' from the context of one block but it will be 'y' from the context of another block. This may cause inconsistencies.\n3. This package relies on the ethers.js default provider. This provider may be subject to rate limits or inconsistencies. For consistent results, please pass in your own provider.\n4. Alchemy's provider v2 uses Geth.\n\n\n## Getting started\n\n```javascript\nconst getRevertReason = require('eth-revert-reason')\n\n// Failed with revert reason \"Failed test\"\nconsole.log(await getRevertReason('0xf212cc42d0eded75041225d71da6c3a8348bdb9102f2b73434b480419d31d69a')) // 'Failed test'\nconsole.log(await getRevertReason('0x640d2e0d1f4cff9b6e273458216451efb0dc08ebc13c30f6c88d48be7b35872a', 'goerli')) // 'Failed test'\n\n// Failed with no revert reason\nconsole.log(await getRevertReason('0x95ac5a6a1752ccac9647eb21ef8614ca2d3e40a5dbb99914adf87690fb1e6ccf')) // ''\n\n// Successful transaction\nconsole.log(await getRevertReason('0x02b8f8a00a0c0e9dcf60ddebd37ea305483fb30fd61233a505b73036408cae75')) // ''\n\n// Call from the context of a previous block with a custom provider\nlet txHash = '0x6ea1798a2d0d21db18d6e45ca00f230160b05f172f6022aa138a0b605831d740'\nlet network = 'mainnet'\nlet blockNumber = 9892243\nlet provider = getAlchemyProvider(network) // NOTE: getAlchemyProvider is not exposed in this package\nconsole.log(await getRevertReason(txHash, network, blockNumber, provider)) // 'BA: Insufficient gas (ETH) for refund'\n```\n\n## Future work\nThe following features will be added over time:\n\n1. A better way to determine whether or not a node is full-archive.\n2. A better way to determine whether or not a node exposes Parity `trace` methods.\n3. Reduce the number of calls made by the provider.\n4. Use raw RPC calls instead of a library\n - Will require unwrapping the provider from the library if provider is still a parameter\n - Note: this would still require using the ethers default provider\n\n\n## Test\n\n```bash\nnpm test\n```\n\n## License\n\n[MIT](LICENSE)\n","readmeFilename":"README.md","contributors":[{"name":"Miguel Mota","email":"miguel.mota@authereum.com"},{"name":"Chris Whinfrey","email":"chris.whinfrey@authereum.com"},{"name":"Adam Hanna","email":"adam.hanna@authereum.com"}]}