Quickstart
Go from zero → first build in minutes.
Integration rules (must follow)
- Never hardcode addresses. Load from
deployments/<network>.json. - Never invent event signatures. Use
src/lib/Events.sol+ ABIs inabis/. - Use correct UI verbs. ETH payouts = “Collect” | CLAIM rewards = “Harvest”
Prereqs
- Foundry 1.5.1
- Node.js (use repo
.nvmrc) - Python 3
Repo setup
make deps && make build && make testRun local stack
npm run localDoes: starts Anvil → deploys contracts → writes manifests → starts frontend dev server.
Variants:
| Command | What it does |
|---|---|
npm run local:deploy | Deploy + write manifests only |
npm run local:frontend | Frontend only (manifests must exist) |
CI-parity gates
make gatesRun this before shipping changes. Checks docs, manifests, ABIs, analytics sync.
Deployed addresses
| Type | Path |
|---|---|
| Canonical | deployments/<network>.json |
| Human-readable | deployments/<network>.md |
Rule: Filter logs by evt_block_number >= startBlock from manifest.
Key params (v1.0.0)
Crown pricing (MineCore)
| Param | Value |
|---|---|
| Floor | 0.001 ETH |
| Decay | 1 hour |
| Reference update | referencePrice = pricePaid * 2 |
Emissions
Linear decay over 2 years.
| Stream | Start | Floor |
|---|---|---|
| Crown (King) | 50 CLAIM/s | ~5.56 CLAIM/s |
| Furnace reserve | 5 CLAIM/s | ~0.56 CLAIM/s |
Locks (VeClaimNFT)
| Param | Value |
|---|---|
| Min amount | 1,000 CLAIM |
| Duration | 7–365 days |
| Max per wallet | 32 |
Barons activation (ShareholderRoyalties)
MIN_VE_FLUSH = 100e18 — ETH stays pending until threshold met.
Next reads
| Goal | Page |
|---|---|
| Big picture | Protocol overview |
| Building an app | Core mechanics, Furnace |
| Analytics/indexing | Events and indexing |
| Building agents | Agents and automation |
| Building keepers | Maintenance and bots |