add index

This commit is contained in:
2025-04-29 23:04:43 +02:00
parent c451f00f3f
commit b3213e4fef
+55
View File
@@ -0,0 +1,55 @@
# 📚 Obsero Spec Index
This folder contains versioned proof formats used by the Obsero protocol.
Each JSON file represents a standardized observation generated by a probe, signed, and optionally stored on IPFS and the blockchain.
---
## ✅ Proof Formats — Version `v0.1`
### 🔵 HTTP Ping
- **`proof_format_http_up_v0.1.json`**
Observation of a successful HTTP response.
`status: "up"`, with latency and HTTP status code.
[View file ](./proof_format_http_up_v0.1.json)
- **`proof_format_http_down_v0.1.json`**
Observation of a failed HTTP response.
`status: "down"`, no latency, includes error message.
[View file ](./proof_format_http_down_v0.1.json)
---
### 🔷 ICMP Ping
- **`proof_format_icmp_up_v0.1.json`**
Observation of a reachable host using ICMP (e.g. `ping`).
`status: "up"`, includes latency.
[View file ](./proof_format_icmp_up_v0.1.json)
- **`proof_format_icmp_down_v0.1.json`**
Observation of an unreachable host using ICMP.
`status: "down"`, includes error message.
[View file ](./proof_format_icmp_down_v0.1.json)
---
## 📌 Common Fields
Each proof includes:
- `timestamp`: UTC ISO8601 datetime
- `target`: Monitored host or endpoint
- `status`: `"up"` or `"down"`
- `latency_ms`: Milliseconds (nullable if down)
- `error_message`: Present if status = `"down"`
- `observer`: Country, city, and public EVM address of the probe
- `proof.hash`: SHA-256 of key fields
- `proof.signature`: EVM signature of the hash
- `version`: Current format version
---
## 🧭 Naming Convention