snapshot: docs.riftenlabs.com/cauldron/ (28 pages) - author: Riften Labs

Backup of Cauldron docs at snapshot time. Canonical source of truth:
  https://docs.riftenlabs.com/cauldron/

Includes: whitepaper, liquidity/swap/yield/wallets, developer resources,
knowledge base, and the full API section (bcmr, broadcast, cauldron,
contract-subscribe, ido, moria_v11, oracle, root, tokenbch, tokentoken).
Supporting CSS/JS bundle preserved so pages render offline.
This commit is contained in:
bch_qp3hvzy09lzcm46qm4cd 2026-09-02 04:05:04 +02:00
commit 66e0acc0be
34 changed files with 94210 additions and 0 deletions

54
README.md Normal file
View file

@ -0,0 +1,54 @@
# 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.

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

3228
docs/cauldron/API/index.html Normal file

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

3165
docs/cauldron/index.html Normal file

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

19
javascripts/mathjax.js Normal file
View file

@ -0,0 +1,19 @@
window.MathJax = {
tex: {
inlineMath: [["\\(", "\\)"]],
displayMath: [["\\[", "\\]"]],
processEscapes: true,
processEnvironments: true
},
options: {
ignoreHtmlClass: ".*|",
processHtmlClass: "arithmatex"
}
};
document$.subscribe(() => {
MathJax.startup.output.clearCache()
MathJax.typesetClear()
MathJax.texReset()
MathJax.typesetPromise()
})

44
stylesheets/custom.css Normal file
View file

@ -0,0 +1,44 @@
/* Custom Styles */
a, .md-nav__item--active > .md-nav__link {
color: rgb(16, 185, 129) !important;
}
a:hover {
color: #80172B !important;
}
label:hover {
color: #9D9FA5 !important;
}
.md-header {
background-color: rgb(16, 185, 129) !important;
}
@media screen and (max-width: 76.1875em) {
.md-nav--primary .md-nav__source, .md-nav--primary .md-nav__title {
background-color: rgb(16, 185, 129) !important;
}
}
.md-source__icon, .md-source__repository {
color: #fff;
}
footer .md-ellipsis, .md-footer-nav__button {
color: #fff;
}
.md-footer-copyright {
display: none;
}
.md-typeset__table {
overflow-wrap: anywhere;
}
.md-typeset__table code {
white-space: nowrap;
}