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


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.2.8-cp311-abi3-manylinux_2_34_x86_64.whl (279.9 kB view details)

Uploaded CPython 3.11+manylinux: glibc 2.34+ x86-64

ciris_edge-0.2.8-cp311-abi3-manylinux_2_34_aarch64.whl (270.5 kB view details)

Uploaded CPython 3.11+manylinux: glibc 2.34+ ARM64

ciris_edge-0.2.8-cp311-abi3-macosx_11_0_arm64.whl (255.8 kB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

File details

Details for the file ciris_edge-0.2.8-cp311-abi3-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.2.8-cp311-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 bf61722aaac0ee1d6e59ffedb1fe9c45d01432f70a211b97ffd19f9b576e2720
MD5 88fadd763b6182572aa7d02c6f4fe4f0
BLAKE2b-256 84b0461060890cfff80690b73472a63d41054ae9360da8a19e738e0d18e6b9ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_edge-0.2.8-cp311-abi3-manylinux_2_34_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.2.8-cp311-abi3-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.2.8-cp311-abi3-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 f1967bb5adc3783d431875c5001a0a5c654d6e0fa9cda7b323f5994b72529dca
MD5 f68ce25a65a16b62cfe756e243d62b57
BLAKE2b-256 955f2441f8c3a2ba6ede641c0052c534729c3e24aef2e89bd2d00110319c6985

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_edge-0.2.8-cp311-abi3-manylinux_2_34_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.2.8-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.2.8-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b765040b141ebf3ba5d023781b23e1513382c9031f77c45767c623799c59419b
MD5 76a41ecb1a8e4916d3d9ff05e4a7da5e
BLAKE2b-256 229764979174871f789b5955e3610612287651d3c8c1195dd0abf40eedd3b627

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_edge-0.2.8-cp311-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