Metadata-Version: 2.4
Name: speedrunpapi
Version: 0.6.4
Summary: ᑕ. exact arithmetic circuit verification; Python entry to the shared Node engine
Author: Colony Technology
Project-URL: Homepage, https://colony.technology
Project-URL: Source, https://github.com/lmtlssss/speedrunpapi
Keywords: circom,r1cs,bitvm,zkvm,verilog,state contraction
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Provides-Extra: onnx
Requires-Dist: onnx<2,>=1.16; extra == "onnx"
Requires-Dist: numpy<3,>=1.26; extra == "onnx"
Dynamic: license-file

# speedrunpapi for Python

The Python package supplies the same bundled ᑕ. analyzer as the npm and browser distributions. It requires Node.js 20 or later on `PATH` and works offline for local scans.

Install with `pip install speedrunpapi` for the free scanner and hosted job commands, or `pip install 'speedrunpapi[onnx]'` to include the independent ONNX checker dependencies. Then run `speedrunpapi scan circuit.circom --json` or `speedrunpapi version`. Node.js 20+ must be installed on `PATH`. PyPI uses the repository's trusted publisher. The wheel includes the JavaScript client and the Python independent checker; it does not download executable code at run time.

The default JSON output carries proof data without paper citations. Add `--references` when research provenance is needed; source rechecking supports both forms.

Local scans and independent replay are free. Hosted jobs require a funded Colony API key. The v0.6.2 client checks nine bounded mathematical operators, including the M-06 shared-input masked carry counter. The repository includes four source-bound production mathematical result bundles with independently checked evidence. Replay them with `speedrunpapi check examples/m02-tap-span.math examples/m02-tap-span.result.json` and the matching M-03/M-04/M-06 files. Use `speedrunpapi quote model.onnx`, then `speedrunpapi optimize model.onnx --out candidate.onnx --proof-dir proof`, then `speedrunpapi verify-onnx proof/source.onnx proof/artifacts` to check the delivered candidate offline. A paid signed certificate requires a Colony API key. Native Bitcoin Script assembly/bytecode supports alternate-stack transfer and hash opcodes; RV32IM v2 records branches, jumps, aligned word loads and stores. BN254 R1CS v1 checks coupled full-rank linear constraints and exact square-zero elimination. Use `speedrunpapi verify result.json --source input.file` for an independent source recheck. Unsupported code and rank-deficient systems return `Unknown`.
