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
- Quickstart — repo setup, local stack, integration rules
- Tutorials — end-to-end integration recipes
Two user-facing loops
| Loop | Protocol surface | Reward |
|---|---|---|
| Takeover (Crown) | MineCore takeover + reign | 75% prev King, 25% to Barons |
| Furnace (Barons) | Furnace enter → veCLAIM | ETH royalties via ShareholderRoyalties |
Entry token defaults (UI): If user has CLAIM, default to CLAIM entry. Otherwise default to ETH. Collect & Lock always uses ETH.
Royalty action defaults: Default to Collect ETH (mode 0). Offer Collect & Lock (mode 1) as optional.
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
Canonical: deployments/<network>.json | Generated: deployments/<network>.md
Rule: Never hardcode addresses. Always load from manifests.
Quick links
| Section | Page |
|---|---|
| Protocol overview | protocol-overview.md |
| Core mechanics | core-mechanics.md |
| Furnace | furnace.md |
| Market | marketrouter.md |
| Events/indexing | events-and-indexing.md |
| Agents | agents-and-automation.md |
| Maintenance | maintenance-and-bots.md |
| Bot sessions | delegationhub.md |
| House rules | house-charter.md |