# Potable v1.0.0 - Table of Contents

Elixir implementation of AT Protocol primitives (CID, TID, MST, DAG-CBOR, CAR).

## Pages

- Getting Started
  - [Potable](readme.md)
  - [Potable Overview](00_overview.md)
  - [Quickstart](01_quickstart.md)

- Core Guides
  - [Data Formats](02_data_formats.md)
  - [Merkle Search Tree (MST)](03_mst.md)
  - [Commits And Signatures](04_commits_and_signatures.md)
  - [Repository Engine](05_repository_engine.md)

- Integration And Ops
  - [Storage Backends](06_storage_backends.md)
  - [Known Limitations](07_known_limitations.md)
  - [Conformance And Interop](08_conformance_and_interop.md)
  - [Sync And Firehose Primitives](09_sync_and_firehose_primitives.md)

## Modules

- [Potable](Potable.md): Potable provides the core building blocks for implementing the AT Protocol

- Repository Engine
  - [Potable.CAR](Potable.CAR.md): CAR v1 (Content Addressable aRchive) export and import.
  - [Potable.Commit](Potable.Commit.md): AT Protocol commit objects -- signed DAG-CBOR structures.
  - [Potable.MST](Potable.MST.md): Merkle Search Tree for AT Protocol repositories.
  - [Potable.Repository](Potable.Repository.md): Pure functional AT Protocol repository engine.
  - [Potable.Signing](Potable.Signing.md): Digital signatures for AT Protocol commit signing.

- Codecs and Addressing
  - [Potable.CID](Potable.CID.md): Content Identifier (CID) handling for AT Protocol.
  - [Potable.DagCbor](Potable.DagCbor.md): DAG-CBOR encoding with IPLD deterministic constraints.
  - [Potable.TID](Potable.TID.md): Timestamp Identifier (TID) generation and validation for AT Protocol.
  - [Potable.Varint](Potable.Varint.md): Variable-length integer encoding/decoding.

- Storage
  - [Potable.Blob](Potable.Blob.md): Blob (binary large object) handling for AT Protocol.
Represents files like images, videos, and other binary content.
  - [Potable.Blob.MemoryStorage](Potable.Blob.MemoryStorage.md): In-memory blob storage for testing.

  - [Potable.Blob.Storage](Potable.Blob.Storage.md): Behaviour for blob storage backends.

  - [Potable.BlockStore](Potable.BlockStore.md): Content-addressed block storage behaviour for AT Protocol repositories.
  - [Potable.BlockStore.Memory](Potable.BlockStore.Memory.md): In-memory block store using ETS. For development and testing.
  - [Potable.EventLog](Potable.EventLog.md): Behaviour for durable, cursorable commit event logs.
  - [Potable.EventLog.Memory](Potable.EventLog.Memory.md): In-memory `Potable.EventLog` implementation for tests/dev harnesses.

- Sync and Firehose
  - [Potable.Sync.CAR](Potable.Sync.CAR.md): CAR utilities for sync/firehose commit envelopes.
  - [Potable.Sync.CommitEnvelope](Potable.Sync.CommitEnvelope.md): Canonical commit envelope for firehose/event-log interoperability.
  - [Potable.Sync.Cursors](Potable.Sync.Cursors.md): Cursor helpers for firehose/event-log replay.

- Identifiers and Records
  - [Potable.AtUri](Potable.AtUri.md): Parsing, validation, and inspection of AT URIs (`at://`).
  - [Potable.DID](Potable.DID.md): Decentralized Identifier (DID) parsing and validation.
  - [Potable.Handle](Potable.Handle.md): Handle format validation for AT Protocol.
  - [Potable.Identity.Resolver](Potable.Identity.Resolver.md): Behaviour for resolving commit verification keys from identity state.
  - [Potable.Identity.StaticResolver](Potable.Identity.StaticResolver.md): Static in-memory resolver for verifier policy.
  - [Potable.NSID](Potable.NSID.md): NSID (Namespaced Identifier) parsing and validation for AT Protocol.
  - [Potable.Record](Potable.Record.md): AT Protocol record data structure.
Records have a type (NSID) and data fields.

- Exceptions
  - [Potable.AtUri.ParseError](Potable.AtUri.ParseError.md)
  - [Potable.CID.ParseError](Potable.CID.ParseError.md)
  - [Potable.DID.ParseError](Potable.DID.ParseError.md)
  - [Potable.NSID.ParseError](Potable.NSID.ParseError.md)