# Cauldron

Backup of the **Cauldron** documentation site — a decentralized exchange on
Bitcoin Cash built by **Riften Labs**: liquidity pools, on-chain token
swapping, oracle integration, and yield primitives.

## Authorship

Cauldron is the work of **Riften Labs**. This repo on Hephaestus is a
snapshot for continuity — the canonical source of truth is:

- Website / docs: <https://docs.riftenlabs.com/cauldron/>
- API reference:  <https://docs.riftenlabs.com/cauldron/API/>
- Group:          <https://gitlab.com/riftenlabs/>

If you're evaluating Cauldron, always cross-check the canonical docs above.

## What's in this repo

- `docs/cauldron/`      — snapshot of every page under docs.riftenlabs.com/cauldron/
  (28 pages: whitepaper, liquidity, swap, yield, wallets, developer resources,
  knowledge base, plus the API section and its sub-endpoints)
- `assets/`, `javascripts/`, `stylesheets/` — supporting CSS/JS so the offline
  copy renders (Material for MkDocs bundle)

Every `docs/**/index.html` is the exact HTML served by the site at snapshot
time; open in a browser (or `npx serve .`) to read offline.

## Related on Hephaestus

- [silentmode/riftenlabs-indexer](../riftenlabs-indexer) — the AGPL backend
  that serves the Cauldron API (full source mirror from GitLab)
- [silentmode/WizardConnect](../WizardConnect) — dapp↔wallet transport used
  by Cauldron-compatible wallets (LGPL source mirror)
- [silentmode/jedex](../jedex) — bitjson's CashTokens DEX demonstration
  (adjacent design)

## Refreshing this snapshot

The snapshot script is trivial — fetch `sitemap.xml`, grep for `/cauldron/`,
and curl each URL:

```bash
curl -s https://docs.riftenlabs.com/sitemap.xml \
  | grep -oE '<loc>[^<]+cauldron[^<]*</loc>' \
  | sed 's|<[^>]*>||g' \
  | while read url; do
      path="${url#https://docs.riftenlabs.com/}"
      mkdir -p "docs/${path%/}"
      curl -s -o "docs/${path%/}/index.html" "$url"
    done
```

Rerun and commit if you want a fresher backup.