BitcoinCash/Cauldron
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Cauldron/docs/cauldron/developer-resources/index.html
bch_qp3hvzy09lzcm46qm4cd 66e0acc0be 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.
2026-09-02 04:05:04 +02:00

3697 lines
No EOL
70 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Documentation for Riften Labs products">
<meta name="author" content="Riften Labs">
<link rel="canonical" href="https://docs.riftenlabs.com/cauldron/developer-resources/">
<link rel="prev" href="../claim/">
<link rel="next" href="../liquidity/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
<title>Developer Resources - Riften Labs Documentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.ec1eaa64.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../stylesheets/custom.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#developer-resources" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Riften Labs Documentation" class="md-header__button md-logo" aria-label="Riften Labs Documentation" data-md-component="logo">
<img src="https://static.wixstatic.com/media/ae85be_a9f280427dbf44b7bcc1a4bfb232c96f~mv2.png/v1/fill/w_30,h_30,al_c,q_85,usm_0.66_1.00_0.01,enc_auto/Riften_Labs_Logo_Transparent_edited.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Riften Labs Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Developer Resources
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Riften Labs Documentation" class="md-nav__button md-logo" aria-label="Riften Labs Documentation" data-md-component="logo">
<img src="https://static.wixstatic.com/media/ae85be_a9f280427dbf44b7bcc1a4bfb232c96f~mv2.png/v1/fill/w_30,h_30,al_c,q_85,usm_0.66_1.00_0.01,enc_auto/Riften_Labs_Logo_Transparent_edited.png" alt="logo">
</a>
Riften Labs Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Riften Labs Documentation
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
RiftenLabs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
RiftenLabs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../RiftenLabs/contributor-agreement/" class="md-nav__link">
<span class="md-ellipsis">
Riften Labs Contributor Agreement
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../RiftenLabs/media/" class="md-nav__link">
<span class="md-ellipsis">
Media
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../RiftenLabs/mediapack/" class="md-nav__link">
<span class="md-ellipsis">
Media Pack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../RiftenLabs/opensource/" class="md-nav__link">
<span class="md-ellipsis">
Open Source
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Cauldron
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Cauldron
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Cauldron DEX
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../aapy/" class="md-nav__link">
<span class="md-ellipsis">
Aggregated APY (AAPY)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../claim/" class="md-nav__link">
<span class="md-ellipsis">
Token Verification &amp; Token Claim
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Developer Resources
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Developer Resources
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#cashlab" class="md-nav__link">
<span class="md-ellipsis">
CashLab
</span>
</a>
<nav class="md-nav" aria-label="CashLab">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#key-concepts" class="md-nav__link">
<span class="md-ellipsis">
Key Concepts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-constructing-a-trade" class="md-nav__link">
<span class="md-ellipsis">
Example: Constructing a Trade
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#vegabch-cli" class="md-nav__link">
<span class="md-ellipsis">
VegaBCH CLI
</span>
</a>
<nav class="md-nav" aria-label="VegaBCH CLI">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#installation_1" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#trading-with-vegabch" class="md-nav__link">
<span class="md-ellipsis">
Trading with VegaBCH
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#wallet-setup" class="md-nav__link">
<span class="md-ellipsis">
Wallet Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cauldron-command-reference" class="md-nav__link">
<span class="md-ellipsis">
Cauldron Command Reference
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#bchcockpit" class="md-nav__link">
<span class="md-ellipsis">
BCHCockpit
</span>
</a>
<nav class="md-nav" aria-label="BCHCockpit">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#what-it-does" class="md-nav__link">
<span class="md-ellipsis">
What It Does
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#using-the-hosted-version" class="md-nav__link">
<span class="md-ellipsis">
Using the Hosted Version
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#self-hosting" class="md-nav__link">
<span class="md-ellipsis">
Self-Hosting
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../liquidity/" class="md-nav__link">
<span class="md-ellipsis">
Liquidity Pools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../sock/" class="md-nav__link">
<span class="md-ellipsis">
SOCK
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../swap/" class="md-nav__link">
<span class="md-ellipsis">
Trade / Swap
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../usecases/" class="md-nav__link">
<span class="md-ellipsis">
Other Use Cases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../wallets/" class="md-nav__link">
<span class="md-ellipsis">
Wallets
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../whitepaper/" class="md-nav__link">
<span class="md-ellipsis">
Whitepaper
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../yield/" class="md-nav__link">
<span class="md-ellipsis">
Pool Yield
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_12" >
<label class="md-nav__link" for="__nav_3_12" id="__nav_3_12_label" tabindex="0">
<span class="md-ellipsis">
API
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_12_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_12">
<span class="md-nav__icon md-icon"></span>
API
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../API/" class="md-nav__link">
<span class="md-ellipsis">
Riften Labs Indexer API Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/bcmr/" class="md-nav__link">
<span class="md-ellipsis">
/bcmr Endpoints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/broadcast/" class="md-nav__link">
<span class="md-ellipsis">
Transaction Broadcast API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/cauldron/" class="md-nav__link">
<span class="md-ellipsis">
/cauldron/ Endpoints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/contract-subscribe/" class="md-nav__link">
<span class="md-ellipsis">
Contract subscribe
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/ido/" class="md-nav__link">
<span class="md-ellipsis">
/ido Endpoints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/moria_v11/" class="md-nav__link">
<span class="md-ellipsis">
/moria/v11 Endpoints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/oracle/" class="md-nav__link">
<span class="md-ellipsis">
/oracle Endpoints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/root/" class="md-nav__link">
<span class="md-ellipsis">
/ Endpoints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/tokenbch/" class="md-nav__link">
<span class="md-ellipsis">
/tokenbch Endpoints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../API/tokentoken/" class="md-nav__link">
<span class="md-ellipsis">
/tokentoken Endpoints
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_13" >
<label class="md-nav__link" for="__nav_3_13" id="__nav_3_13_label" tabindex="0">
<span class="md-ellipsis">
Knowledge base
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_13_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_13">
<span class="md-nav__icon md-icon"></span>
Knowledge base
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../knowledge-base/" class="md-nav__link">
<span class="md-ellipsis">
Knowledge Base
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../knowledge-base/hdwallet/" class="md-nav__link">
<span class="md-ellipsis">
HD Wallet &amp; Derivation Paths
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../knowledge-base/pending/" class="md-nav__link">
<span class="md-ellipsis">
Pending Transactions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../knowledge-base/summon/" class="md-nav__link">
<span class="md-ellipsis">
Pool Announcement (SUMMON)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../knowledge-base/token-rating/" class="md-nav__link">
<span class="md-ellipsis">
Token Rating
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../knowledge-base/txordering/" class="md-nav__link">
<span class="md-ellipsis">
Ordering of trades on Cauldron
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Delphi
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Delphi
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../delphi/" class="md-nav__link">
<span class="md-ellipsis">
Delphi Oracle
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Moria
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Moria
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../moria/" class="md-nav__link">
<span class="md-ellipsis">
Moria Protocol
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/borrowing/" class="md-nav__link">
<span class="md-ellipsis">
Borrowing, redeeming and liquidations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/developer-resources/" class="md-nav__link">
<span class="md-ellipsis">
Developer Resources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/general/" class="md-nav__link">
<span class="md-ellipsis">
General
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/roadmap/" class="md-nav__link">
<span class="md-ellipsis">
Roadmap
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_6" >
<label class="md-nav__link" for="__nav_5_6" id="__nav_5_6_label" tabindex="0">
<span class="md-ellipsis">
FAQ
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_6">
<span class="md-nav__icon md-icon"></span>
FAQ
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../moria/FAQ/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/FAQ/liquidation-incentives/" class="md-nav__link">
<span class="md-ellipsis">
Liquidation Incentives
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/FAQ/redeem-bch-balance/" class="md-nav__link">
<span class="md-ellipsis">
Where is my BCH after redeeming?
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7" >
<label class="md-nav__link" for="__nav_5_7" id="__nav_5_7_label" tabindex="0">
<span class="md-ellipsis">
Technical
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_7">
<span class="md-nav__icon md-icon"></span>
Technical
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../moria/technical/bpsoracle/" class="md-nav__link">
<span class="md-ellipsis">
Basis Point Oracle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/technical/delphi-v1/" class="md-nav__link">
<span class="md-ellipsis">
Delphi Oracle (v1)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/technical/deployment/" class="md-nav__link">
<span class="md-ellipsis">
Technical Details
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/technical/wainterest/" class="md-nav__link">
<span class="md-ellipsis">
Weighted Average Interest Rate
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_8" >
<label class="md-nav__link" for="__nav_5_8" id="__nav_5_8_label" tabindex="0">
<span class="md-ellipsis">
V0
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_8">
<span class="md-nav__icon md-icon"></span>
V0
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../moria/v0/" class="md-nav__link">
<span class="md-ellipsis">
Moria v0
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../moria/v0/testrun/" class="md-nav__link">
<span class="md-ellipsis">
Moria Protocol v0 Test Run #1 Overview
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Router
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Router
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../router/" class="md-nav__link">
<span class="md-ellipsis">
Cauldron Router API
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
<label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
<span class="md-ellipsis">
Api
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_2">
<span class="md-nav__icon md-icon"></span>
Api
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../router/api/route.quote/" class="md-nav__link">
<span class="md-ellipsis">
route.quote
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../router/api/route.subscribe/" class="md-nav__link">
<span class="md-ellipsis">
route.subscribe
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../router/api/tx.build/" class="md-nav__link">
<span class="md-ellipsis">
tx.build
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../router/api/tx.subscribe/" class="md-nav__link">
<span class="md-ellipsis">
tx.subscribe
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
<label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
<span class="md-ellipsis">
Protocol
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_3">
<span class="md-nav__icon md-icon"></span>
Protocol
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../router/protocol/errors/" class="md-nav__link">
<span class="md-ellipsis">
Error Codes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../router/protocol/overview/" class="md-nav__link">
<span class="md-ellipsis">
Protocol Overview
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
<label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
<span class="md-ellipsis">
Schemas
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_4">
<span class="md-nav__icon md-icon"></span>
Schemas
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../router/schemas/" class="md-nav__link">
<span class="md-ellipsis">
JSON Schemas
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Wizardconnect
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Wizardconnect
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../wizardconnect/" class="md-nav__link">
<span class="md-ellipsis">
WizardConnect
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/connection-uri/" class="md-nav__link">
<span class="md-ellipsis">
Connection URI and key exchange
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/dapp/" class="md-nav__link">
<span class="md-ellipsis">
Dapp integration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/extensions/" class="md-nav__link">
<span class="md-ellipsis">
Extensions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/protocol/" class="md-nav__link">
<span class="md-ellipsis">
Protocol
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/pubkey-derivation/" class="md-nav__link">
<span class="md-ellipsis">
xpub delivery and pubkey derivation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/react/" class="md-nav__link">
<span class="md-ellipsis">
React integration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/serialization/" class="md-nav__link">
<span class="md-ellipsis">
Relay serialization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/transport/" class="md-nav__link">
<span class="md-ellipsis">
Relay transport
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/wallet/" class="md-nav__link">
<span class="md-ellipsis">
Wallet integration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wizardconnect/xpub-sharing/" class="md-nav__link">
<span class="md-ellipsis">
xpub sharing: why it's safe and why we do it
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#cashlab" class="md-nav__link">
<span class="md-ellipsis">
CashLab
</span>
</a>
<nav class="md-nav" aria-label="CashLab">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#key-concepts" class="md-nav__link">
<span class="md-ellipsis">
Key Concepts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-constructing-a-trade" class="md-nav__link">
<span class="md-ellipsis">
Example: Constructing a Trade
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#vegabch-cli" class="md-nav__link">
<span class="md-ellipsis">
VegaBCH CLI
</span>
</a>
<nav class="md-nav" aria-label="VegaBCH CLI">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#installation_1" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#trading-with-vegabch" class="md-nav__link">
<span class="md-ellipsis">
Trading with VegaBCH
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#wallet-setup" class="md-nav__link">
<span class="md-ellipsis">
Wallet Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cauldron-command-reference" class="md-nav__link">
<span class="md-ellipsis">
Cauldron Command Reference
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#bchcockpit" class="md-nav__link">
<span class="md-ellipsis">
BCHCockpit
</span>
</a>
<nav class="md-nav" aria-label="BCHCockpit">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#what-it-does" class="md-nav__link">
<span class="md-ellipsis">
What It Does
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#using-the-hosted-version" class="md-nav__link">
<span class="md-ellipsis">
Using the Hosted Version
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#self-hosting" class="md-nav__link">
<span class="md-ellipsis">
Self-Hosting
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<nav class="md-path" aria-label="Navigation" >
<ol class="md-path__list">
<li class="md-path__item">
<a href="../.." class="md-path__link">
<span class="md-ellipsis">
Riften Labs Documentation
</span>
</a>
</li>
<li class="md-path__item">
<a href="../" class="md-path__link">
<span class="md-ellipsis">
Cauldron
</span>
</a>
</li>
</ol>
</nav>
<article class="md-content__inner md-typeset">
<h1 id="developer-resources">Developer Resources</h1>
<p>Community-built open source tools exist for building on top of Cauldron programmatically. These are third-party projects not maintained by Riften Labs.</p>
<table>
<thead>
<tr>
<th>Tool</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="#cashlab">CashLab</a></td>
<td>TypeScript library</td>
<td>Programmatic API for trade construction and pool interaction</td>
</tr>
<tr>
<td><a href="#vegabch-cli">VegaBCH</a></td>
<td>CLI application</td>
<td>Command-line interface for executing trades</td>
</tr>
<tr>
<td><a href="#bchcockpit">BCHCockpit</a></td>
<td>Web application</td>
<td>Browser-based tool for discovering and withdrawing pool positions</td>
</tr>
</tbody>
</table>
<p>All three are built by the same developer (<a href="https://github.com/hosseinzoda">hosseinzoda</a>). CashLab is the foundational library; VegaBCH and BCHCockpit both depend on it.</p>
<hr />
<h2 id="cashlab">CashLab</h2>
<p><a href="https://github.com/hosseinzoda/cashlab">CashLab</a> is a set of TypeScript packages for BCH DeFi. The <code>@cashlab/cauldron</code> package provides programmatic access to Cauldron trade construction and pool interaction. It works in both Node.js and browser environments.</p>
<ul>
<li><strong>Repository</strong>: <a href="https://github.com/hosseinzoda/cashlab">github.com/hosseinzoda/cashlab</a></li>
<li><strong>API Documentation</strong>: <a href="https://hosseinzoda.github.io/cashlab/cauldron/">hosseinzoda.github.io/cashlab/cauldron/</a></li>
<li><strong>License</strong>: ISC</li>
</ul>
<h3 id="installation">Installation</h3>
<div class="highlight"><pre><span></span><code>npm<span class="w"> </span>install<span class="w"> </span>@cashlab/common<span class="w"> </span>@cashlab/cauldron
</code></pre></div>
<p><code>@cashlab/common</code> is always required alongside <code>@cashlab/cauldron</code>. It provides the transaction construction primitives (<code>SpendableCoin</code>, <code>PayoutRule</code>, <code>createPayoutTx</code>, etc.) that the cauldron package builds on.</p>
<h3 id="key-concepts">Key Concepts</h3>
<table>
<thead>
<tr>
<th>Export</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>ExchangeLab</code></td>
<td>Main class for constructing and verifying trades</td>
</tr>
<tr>
<td><code>constructTradeBestRateForTargetDemand()</code></td>
<td>Route a trade across multiple pools for optimal rate</td>
</tr>
<tr>
<td><code>createTradeTx()</code></td>
<td>Build the signed trade transaction</td>
</tr>
<tr>
<td><code>verifyTradeTx()</code></td>
<td>Verify the transaction satisfies pool constraints</td>
</tr>
<tr>
<td><code>generatePoolV0LockingBytecode()</code></td>
<td>Generate locking script for a V0 pool</td>
</tr>
<tr>
<td><code>buildPoolV0RedeemScriptBytecode()</code></td>
<td>Build redeem script for pool withdrawal</td>
</tr>
</tbody>
</table>
<h3 id="example-constructing-a-trade">Example: Constructing a Trade</h3>
<p>The following example shows how to construct a trade that buys tokens with BCH, routing across multiple pools for the best rate:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">cauldron</span><span class="p">,</span><span class="w"> </span><span class="nx">TokenId</span><span class="p">,</span><span class="w"> </span><span class="nx">NATIVE_BCH_TOKEN_ID</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'@cashlab/cauldron'</span><span class="p">;</span>
<span class="k">import</span><span class="w"> </span><span class="kr">type</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">PoolV0Parameters</span><span class="p">,</span><span class="w"> </span><span class="nx">PoolV0</span><span class="p">,</span><span class="w"> </span><span class="nx">TradeResult</span><span class="p">,</span><span class="w"> </span><span class="nx">TradeTxResult</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'@cashlab/cauldron'</span><span class="p">;</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">exlab</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">cauldron</span><span class="p">.</span><span class="nx">ExchangeLab</span><span class="p">();</span>
<span class="c1">// Define the trade: supply BCH, demand tokens</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">supply_token_id</span><span class="o">:</span><span class="w"> </span><span class="kt">TokenId</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'BCH'</span><span class="p">;</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">demand_token_id</span><span class="o">:</span><span class="w"> </span><span class="kt">TokenId</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'&lt;token_id_hex&gt;'</span><span class="p">;</span>
<span class="c1">// Pool parameters (fetched from an indexer or Electrum)</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">pool_params</span><span class="o">:</span><span class="w"> </span><span class="kt">PoolV0Parameters</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">withdraw_pubkey_hash</span><span class="o">:</span><span class="w"> </span><span class="s1">'&lt;pool_withdraw_pubkey_hash&gt;'</span><span class="p">,</span>
<span class="p">};</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">pool_locking_bytecode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">exlab</span><span class="p">.</span><span class="nx">generatePoolV0LockingBytecode</span><span class="p">(</span><span class="nx">pool_params</span><span class="p">);</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">input_pools</span><span class="o">:</span><span class="w"> </span><span class="kt">PoolV0</span><span class="p">[]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">version</span><span class="o">:</span><span class="w"> </span><span class="s1">'0'</span><span class="p">,</span>
<span class="w"> </span><span class="nx">parameters</span><span class="o">:</span><span class="w"> </span><span class="kt">pool_params</span><span class="p">,</span>
<span class="w"> </span><span class="nx">outpoint</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">index</span><span class="o">:</span><span class="w"> </span><span class="kt">0</span><span class="p">,</span>
<span class="w"> </span><span class="nx">txhash</span><span class="o">:</span><span class="w"> </span><span class="kt">hexToBin</span><span class="p">(</span><span class="s1">'&lt;txhash_hex&gt;'</span><span class="p">),</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nx">output</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">locking_bytecode</span><span class="o">:</span><span class="w"> </span><span class="kt">pool_locking_bytecode</span><span class="p">,</span>
<span class="w"> </span><span class="nx">token</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nx">amount</span><span class="o">:</span><span class="w"> </span><span class="kt">1000000n</span><span class="p">,</span>
<span class="w"> </span><span class="nx">token_id</span><span class="o">:</span><span class="w"> </span><span class="s1">'&lt;token_id_hex&gt;'</span><span class="p">,</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nx">amount</span><span class="o">:</span><span class="w"> </span><span class="kt">500000000n</span><span class="p">,</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="c1">// ... additional pools for better routing</span>
<span class="p">];</span>
<span class="c1">// Find the best route across pools for 50000 tokens</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">demand</span><span class="o">:</span><span class="w"> </span><span class="kt">bigint</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">50000n</span><span class="p">;</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="o">:</span><span class="w"> </span><span class="kt">TradeResult</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">exlab</span><span class="p">.</span><span class="nx">constructTradeBestRateForTargetDemand</span><span class="p">(</span>
<span class="w"> </span><span class="nx">supply_token_id</span><span class="p">,</span>
<span class="w"> </span><span class="nx">demand_token_id</span><span class="p">,</span>
<span class="w"> </span><span class="nx">demand</span><span class="p">,</span>
<span class="w"> </span><span class="nx">input_pools</span>
<span class="p">);</span>
<span class="c1">// Build the transaction</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">txfee_per_byte</span><span class="o">:</span><span class="w"> </span><span class="kt">bigint</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1n</span><span class="p">;</span>
<span class="kd">const</span><span class="w"> </span><span class="nx">tx_result</span><span class="o">:</span><span class="w"> </span><span class="kt">TradeTxResult</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">exlab</span><span class="p">.</span><span class="nx">createTradeTx</span><span class="p">(</span>
<span class="w"> </span><span class="nx">result</span><span class="p">.</span><span class="nx">pool_trade_list</span><span class="p">,</span>
<span class="w"> </span><span class="nx">input_coins</span><span class="p">,</span><span class="w"> </span><span class="c1">// SpendableCoin[] from your wallet</span>
<span class="w"> </span><span class="nx">payout_rules</span><span class="p">,</span><span class="w"> </span><span class="c1">// PayoutRule[] for trade outputs</span>
<span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nx">txfee_per_byte</span>
<span class="p">);</span>
<span class="c1">// Verify and broadcast</span>
<span class="nx">exlab</span><span class="p">.</span><span class="nx">verifyTradeTx</span><span class="p">(</span><span class="nx">tx_result</span><span class="p">);</span>
<span class="c1">// tx_result.txbin is the raw transaction ready for broadcast</span>
</code></pre></div>
<p>!!! note
One side of every Cauldron trade must be native BCH. Direct token-to-token swaps require routing through BCH as an intermediary.</p>
<p>For the full <code>@cashlab/common</code> API (transaction construction, UTXO types, payout rules), see the <a href="https://hosseinzoda.github.io/cashlab/common/">common package documentation</a>.</p>
<hr />
<h2 id="vegabch-cli">VegaBCH CLI</h2>
<p><a href="https://github.com/hosseinzoda/vegabch">VegaBCH</a> is a command-line tool for BCH DeFi operations. It wraps CashLab with wallet management, Electrum connectivity, and a daemon mode.</p>
<ul>
<li><strong>Repository</strong>: <a href="https://github.com/hosseinzoda/vegabch">github.com/hosseinzoda/vegabch</a></li>
<li><strong>npm</strong>: <a href="https://www.npmjs.com/package/vegabch">npmjs.com/package/vegabch</a></li>
<li><strong>License</strong>: MIT</li>
</ul>
<h3 id="installation_1">Installation</h3>
<div class="highlight"><pre><span></span><code>npm<span class="w"> </span>install<span class="w"> </span>-g<span class="w"> </span>vegabch
</code></pre></div>
<h3 id="configuration">Configuration</h3>
<p>VegaBCH requires a JSON config file passed via <code>--config &lt;path&gt;</code>. The simplest setup is standalone mode:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"standalone"</span><span class="p">,</span>
<span class="w"> </span><span class="nt">"vega_storage_file"</span><span class="p">:</span><span class="w"> </span><span class="s2">"./vega-storage.json"</span><span class="p">,</span>
<span class="w"> </span><span class="nt">"main_electrum_node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wss://electrum.imaginary.cash:50004"</span><span class="p">,</span>
<span class="w"> </span><span class="nt">"cauldron_indexer_node"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wss://electrum.cauldron.quest:50004"</span>
<span class="p">}</span>
</code></pre></div>
<p>VegaBCH also supports a <strong>daemon mode</strong> (persistent HTTP/RPC server) and a <strong>client mode</strong> (connects to a running daemon). See the <a href="https://github.com/hosseinzoda/vegabch#readme">VegaBCH README</a> for details.</p>
<h3 id="trading-with-vegabch">Trading with VegaBCH</h3>
<p>Trading is a two-step process:</p>
<p><strong>Step 1: Construct the trade</strong> - finds the optimal route across pools:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># Buy tokens with BCH (get at least 100 tokens)</span>
vegabch<span class="w"> </span>cauldron:construct-trade<span class="w"> </span>BCH<span class="w"> </span>&lt;token_id&gt;<span class="w"> </span><span class="m">100</span><span class="w"> </span>trade.json<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--config<span class="w"> </span>config.json<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--txfee-per-byte<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--target-demand<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--decimal-amounts
</code></pre></div>
<ul>
<li><code>--target-demand</code> (default): the demand output will be &gt;= the requested amount</li>
<li><code>--target-supply</code>: the supply input will be &lt;= the requested amount</li>
<li><code>--decimal-amounts</code>: use token-defined decimal places (e.g., <code>1.00000000</code> = 1 BCH)</li>
</ul>
<p><strong>Step 2: Fund and broadcast</strong> - signs with your wallet and sends:</p>
<div class="highlight"><pre><span></span><code>vegabch<span class="w"> </span>cauldron:fund-trade<span class="w"> </span>trade.json<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--config<span class="w"> </span>config.json<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--wallet<span class="w"> </span>mywallet<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--txfee-per-byte<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--broadcast
</code></pre></div>
<h3 id="wallet-setup">Wallet Setup</h3>
<div class="highlight"><pre><span></span><code><span class="c1"># Generate a new HD wallet</span>
vegabch<span class="w"> </span>wallet:generate<span class="w"> </span>mywallet<span class="w"> </span>seed<span class="w"> </span>--config<span class="w"> </span>config.json
<span class="c1"># Or import an existing mnemonic</span>
vegabch<span class="w"> </span>wallet:create<span class="w"> </span>mywallet<span class="w"> </span>seed<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--config<span class="w"> </span>config.json<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--mnemonic<span class="w"> </span><span class="s1">'your twelve words here'</span>
<span class="c1"># Pin it as the default</span>
vegabch<span class="w"> </span>wallet:pin<span class="w"> </span>mywallet<span class="w"> </span>--config<span class="w"> </span>config.json
<span class="c1"># Check balance</span>
vegabch<span class="w"> </span>wallet:balance<span class="w"> </span>--config<span class="w"> </span>config.json
</code></pre></div>
<h3 id="cauldron-command-reference">Cauldron Command Reference</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cauldron:construct-trade SUPPLY DEMAND AMOUNT [OUTPUT]</code></td>
<td>Construct optimal multi-pool trade</td>
</tr>
<tr>
<td><code>cauldron:fund-trade TRADE_FILE</code></td>
<td>Fund trade with wallet, optionally broadcast</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="bchcockpit">BCHCockpit</h2>
<p><a href="https://github.com/hosseinzoda/bchcockpit">BCHCockpit</a> is a browser-based tool for discovering and withdrawing Cauldron V0 liquidity pool positions. It was built as a fallback for when the official Cauldron frontend is unavailable.</p>
<ul>
<li><strong>Live App</strong>: <a href="https://hosseinzoda.github.io/bchcockpit/">hosseinzoda.github.io/bchcockpit/</a></li>
<li><strong>Repository</strong>: <a href="https://github.com/hosseinzoda/bchcockpit">github.com/hosseinzoda/bchcockpit</a></li>
<li><strong>License</strong>: MIT</li>
</ul>
<h3 id="what-it-does">What It Does</h3>
<ul>
<li><strong>Wallet management</strong>: Add wallets via BIP39 mnemonic or as watch-only</li>
<li><strong>Pool discovery</strong>: Scans for Cauldron V0 pools associated with your wallet addresses</li>
<li><strong>Withdrawal</strong>: Withdraw your liquidity from discovered pools</li>
</ul>
<p>BCHCockpit runs entirely in the browser. It connects directly to Electrum servers for blockchain data and resolves token metadata via BCMR (Bitcoin Cash Metadata Registry). No backend server is required.</p>
<p>!!! warning
BCHCockpit is designed for <strong>pool withdrawal only</strong>. It does not support trading, pool creation, or deposits.</p>
<h3 id="using-the-hosted-version">Using the Hosted Version</h3>
<p>The easiest way to use BCHCockpit is the hosted version at <a href="https://hosseinzoda.github.io/bchcockpit/">hosseinzoda.github.io/bchcockpit/</a>. No installation required.</p>
<h3 id="self-hosting">Self-Hosting</h3>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/hosseinzoda/bchcockpit.git
<span class="nb">cd</span><span class="w"> </span>bchcockpit
npm<span class="w"> </span>install
npm<span class="w"> </span>run<span class="w"> </span>build<span class="w"> </span><span class="c1"># Build static files for production</span>
npm<span class="w"> </span>run<span class="w"> </span>start<span class="w"> </span><span class="c1"># Or run dev server</span>
</code></pre></div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../claim/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Token Verification &amp;amp; Token Claim">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Token Verification &amp; Token Claim
</div>
</div>
</a>
<a href="../liquidity/" class="md-footer__link md-footer__link--next" aria-label="Next: Liquidity Pools">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Liquidity Pools
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
</div>
<div class="md-social">
<a href="https://x.com/riftenlabs" target="_blank" rel="noopener" title="Riften Labs on X" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M357.2 48h70.6L273.6 224.2 455 464H313L201.7 318.6 74.5 464H3.8l164.9-188.5L-5.2 48h145.6l100.5 132.9zm-24.8 373.8h39.1L119.1 88h-42z"/></svg>
</a>
<a href="https://x.com/moriamoney" target="_blank" rel="noopener" title="Moria Money on X" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M357.2 48h70.6L273.6 224.2 455 464H313L201.7 318.6 74.5 464H3.8l164.9-188.5L-5.2 48h145.6l100.5 132.9zm-24.8 373.8h39.1L119.1 88h-42z"/></svg>
</a>
<a href="https://x.com/cauldronswap" target="_blank" rel="noopener" title="Cauldron Swap on X" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M357.2 48h70.6L273.6 224.2 455 464H313L201.7 318.6 74.5 464H3.8l164.9-188.5L-5.2 48h145.6l100.5 132.9zm-24.8 373.8h39.1L119.1 88h-42z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.footer", "navigation.path"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.d7400e89.min.js"></script>
<script src="../../javascripts/mathjax.js"></script>
<script src="https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink