Operator documentation
Build your Bitcoin Cash pool.
Understand every part.
Set up the stratum engine, choose your payouts, and turn mining data into your own miner experience. Start with a guide, then go deeper in the public source.
Run a Bitcoin Cash solo mining pool
Plan a CashStratum solo pool on Linux: supported BCH nodes, CashAddr payouts, installer choices, miner connections and deployment checks.
Read the guide →BUILD THE EXPERIENCEBuild your miner experience with the Go API
Build BCH miner dashboards with CashStratum's read-only Go API: share quality, resumable polling, worker stats, coinbase inspection and block events.
Read the guide →Source of truth
The complete documentation index
These documents live beside the software in the public repository. Use documentation from your release tag when configuring a specific version. Index reviewed 2026-10-26.
Start here
- Project overview
Software scope, releases, validation and community entry points.
- Installation
Supported nodes, prerequisites, solo installer, upgrades and proxy installation.
- BCH configuration
Bitcoin Cash-specific engine configuration and operation.
- Solo mining and payouts
Per-address solo mining, worker names and payout behavior.
- Pool fees
Operator fee configuration and coinbase outputs.
Build with the Go API
- Operator API reference
Authentication, endpoints, share cursors, rate limits and response fields.
- API installation
Build and run the separate Go API service.
- API integration guide
Application integration and API usage.
- API examples
Examples for consuming pool data.
- Coinbase API
Inspect the coinbase a miner is currently working on.
- Block notifier
Optional companion for signed block notifications.
Operate and verify
- Server modes
Choose the engine mode for your deployment.
- Stratum proxy
Proxy operation and upstream configuration.
- Security hardening
Deployment boundaries and operational hardening.
- Security overview
Engine security notes and mitigations.
- Share accounting security
Share-inflation defenses and verification.
- Archived block proofs
The original public proof archive and reproduction procedure; the site includes a separately verified update.
- Historical valuation method
BCH reward valuation methodology and limitations.
- Exchange valuation method
Historical exchange price methodology.
Community
- Release history
Changes across published software versions.
- Contributing
Development, tests and contribution process.
- Security reporting
How to report a vulnerability.
- Pool registry
Canonical, verified registry of independently operated pools.
Before you start
Questions operators ask
Is CashStratum a mining pool or mining software?
CashStratum is open-source stratum server and solo mining pool software. Operators run their own deployments. BlockSniper is a reference deployment, and the pool directory lists independently operated pools.
How does CashStratum differ from CKPool?
CashStratum develops CKPool's C engine for Bitcoin Cash, including native CashAddr handling, configurable solo payouts, rental compatibility, node support and a separate Go operator API. The comparison page cites the source for each capability and identifies the versions compared.
Which Bitcoin Cash node should I use?
BCHN is the reference node and the managed solo installer's supported target. BCHD and Flowee are supported through manual configuration. Read the installation guide for their RPC and polling requirements.
Can I build a dashboard with shares, sounds and block celebrations?
Yes. The Go API supplies share quality, worker data, coinbase details and solve context to your backend. Your frontend builds the charts, sounds and effects. The optional notifier supplies signed block events; the API itself remains read-only.
Do the block proofs all come from the latest release?
No. The ledger labels the software lineage: the earlier EloPool deployment used skaisser/ckpool, a modified CKPool; the first BlockSniper block used pre-release CashStratum; later entries identify published CashStratum versions when evidenced. Historical results do not guarantee future solves.