Skip to main content

Reticulum-native federation transport for the CIRIS stack

Project description

ciris-edge

Reticulum-native federation transport for the CIRIS stack. Replaces the Python edge across CIRISLens (FastAPI), CIRISAgent (httpx), CIRISRegistry (HTTPS) with a single Rust crate that does signed message in/out, verify-via-persist, and typed handler dispatch.

Status: v0.2.0 — Phase 1 substrate live. Verify pipeline (hybrid Ed25519 + ML-DSA-65 via persist's directory lookup), durable outbound queue + dispatcher, typed handler dispatch, HTTP transport, outbound inline-text pipeline integration (Classify + Scrub + EncryptAndStore via ciris-persist v1.1.2), and a sovereign-mode convenience constructor (EdgeBuilder::from_keyring_seed_dir) for Reticulum-style adoption with no persist Engine in-process. PyO3 surface (Edge class registration + init_edge_runtime) lands in v0.3.x; reticulum

  • multi-medium transports follow per Phase 3 of the FSD.

Read in this order

  1. MISSION.md — the WHY. Mission Driven Development alignment to CIRIS Accord Meta-Goal M-1; per-module mission statements; anti-patterns that violate the mission; failure modes.

  2. FSD/CIRIS_EDGE.md — the WHAT. Architecture spec, three-phase delivery plan, crate shape, public API surface, verify-via-persist contract, wire-format envelope, test categories.

  3. FSD/OPEN_QUESTIONS.md — the HOW. Thirteen design forks needing owner input before Phase 1 starts. Each question states the choice, the trade-off, and a lens-side default; resolutions land at the bottom in CLOSED.

TL;DR

The CIRIS architecture has three peers (agent, lens, registry) each maintaining their own network edge. Three parallel HTTP shims, three retry policies, three cert-management stories. The Proof-of-Benefit Federation FSD (~/CIRISAgent/FSD/PROOF_OF_BENEFIT_FEDERATION.md §3.2) names Reticulum-rs as the transport that closes the federation loop: addressing IS identity, multi-medium reach, fork-survivable Rust.

ciris-edge is the crate that operationalizes that proposal. Each peer becomes:

host application code
    │ registers handlers
    ▼
ciris-edge       ←── Reticulum link sessions (TCP / LoRa / serial / I²P)
    │ verify via persist
    ▼
ciris-persist    ←── steward identity, federation_keys, trace storage

One shape, many peers. Library, not sidecar. Verify happens at the wire, before any handler sees a byte. Key seeds never cross the FFI boundary. HTTP fallback ships in Phase 1 so cloud deployments can participate today; Reticulum is canonical and Phase 3 productionizes LoRa + serial + I²P for the deployments that need M-1 most.

Phases

Phase Outcome
1 (immediate) Crate skeleton; HTTP transport + Reticulum behind a feature flag; Ed25519 verify via persist; typed handler dispatch; lens cuts over from FastAPI to embedded edge runner
2 Agent + registry adopt edge; HTTPS becomes per-peer fallback
3 LoRa, packet-radio, serial transports productionized; off-grid CIRIS deployments tractable

Sister repos

  • CIRISAgent — agent reasoning loop; emits signed traces. Wire-format spec lives at FSD/TRACE_WIRE_FORMAT.md.
  • CIRISPersist — substrate. Owns the federation keys directory, steward identity, canonical-bytes canonicalization, trace storage. Edge calls into persist for sign + verify.
  • CIRISLens — analytical observatory. First peer to adopt edge in Phase 1 (cuts over from FastAPI ingest).
  • CIRISRegistry — identity / build / license / revocation directory. Adopts edge in Phase 2.
  • CIRISVerify — cryptographic primitives library. Edge depends transitively via persist.

License

AGPL-3.0, matching the rest of the CIRIS federation stack. License- locked mission preservation per MISSION.md §6.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_x86_64.whl (11.7 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.39+ x86-64

ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_aarch64.whl (10.9 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.39+ ARM64

ciris_edge-0.20.1-cp310-abi3-macosx_11_0_arm64.whl (8.5 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

Details for the file ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 468a4caf3bb58a3226766ce25e639d6a5f11ea385bf3668813c07426716c26a7
MD5 b822e22c1caa83b510a89897b75f5c0d
BLAKE2b-256 0daf1674dd615daf750050923ef0900fce64bf5cf2bd0b62e2706f886dcb41ed

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_x86_64.whl:

Publisher: ci.yml on CIRISAI/CIRISEdge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_aarch64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_aarch64.whl
Algorithm Hash digest
SHA256 9a234ebbbed22a9ea01a61ecea705f269f49b519b88b81d374d7ec6bf5493264
MD5 2732178df6e0f6bda2e36c6c286d67a0
BLAKE2b-256 25c193e78a650b8e83e603fd04b448c1dc6f59f4b916cceb18391b5c0553e92c

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_edge-0.20.1-cp310-abi3-manylinux_2_39_aarch64.whl:

Publisher: ci.yml on CIRISAI/CIRISEdge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_edge-0.20.1-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.20.1-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c973deba8518c473d532a189d959559c597cc319ddf2de50b50e345fa5e47b03
MD5 726eaa6ab5f44daa44d0ee3e737073d5
BLAKE2b-256 2fc41229bc969bbd13f32221ea3e870ab59b57809ab72b2c5570bd37ac5b2d8d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_edge-0.20.1-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: ci.yml on CIRISAI/CIRISEdge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page