ClaimRush Developers
Docs for smart-contract integrators, app and bot developers, and indexers.
Start here
- Getting Started — repo setup, local stack, integration rules, key params
- Repo Map — shipped repo surface, path roles, and entry routes
- Protocol Overview — the CLAIM stream, contract map, trust boundaries
- Choose a track:
| Goal | Type | Page |
|---|---|---|
| Building an app / client | Reference | Core Mechanics, Furnace, Locks |
| Analytics / indexing | Reference | Events & Indexing |
| Building agents | Reference | Agents & Automation |
| Building keepers | Operator | Maintenance & Bots |
| Upgrading live runtime contracts | Operator | Runtime Proxy Upgrades |
| Locking runtime logic permanently | Operator | Freeze-and-Burn Finality |
| Integration tutorials | Reference | Tutorials |
Naming map (UI vs protocol)
| UI | Protocol |
|---|---|
| Crown | MineCore.currentKing + reign system |
veCLAIM (overview at /veclaim) | VeClaimNFT (public concept surface) |
Locks (cockpit at /locks) | VeClaimNFT (personal positions surface) |
| Barons | ShareholderRoyalties (ETH royalties to veCLAIM holders) |
| Furnace | Furnace (enter → lock with bonus) |
| Market | MarketRouter (listings + bonus target escrow) |
| LP Vault | LpStakingVault7D (Aerodrome WETH/CLAIM LP staking) |
| Bot access | DelegationHub (session registry for opt-in delegated agents) |
| Bundled Collect | ClaimAllHelper (one-call multi-surface payout + delegated wrapper) |
| 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 | src/lib/Constants.sol, docs/manuals/developer/appendix-constants-v100.md |
| Events | src/lib/Events.sol, docs/analytics/dune-integration-pack-v1.0.0.md |
| Roles | docs/manuals/developer/security-guardian-pausing.md |
Deployed addresses
See Getting Started — Deployed addresses.
Reference indexes
- Errors Reference — every revert by surface
- Glossary — protocol vocabulary used across pages
- Constants Reference — canonical numeric thresholds
- Developer FAQ — common reverts, indexer gotchas, SDK and keeper questions
- SUMMARY — full table of contents
Scope
ClaimRush is the protocol (smart contracts, subgraph, keeper, SDK). The official application UI is proprietary and is not released. References to UI defaults in these docs describe integration guidance for apps built on the protocol — 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 — integration tutorials
- Linking convention — how to link to other manuals, source files, and the CRAL companion yaml
- User manual: ClaimRush User Manual