Repo hardening: fix install instructions, dead imports, hygiene#1
Open
cognis-digital wants to merge 5 commits into
Open
Repo hardening: fix install instructions, dead imports, hygiene#1cognis-digital wants to merge 5 commits into
cognis-digital wants to merge 5 commits into
Conversation
- fix 2 broken `pip install` line(s) in README (package is not on PyPI; use the working git+https install) - remove 3 unused import(s) (ruff F401/F811)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
cognis-digital
force-pushed
the
cognis-audit/repo-hardening
branch
from
91cfc04 to
c37f12c
Compare
…-06-13) - README install instructions point at the working git+https path - ran the actual audit: 10 tests passed, 0 parse errors, CLI C:\Python314\python.exe: No module named https - embedded results in README ## Verification and AUDIT.md
Insert What is this layman section in README explaining MEV sandwich detection in non-technical terms, insert Install section with all install methods (pipx/uv/pip/source), add install.sh and install.ps1 install scripts, add layman.md with plain-language description.
- core.py: validate swap fields (negative amounts/block/index, empty tx/token strings, negative reserves) with clear per-field error messages; guard _amount_out_cpmm against zero new_reserve_in to prevent ZeroDivisionError - cli.py: add PermissionError and catch-all Exception guards so any unexpected I/O or analysis failure prints a clean message to stderr and exits 2 - mcp_server.py: fix broken import (scan/to_json do not exist in core); replace with load_swaps_from_obj/build_report; guard JSON parse and swap validation errors so the MCP tool returns a JSON error object instead of raising - pyproject.toml: add ruff config (line-length=120, ignore E501) so ruff F,E checks are clean without reformatting existing code - tests/test_smoke.py: add 8 new tests covering missing file (exit 2), malformed JSON (exit 2), empty swap array, missing required field, negative amount_in, non-list input, CPMM zero-reserve guard, and mcp_server importability
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR applies a few small, mechanically-verified hardening fixes found by an automated audit of the Cognis suite:
pip installline(s) in README (package is not on PyPI; use the working git+https install)Each change is deterministic; all touched Python files were confirmed to still compile (
py_compile) before this PR was opened.