Files
alkcall/docs/architecture/call-README.md
T
glm-5.3-flash 5f019c02f1 docs: re-key architecture docs off the alknet mono-repo — speak as alkcall
The ported docs still framed alknet siblings (alknet-core/-call/-channels/
-http/-tls/-client) as live load-bearing context of this crate. With the
extraction complete and alknet headed for glue-level replacement, the docs
now speak as alkcall and cite the real sibling crates (alkhttp, alktls,
alktty, alktunnels, alktrader).

- ADR-054 (new): re-own the verifier-selection rule in-crate — three
  remote roles (public X.509 endpoint / transport relay / hub),
  ServerCertVerifier by PeerEntry presence, RemoteIdentity None
  load-bearing. Provenance: alknet ADR-034 (never ported), demoted to
  footnote. Resolves OQ-21's cross-repo authority gap.
- OQ-43 (new, deferred(scope)): composition-layer ownership and shape
  after the alknet replacement — the named receiver for the
  downstream-side deferrals (OQ-33 endpoint layer, OQ-41 QUIC-native
  substrate, OQ-42 hub broker, OQ-19 persistence adapters, ADR-045 dial
  seam). README layering diagram redrawn with the composition layer as
  TBD-ownership instead of "alknet / alknode" in concrete.
- Spec docs reframed: titles, self-references, dial/TLS/from_jsonschema
  homes, malformed legacy cite rows removed; dead relative research
  paths qualified as source-repo paths.
- ADR amendments (append-only): 027 (alknet-http -> alkhttp), 031 (post-
  extraction state), 044 (split landed as modules in alkcall), 045
  (name normalization; citation-space note).
- Citation hygiene: unprefixed/colliding source-repo cites prefixed
  ("alknet ADR-NNN (provenance)") across 009/011/022/034/035/038/040/
  043/044/045; stale OQ cites corrected (session registries OQ-04, batch
  semantics OQ-03, verifier rule ADR-054); stale anchors fixed.
- README provenance note consolidated; citation conventions documented.

Verification: markdown link check (all local links resolve, all in-crate
ADR cites point at existing decisions/ files); table integrity check
(uniform row widths across open-questions.md and edited tables); residual
alknet-mention sweep (only provenance/historical/intentional framing
remains); architecture review subagent pass with zero remaining criticals.
Docs-only change — no code paths touched.
2026-10-13 10:53:47 +00:00

15 KiB
Raw Blame History


status: draft last_updated: 2026-10-13 (alkcall reframing — historical alknet framing moved to the provenance note) review: call/review-call passed 2026-06-23 — registry, protocol, ADR (005/012/014/015/016/017/022/023/024), security, and pattern-consistency checks all conformant; 159 unit/integration tests green; cargo build, cargo clippy -- -D warnings, cargo fmt --check, cargo test clean. Call-completion gap (ADR-022 client/adapter surface) addressed 2026-06-26; ADR-024 migration landed. Transport generalization sweep (ADR-014 supersedes ADR-013; ADR-007 from_stream) synced 2026-07-09. Crate-extraction sweep (phases 0–5) landed 2026-07-17: ConnectionCredentials/RemoteIdentity vendored into alkcall's core types (ADR-012); dial extracted as the composition layer's helper (ADR-045); alkcall is a pure protocol crate with no TLS/transport deps.

alkcall — Call Protocol

Structured RPC: operations, request/response, streaming subscriptions, and service discovery. Implements ProtocolHandler on ALPN alk/call. Runs over QUIC (quinn/iroh) and, via Connection::from_stream (ADR-007), over any AsyncRead + AsyncWrite transport. A pure protocol crate — no TLS or transport deps. The dial and TLS config belong to the composition layer (the dial helper is AlknetClient; the TLS config types live in the sibling host crate alktls — see ADR-045 and OQ-43).

Documents

