storagelens
cognis-digital/storagelens
Diffs and decodes contract storage layouts across proxy upgrades to catch storage-collision and uninitialized-slot bugs.
Instalação
npx convez-ai cognis-digital/storagelens1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.
Métricas
README
A tradução para o português deste README ainda está na fila.
STORAGELENS
Diffs and decodes contract storage layouts across proxy upgrades to catch storage-collision and uninitialized-slot bugs.
Web3 & Smart-Contract Security — on-chain safety and analytics.
pip install cognis-storagelens
storagelens scan . # → prioritized findings in seconds
Usage — step by step
-
Install (Python 3.9+):
pip install storagelens -
Diff two storage layouts. Compare an old layout against a new one to surface upgrade hazards:
storagelens diff old_layout.json new_layout.json -
Read the output as JSON for tooling:
storagelens --format json diff old_layout.json new_layout.json | jq . -
Check the version when pinning in an environment:
storagelens --version -
Gate in CI. Exit
0means the layouts are upgrade-compatible;1means a storage collision was detected (fail the gate);2is a usage error:storagelens diff old_layout.json new_layout.json || echo "Storage collision detected"
Contents
- Why storagelens? · Features · Quick start · Example · Architecture · AI stack · How it compares · Integrations · Install anywhere · Related · Contributing
Why storagelens?
Storage-collision bugs brick upgradeable proxies silently; a CI gate that diffs layout between versions is a must-have nobody packages standalone.
storagelens is single-purpose, scriptable, and self-hostable: point it at a target, get prioritized results in the format your workflow already speaks (table · JSON · SARIF), gate CI on it, and let agents drive it over MCP.
Features
- ✅ Parse Layout
- ✅ Load Layout
- ✅ Diff Layouts
- ✅ Runs on Linux/macOS/Windows · Docker · devcontainer
- ✅ Ports in Python, JavaScript, Go, and Rust (
ports/)
Quick start
pip install cognis-storagelens
storagelens --version
storagelens scan . # scan current project
storagelens scan . --format json # machine-readable
storagelens scan . --fail-on high # CI gate (non-zero exit)
Example
$ storagelens scan .
[HIGH ] STO-001 example finding (./src/app.py)
[MEDIUM ] STO-002 another signal (./config.yaml)
2 findings · risk score 5 · 38ms
Architecture
flowchart LR
IN[input] --> P[storagelens<br/>analyze + score]
P --> OUT[report]
Use it from any AI stack
storagelens is interoperable with every popular way of using AI:
- MCP server —
storagelens mcp(Claude Desktop, Cursor, Cognis.Studio, uncensored-fleet) - OpenAI-compatible / JSON — pipe
storagelens scan . --format jsoninto any agent or LLM - LangChain · CrewAI · AutoGen · LlamaIndex — wrap the CLI/JSON as a tool in one line
- CI / scripts — exit codes + SARIF for non-AI pipelines
How it compares
| Cognis storagelens | OpenZeppelin Upgrades plugin | |
|---|---|---|
| Self-hostable, no account | ✅ | varies |
| Single command, zero config | ✅ | ⚠️ |
| JSON + SARIF for CI | ✅ | varies |
| MCP-native (AI agents) | ✅ | ❌ |
| Polyglot ports (JS/Go/Rust) | ✅ | ❌ |
| Open license | ✅ COCL | varies |
Built in the spirit of OpenZeppelin Upgrades plugin, re-framed the Cognis way. Missing a credit? Open a PR.
Integrations
Pipes into your stack: SARIF for code-scanning, JSON for anything, an MCP server (storagelens mcp) for AI agents, and a webhook forwarder for SIEM/Slack/Jira. See docs/INTEGRATIONS.md.
Install — every way, every platform
pip install "git+https://github.com/cognis-digital/storagelens.git" # pip (works today)
pipx install "git+https://github.com/cognis-digital/storagelens.git" # isolated CLI
uv tool install "git+https://github.com/cognis-digital/storagelens.git" # uv
pip install cognis-storagelens # PyPI (when published)
docker run --rm ghcr.io/cognis-digital/storagelens:latest --help # Docker
brew install cognis-digital/tap/storagelens # Homebrew tap
curl -fsSL https://raw.githubusercontent.com/cognis-digital/storagelens/main/install.sh | sh
| Linux | macOS | Windows | Docker | Cloud |
|---|---|---|---|---|
scripts/setup-linux.sh | scripts/setup-macos.sh | scripts/setup-windows.ps1 | docker run ghcr.io/cognis-digital/storagelens | DEPLOY.md (AWS/Azure/GCP/k8s) |
Related Cognis tools
reentryx— Static + symbolic detector that flags reentrancy, cross-function, and read-only reentrancy paths in Solidity/Vyper with CI-gating SARIF output.forkfuzz— Mainnet-fork invariant fuzzer that replays your contract against live state and stateful sequences to break protocol invariants before deploy.approvewarden— Scans any wallet for dangerous ERC-20/721/1155 token approvals and infinite allowances, scoring drainer exposure and emitting revoke transactions.mevscope— Replays a tx or address history to attribute sandwich, frontrun, and backrun MEV extraction with per-trade loss accounting.rugradar— Token contract risk scanner detecting honeypots, hidden mint/blacklist functions, owner backdoors, and unlocked liquidity before you ape.sigsleuth— Decodes raw calldata and EIP-712 typed-data into human-readable intent, flagging blind-signing and malicious permit/Permit2 payloads.
Explore the suite → 🗂️ all 170+ tools · ⭐ awesome-cognis · 🔗 cognis-sources · 🤖 uncensored-fleet · 🧠 engram
Contributing
PRs, new rules, and demo scenarios are welcome under the collaboration-pull model — see CONTRIBUTING.md and SECURITY.md.
⭐ If
storagelenssaved you time, star it — it genuinely helps others find it.
Interoperability
{} composes with the 300+ tool Cognis suite — JSON in/out and a shared
OpenAI-compatible /v1 backbone. See INTEROP.md for the
suite map, composition patterns, and reference stacks.
License
Source-available under the Cognis Open Collaboration License (COCL) v1.0 — free for personal, internal-evaluation, research, and educational use; commercial / production use requires a license (licensing@cognis.digital). See LICENSE.