Arxi Docs

Proof recording and tamper-evident evidence documentation.

Other product docs

Download: glossary.md (12 KB)

Arxi Glossary

Short, canonical definitions for Arxi contract terms.

actor_id

Category: schema_field

actor_id binds the event to its declarative producer identity, enabling provenance-aware query and audit workflows.

Related Terms: environment_id, event_type

attachment_hashes

Category: verification

attachment_hashes records expected attachment digests used to verify attachment byte integrity in bundle verification.

Related Terms: attachment_refs, manifest

attachment_refs

Category: schema_field

attachment_refs contain content type, hash, and size metadata for each attachment included with an envelope.

Related Terms: attachment_hashes, content_hash

Bundle

Category: core

A bundle is the deterministic export format used for offline verification, including segments, envelopes, attachment bytes, and a verification manifest.

Related Terms: attachment_hashes, bundle_selector, verification_manifest

Examples:

  • examples/bundle.json#: Self-contained bundle used for contract validation.

Bundle Selector

Category: core

The selector captures which evidence subset is exported into a bundle. The canonical sample uses BySegment for stable reproductions.

Related Terms: bundle, segment

chain_hash

Category: integrity_field

chain_hash links each envelope to prior chain state, providing tamper evidence for append ordering and continuity.

Related Terms: content_hash, segment

claimed_time

Category: schema_field

claimed_time is operator-provided event time captured as structured UTC components in canonical envelope encoding.

Related Terms: event_type, sequence

content_hash

Category: integrity_field

content_hash is computed from canonical envelope body bytes and is used for payload and attachment integrity tracking.

Related Terms: chain_hash, envelope

contract_version

Category: projection

contract_version marks the compatibility surface for generated artifacts and is included in index and tooltip contract files.

Related Terms: index_manifest, tooltips_catalog

emit_envelope

Category: contract_method

RecorderAdapter method emit_envelope. Request shape: UnsealedEnvelope. Response shape: EnvelopeReceipt. This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: recorder_adapter

emit_with_attachments

Category: contract_method

RecorderAdapter method emit_with_attachments. Request shape: UnsealedEnvelope + Vec<AttachmentData>. Response shape: EnvelopeReceipt. This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: recorder_adapter

Envelope

Category: core

An envelope is the canonical append-only evidence unit containing identity fields, payload, attachment references, and integrity hashes.

Related Terms: chain_hash, content_hash, segment, signature

Examples:

  • examples/envelope.json#: Canonical envelope example emitted by arxi-contract.

id (envelope)

Category: schema_field

Envelope IDs provide immutable references for chain membership, parent links, and verification manifests.

Related Terms: segment_id, trace_id

environment_id

Category: schema_field

environment_id identifies the execution environment where the event occurred and supports environment-scoped filtering.

Related Terms: actor_id, trace_id

event_type

Category: schema_field

event_type captures deterministic event taxonomy used for filtering and downstream policy evaluation.

Related Terms: payload, trace_id

EvidenceProvider

Category: contract_type

EvidenceProvider defines deterministic query and bundle retrieval surfaces consumed by control planes such as Decision Gate.

Related Terms: fetch_bundle, list_bundles, query_envelopes, verify_bundle

fetch_bundle

Category: contract_method

EvidenceProvider method fetch_bundle. Request shape: BundleId. Response shape: Bundle. This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: evidence_provider

flush

Category: contract_method

RecorderAdapter method flush. Request shape: (). Response shape: (). This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: recorder_adapter

glossary.md

Category: projection

glossary.md is generated from the canonical tooltip catalog to keep long-form term explanations aligned with machine-readable tooltip metadata.

Related Terms: tooltips_catalog

hash_algorithm_id

Category: integrity_field

hash_algorithm_id marks the algorithm used for segment and manifest hashing so verification can use deterministic hash semantics.

Related Terms: chain_hash, content_hash

health

Category: contract_method

RecorderAdapter method health. Request shape: (). Response shape: AdapterHealth. This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: recorder_adapter

index.json

Category: projection

index.json inventories generated artifacts and per-file hashes. Downstream projections must verify artifact bytes against this manifest before publish.

Related Terms: contract_version, glossary_markdown, tooltips_catalog

key_id

Category: security

key_id links an envelope signature to trust-root public key material during verification phase checks.

Related Terms: signature, trust_root

list_bundles

Category: contract_method

EvidenceProvider method list_bundles. Request shape: BundleFilter. Response shape: Vec<BundleMetadata>. This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: evidence_provider

manifest

Category: verification

The manifest lists segment summaries, attachment hashes, and omission metadata used to verify exported bundles offline.

