{"id":13421677,"url":"https://github.com/enzymefinance/oyente","last_synced_at":"2025-09-27T07:32:37.503Z","repository":{"id":40295527,"uuid":"85322085","full_name":"enzymefinance/oyente","owner":"enzymefinance","description":" An Analysis Tool for Smart Contracts ","archived":true,"fork":false,"pushed_at":"2023-01-19T05:35:00.000Z","size":67351,"stargazers_count":1316,"open_issues_count":85,"forks_count":308,"subscribers_count":57,"default_branch":"master","last_synced_at":"2024-08-05T02:01:19.649Z","etag":null,"topics":["blockchain","ethereum","security-analyzers","smart-contracts"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/enzymefinance.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-17T14:42:38.000Z","updated_at":"2024-08-04T14:42:57.000Z","dependencies_parsed_at":"2023-02-10T20:45:50.254Z","dependency_job_id":null,"html_url":"https://github.com/enzymefinance/oyente","commit_stats":null,"previous_names":["melonproject/oyente"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enzymefinance%2Foyente","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enzymefinance%2Foyente/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enzymefinance%2Foyente/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enzymefinance%2Foyente/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/enzymefinance","download_url":"https://codeload.github.com/enzymefinance/oyente/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234410436,"owners_count":18828205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","ethereum","security-analyzers","smart-contracts"],"created_at":"2024-07-30T23:00:28.107Z","updated_at":"2025-09-27T07:32:30.688Z","avatar_url":"https://github.com/enzymefinance.png","language":"JavaScript","funding_links":[],"categories":["Software Development","JavaScript","Vulnerability-based Dataset","📖 Contents","Static Analysis"],"sub_categories":["Risk Management","Security Analysis Tool","Security Analysis Tools for SC"],"readme":"Oyente\n======\n\nAn Analysis Tool for Smart Contracts\n\n[![Gitter][gitter-badge]][gitter-url]\n[![License: GPL v3][license-badge]][license-badge-url]\n[![Build Status](https://travis-ci.org/melonproject/oyente.svg?branch=master)](https://travis-ci.org/melonproject/oyente)\n\n*This repository is currently maintained by Xiao Liang Yu ([@yxliang01](https://github.com/yxliang01)). If you encounter any bugs or usage issues, please feel free to create an issue on [our issue tracker](https://github.com/melonproject/oyente/issues).*\n\n## Quick Start\n\nA container with required dependencies configured can be found [here](https://hub.docker.com/r/luongnguyen/oyente/). The image is however outdated. We are working on pushing the latest image to dockerhub for your convenience. If you experience any issue with this image, please try to build a new docker image by pulling this codebase before open an issue.\n\nTo open the container, install docker and run:\n\n```\ndocker pull luongnguyen/oyente \u0026\u0026 docker run -i -t luongnguyen/oyente\n```\n\nTo evaluate the greeter contract inside the container, run:\n\n```\ncd /oyente/oyente \u0026\u0026 python oyente.py -s greeter.sol\n```\n\nand you are done!\n\nNote - If need the [version of Oyente](https://github.com/melonproject/oyente/tree/290f1ae1bbb295b8e61cbf0eed93dbde6f287e69) referred to in the paper, run the container from [here](https://hub.docker.com/r/hrishioa/oyente/)\n\nTo run the web interface, execute\n`docker run -w /oyente/web -p 3000:3000 oyente:latest ./bin/rails server`\n\n## Custom Docker image build\n\n```\ndocker build -t oyente .\ndocker run -it -p 3000:3000 -e \"OYENTE=/oyente/oyente\" oyente:latest\n```\n\nOpen a web browser to `http://localhost:3000` for the graphical interface.\n\n## Installation\n\nExecute a python virtualenv\n\n```\npython -m virtualenv env\nsource env/bin/activate\n```\n\nInstall Oyente via pip:\n\n```\n$ pip2 install oyente\n```\nDependencies:\n\nThe following require a Linux system to fufill. macOS instructions forthcoming.\n\n[solc](https://github.com/melonproject/oyente#solc)\n[evm](https://github.com/melonproject/oyente#evm-from-go-ethereum)\n\n## Full installation\n\n### Install the following dependencies\n#### solc\n```\n$ sudo add-apt-repository ppa:ethereum/ethereum\n$ sudo apt-get update\n$ sudo apt-get install solc\n```\n\n#### evm from [go-ethereum](https://github.com/ethereum/go-ethereum)\n\n1. https://geth.ethereum.org/downloads/ or\n2. By from PPA if your using Ubuntu\n```\n$ sudo apt-get install software-properties-common\n$ sudo add-apt-repository -y ppa:ethereum/ethereum\n$ sudo apt-get update\n$ sudo apt-get install ethereum\n```\n\n#### [z3](https://github.com/Z3Prover/z3/releases) Theorem Prover version 4.5.0.\n\nDownload the [source code of version z3-4.5.0](https://github.com/Z3Prover/z3/releases/tag/z3-4.5.0)\n\nInstall z3 using Python bindings\n\n```\n$ python scripts/mk_make.py --python\n$ cd build\n$ make\n$ sudo make install\n```\n\n#### [Requests](https://github.com/kennethreitz/requests/) library\n\n```\npip install requests\n```\n\n#### [web3](https://github.com/pipermerriam/web3.py) library\n\n```\npip install web3\n```\n\n### Evaluating Ethereum Contracts\n\n```\n#evaluate a local solidity contract\npython oyente.py -s \u003ccontract filename\u003e\n\n#evaluate a local solidity with option -a to verify assertions in the contract\npython oyente.py -a -s \u003ccontract filename\u003e\n\n#evaluate a local evm contract\npython oyente.py -s \u003ccontract filename\u003e -b\n\n#evaluate a remote contract\npython oyente.py -ru https://gist.githubusercontent.com/loiluu/d0eb34d473e421df12b38c12a7423a61/raw/2415b3fb782f5d286777e0bcebc57812ce3786da/puzzle.sol\n\n```\n\nAnd that's it! Run ```python oyente.py --help``` for a list of options.\n\n## Paper\n\nThe accompanying paper explaining the bugs detected by the tool can be found [here](https://www.comp.nus.edu.sg/~prateeks/papers/Oyente.pdf).\n\n## Miscellaneous Utilities\n\nA 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.\n\n1. `generate-graphs.py` - Contains a number of functions to get statistics from contracts.\n2. `get_source.py` - The *get_contract_code* function can be used to retrieve contract source from [EtherScan](https://etherscan.io)\n3. `transaction_scrape.py` - Contains functions to retrieve up-to-date transaction information for a particular contract.\n\n## Benchmarks\n\nNote: This is an improved version of the tool used for the paper. Benchmarks are not for direct comparison.\n\nTo run the benchmarks, it is best to use the docker container as it includes the blockchain snapshot necessary.\nIn the container, run `batch_run.py` after activating the virtualenv. Results are in `results.json` once the benchmark completes.\n\nThe benchmarks take a long time and a *lot* of RAM in any but the largest of clusters, beware.\n\nSome analytics regarding the number of contracts tested, number of contracts analysed etc. is collected when running this benchmark.\n\n## Contributing\n\nCheckout out our [contribution guide](https://github.com/melonproject/oyente/blob/master/CONTRIBUTING.md) and the code structure [here](https://github.com/melonproject/oyente/blob/master/code.md).\n\n\n[gitter-badge]: https://img.shields.io/gitter/room/melonproject/oyente.js.svg?style=flat-square\n[gitter-url]: https://gitter.im/melonproject/oyente?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\n[license-badge]: https://img.shields.io/badge/License-GPL%20v3-blue.svg?style=flat-square\n[license-badge-url]: ./LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenzymefinance%2Foyente","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenzymefinance%2Foyente","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenzymefinance%2Foyente/lists"}