Document Status Description
call-protocol.md draft CallAdapter, hand-rolled EventEnvelope framing (no irpc — ADR-014), stream model, PendingRequestMap, bidirectional calls
operation-registry.md draft OperationSpec, Handler, OperationRegistry, AccessControl, service discovery, hand-rolled framing (no irpc — ADR-014)
client-and-adapters.md draft CallClient (transport-agnostic spawn_dispatch primary; dial lives in the composition layer's dial helper per ADR-045), from_call, OperationAdapter trait, adapter location map, no-env-vars invariant, exchange-of-operations pattern (from_jsonschema in alkhttp per ADR-027)

Applicable ADRs

ADR Title Relevance
001 ALPN-Based Protocol Dispatch CallAdapter registers on ALPN alk/call
002 ProtocolHandler Trait CallAdapter implements ProtocolHandler
031 Crate Decomposition alkcall is self-contained: call + channels subsystems + vendored core types (no irpc — ADR-014)
033 Rust as Canonical Implementation Language Adapter traits defined in Rust; TS is reference/browser adaptation
003 Auth as Shared Core AuthContext passed to call handlers
013 irpc as Call Protocol Foundation Accepted → Superseded by ADR-014 (irpc was never integrated; framing is hand-rolled)
014 Hand-Rolled EventEnvelope Framing Wire format, registry, dispatch are hand-rolled in alkcall; supersedes ADR-013
007 Connection::from_stream Generic single-stream connections; unblocks TCP+TLS/SSH/WT/wasm dispatch
004 ALPN String Convention alk/call ALPN, one ALPN per connection
005 BiStream Type Definition CallAdapter receives Connection, not BiStream
015 Call Protocol Stream Model Bidirectional streams, EventEnvelope, ID-based correlation
010 Secret Material Flow and Capability Injection Call protocol carries no secret material; capabilities injected at assembly layer
017 Privilege Model and Authority Context internal = authority switch not ACL skip; External/Internal visibility; handler identity + scoped env
020 Abort Cascade for Nested Calls call.aborted cascades to descendants; default abort-dependents, continue-running opt-in
022 Call Protocol Client and Adapter Contract CallClient opens connections; from_call imports remote ops; connection direction independent of call direction
027 from_jsonschema as HTTP-Backed Single-Endpoint Adapter Moved from_jsonschema out of the call protocol (broken schema-only placeholder) to the HTTP host crate as a real reqwest-backed single-endpoint adapter — today alkhttp (ex-alknet-http); FromJsonSchema provenance stays in alkcall as a leaf
018 Handler Registration, Provenance, and Composition Authority Registration bundle carries provenance, composition authority, scoped env, capabilities
016 Operation Error Schemas Operations declare domain errors; call.error carries typed details; adapter fidelity
019 Operation Registry Layering Curated (static) + session/connection overlays (dynamic); OperationEnv as trait-object integration point; OperationContext.env split into scoped_env (data) and env (dispatch trait)
023 Peer-Scoped Registry Filtering Accepted → Superseded by ADR-024 (flat-namespace single-peer model couldn't express head→N-workers; parallel auth system duplicated AccessControl)
024 Peer-Graph Routing Model Peer-keyed overlays + PeerRef routing; AccessControl-based peer authorization; retires remote_safe/trusted_peer
025 PeerEntry and Identity.id Decoupling PeerId source = Identity.id = PeerEntry.peer_id (stable); supersedes ADR-024's UUID source
026 Forwarded-For Identity forwarded_for on OperationContext and call.requested; metadata only, never used by AccessControl::check
045 Dial Seam — Dial Out of the Protocol Crate The dial lives in the composition layer's dial helper (AlknetClient, today in the alknet glue — future owner OQ-43); CallClient is spawn_dispatch only; alkcall is a pure protocol crate with no TLS/transport deps
012 ConnectionCredentials — Decouple Dial from Call Protocol ConnectionCredentials/RemoteIdentity live with the vendored core types in alkcall (originally alknet-core); auth_token is a per-request payload field

Provenance (source-repo ADRs, not ported): alknet ADR-008 — Vault Integration Point (superseded in-crate by ADR-010) and alknet ADR-010 — ALPN Router and Endpoint (superseded in-crate by ADR-001's ALPN dispatch and the decision that alkcall has no endpoint layer) are historical origins only. alknet ADR-033 — Storage Boundary and Repo/Adapter Pattern is the repo/adapter pattern behind the OwnershipProvider persistence story (OQ-19); its persistence adapters belong to the composition layer (OQ-43).

Relevant Open Questions

OQ Title Status Relevance
OQ-01 Call protocol scope within a connection resolved (ADR-015) Stream model, multiplexing, scope
OQ-02 Operation path format and routing scope resolved /{service}/{op} is the correct design; remote dispatch is a separate layer
OQ-03 Batch operation semantics resolved Correlated call.requested events is the correct protocol design
OQ-04 Session-scoped operation registries resolved Agent-written operations overlaid on curated registry via OperationEnv trait layering. Protocol doesn't need changes; OperationEnv must remain a trait. Generalized by ADR-019 to cover connection-scoped overlays.
OQ-09 Safe vault operations for call protocol exposure resolved (ADR-010) None exposed for now
OQ-10 Remote-safe marking shape dissolved (ADR-024) remote_safe/trusted_peer retired; peer authorization is AccessControl::check(peer_identity)
OQ-11 OperationAdapter error type (AdapterError variants) resolved DiscoveryFailed, SchemaParse, Transport, Unauthorized, SamePeerCollision; #[non_exhaustive]
OQ-12 from_call re-import trigger resolved from_call is a manual free function; the assembly layer calls it after the dial (in the composition layer's dial helper, AlknetClient — today the alknet glue; OQ-43). refresh() is a genuine feature addition. See ADR-028.
OQ-13 from_call namespace collision resolved Same-peer collision = error; cross-peer dissolved by ADR-024 (separate sub-overlays)
OQ-14 CallClient TLS client-auth resolved Wire quinn client-auth; key-type-aware server cert verification; fingerprint normalization
OQ-15 PeerRef::Any routing policy resolved Insertion-order first-match; richer routing is a feature extension
OQ-16 services/list-peers re-export semantics resolved Opt-in services/list-peers; services/list is "own ops only"
OQ-17 Multi-hop federation deferred(scope) (feature extension) One-hop model is the commitment; multi-hop is a feature extension, not a deferral
OQ-18 PeerId — crypto identity vs stable logical id resolved (ADR-025) PeerId = Identity.id = PeerEntry.peer_id (stable across key rotation)
OQ-19 Persistent peer registry resolved (ADR-025; persistence adapters are composition-layer work — OQ-43) Core trait + in-memory default; persistence adapters are separate crates
OQ-20 API key asymmetry dissolved PeerEntry supports multiple credential paths; ApiKeyEntry is for tokens that ARE the identity
OQ-21 X.509 outgoing-only case resolved (ADR-054; provenance: alknet ADR-034, not ported) Three remote roles (public X.509 endpoint, transport relay, hub); PeerEntry asymmetry correct; verifier by PeerEntry presence — re-owned in-crate by ADR-054

Key Design Principles

  1. One connection, full access: An alk/call connection gives access to the entire operation registry — calls, subscriptions, batch, schema.
  2. Protocol is symmetric: Both sides can initiate calls. The server calling a client uses the same EventEnvelope format and correlation.
  3. Stream-agnostic correlation: PendingRequestMap correlates by request ID, not by stream. The protocol works with any stream arrangement.
  4. Operation registry is layered: The curated layer (Local provenance) is static — registered at startup by the CLI binary, immutable for the process lifetime. Session (Session) and imported (FromCall etc.) ops are dynamic overlays at their respective scopes (per-session, per-connection). The registry supports JSON Schema discovery. See ADR-019.
  5. Hand-rolled dispatch (no irpc): Operations dispatch through the hand-rolled OperationRegistry (ADR-014). The call protocol is the external interface; internal handler dispatch uses Handler/StreamingHandler trait objects (ADR-021), not an irpc service.
  6. Local dispatch only: The operation registry dispatches to local handlers. Remote dispatch (federation, head/worker routing) would be a separate mechanism at a different layer, not a modification to alkcall's path format.
  7. No secret material on the wire: The call protocol carries no private keys, API keys, mnemonics, or decrypted credentials. Handlers receive outbound credentials through OperationContext.capabilities, injected at the assembly layer. See ADR-010.
  8. Abort cascades to descendants: call.aborted for a parent request cascades to all non-terminal descendants. Default abort-dependents; continue-running opt-in. See ADR-020.
  9. Internal calls switch authority context, not skip ACL: The internal flag marks composition-originated calls. ACL runs against the handler's composition authority, not the caller's and not as a blanket skip. Operations have External/Internal visibility. Scoped composition env bounds reachability. See ADR-017, ADR-018.
  10. Provenance determines composition capability: Only Local and Session ops can compose. Leaves (FromOpenAPI, FromMCP, FromCall, FromJsonSchema) are forwarding stubs — they don't get composition authority or a scoped env. The assembly layer is the sole grantor of composition authority. See ADR-018. (FromJsonSchema is now a real HTTP-forwarding leaf per ADR-027, not a schema-only placeholder.)
  11. Connection direction is independent of call direction: Who opens the connection is a connection-layer concern, not a protocol-layer concern. Both sides can call each other once connected. The CallAdapter accepts connections; the CallClient takes them over (spawn_dispatch primary; dial in AlknetClient per ADR-045); both produce the same CallConnection and dispatch through the same loop. See ADR-022, client-and-adapters.md.
  12. Peer authorization via AccessControl: A remote peer's call is authorized by AccessControl::check(peer_identity) against the op's AccessControl — the same mechanism that gates every other call. No remote_safe flag, no trusted_peer bypass. An op with AccessControl::default() is callable by any peer; an op with required_scopes is callable only by peers whose Identity.scopes satisfy them; an op with Visibility::Internal is never callable from the wire. See ADR-024.
  13. Adapter trait lives with the types; implementations live with their transport: OperationAdapter is in alkcall; from_call is in alkcall (QUIC); from_jsonschema/from_openapi/from_mcp/to_openapi/to_mcp are in the HTTP host crate, alkhttp (reqwest / axum). alkcall stays lean — no HTTP client, no HTTP server. (from_jsonschema was originally in the call protocol as a schema-only placeholder; ADR-027 moved it to alkhttp — then named alknet-http — as a real HTTP-backed adapter.) See client-and-adapters.md.
  14. No handler reads outbound credentials from any source other than OperationContext.capabilities (no-env-vars invariant): the credential injection path is vault → assembly layer → Capabilities → HandlerRegistration.capabilities → OperationContext.capabilities → handler. Downstream consumers' std::env::var reads are unreachable because the assembly layer never calls Default::default(). See ADR-010, client-and-adapters.md.