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.5.1-cp311-abi3-manylinux_2_39_x86_64.whl (9.5 MB view details)

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

ciris_edge-0.5.1-cp311-abi3-manylinux_2_39_aarch64.whl (8.7 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.39+ ARM64

ciris_edge-0.5.1-cp311-abi3-macosx_11_0_arm64.whl (6.2 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

File details

Details for the file ciris_edge-0.5.1-cp311-abi3-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.5.1-cp311-abi3-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 afab38c567a64e82a4bea32c02777af7b1d85f864dae519d5660dffeffa054a2
MD5 cec87a41ff4695e4020651643d67aad6
BLAKE2b-256 0520d1fb33d5eba82b0338e2d86c19b7996274c42b31cfcd2f87870d02808846

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_edge-0.5.1-cp311-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.5.1-cp311-abi3-manylinux_2_39_aarch64.whl.

File metadata

File hashes

Hashes for ciris_edge-0.5.1-cp311-abi3-manylinux_2_39_aarch64.whl
Algorithm Hash digest
SHA256 ca7484aa206c4de9b1989243ba52a3b82f6f8cb4f3da371bbd84231483f235ba
MD5 79fc8d87787c8b3e2aa44537b077bf5f
BLAKE2b-256 050d1b051576825f47407755cdacdcf961b5a4f33d66816124511a6e6a3d09a5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_edge-0.5.1-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 01a137881a01fb235dc7b64cf0d1e6fd5a7ae98e2e6da8252e762816e227c3fb
MD5 ed89e09079d94cb41ff0cb3d23ac43ed
BLAKE2b-256 433e4129e1d794d933a91127f8edee8885ff9576e8e7ee1f677067a8e6f0615c

See more details on using hashes here.

Provenance

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