Note: The tool is currently under development, please report any bugs you may find.
A container with the dependencies set up and the blockchain snapshot installed can be found here.
To open the container, install docker and run:
docker pull hrishioa/oyente && docker run -i -t hrishioa/oyente
To evaluate the greeter contract inside the container, run:
cd /home/oyente/oyente && source ../dependencies/venv/bin/activate && python oyente.py greeter.sol
and you are done!
- solc and disasm from go-ethereum
- z3 Theorem Prover
python oyente.py <contract filename>
And that's it! Run python oyente.py --help for a list of options.
The accompanying paper explaining the bugs detected by the tool can be found here.
A collection of the utilities that were developed for the paper are in misc_utils. Use them at your own risk - they have mostly been disposable.
generate-graphs.py- Contains a number of functions to get statistics from contracts.get_source.py- The get_contract_code function can be used to retrieve contract source from EtherScantransaction_scrape.py- Contains functions to retrieve up-to-date transaction information for a particular contract.
Note: This is an improved version of the tool used for the paper. Benchmarks are not for direct comparison.
To run the benchmarks, it is best to use the docker container as it includes the blockchain snapshot necessary.
In the container, run batch_run.py after activating the virtualenv. Results are in results.json once the benchmark completes.
The benchmarks take a long time and a lot of RAM in any but the largest of clusters, beware.
Some analytics regarding the number of contracts tested, number of contracts analysed etc. is collected when running this benchmark.
If you encounter the unhashable instance error, please add the following to your class AstRef(Z3PPObject): in /usr/lib/python2.7/dist-packages/z3.py:
def __hash__(self):
return self.hash()
The latest version of Z3 does support this, but some previous version does not.