@xyo-network/xl1-driver-s3

S3-compatible map driver for XL1 protocol storage (AWS S3, Cloudflare R2, MinIO).

Description

XL1 is the XYO Layer One blockchain protocol. This package provides S3Map, an AsyncIterableMap for any S3-compatible object store — AWS S3, Cloudflare R2, MinIO, and others. It stores each value as JSON under a deterministic object key and can optionally use an in-memory read-through cache.

Use it for durable object-storage-backed maps in Node services and publishers.

This package replaces the deprecated @xyo-network/xl1-driver-cloudflare-r2 package (S3Map was formerly R2Map).

Install

Using npm:

npm i --save @xyo-network/xl1-driver-s3

Using yarn:

yarn add @xyo-network/xl1-driver-s3

Using pnpm:

pnpm add @xyo-network/xl1-driver-s3

Using bun:

bun add @xyo-network/xl1-driver-s3

This package expects an @aws-sdk/client-s3 S3Client configured for your S3-compatible endpoint.

Usage

import { S3Client } from '@aws-sdk/client-s3'
import { S3Map } from '@xyo-network/xl1-driver-s3'

const client = new S3Client({
  region: 'auto',
  endpoint: `https://${accountId}.r2.cloudflarestorage.com`,
  credentials: { accessKeyId, secretAccessKey },
})

const map = await S3Map.create({
  bucket: 'xl1-cache',
  client,
  prefix: 'blocks/',
  getCache: { enabled: true },
})

await map.start()
await map.set('head', { block: 42 })

Documentation

S3Map implements async get, set, has, getMany, setMany, delete, clear, and for await...of iteration over the matching object prefix.

Use @xyo-network/xl1-s3-providers when you need to publish the complete XL1 static REST layout rather than a generic map abstraction.

AI Agent Skills

Install the recommended XL1/XYO skills with Skills.sh:

npx skills add XYOracleNetwork/xyo-skills --all

In XY toolchain repos, the equivalent convenience command is:

pnpm xy skills defaults
pnpm xy skills lint --fix

For XL1 work, ask your agent to use xyo-knowledge, xl1-knowledge, and xl1-patterns. These skills cover XYO primitives, XL1 chain and gateway APIs, and application patterns for XL1 dApps.

Building Locally

pnpm xy build @xyo-network/xl1-driver-s3
pnpm xy test @xyo-network/xl1-driver-s3
pnpm xy lint @xyo-network/xl1-driver-s3

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Credits

Made with 🔥 and ❄️ by XYO Foundation