ClaimRush Developer Docs (v1.0.0)
Docs for smart-contract integrators, frontend/bot developers, and indexers.
Hosts: docs.claimru.sh (users) | developers.claimru.sh (devs)
Start here
- Getting Started — repo setup, local stack, integration rules, key params
- Protocol Overview — the CLAIM stream, contract map, trust boundaries
- Pick your track:
| Goal | Page |
|---|---|
| Building an app / frontend | Core Mechanics, Furnace, Locks |
| Analytics / indexing | Events & Indexing |
| Building agents | Agents & Automation |
| Building keepers | Maintenance & Bots |
| Upgrading live runtime contracts | Runtime Proxy Upgrades |
| Locking runtime logic permanently | Freeze-and-Burn Finality |
| Step-by-step recipes | Tutorials |
Naming map (UI vs protocol)
| UI | Protocol |
|---|---|
| Crown | MineCore.currentKing + reign system |
| Locks | veCLAIM (VeClaimNFT) + ShareholderRoyalties |
| Furnace | Furnace (enter → lock with bonus) |
| Market | MarketRouter (listings + bonus target escrow) |
| $CLAIM | ClaimToken (ERC20, 18 decimals) |
Verbs: ETH payouts = “Collect” | LP rewards = “Harvest”
Source of truth
| What | File |
|---|---|
| Master index | docs/v1.0.0-index.md |
| Spec | docs/spec/spec-v1.0.0.md |
| Constants | docs/spec/env-config-and-constants-v1.0.0.md, src/lib/Constants.sol |
| Events | src/lib/Events.sol, docs/analytics/dune-integration-pack-v1.0.0.md |
| Roles | docs/security/roles-and-permissions-matrix-v1.0.0.md |
Deployed addresses
See Getting Started — Deployed addresses.
Quick links
| Section | Page |
|---|---|
| Protocol Overview | protocol-overview.md |
| Core Mechanics | core-mechanics.md |
| Furnace | furnace.md |
| Locks (veCLAIM) | locks-veclaim.md |
| Royalties (Barons) | shareholderroyalties-barons.md |
| Market | marketrouter.md |
| ClaimAllHelper | claimallhelper.md |
| Events & Indexing | events-and-indexing.md |
| Agents | agents-and-automation.md |
| Maintenance | maintenance-and-bots.md |
| Runtime Proxy Upgrades | runtime-proxy-upgrades.md |
| Freeze-and-Burn Finality | freeze-and-burn-finality.md |
| Bot Sessions | delegationhub.md |
| Security & Guardian | security-guardian-pausing.md |
| Constants Reference | appendix-constants-v100.md |
| House Charter | house-charter.md |
Scope
ClaimRush is the protocol (smart contracts, subgraph, keeper, SDK). The official frontend is proprietary and is not released. References to “the shipped frontend” in these docs describe recommended UI defaults for integrators building their own apps — they are not a code release.
See TRADEMARKS.md. The protocol is licensed under the MIT License — see LICENSE. Contributions require signing the Contributor License Agreement — see CLA.md and CONTRIBUTING.md.
See also
- Getting Started — deployed addresses, SDK install, and first calls
- Protocol Overview — architecture and CLAIM stream
- Runtime Proxy Upgrades — production upgrade runbook for the proxy-backed runtime quartet
- Freeze-and-Burn Finality — permanent runtime finality ceremony and post-burn governance model
- Tutorials — step-by-step recipes
- User manual: docs.claimru.sh