From b3213e4fef325ff34c96790f855565b47e906613 Mon Sep 17 00:00:00 2001 From: Foudre Date: Tue, 29 Apr 2025 23:04:43 +0200 Subject: [PATCH] add index --- specs/index.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 specs/index.md diff --git a/specs/index.md b/specs/index.md new file mode 100644 index 0000000..f5207ee --- /dev/null +++ b/specs/index.md @@ -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 +