Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.99 KB

File metadata and controls

41 lines (29 loc) · 1.99 KB

File System Interface (Layer 1)

A high-level abstraction over Layer 0's raw blob storage: drives, directories, files. Users don't interact with buckets, agreements, or providers directly — those are managed by the file-system layer.

Documents

Document Audience
ARCHITECTURE.md Encoding, security, encryption, chain integration
USER_GUIDE.md Drive/file/directory operations, configuration
ADMIN_GUIDE.md System management, provider operations, dispute handling
API_REFERENCE.md Extrinsics, SDK methods, primitives, events, errors

Getting started

Three terminals (full setup in LAYER1_QUICKSTART.md):

just start-chain        # Terminal 1
just start-provider     # Terminal 2
just fs-demo-ci         # Terminal 3 — integration example, requires the above

Or for the basic SDK example:

cargo run -p file-system-client --example basic_usage

Components

  • Drive Registry pallet (storage-interfaces/file-system/pallet-registry/) — on-chain drive metadata, owner mapping, root CID slot.
  • File-system primitives (storage-interfaces/file-system/primitives/) — shared types: DriveInfo, DirectoryNode, FileManifest, CommitStrategy.
  • File-system client SDK (storage-interfaces/file-system/client/) — Rust client. Real chain queries via subxt; file operations via the provider's /fs/{bucket}/... HTTP endpoints.
  • TypeScript SDK (user-interfaces/sdk/typescript/file-system/) — equivalent in TS, used by the drive-ui frontend.

Related