Expand description
Stable, versioned contracts shared by Rill Runtime and its hosts.
§IPC API versions
| Version | Introduced in | Changes |
|---|---|---|
| 1 | 0.5.0 | Original handshake, health, invoke |
| 2 | 0.7.0 | Handshake response gains handler identity and effective capabilities |
The runtime accepts both v1 and v2 requests. v1 clients receive
RuntimeResponse (no handler fields). v2 clients receive
RuntimeResponseV2 (with handler identity). The two wire schemas are
independently frozen with fixture tests.
Modules§
- error_
code - Stable IPC error code constants.
- v3
- Preview IPC v3 types. This module is independent from the frozen v1/v2 request and response types below. Preview Runtime IPC v3.
Structs§
- Handler
Pack Manifest - Model
Pack Manifest - Release
Artifact - Release
Index Payload - Signed
Release Index - Signed
Release Index With Generation V1 - A signed v3 index plus a monotonic generation used for rollback protection.
- Trust
KeyMetadata V1 - A trusted publisher key and its lifecycle state.
- Trust
Metadata V1 - External trust metadata for publisher key rotation.
- Trust
Verification Floor V1 - Monotonic state persisted by a consumer that opts into trust-metadata lifecycle verification.
Enums§
- Release
Artifact Kind - Runtime
Request - Runtime
Response - Runtime
Response V2 - Trust
KeyRole - Rotation role for a trusted publisher key.
Constants§
- HANDLER_
API_ VERSION - Handler ABI version (independent of IPC API version).
- HANDLER_
PACKAGE_ FORMAT_ VERSION - Signed handler-pack container version.
- MAX_
MESSAGE_ BYTES - Hard upper bound for one newline-delimited IPC message.
- MIN_
RUNTIME_ API_ VERSION - Minimum IPC API version the runtime still accepts.
- MODEL_
PACK_ FORMAT_ VERSION - Signed model-pack container version.
- PM_
ADAPTER_ ARTIFACT_ ID - Stable artifact id for the OpenWrt Performance Manager decision
adapter. The adapter is a distinct artifact kind (
pm-adapter) because it speaks the independentpm-rill-shadowv1 protocol, not the Rill Runtime IPC API. - PM_
ADAPTER_ PROTOCOL_ VERSION pm-rill-shadowprotocol version advertised by released adapter binaries and required bypm-adapterindex entries.- RELEASE_
INDEX_ LIFECYCLE_ SCHEMA_ VERSION - Version of the signed release-generation envelope used with trust metadata.
- RELEASE_
INDEX_ SCHEMA_ VERSION - Signed release-index schema understood by independent updaters.
- RUNTIME_
API_ VERSION - Latest IPC API version supported by this crate.
- RUNTIME_
ARTIFACT_ ID - Stable artifact id for the GNU (default) runtime build.
- RUNTIME_
ARTIFACT_ ID_ MUSL - Stable artifact id for the musl runtime build. The libc variant is part of the stable asset identity so gnu and musl builds of the same OS+arch do not collide in a v2 release index.
- RUNTIME_
STATE_ FORMAT_ VERSION - Persisted host/runtime state envelope version.
- TRUST_
METADATA_ SCHEMA_ VERSION - Version of the external trust metadata used for key rotation and rollback protection. This is deliberately separate from the frozen release-index v3 payload, so existing v1.2 readers keep their exact fail-closed semantics.