{"id":15630912,"url":"https://github.com/joranhonig/vertigo","last_synced_at":"2025-04-05T13:03:38.267Z","repository":{"id":35068688,"uuid":"202979470","full_name":"JoranHonig/vertigo","owner":"JoranHonig","description":"Mutation Testing for Ethereum Smart Contracts","archived":false,"fork":false,"pushed_at":"2023-11-21T01:12:29.000Z","size":127,"stargazers_count":207,"open_issues_count":17,"forks_count":42,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T12:09:11.650Z","etag":null,"topics":["ethereum","mutation-testing","mutations","security","solidity","testing"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JoranHonig.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-08-18T08:39:38.000Z","updated_at":"2025-03-24T15:40:52.000Z","dependencies_parsed_at":"2024-01-14T06:54:12.331Z","dependency_job_id":"7b5aba6c-7ef6-419c-aa6e-4b2dd9973560","html_url":"https://github.com/JoranHonig/vertigo","commit_stats":{"total_commits":107,"total_committers":6,"mean_commits":"17.833333333333332","dds":"0.12149532710280375","last_synced_commit":"659b71cf763106c0d0fc8c1ce130658cece997c7"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoranHonig%2Fvertigo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoranHonig%2Fvertigo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoranHonig%2Fvertigo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoranHonig%2Fvertigo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JoranHonig","download_url":"https://codeload.github.com/JoranHonig/vertigo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247339153,"owners_count":20923014,"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":["ethereum","mutation-testing","mutations","security","solidity","testing"],"created_at":"2024-10-03T10:37:24.917Z","updated_at":"2025-04-05T13:03:38.250Z","avatar_url":"https://github.com/JoranHonig.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vertigo\n[![Build Status](https://travis-ci.org/JoranHonig/vertigo.svg?branch=master)](https://travis-ci.org/JoranHonig/vertigo)\n[![Gitter](https://badges.gitter.im/eth-vertigo/community.svg)](https://gitter.im/eth-vertigo/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\nVertigo is a mutation testing framework designed to work specifically for smart contracts.\nThis mutation testing framework implements a range of mutation operators that are either selected from previous works or tailored to solidity.\n\n### Quick Start Guide\n\nTo install vertigo, execute the following command:\n```bash\npip3 install --user eth-vertigo\n```\n\nYou can now run vertigo on a truffle project with the following command (assuming you have a `development` network configured in your`truffle-config.js`):\n\n```bash\nvertigo run --network development\n```\nDepending on your environment it might be required to specify the location of the truffle executable:\n```bash\nvertigo run --network development --truffle-location \u003cnode_dir\u003e/bin/truffle \n```\n\nOr, if you're using Hardhat, just use dynamic networks:\n```bash\nvertigo run --hardhat-parallel 8\n```\n\nThere are a few additional parameters available that allow you to tweak the execution of vertigo:\n```bash\n$ vertigo run --help                                                                                                                                                                  \nUsage: vertigo run [OPTIONS]\n\n  Performs a core test campaign\n\nOptions:\n  --output TEXT                   Output core test results to file\n  --network TEXT                  Network names that vertigo can use\n  --ganache-path TEXT             Path to ganache binary\n  --ganache-network \u003cTEXT INTEGER\u003e...\n                                  Dynamic networks that vertigo can use eg.\n                                  (develop, 8485)\n\n  --ganache-network-options TEXT  Options to pass to dynamic ganache networks\n  --hardhat-parallel INTEGER      Amount of networks that hardhat should be\n                                  using in parallel\n\n  --rules TEXT                    Universal Mutator style rules to use in\n                                  mutation testing\n\n  --truffle-location TEXT         Location of truffle cli\n  --sample-ratio FLOAT            If this option is set. Vertigo will apply\n                                  the sample filter with the given ratio\n\n  --exclude TEXT                  Vertigo won't mutate files in these\n                                  directories\n\n  --incremental TEXT              File where incremental mutation state is\n                                  stored\n\n  --help                          Show this message and exit.\n                                                                                                                                     \n```\n\n### Known Issues\n\n**Ganache** is generally used only for a single run of the entire test suite. \nFor the general use case, it does not matter if Ganache creates a few thousand files.\nUnfortunately, once you start executing the entire test suite hundreds of times, you can end up with millions of files, and your machine could run out of free inode's.\nYou can check whether this happens to you by running:\n```\ndf -i\n```\n\nThis issue ([#1](https://github.com/JoranHonig/vertigo/issues/1)) is known, and we're working on a fix.\n \nIn the meanwhile. If your test suite is large enough to munch all your inodes, then there are two options:\n - You can use the command line option `--sample-ratio` to select a random subsample of the mutations (reducing the number of times that the test suite is run)\n - You can create a partition that has a sufficient amount of inodes available\n\n### Publications and Articles\n[Practical Mutation Testing for Smart Contracts](https://link.springer.com/chapter/10.1007/978-3-030-31500-9_19) - Joran J. Honig, Maarten H. Everts, Marieke Huisman\n\n[Introduction into Mutation Testing](https://medium.com/swlh/introduction-into-mutation-testing-d6512dc702b0?source=friends_link\u0026sk=2878e0c08b6301a125198a264e43edb4) - Joran Honig\n\n[Mutation Testing for Smart Contracts - A step by step guide](https://medium.com/@joran.honig/mutation-testing-for-smart-contracts-a-step-by-step-guide-68c838ca2094) - Joran Honig\n\nIf you want to cite vertigo, please use the following:\n```\n@InProceedings{10.1007/978-3-030-31500-9_19,\nauthor=\"Honig, Joran J.\nand Everts, Maarten H.\nand Huisman, Marieke\",\ntitle=\"Practical Mutation Testing for Smart Contracts\",\nbooktitle=\"Data Privacy Management, Cryptocurrencies and Blockchain Technology\",\nyear=\"2019\",\npublisher=\"Springer International Publishing\",\npages=\"289--303\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoranhonig%2Fvertigo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoranhonig%2Fvertigo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoranhonig%2Fvertigo/lists"}