@substratumcloud/lexicons

Canonical AT Protocol lexicons for the Substratum private storage network.

Overview

This package contains the machine-readable schemas (lexicons) used by Substratum for identity-gated, content-addressed storage. It includes definitions for:

• Passports: Cryptographic bindings between asset CIDs and owners/ACLs.
• Filesystem: AT Protocol repo records that index files and folders in a Substratum Drive.
• Metadata: Standardized Digital Asset Passport (DAP) fields for provenance and copyright.

Installation

npm install @substratumcloud/lexicons

Usage

TypeScript Types

Generated types are available for all lexicon definitions:

import { Receipt, DriveEntry } from '@substratumcloud/lexicons';

const myReceipt: Receipt.Main = {
  version: '1.0.0',
  assetCid: 'bafy...',
  ownerDid: 'did:plc:...',
  timestamp: new Date().toISOString(),
  provenanceSignature: '...',
  acl: []
};

Lexicon Definitions

The raw JSON definitions are located in the defs/ directory of the package.

Development

Generate Types

To regenerate TypeScript types from the JSON lexicons:

npm run generate

Build

npm run build

License

MIT OR Apache-2.0