Files
psf-memo-indexer/dev-docs/README.md
2026-06-02 16:54:13 -07:00

1.4 KiB

Memo Indexer Developer Documentation

This directory documents the architecture, operation, and design rationale for the Permissionless Software Foundation Memo indexing stack:

Repository Role
psf-memo-db LevelDB persistence exposed as a REST API
psf-memo-indexer Block and mempool indexer (this repo)

Protocol reference: memo-protocol.md. Reference implementation: memo/index (Go).

Reading order

  1. Overview — Why these services exist and what they produce
  2. Architecture — Components, processes, Clean Architecture layout, data flow
  3. Theory of operation — IBD, ZMQ, parsing, indexing pipeline step-by-step
  4. psf-memo-db — Database service design and REST contract
  5. Design decisions and tradeoffs — Comparisons to SLP and the Go indexer, scope limits, future work