halmos 0.2.1

A symbolic testing tool for EVM smart contracts

Halmos

Install | Getting Started | Examples | FAQ | Chat | awesome-halmos

Halmos is a symbolic testing tool for EVM smart contracts. A Solidity/Foundry frontend is currently offered by default, with plans to provide support for other languages, such as Vyper and Huff, in the future.

You can read more in our post: "Symbolic testing with Halmos: Leveraging existing tests for formal verification."

Join the Halmos Telegram Group for any inquiries or further discussions.

Installation

pip install halmos

Or, if you want to try out the nightly build version:

pip install git+https://github.com/a16z/halmos

Alternatively, you can download the Docker image that contains halmos and its dependencies:

docker pull .:/workspace ghcr.io/a16z/halmos:0.1.14

And finally, if you want to install halmos into an isolated virtual environment (so you don't have to deal with dependency issues), you can install it with uv:

curl -LsSf https://astral.sh/uv/install.sh | sh # install UV (see docs for other install methods)
uv tool install halmos

Usage

cd /path/to/src
halmos

For more details:

halmos --help

Alternatively, you can run the latest halmos Docker image available at ghcr.io/a16z/halmos:

cd /path/to/src

# mount '.' under /workspace in the container
docker run -v .:/workspace ghcr.io/a16z/halmos:0.1.14

Examples

Refer to the getting started guide and the examples directory.

Contributing

Refer to the contributing guidelines, and explore the list of issues labeled "good first issue" or "help wanted."

Disclaimer

These smart contracts and code are being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of the user interface or the smart contracts and code. They have not been audited and as such there can be no assurance they will work as intended, and users may experience delays, failures, errors, omissions or loss of transmitted information. THE SMART CONTRACTS AND CODE CONTAINED HEREIN ARE FURNISHED AS IS, WHERE IS, WITH ALL FAULTS AND WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING ANY WARRANTY OF MERCHANTABILITY, NON-INFRINGEMENT OR FITNESS FOR ANY PARTICULAR PURPOSE. Further, use of any of these smart contracts and code may be restricted or prohibited under applicable law, including securities laws, and it is therefore strongly advised for you to contact a reputable attorney in any jurisdiction where these smart contracts and code may be accessible for any questions or concerns with respect thereto. Further, no information provided in this repo should be construed as investment advice or legal advice for any particular facts or circumstances, and is not meant to replace competent counsel. a16z is not liable for any use of the foregoing, and users should proceed with caution and use at their own risk. See a16z.com/disclosures for more info.