Public-Library Quickstart

Start an Auto Drive integration using the verified public npm adapter.

This draft deliberately stops at the verified public library boundary. It does not require a command-line wallet, private repository, unpublished package, or internal endpoint.

1

Prepare a server-side project

Use Node.js 26 for the current public storage package. Keep provider credentials in a protected server or operator environment; never bundle them into browser code.

2

Install the public adapter

npm install @xyo-network/archivist-s3@8.0.0

Pin the version in deployed applications and review the release before upgrading.

3

Import the published entry point

import {
  createAutoDriveArchivist,
  createAutoDriveS3Client,
} from '@xyo-network/archivist-s3/auto-drive'

The documentation checks install this exact public package and confirm both exports are available.

4

Add application safeguards

Before accepting data, enforce an allowlisted schema, a strict UTF-8 byte limit, authentication and authorization, request-rate limits, and an operation timeout. Treat every retrieved payload as untrusted input.

5

Verify a complete round trip

Write one bounded test payload, retrieve it through a fresh request, recompute its identity, and compare the exact canonical bytes. A successful write response alone is not proof that the intended content can be retrieved.

The current storage package uses the 8.x protocol SDK. Do not combine it with the current XL1 SDK's 7.4.x peer line in one runtime until an officially supported compatibility release is available.