For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integration Guide

Design a bounded and verifiable Auto Drive integration using public libraries.

Use this sequence when adapting the public Auto Drive adapter to an application.

1

Validate the request

Authenticate the caller, authorize the operation, allowlist the payload schema, and enforce strict byte, field, and nesting limits. Reject unexpected content before making a provider or wallet request.

2

Create one canonical payload

Choose exactly which fields define payload identity. Serialize them deterministically and compute the identity once. Do not normalize or mutate the payload after approval.

3

Store with bounded resources

Use the public @xyo-network/archivist-s3/auto-drive entry point from a protected server environment. Apply a deadline, cancellation signal, bounded concurrency, rate limits, and per-principal quotas.

4

Read and verify

Perform a fresh retrieval by the expected identity. Reapply size and schema checks, recompute the identity, and compare canonical bytes. Never render retrieved content as HTML or pass it to a shell, template engine, or dynamic evaluator.

5

Anchor only compatible evidence

Submit an XL1 reference only through a supported public-library combination. Confirm the signer, account, network, recipient, fees, payload identity, and complete transaction intent before approval.

6

Observe finality independently

Use the typed XL1 SDK to observe finalized inclusion. Keep provider retrieval, transaction acceptance, finality, and archival as distinct results.

Operational requirements

  • Make writes idempotent where the provider contract supports it.

  • Do not automatically retry an ambiguous upload or transaction submission.

  • Limit recovery lookups by identity, caller, rate, and time window.

  • Escape or encode untrusted values before displaying them.

  • Record non-secret evidence sufficient to investigate an interrupted operation.

Last updated