mirror of
https://github.com/Permissionless-Software-Foundation/psf-memo-indexer.git
synced 2026-09-21 16:52:02 -07:00
1.4 KiB
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
- Overview — Why these services exist and what they produce
- Architecture — Components, processes, Clean Architecture layout, data flow
- Theory of operation — IBD, ZMQ, parsing, indexing pipeline step-by-step
- psf-memo-db — Database service design and REST contract
- Design decisions and tradeoffs — Comparisons to SLP and the Go indexer, scope limits, future work
Related material
- Production deployment: production/docker
- SLP analogue: psf-slp-indexer-g2 and psf-slp-db
- Clean Architecture primer: Chris Troutner — Clean Architecture