Related Terms: attachment_hashes, verification_manifest

omitted_parents

Category: verification

omitted_parents captures explicit parent omissions in partial exports so verifiers can distinguish expected gaps from integrity defects.

Related Terms: manifest, proof_anchor

parent_id

Category: schema_field

parent_id captures parent-child relationships between envelopes when higher-level workflows need explicit hierarchy.

Related Terms: envelope_id, trace_id

payload

Category: schema_field

payload carries the event-specific JSON object and is covered by content hashing and signature policies.

Related Terms: content_hash, event_type

Examples:

  • examples/envelope.json#/payload: Minimal payload shape used by the generated contract fixture.

predecessor_chain_head

Category: integrity_field

predecessor_chain_head records prior segment chain state needed to validate cross-segment linkage during verification.

Related Terms: chain_hash, predecessor_id

predecessor_id

Category: integrity_field

predecessor_id links a segment to the prior segment in cross-segment continuity chains when present.

Related Terms: predecessor_chain_head, segment

Proof Anchor

Category: verification

A proof anchor captures chain state before the first included envelope in a partial segment to preserve deterministic subsequence integrity checks.

Related Terms: bundle, segment, verification_manifest

query_envelopes

Category: contract_method

EvidenceProvider method query_envelopes. Request shape: EnvelopeFilter. Response shape: Vec<Envelope>. This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: evidence_provider

RecorderAdapter

Category: contract_type

RecorderAdapter is the ingest boundary used by integrations to emit unsealed events and attachment payloads into the canonical recorder flow.

Related Terms: emit_envelope, emit_with_attachments, health

recorder_id

Category: runtime

recorder_id marks which recorder runtime emitted the segment genesis and supports multi-recorder provenance analysis.

Related Terms: segment_genesis, segment_id

schema_version

Category: schema_field

schema_version carries model versioning metadata for envelope and segment records to enforce deterministic compatibility checks.

Related Terms: contract_version, index_manifest

Segment

Category: core

A segment groups envelopes into an ordered append-only partition anchored by SegmentGenesis and optionally closed by a seal envelope.

Related Terms: bundle, proof_anchor, segment_genesis

Examples:

  • examples/segment.json#: Segment genesis metadata used by the bundle example.

SegmentGenesis

Category: verification

SegmentGenesis records the segment identity, predecessor linkage, hash algorithm, recorder ID, and schema version used at segment creation.

Related Terms: predecessor_chain_head, predecessor_id, recorder_id, segment

segment_id

Category: schema_field

segment_id ties envelopes, segment genesis records, selectors, and manifest segment rows together under one append-only partition identity.

Related Terms: envelope_id, segment

sequence

Category: integrity_field

sequence encodes append ordering for envelopes within a segment and participates in continuity checks.

Related Terms: chain_hash, segment

session_id

Category: schema_field

session_id captures session-scoped continuity when evidence needs to be grouped by interactive or runtime session boundaries.

Related Terms: actor_id, trace_id

signature

Category: security

signature stores key ID, algorithm, and signature bytes for authenticity checks under verifier trust-root policy.

Related Terms: key_id, signature_algorithm, trust_root

algorithm (signature)

Category: security

The signature algorithm marker identifies how signature bytes should be verified against trust-root key material.

Related Terms: key_id, signature

tooltips.annotations.json

Category: projection

tooltips.annotations.json maps schema pointers and term keys to catalog entries so UI code blocks and JSON examples can resolve hover tooltips consistently.

Related Terms: tooltips_catalog

tooltips.catalog.json

Category: projection

tooltips.catalog.json is the machine-readable world-class term catalog with categories, references, related terms, and example bindings.

Related Terms: glossary_markdown, tooltips_annotations

trace_id

Category: schema_field

trace_id provides deterministic cross-envelope correlation for query and bundle selection workflows.

Related Terms: actor_id, event_type

Trust Root

Category: security

The trust root maps key IDs to public keys and defines signature policy semantics enforced during verifier signature checks.

Related Terms: key_id, signature, signature_algorithm

Verification Manifest

Category: verification

The verification manifest records declared segment chain heads, attachment hashes, and omission metadata used by offline verifier phases.

Related Terms: attachment_hashes, bundle, omitted_parents

Examples:

  • examples/bundle.json#/manifest: Manifest object in the generated bundle example.

verify_bundle

Category: contract_method

EvidenceProvider method verify_bundle. Request shape: Bundle. Response shape: VerificationVerdict. This method is part of the canonical generated contract and is consumed by downstream tooling and docs projections.

Related Terms: evidence_provider