Skip to content

Commit aa5d6ae

Browse files
committed
add API docs link, conformance section to README
1 parent a748530 commit aa5d6ae

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,21 @@ Consumer examples in `examples/`: wallet (Python), explorer (Python), indexer (b
154154
| /memo/decode | POST | universal memo classifier |
155155
| /lifecycle/{wallet_hash} | GET | events for a wallet |
156156

157+
Interactive docs: [frontiercompute.io/api.html](https://frontiercompute.io/api.html)
158+
OpenAPI spec: [conformance/openapi.yaml](conformance/openapi.yaml)
159+
Reference clients: [Python](conformance/clients/zap1_client.py) | [TypeScript](conformance/clients/zap1_client.ts)
160+
161+
## Conformance
162+
163+
```bash
164+
python3 conformance/check.py # 14 protocol checks
165+
python3 conformance/check_api.py # 21 API schema checks
166+
python3 scripts/check_compatibility.py # 6 hash vectors
167+
bash scripts/evaluate.sh # 14 end-to-end checks
168+
```
169+
170+
See [conformance/](conformance/) for fixtures, schemas, versioning policy, and consumer contracts.
171+
157172
## Ecosystem
158173

159174
- **Verification SDK (Rust + WASM):** [Frontier-Compute/zap1-verify](https://github.com/Frontier-Compute/zap1-verify) - 22 tests

0 commit comments

Comments
 (0)