solflow 0.11.2__py3-none-any.whl

solflow-0.11.2.dist-info/METADATA

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: solflow
+Version: 0.11.2
+Summary: Per-entry-point navigable call-graph visualizations of Solidity repositories, for Web3 security auditors.
+Author: Norah
+License-Expression: AGPL-3.0-only
+Project-URL: Repository, https://github.com/norah1499/solidity-flow-navigator
+Project-URL: Issues, https://github.com/norah1499/solidity-flow-navigator/issues
+Keywords: solidity,security,audit,static-analysis,slither
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: slither-analyzer<0.12,>=0.11.5
+Requires-Dist: Flask<4.0,>=3.0
+Requires-Dist: Pygments<3.0,>=2.17
+Requires-Dist: pathspec<2,>=1.1.1
+Provides-Extra: dev
+Requires-Dist: pytest<9.0,>=8.0; extra == "dev"
+Requires-Dist: black<27,>=26; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Dynamic: license-file
+
+# SolFlow (Solidity Flow Navigator)
+
+[![CI](https://github.com/norah1499/solidity-flow-navigator/actions/workflows/ci.yml/badge.svg)](https://github.com/norah1499/solidity-flow-navigator/actions/workflows/ci.yml)
+
+**Read a contract the way it executes, not the way its files are organized.**
+
+SolFlow compiles a Solidity repository, extracts call-graph facts with [Slither](https://github.com/crytic/slither), and serves one interactive call-flow visualization per external entry point. Every panel shows the function's real source. Built for smart contract auditing.
+
+![SolFlow navigating Morpho Blue: the entry-point index, the fully expanded liquidate flow, and the same flow zoomed to source level](docs/demo.gif)
+
+*SolFlow on [Morpho Blue](https://github.com/morpho-org/morpho-blue): the entry-point index, the fully expanded `liquidate` flow, and the same flow zoomed to source level. Pausable stills are under [Screenshots](#screenshots).*
+
+## Why
+
+The first job in any audit is reconstructing what actually happens when someone calls an entry point. The answer is scattered across base contracts, libraries, and modifiers in a dozen files. SolFlow lays it out as a graph you can read:
+
+- **One Flow per entry point.** The index lists every externally callable function, grouped by contract and split into mutating vs read-only, with modifier badges, call-tree depth, and unresolved-target counts per entry: the whole audit surface on one page.
+- **Real source, not boxes.** Every node renders the target function's actual code, syntax-highlighted and line-numbered. Click a call site and the callee expands beside it, the edge anchored to the exact line that makes the call.
+- **It never silently lies.** When a call target can't be resolved statically (an interface with no bound implementation, `addr.call(...)`, computed-target Yul), the node is explicitly marked unresolved, with the reason. No guessing, no silent omissions.
+- **Local and private.** Analysis runs entirely on your machine and the server binds only to `127.0.0.1`. Audit code is never uploaded anywhere.
+
+SolFlow is **not a vulnerability scanner**. It emits no findings and makes no security claims. It shows you the code's shape so you can find the problems faster.
+
+## Install
+
+Requires Python 3.11+ and a `solc` matching your target, via [solc-select](https://github.com/crytic/solc-select) (Slither needs it to compile):
+
+```bash
+pipx install solflow
+pipx install solc-select
+solc-select install <version> && solc-select use <version>
+```
+
+For the latest development version instead: `pipx install git+https://github.com/norah1499/solidity-flow-navigator`.
+
+## Use
+
+```bash
+solflow path/to/your/solidity/project
+```
+
+Point it at the repository root, where Slither can resolve dependencies. SolFlow compiles the project, binds `127.0.0.1:8080` (or the next free port), and prints the URL.
+
+Compilation goes through [crytic-compile](https://github.com/crytic/crytic-compile), so any build system it detects should work (Foundry, Hardhat, Truffle, Brownie, plain solc); Foundry projects are what SolFlow is tested against. If compilation fails, SolFlow prints the compiler error verbatim and exits without producing anything. No partial Flows, by design: a half-compiled picture would silently mislead. The usual fix is matching the project's pragma with `solc-select use <version>`.
+
+Useful flags (run `solflow --help` for the full reference, grouped into **Scope**, **Resolution**, **Rendering**, and **Server**):
+
+| Flag | What it does |
+|------|--------------|
+| `--expand-all` | Open every Flow fully expanded, for a bird's-eye view |
+| `--exclude-path GLOB`, `--exclude-contract PATTERN` | Narrow which contracts produce Flows |
+| `--inline-library NAME` | Recurse into a `lib/<NAME>/` dependency instead of stubbing it |
+| `--port N` | Bind a specific port |
+
+## Screenshots
+
+<details>
+<summary>Stills from the demo above (Morpho Blue)</summary>
+
+The index lists every external entry point of the analyzed repository:
+
+![Index view listing the entry points of Morpho Blue](docs/index-morpho.png)
+
+Opening an entry point renders its full call flow; every callee panel shows the real source:
+
+![Expanded call-flow graph of Morpho.liquidate](docs/flow-liquidate-overview.png)
+
+![Zoomed view of the liquidate flow with inherited library functions](docs/flow-liquidate-detail.png)
+
+</details>
+
+## Contributing
+
+Issues and pull requests are welcome. Before opening a PR, make sure these pass:
+
+```bash
+pytest
+black --check .
+ruff check
+```
+
+## License
+
+AGPL-3.0, and not a free choice: SolFlow builds on Slither and crytic-compile, both AGPL-3.0. If you host an instance for others, the license requires offering them the source; the index footer links back here.

solflow-0.11.2.dist-info/RECORD

@@ -0,0 +1,33 @@
+solflow-0.11.2.dist-info/licenses/LICENSE,sha256=DZak_2itbUtvHzD3E7GNUYSRK6jdOJ-GqncQ2weavLA,34523
+solidity_flow_navigator/__init__.py,sha256=7cwnSFUWrLiAQr6_ho7CHtrKP0TFZfGwlJpmzci3Vx8,99
+solidity_flow_navigator/__main__.py,sha256=lM0tiA92uu63BRwTttlcH6oMDucZWrkjrfLdc2NoSiA,167
+solidity_flow_navigator/cli.py,sha256=B7VFP_rhbF6DbIfArFuyEyhIudsc0CFfWQj4YEegDIw,17149
+solidity_flow_navigator/analysis/__init__.py,sha256=t_Zgnan_dbriztTbKVOzxmZMfEWnwyELQnpAYT5M-YU,89
+solidity_flow_navigator/analysis/compile.py,sha256=5wUjrNjZrIGlYkPFIO00RcUcKjgVgGnLd_ToM-lZ3FQ,1497
+solidity_flow_navigator/analysis/slither_facts.py,sha256=sFi-uKe60qSqzf8jkeN9Y60C37WNXOfnFbN4EImNttI,15543
+solidity_flow_navigator/analysis/types.py,sha256=vb19H3STWaT98vCYTRA_4iMPP3EdkhtM_BPnuFFdJpU,7523
+solidity_flow_navigator/flow/__init__.py,sha256=Efxs3wlaKyl9NDLF-NCJrZbAJTaMQuPPJrLfsCIqgJ4,130
+solidity_flow_navigator/flow/builder.py,sha256=cnsqSlae3mWUEBHGgFqtZA5czxpwWSoaPXgu_1tM44g,42444
+solidity_flow_navigator/flow/config.py,sha256=r0S2HQNfL_DQQuZtr9Loq_7kOQuimT4VSmrvCODiMvk,7157
+solidity_flow_navigator/flow/modifiers.py,sha256=yUL9G5EjukqMI6FgdzhpKbwDiF3fQmy6Umgy6ZpePNM,2011
+solidity_flow_navigator/flow/scope.py,sha256=WeMZgJpceehImto5r2AABf22MyOegT7WtRk9DGyGAX8,6142
+solidity_flow_navigator/flow/types.py,sha256=b-PUH9aAIXD8K_qEDFcy45VykO8wwynMP234l_guDSc,7542
+solidity_flow_navigator/flow/virtual_dispatch.py,sha256=w36I_8rsQZW6yQ9otO3fXsrh2Z-qaujYrTlVRPVwFt8,2988
+solidity_flow_navigator/serve/__init__.py,sha256=nJWwi_cYToGl6ErHp6K-1ymKJUpB1TGS14mh1o5PeQ4,127
+solidity_flow_navigator/serve/app.py,sha256=uBqCAGPx96QP-m6JmW1z0LmFQQctNqBSAUo985VAglE,16198
+solidity_flow_navigator/serve/highlight.py,sha256=itRhQMVU15DKgIQ1rkFR71ZnlUldbi7T9DM2Y0TlUr4,4290
+solidity_flow_navigator/serve/serializer.py,sha256=SBa5XMMFX8t4eS17NPBkcztoXq00jYKeOxFZGopeL-8,3576
+solidity_flow_navigator/serve/static/css/main.css,sha256=IKyiPnMkO1XLZWK9BMeFzR3jy3AGJyY4hHB6kIPJh2w,23930
+solidity_flow_navigator/serve/static/js/flow-progressive.js,sha256=0s1_vI1D-QVveN_Jo_8FeRP33BBCL9_r-ruInnG4ark,70357
+solidity_flow_navigator/serve/static/vendor/LICENSES.md,sha256=AOHxz1uMWqErCDjhss7Px2YuSlMkriaGpjr7zBH69mQ,947
+solidity_flow_navigator/serve/static/vendor/d3.min.js,sha256=8glLv2FBs1lyLE_kVOtsSw8OQswQzHr5IfwVj864ZTk,279706
+solidity_flow_navigator/serve/static/vendor/dagre.min.js,sha256=LN6CuvC5IywAqhOTKUX_kqF_sIxohaY1WSMwpMLFZ8U,96038
+solidity_flow_navigator/serve/templates/base.html,sha256=iTRYVa58yavpjMf73QLytb_hLB_Sxe4L94yfmM-Qt4Q,966
+solidity_flow_navigator/serve/templates/flow.html,sha256=boTNBxNuiB5R_st6McBt7P-vO7mD3-yLCI1BOHm30-8,2783
+solidity_flow_navigator/serve/templates/index.html,sha256=vmL2jGazT2w3Jkmfli_gSynlFzbSLTrj70_GwzMp8Go,5474
+solidity_flow_navigator/serve/templates/not_found.html,sha256=NATZl_urCbpmfvNa88dQLBw0E0285ZsSwGweYp1Ln3o,640
+solflow-0.11.2.dist-info/METADATA,sha256=YyUIZcXpfPIbEiTP5n9He9xh7qIC5t-3fQ7Yz6dT16k,6019
+solflow-0.11.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+solflow-0.11.2.dist-info/entry_points.txt,sha256=xow75PTWBIvwWKuh_ZuI6TrZQEZupf8mljRDQ9rj2R0,61
+solflow-0.11.2.dist-info/top_level.txt,sha256=N6o92BfUtKxiFmhJmf3zfTOTIuampfulrYp9wv1MeyU,24
+solflow-0.11.2.dist-info/RECORD,,

solflow-0.11.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

solflow-0.11.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+solflow = solidity_flow_navigator.cli:main