Arxi Docs

Proof recording and tamper-evident evidence documentation.

Other product docs

Contracts

Canonical Arxi trait contracts generated from arxi-contract.

Download: contracts/adapter.json (442 B) Download: contracts/provider.json (372 B)

RecorderAdapter

Trait: RecorderAdapter

MethodRequestResponse
emit_envelopeUnsealedEnvelopeEnvelopeReceipt
emit_with_attachmentsUnsealedEnvelope + Vec<AttachmentData>EnvelopeReceipt
flush()()
health()AdapterHealth

adapter.json

{
  "contract_version": "1.0.0",
  "key_status_variants": [
    "Available",
    "NotConfigured",
    "Expired",
    "Rotated"
  ],
  "methods": [
    {
      "name": "emit_envelope",
      "request": "UnsealedEnvelope",
      "response": "EnvelopeReceipt"
    },
    {
      "name": "emit_with_attachments",
      "request": "UnsealedEnvelope + Vec<AttachmentData>",
      "response": "EnvelopeReceipt"
    },
    {
      "name": "flush",
      "request": "()",
      "response": "()"
    },
    {
      "name": "health",
      "request": "()",
      "response": "AdapterHealth"
    }
  ],
  "trait": "RecorderAdapter"
}

EvidenceProvider

Trait: EvidenceProvider

MethodRequestResponse
list_bundlesBundleFilterVec<BundleMetadata>
fetch_bundleBundleIdBundle
verify_bundleBundleVerificationVerdict
query_envelopesEnvelopeFilterVec<Envelope>

provider.json

{
  "contract_version": "1.0.0",
  "methods": [
    {
      "name": "list_bundles",
      "request": "BundleFilter",
      "response": "Vec<BundleMetadata>"
    },
    {
      "name": "fetch_bundle",
      "request": "BundleId",
      "response": "Bundle"
    },
    {
      "name": "verify_bundle",
      "request": "Bundle",
      "response": "VerificationVerdict"
    },
    {
      "name": "query_envelopes",
      "request": "EnvelopeFilter",
      "response": "Vec<Envelope>"
    }
  ],
  "trait": "EvidenceProvider"
}