Skip to content

Arkheionx v3.1.0 — Protocol Review Map

Choose a tag to compare

View all tags
@Yudis-bit Yudis-bit released this 01 Jun 03:56
· 118 commits to main since this release
v3.1.0
2ae3b91

Arkheionx v3.1.0 — Protocol Review Map

  • Release date: 2026-05-31
  • Package version: 3.1.0
  • Latest stable release: v3.0.0 (moves to v3.1.0 in post-release cleanup)
  • Current milestone: v3.1.0 · Next milestone: v3.2.0

Summary

Foundry tells you which tests passed. Arkheionx shows what the protocol still
needs to prove. v3.1.0 adds the Protocol Review Map: a structured,
developer-native review surface built on the workbench. The new
arkheionx review-map command turns a local DeFi repository into contracts,
value paths, assumptions, test gaps, proof suggestions, and links to any evidence
artifacts you have already produced — written as JSON and Markdown for reviewers.

It is local and static by default: no RPC, no private keys, no live-chain calls,
no Foundry required, and no network access. Review-map outputs are review
guidance, not confirmed vulnerabilities.

What changed since v3.0.0

  • New public command: arkheionx review-map.
  • New arkheionx/review_map/ package and schemas/review-map.schema.json.
  • New docs/REVIEW_MAP.md; public-surface, CLI, stability, output, demo,
    roadmap, release-checklist, and v3-readiness docs updated.
  • Version metadata is 3.1.0; latest stable stays v3.0.0 until publication.
  • No existing command was removed or renamed; JSON output and safety boundaries
    are unchanged.

review-map command

arkheionx review-map .
arkheionx review-map . --top 5
arkheionx review-map . --target Vault.withdraw
arkheionx review-map . --json
arkheionx review-map . --no-write
arkheionx review-map . --out ./review-out
arkheionx review-map . --include-low-confidence

review-map artifacts

Written under <repo>/.arkheionx/out/review-map/ (gitignored):
review-map.json, review-map.md, value-paths.json, test-gaps.json,
assumptions.json, proof-plan.json, evidence-links.json,
review-summary.md, and review-map.mmd. All plain text (no ANSI).

Value paths

Each value path shows where value enters, how it moves, and where it can exit,
plus the conditions a reviewer should verify and the assumptions the path relies
on. High-priority paths (value leaving the system) are surfaced first.

Assumptions

Protective properties a value path appears to rely on — fresh oracle price,
standard ERC20 behavior, bounded admin role, monotonic reward index, proportional
share accounting, no unsafe re-entry, normalized decimals, bounded fees, bounded
liquidation math. They are review prompts, not findings.

Test gaps

Suggested local test scenarios for value-sensitive functions (for example
withdrawal boundary, stale oracle, double claim, slippage bound, access control).
Low-confidence gaps are hidden unless --include-low-confidence is passed. A test
gap is not a claim that a bug exists.

Proof suggestions

For high-priority gaps, a concrete local Foundry proof outline (objective, setup,
action, assertions) with a hint that reuses the existing
arkheionx prove --run workflow.

Evidence links

If proof / trace / evidence / report artifacts already exist under
.arkheionx/out/, they are linked to review-map targets by name with their
recorded evidence level. If none exist, the map says so.

Demo fixture support

The bundled oracle-staking, amm-swap, and lending-vault demos all produce a
full review map:

arkheionx demo --copy amm-swap ./arkheionx-demo
arkheionx review-map ./arkheionx-demo

Safety boundaries

  • Local/static repository analysis only.
  • No RPC, no live-chain calls, no deployed-contract scanning.
  • No private keys, seed phrases, or secrets.
  • No exploit automation, no transaction broadcasting, no auto-submit.
  • Review guidance only — not a formal audit, not confirmed vulnerabilities, no
    final severity, no bounty eligibility. Human review remains required.

Known limitations

  • Static/heuristic mapping: it may miss value paths and may suggest
    false-positive test gaps.
  • It does not perform full Solidity semantic analysis (parsing is regex/static).
  • It does not replace manual review.
  • Most review-map signals start at HEURISTIC unless linked to proof, trace, or
    evidence artifacts.

Validation

  • python3 -m unittest discover -s tests -p "test_*.py" — 387 tests pass.
  • make validate — docs links, version consistency, safety wording, and release
    readiness all pass.
  • python3 scripts/check_release_readiness.py --check — passes
    (v3.1.0, stable v3.0.0).
  • review-map smoke on oracle-staking, amm-swap, and lending-vault: artifacts
    generated, JSON valid with no ANSI (including ARKHEIONX_COLOR=always), and
    --no-write writes nothing.
  • sh -n install.sh, sh -n uninstall.sh, sh -n arkup — clean.

Upgrade instructions

Local install only (no PyPI):

sh arkup --update          # or
python3 -m pip install -e .
arkheionx version
arkheionx review-map .

Next milestone

v3.2.0 — Review Map Deepening / Test Gap Map: deepen value-path and test-gap
analysis and consider promoting review-map sub-outputs into focused commands.

Assets 2
Loading