scrypto-audit-kit 0.5.0__tar.gz

scrypto_audit_kit-0.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 scrypto-audit-kit contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

scrypto_audit_kit-0.5.0/PKG-INFO

@@ -0,0 +1,307 @@
+Metadata-Version: 2.4
+Name: scrypto-audit-kit
+Version: 0.5.0
+Summary: Pre-audit toolkit for Scrypto blueprints on Radix: deterministic static analysis, an LLM checklist pass, machine-readable reports, an MCP server, and on-chain attestation.
+Author: bigdev
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/bigdevxrd/scrypto-audit-kit
+Project-URL: Repository, https://github.com/bigdevxrd/scrypto-audit-kit
+Project-URL: Issues, https://github.com/bigdevxrd/scrypto-audit-kit/issues
+Project-URL: Documentation, https://github.com/bigdevxrd/scrypto-audit-kit/tree/main/docs
+Keywords: scrypto,radix,smart-contracts,security,audit,static-analysis,mcp,defi,web3
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: mcp
+Requires-Dist: mcp[cli]>=1.0; extra == "mcp"
+Provides-Extra: schema
+Requires-Dist: jsonschema>=4.0; extra == "schema"
+Provides-Extra: dev
+Requires-Dist: jsonschema>=4.0; extra == "dev"
+Requires-Dist: mcp[cli]>=1.0; extra == "dev"
+Dynamic: license-file
+
+# scrypto-audit-kit
+
+[![lint](https://github.com/bigdevxrd/scrypto-audit-kit/actions/workflows/lint.yml/badge.svg)](https://github.com/bigdevxrd/scrypto-audit-kit/actions/workflows/lint.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Scrypto · Radix](https://img.shields.io/badge/Scrypto-Radix-052CC0)](https://docs.radixdlt.com/docs/scrypto-1)
+[![status: alpha](https://img.shields.io/badge/status-alpha-orange.svg)](#limitations--read-this-before-relying-on-the-output)
+[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
+
+Pre-audit harness for [Scrypto](https://docs.radixdlt.com/docs/scrypto-1) blueprints on the Radix network. Runs a **hybrid analysis** — deterministic static rules plus an LLM pass over a curated checklist + reference patterns — and produces a findings report (markdown + JSON) you can hand to a human auditor (or use to fix issues yourself). The static pass alone is free and needs no API key.
+
+This is a **pre-audit** tool, not an audit. It catches the kinds of issues a careful reviewer would catch on a first read so that paid auditors can spend their time on the harder, second-read findings. **It does not replace a human audit before mainnet deployment.**
+
+> **Where this fits** — the kit is the entry rung of a *trust ladder* that climbs from `cargo check` up to a full human audit (Hacken, Certik, …). The bigger plan — agentic audit→fix→verify loops, reproducible attested runs, and on-chain attestation — lives in **[VISION.md](VISION.md)**.
+
+## What it does
+
+For each scrypto package you point it at, the kit:
+
+1. Runs a **deterministic static pass** (free, no API) — a curated set of high-precision Scrypto rules (unbounded drains, no-owner globalize, self-rotating roles, floats, hardcoded addresses, …).
+2. Loads the package's source (Cargo.toml + everything under `src/` and `tests/`) into an [aider](https://aider.chat) session.
+3. Loads a vulnerability **checklist** (11 classes — auth, reentrancy, decimal, resource handling, time, state machine, external calls, upgrade, oracle, slippage, allowances) and a catalogue of **reference patterns** (Ignition, CaviarNine HyperStake, subintents, a strategy-vault threat model, general scrypto knowledge) as read-only context.
+4. Asks Claude Sonnet 4.6 to produce a structured findings report — summary, findings (Critical → Info), checklist coverage walk, pattern conformance check, test-coverage gaps, open questions for the human auditor.
+5. Merges both passes and writes a markdown report to `audit-reports/<repo>-<package>-<date>.md` **and** a machine-readable `report.json` ([schema](schema/audit-report.schema.json)) that agents and the CI gate consume.
+
+The kit is **read-only by design**. It produces reports; it does not edit your blueprint. Edits to audit-grade code must go through a separate, human-supervised session.
+
+## Quickstart
+
+```bash
+pip install scrypto-audit-kit        # the deterministic toolkit + MCP server, no API key needed
+# ...or clone for the full LLM audit harness (audit.sh):
+git clone https://github.com/bigdevxrd/scrypto-audit-kit
+```
+
+The pip package gives you the free static analysis, test-scaffold generation, the attestation
+bridge, and the MCP server — importable and as `sak-*` commands. The full `./audit.sh` (the LLM
+checklist pass) lives in the clone. **[docs/quickstart.md](docs/quickstart.md)** walks all three
+tiers end to end.
+
+### Requirements (for the full `./audit.sh` audit)
+
+- [aider](https://aider.chat) (`pip install aider-chat` — version 0.86 or newer)
+- An Anthropic API key (the kit defaults to Claude Sonnet 4.6 — get one at <https://console.anthropic.com>)
+- bash, awk, find (standard on macOS / Linux)
+- `python3` — optional; only needed for the machine-readable `report.json` (the markdown report works without it)
+
+The key can be provided in any of three ways:
+
+```bash
+# 1. Export in your shell (preferred for CI)
+export ANTHROPIC_API_KEY=sk-ant-...
+
+# 2. Point AIDER_ENV_FILE at an existing env file
+AIDER_ENV_FILE=~/some/.env ./audit.sh /path/to/package
+
+# 3. Drop a .env file (gitignored) in the kit directory
+echo "ANTHROPIC_API_KEY=sk-ant-..." > .env
+```
+
+Verify with:
+
+```bash
+make check-deps
+```
+
+### Run an audit
+
+```bash
+git clone https://github.com/bigdevxrd/scrypto-audit-kit
+cd scrypto-audit-kit
+chmod +x audit.sh
+
+./audit.sh /path/to/your/scrypto/package
+# or:
+make audit TARGET=/path/to/your/scrypto/package
+```
+
+The target must be a scrypto package directory (has a `Cargo.toml` and a `src/lib.rs`). The kit will read everything under `src/` and `tests/`.
+
+The report lands in `audit-reports/<repo>-<package>-<YYYY-MM-DD>.md`. Reports are gitignored — share them by other means, don't commit them.
+
+### Example
+
+```bash
+./audit.sh ~/scrypto/my-vault
+[pre-flight] compile check OFF (default; compiling runs the target's build scripts).
+             opt in with --compile-check for code you trust.
+
+==> scrypto-audit-kit
+    target:    scrypto / my-vault
+    path:      /home/me/scrypto/my-vault
+    model:     claude
+    sources:   3 files
+    refs:      6 files (read-only)
+    report ->  audit-reports/scrypto-my-vault-2026-05-11.md
+
+[aider runs ...]
+
+==> done. report: audit-reports/scrypto-my-vault-2026-05-11.md
+```
+
+> Note: an opt-in `--compile-check` pre-flight runs `cargo check --release --target
+> wasm32-unknown-unknown` first and bails if the package doesn't compile. It is **off by
+> default**: compiling executes the target's build scripts and proc-macros on your machine,
+> so enable it only for code you trust enough to run
+> (`rustup target add wasm32-unknown-unknown` sets up the target).
+
+### Choosing a model
+
+The default is Claude Sonnet 4.6. A `--model` flag selects the analysis model:
+
+```bash
+./audit.sh --model claude   <path>   # default — Sonnet 4.6, best pattern depth
+./audit.sh --model deepseek <path>   # cheaper broad scan (needs DEEPSEEK_API_KEY)
+./audit.sh --model both     <path>   # DeepSeek broad pass, then Claude deep pass,
+                                     # with a cross-model confidence summary
+```
+
+`both` runs DeepSeek first for a wide net, feeds its findings to Claude as
+context, and tags findings both models agree on as HIGH confidence. Use it when
+you want a second opinion on a high-stakes blueprint.
+
+### Free tier: deterministic static analysis
+
+A static pass runs on every audit, and you can run it *alone* with **no API key, no aider, and no toolchain**:
+
+```bash
+./audit.sh --static-only <path>     # free, instant, deterministic
+```
+
+It applies a curated set of high-precision Scrypto rules — comment/string-aware, so code rules don't match inside comments or string literals — and writes the same `report.json`. Suppress a finding with a `// sak:allow <rule-id>` comment; add `--no-static` to a full run to skip the pass. See [docs/static-analysis.md](docs/static-analysis.md) for the rule list and how to add one.
+
+### Try it on the bundled example
+
+The repo ships a deliberately-vulnerable blueprint so you can see real output without writing any code — the static tier needs no API key:
+
+```bash
+./audit.sh --static-only examples/vulnerable-vault   # free; drop --static-only for the full hybrid run
+```
+
+The expected result is committed beside it — [`examples/vulnerable-vault.pre-audit.md`](examples/vulnerable-vault.pre-audit.md) (human) and [`.json`](examples/vulnerable-vault.pre-audit.json) (machine-readable). Every `file:line` in it is exact, because the bugs are planted.
+
+### Machine-readable output
+
+Alongside the markdown, the kit writes `report.json` conforming to [`schema/audit-report.schema.json`](schema/audit-report.schema.json) — stable ids (`F-###` from the LLM, `S-###` from the static pass, each tagged with its `source`), severities, full checklist coverage, and a provenance block (kit version, model, checklist version, and a sha256 of the analyzed source). This is what agents, the CI gate, and (later) on-chain attestation consume; the markdown is a render of it.
+
+### Continuous integration & a badge
+
+Run the pre-audit on every PR and show a status badge — full setup in [docs/ci.md](docs/ci.md). In short, call the reusable workflow:
+
+```yaml
+jobs:
+  scrypto-pre-audit:
+    uses: bigdevxrd/scrypto-audit-kit/.github/workflows/pre-audit.yml@main
+    with:
+      package: packages/my-blueprint
+      fail-on: high
+    secrets:
+      ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+```
+
+It compiles, audits, uploads the report, and fails on High/Critical findings — an honest "pre-audit passing" signal, not a safety guarantee.
+
+### Use it from an agent (MCP + Claude Code)
+
+The kit ships an **MCP server** so an agent can run the pre-audit as tools and walk you through **audit → fix → re-verify**:
+
+```bash
+pip install "mcp[cli]"
+claude mcp add --transport stdio scrypto-audit-kit -- python3 "$PWD/bin/mcp_server.py"
+```
+
+Tools: `static_scan` (free), `audit_package`, `propose_tests`, `attestation_payload`, `get_findings`, `show_finding_source`, `reaudit_diff`, `gate`, `get_checklist`. There's also a Claude Code skill (`/scrypto-pre-audit`) and an [AGENTS.md](AGENTS.md) playbook for any agent. Full setup — including the audit→fix→verify loop — in [docs/agents.md](docs/agents.md); the nine tools and their formal contracts are in [docs/mcp-tools.md](docs/mcp-tools.md).
+
+### Build on it — the Python SDK
+
+`pip install scrypto-audit-kit` makes the deterministic core importable, with zero required
+dependencies:
+
+```python
+from scrypto_audit_kit import static_analysis, sak_lib
+findings = static_analysis.analyze_package("path/to/package")     # free, no API key
+verdict  = sak_lib.gate_verdict(sak_lib.build_report(findings), "high")
+```
+
+The full API, the nine tools in-process, and the `sak-*` console scripts are in
+[docs/sdk.md](docs/sdk.md). Three runnable example agents — a free-tier CI gate, the
+audit→fix→verify loop, and an MCP client — are in [examples/agents/](examples/agents/).
+
+### Generate tests, attest on-chain
+
+- **Property tests.** `propose_tests` (or `python3 bin/gen_tests.py <pkg>`) emits compilable `#[ignore]`d `scrypto-test` scaffolds for the coverage gaps — auth negative-paths, happy paths, a value invariant — so closing them is fill-in-the-blank.
+- **On-chain attestation (L3).** `attestation_payload` (or `python3 bin/attest.py <report.json>`) turns a report into a Radix transaction manifest that records an attestation on-ledger via the [attestation/](attestation/) registry blueprint — bound to your exact source hash (the deterministic anchor). A coverage record, not a safety guarantee, and for the LLM tier not byte-reproducible (see [attestation/README.md](attestation/README.md)).
+
+## What's in the kit
+
+```
+scrypto-audit-kit/
+├── audit.sh                The harness — wraps aider with the right flags + context.
+├── Makefile                Convenience targets (audit, lint, test, check-deps).
+├── pyproject.toml          Pip packaging — importable SDK + sak-* console scripts.
+├── VERSION                 Kit version, stamped into every report.
+├── VISION.md / ROADMAP.md  The trust-ladder strategy + the live phase checklist.
+├── AGENTS.md               How an agent should drive the kit (audit → fix → verify).
+├── .mcp.json               MCP server config (auto-wires the tools in Claude Code).
+├── .aider.conf.yml         Tuned config: model=Sonnet 4.6, no editor/commits, cache on.
+├── prompts/
+│   ├── audit.md            Auditor-role prompt + report structure (incl. the JSON appendix).
+│   └── checklist.md        Eleven vulnerability classes with concrete questions per class.
+├── references/             Read-only context — production patterns + threat models (5 files).
+├── schema/                 JSON Schemas — the report + the MCP tool contracts.
+├── bin/                    engine + tools: static_analysis.py, gen_tests.py, attest.py, mcp_server.py, …
+├── tests/                  Stdlib unit tests for the tooling (`make test`).
+├── docs/                   The docs suite (quickstart · sdk · mcp-tools · architecture · …).
+├── attestation/            On-chain attestation registry blueprint (Scrypto, L3).
+├── .claude/skills/         The scrypto-pre-audit Claude Code skill.
+├── audit-reports/          Output dir, gitignored.
+└── examples/
+    ├── vulnerable-vault/   Deliberately-vulnerable fixture + its committed report.
+    ├── agents/             Runnable example agents (CI gate, audit→fix→verify, MCP client).
+    └── ci/                 Drop-in pre-audit workflow for your repo.
+```
+
+## Documentation
+
+Everything is in **[docs/](docs/README.md)**; the short list:
+
+- [quickstart.md](docs/quickstart.md) — install + run, all three tiers
+- [static-analysis.md](docs/static-analysis.md) — the deterministic rules (and adding one)
+- [agents.md](docs/agents.md) · [mcp-tools.md](docs/mcp-tools.md) — drive it from an agent / over MCP
+- [sdk.md](docs/sdk.md) — the Python API + console scripts
+- [ci.md](docs/ci.md) — CI gate + badge
+- [architecture.md](docs/architecture.md) — how the pieces fit together
+- [VISION.md](VISION.md) · [ROADMAP.md](ROADMAP.md) · [CHANGELOG.md](CHANGELOG.md) — strategy, status, history
+
+## Limitations — read this before relying on the output
+
+The kit is honest about what it is. Things it explicitly does **not** do:
+
+- **It is not a formal verifier.** No theorem proving, no symbolic execution, no fuzzing. Findings are derived from pattern matching against a checklist by an LLM.
+- **It does not run `cargo build` or `cargo test`.** Compilation issues, dependency vulnerabilities, and test failures are not in scope. Run those separately.
+- **It does not catch novel attack classes.** It will surface known footguns reliably and propose novel concerns as low-confidence open questions. Novel-attack discovery is the human auditor's job.
+- **The LLM can hallucinate file:line citations.** Every finding cites a location; you must verify those citations before acting on them. The audit prompt explicitly instructs the model to cite, but verification is on the reader.
+- **It is not a deployment gate.** Do not block deploys on a clean report. The kit is an aid, not approval.
+
+If any of these limitations matter for your use case, do not use this kit as a substitute for a paid audit.
+
+## Cost
+
+With the default config (Sonnet 4.6, prompt caching on, references cached across runs):
+
+- First audit of a session: ~50k input tokens (references) + 5–20k input tokens (target source) + ~5–15k output tokens → roughly $0.20–$0.40 per run.
+- Subsequent audits in the same prompt-cache window: cached references reduce cost ~70% → roughly $0.10 per run.
+
+These figures are estimates as of 2026. Check current [Anthropic pricing](https://www.anthropic.com/pricing) for accurate numbers. The kit deliberately does *not* use the architect/editor split (which would add a second model call) because we want analysis, not code edits.
+
+## Contributing
+
+This kit is community-maintained and gets stronger with more eyes on it. The most valuable contributions:
+
+- **New vulnerability classes for the checklist.** Real-world Scrypto exploits or footguns we haven't catalogued yet.
+- **New reference patterns.** Open-source Radix blueprints with patterns worth catalogue-ing — adapter scaffolds, role hierarchies, panic modes, etc.
+- **Trial reports.** Run the kit against a public blueprint and share what it found (or missed). Negative results are valuable.
+- **Harness fixes.** False-positive patterns, brittle parsing, missing edge cases in `audit.sh`.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow.
+
+## License
+
+[Apache 2.0](LICENSE) — the same license most of the upstream Radix ecosystem uses. Forks, derivatives, and commercial use all welcome; attribution preserved per the license.
+
+## Related
+
+- [Radix Scrypto docs](https://docs.radixdlt.com/docs/scrypto-1)
+- [radixdlt/Ignition](https://github.com/radixdlt/Ignition) — the canonical Radix-team-maintained reference codebase (most of our `references/ignition-patterns.md` extracts from here)
+- [caviarnine/caviarnine-scrypto](https://github.com/caviarnine/caviarnine-scrypto) — Apache-licensed CaviarNine production blueprints
+- [aider](https://aider.chat) — the LLM coding agent this kit wraps