verae-archive-worm/README.md

34 lines
1.1 KiB
Markdown

# verae-archive-worm
Bloom-filtered append-only WORM node. Stores metadata and files **off chain**. A bloom **miss is silence** (no NATS reply).
**Forgejo:** https://git.georgelambert.org/marchon/verae-archive-worm
**Catalog:** https://zapier.georgelambert.org/packages/verae-archive-worm/README.pdf
**NATS:** https://zapier.georgelambert.org/docs-master/modules/verae-archive-worm/NATS.pdf
## Run
```bash
cd packages/verae-archive-worm
npm test
```
Fleet keeps **min 3** copies (`keepFloor`). Pause does not count as available.
## Addresses
| Subject | Role |
|---------|------|
| `verae.archive.put` | Append `{ sha256, kind, record }` and add the hash to the bloom |
| `verae.archive.query` | Broadcast (no queue group). Hit → `verae.archive.reply.<correlationId>` |
| miss | **no message** |
Kinds: `publicMeta`, `privateMeta`, `file`. Tree leaves live on **verae-tree-node** (`kind=tree`).
## Depends on
- NATS JetStream reachable on the **private** URL (`NATS_URL`)
- archive-aggregator (query fan-out / merge)
- fleet replica floor
Does not talk to Zapier or the chain.