{"_id":"@__haoyang__/erwin","_rev":"41-c298616f9ab8e11ec0948fbfbe927d22","name":"@__haoyang__/erwin","dist-tags":{"latest":"1.3.7"},"versions":{"1.0.1":{"name":"@__haoyang__/erwin","version":"1.0.1","keywords":["Random Program Generation","Solidity","Smart Contract","Bug Detection","Compiler Verifier"],"author":{"name":"Haoyang Ma","email":"haoyanghkust@gmail.com"},"license":"Apache-2.0","_id":"@__haoyang__/erwin@1.0.1","maintainers":[{"name":"__haoyang__","email":"haoyanghkust@gmail.com"}],"homepage":"https://github.com/haoyang9804/Erwin#readme","bugs":{"url":"https://github.com/haoyang9804/Erwin/issues"},"bin":{"erwin":"dist/index.js"},"dist":{"shasum":"d75c6c018d4d6c91762c48f33756ab890c2acb06","tarball":"https://registry.npmjs.org/@__haoyang__/erwin/-/erwin-1.0.1.tgz","fileCount":112,"integrity":"sha512-uZiH+sxjCwVqtVIZZTZrsbdLwt+HpqCgHJmuYa6dKTXRZDZsPpF/LjF10QZs2GYBYnojEX8HenojSSrr1zu2yg==","signatures":[{"sig":"MEYCIQCjQvCBLrLFOC/RKlKXbqdmMN5PgFmSygJSOnouKbHlVgIhAKjZEU0nh0tWfP24hTZ2hYMFDL4OJnwsDVoe9SFYMUBS","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1541118},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"13bdcf3aa6c2edab6a113e8084f5b2b4beea76bb","scripts":{"test":"jest --coverage","build":"tsc --build --pretty && npm run format && chmod u+x dist/index.js","clean":"tsc --build --clean && rm -rf dist","format":"tsfmt -r"},"_npmUser":{"name":"__haoyang__","email":"haoyanghkust@gmail.com"},"prepublish":"tsc","repository":{"url":"git+https://github.com/haoyang9804/Erwin.git","type":"git"},"_npmVersion":"10.9.1","description":" ![\"erwin\"](\"https://raw.githubusercontent.com/haoyang9804/haoyang9804.github.io/master/Erwin_icon.png\")
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"NPM]()
![\"erwin\"](\"https://raw.githubusercontent.com/haoyang9804/Erwin/master/Erwin_icon.png\")
![\"NPM](\"https:/","bugs":{"url":"https://github.com/haoyang9804/Erwin/issues"},"_nodeVersion":"20.19.6","_npmVersion":"10.8.2","dist":{"integrity":"sha512-mTd26XCZToTarY37gd7DufC6dXL4xfYYyRqiqF+Jx35LodQwZ2ySFzeAwXKxyCATrifOD2NI0eF/HrMFmzn4fg==","shasum":"08ccf044f939ead9a8c98db3eb7e0d8c8436cc63","tarball":"https://registry.npmjs.org/@__haoyang__/erwin/-/erwin-1.3.7.tgz","fileCount":104,"unpackedSize":1501916,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCEvP64KhZuHAoHVyGuIUJQLcNKup2fj7u+Ju9XR5yU5gIgZImTXsw4ds8u4NbVwxpYdSp8kDRkYFJ/8kdXaefDle0="}]},"_npmUser":{"name":"__haoyang__","email":"haoyanghkust@gmail.com"},"directories":{},"maintainers":[{"name":"__haoyang__","email":"haoyanghkust@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/erwin_1.3.7_1767497546913_0.8680776992019281"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-19T10:14:27.100Z","modified":"2026-01-04T03:32:27.278Z","0.7.1":"2024-11-28T22:39:16.747Z","0.7.7":"2024-12-19T10:14:27.429Z","0.7.8":"2024-12-19T15:23:28.248Z","1.0.0":"2024-12-19T18:12:21.523Z","1.0.1":"2024-12-20T14:07:16.058Z","1.0.2":"2024-12-23T01:00:48.035Z","1.0.3":"2024-12-23T01:07:38.914Z","1.0.4":"2024-12-23T17:05:29.003Z","1.1.0":"2024-12-23T20:35:52.445Z","1.1.1":"2024-12-23T23:32:16.478Z","1.1.2":"2024-12-24T13:00:26.489Z","1.1.3":"2024-12-29T15:59:32.663Z","1.1.4":"2024-12-30T20:47:07.247Z","1.1.5":"2024-12-31T15:03:31.385Z","1.1.6":"2024-12-31T22:00:58.601Z","1.1.7":"2025-01-04T00:34:53.605Z","1.1.8":"2025-01-05T14:49:11.570Z","1.1.9":"2025-01-10T08:17:09.021Z","1.2.0":"2025-01-10T08:55:07.020Z","1.2.1":"2025-01-10T09:18:34.622Z","1.2.2":"2025-01-10T09:57:57.534Z","1.2.3":"2025-01-10T10:29:08.548Z","1.2.4":"2025-01-13T21:52:47.459Z","1.2.5":"2025-01-14T10:14:09.649Z","1.2.6":"2025-01-15T08:02:26.641Z","1.2.7":"2025-01-19T03:06:31.056Z","1.2.8":"2025-01-23T08:40:32.558Z","1.2.9":"2025-01-26T07:46:54.451Z","1.3.0":"2025-01-26T18:20:28.624Z","1.3.1":"2025-03-14T10:20:20.787Z","1.3.2":"2025-04-28T13:37:46.340Z","1.3.3":"2025-04-28T17:37:36.451Z","1.3.4":"2025-04-29T02:41:04.716Z","1.3.5":"2025-04-29T06:29:07.634Z","1.3.6":"2025-06-25T13:32:31.756Z","1.3.7":"2026-01-04T03:32:27.087Z"},"bugs":{"url":"https://github.com/haoyang9804/Erwin/issues"},"author":{"name":"Haoyang)
![\"NPM](\"https:/","maintainers":[{"name":"__haoyang__","email":"haoyanghkust@gmail.com"}],"readme":"<p)
\n\n
\n\n \n ![\"NPM](\"https://img.shields.io/npm/v/%40__haoyang__%2Ferwin\")
\n \n ![\"NPM](\"https://img.shields.io/npm/l/%40__haoyang__%2Ferwin\")
\n \n ![\"Static](\"https://img.shields.io/badge/Erwin-doc-pink\")
\n \n ![\"GitHub](\"https://img.shields.io/github/actions/workflow/status/haoyang9804/Erwin/npm.yml\")
\n \n
\n\n\n***Erwin*** is an academic attempt on introducing `bounded exhaustive instantiation` in random program generator to mitigate opportunism. This effort is inspired by [](https://arxiv.org/abs/2407.05981). Paper for this work can be found on [](https://arxiv.org/abs/2503.20332).\n\nDifferent from [Csmith](https://github.com/csmith-project/csmith)-family tools that generate a test program in one go, ***Erwin*** separates the generation process into two sub-steps: 1) randomly generate a type/loc/scope-agnostic IR (i.e., a program without type, storage location, and scope), and 2) conducts bounded exhaustive instantiation to instantiate the IR into a swarm of real-word test programs.\nBy masking out bug-related langauge features, such as type, storage location, and scope in the IR, ***Erwin*** shrinks the search space into a highly bug-related subspace. This way, ***Erwin*** reduce opportunism in random program generations.\n\n***Erwin*** is still under development, any suggestion and collaboration is welcomed.\n\n## Install Erwin\n\n### Install through NPM\n\n```\nnpm install @__haoyang__/erwin\n```\n\n### Install through Git\n\n```\ngit install git@github.com:haoyang9804/Erwin.git\ncd Erwin\nnpm install\nnpm run build\n```\n\n## Run Erwin\n\nIf you install Erwin through NPM, the `erwin` executable is in `node_modules/.bin`, add it to your PATH, and directly call `erwin`.\nIf you install Erwin through Git, go into the folder and type `npx erwin generate`.\n\n### Use Erwin as a Solidity program generator.\n\nErwin support various flags to tune the probability distribution of all language features (e.g., `literal_prob`), control the program size (e.g., `function_body_stmt_cnt_upper_limit`), change the generation mode (e.g, `-m`), regulate the upperlimit of the amount of the test programs generated from the IR (e.g., `-max`), etc.\n\n`npx erwin generate` is the trivial generation that generates a test program in a generation round, just like Csmith.\n\nTo enable the `bounded exhaustive instantiation` feature, use `-m` to specify the a class of language features you want to exhausitively instantiate from the IR, including `type`, `loc`ation, and `scope`. `-max` helps control the upperlimit of the instantiation.\n\nSince different compilers (Solidity, Solang, Solar) define slightly different Solidity grammar, you can use `--target` to specify the \"accent\" of Solidity you want to generate. It defaults to solidity.\n\nBelow is an example for generating Solidity programs of solang \"accent\".\n\n```\nnpx erwin generate -m type -max 100 --target solang\n```\n\nThe generated programs are stored in `generated_programs`, you can change it by `-o`.\n\nErwin can generate for multiple rounds until the round count reaches `generation_rounds` or the time consumed in generation reaches `time_limit` if `time` is enabled.\n\n### Use Erwin as a generation-based fuzzer.\n\nErwin integrates four distinct automated testing workflows, each designed to target a specific software tool: the [Solidity](https://github.com/ethereum/solidity), [Solang](https://github.com/hyperledger-solang/solang), [Solar](https://github.com/paradigmxyz/solar), and [Slither](https://github.com/crytic/slither). The first three are compilers for Solidity programs while the last is a static analyzer of Solidity.\n\nBelow is an example for enable the testing workflow for Solidity.\n\n```\nnpx erwin generate --target solc -m scope --enable_test --compiler_path solc --refresh_folder --generation_rounds 1000 -max 100\n```\n\nMisbehavior-triggering test programs will be moved to `test_results`.\n\n## Detected Bugs\n\n1. https://github.com/ethereum/solidity/issues/14719 (type error, segmentation fault) ✅🔨\n2. https://github.com/ethereum/solidity/issues/14720 (duplicate of 14719) 🤡🔨\n3. https://github.com/ethereum/solidity/issues/15223 (error handling, segmentation fault) ✅\n4. https://github.com/ethereum/solidity/issues/15236 (type error, reject valid program) ✅🔨\n5. https://github.com/ethereum/solidity/issues/15219 (version control, incorrect output) ✅\n6. https://github.com/ethereum/solidity/issues/15468 (low effort, low impact, confirmed, duplicate of https://github.com/ethereum/solidity/issues/15427) 🤡\n7. https://github.com/ethereum/solidity/issues/15469 (smt, incorrect output) ✅\n8. https://github.com/ethereum/solidity/issues/15469 (smt, incorrect output, two bugs in a thread) ✅\n9. https://github.com/ethereum/solidity/issues/15483\n10. https://github.com/ethereum/solidity/issues/15525 (documentation error, reject valid program) ✅🔨\n11. https://github.com/ethereum/solidity/issues/15483 (documentation error, reject valid program) ✅🔨\n12. https://github.com/ethereum/solidity/issues/15565 (error handling)\n13. https://github.com/ethereum/solidity/issues/15564 (error handling)\n14. https://github.com/ethereum/solidity/issues/15567 (error handling)\n15. https://github.com/ethereum/solidity/pull/15566 (documentation error) ✅🔨\n16. https://github.com/ethereum/solidity/issues/15583 (error handling, reject valid program) ✅\n17. https://github.com/ethereum/solidity/issues/15645 (ICE, duplicate) 🤡🔨\n18. https://github.com/ethereum/solidity/issues/15646 (error handling, incorrect output) ✅\n19. https://github.com/ethereum/solidity/issues/15647 (smt, ICE) ✅🔨\n20. https://github.com/ethereum/solidity/issues/15649 (ICE) ✅\n21. https://github.com/ethereum/solidity/issues/15651 (smt, ICE) ✅🔨\n22. https://github.com/crytic/slither/issues/2619 (analysis error, hang) ✅🔨\n23. https://github.com/hyperledger-solang/solang/issues/1687 (ICE)\n24. https://github.com/hyperledger-solang/solang/issues/1688 (error handling)\n25. https://github.com/hyperledger-solang/solang/issues/1689 (ICE)\n26. https://github.com/hyperledger-solang/solang/issues/1690 (ICE)\n\n\n## TODO\n\n- 🔨 Support Solar testing workflow\n- 🔨 Support fixed\n- 🔨 Support .push .pop for arrays\n- 🔨 Support byte\n- 🔨 Support type definition (for instance, `type T is bool;`)\n- 🔨 Support enum type\n- 🔨 Support assertion\n- 🔨 Support using for\n- 🔨 Support inherent keywords, such as `msg.sender`, `abi.encode`, etc\n- 🔨 Support bytes\n- 🔨 Support contract inheritance\n- 🔨 Support global constant variable, functions, and structs\n- 🔨 Support variable shallowing\n- 🔨 Support function type\n- 🔨 Support inline assembly\n- 🔨 Support try catch\n- 🔨 Mutate Solidity programs\n","readmeFilename":"README.md"}