de3c8eef94
- Rewrite root README.md with proper project overview, tech stack, and repo structure - Remove duplicate CLAUDE.md files (root, onchain, ponder) — AGENTS.md is the standard - Update HARBERG.md to reflect Stage 1 completion and Stage 2 evolution - Delete stale onchain/testing_todos.md (all high-priority items completed) - Update VERSION_VALIDATION.md for VERSION=2 - Trim root AGENTS.md: replace Docker duplication with docs/docker.md reference - Trim onchain/AGENTS.md (129→71 lines): reference TECHNICAL_APPENDIX for formulas - Trim web-app/AGENTS.md (278→55 lines): remove internal API docs, keep architecture - Rewrite onchain/README.md: add contract table, deployment addresses, analysis links - Trim services/ponder/README.md: remove stale subgraph comparison - Add otterscan to docs/docker.md service topology - Update TECHNICAL_APPENDIX.md references Net: -388 lines across documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
69 lines
2.5 KiB
Markdown
69 lines
2.5 KiB
Markdown
# KRAIKEN Onchain
|
|
|
|
Solidity contracts for the KRAIKEN protocol. Built with Foundry.
|
|
|
|
## Contracts
|
|
|
|
| Contract | Description |
|
|
|----------|-------------|
|
|
| `Kraiken.sol` | ERC20 token with mint/burn controlled by LiquidityManager. VERSION=2. |
|
|
| `LiquidityManager.sol` | Three-position Uniswap V3 strategy (Anchor, Discovery, Floor). |
|
|
| `Stake.sol` | Harberger-tax staking with snatching auctions and discrete tax brackets. |
|
|
| `OptimizerV3.sol` | UUPS upgradeable. Binary bear/bull parameter selection from staking sentiment. |
|
|
| `VWAPTracker.sol` | Volume-weighted average price with directional recording and compression. |
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
git submodule update --init --recursive
|
|
cd lib/uni-v3-lib && npm install && cd ../..
|
|
forge build
|
|
forge test
|
|
```
|
|
|
|
## Deploy
|
|
|
|
```bash
|
|
source .env
|
|
forge script script/BaseSepoliaDeploy.sol:BaseSepoliaDeploy --slow --broadcast --verify --rpc-url ${BASE_SEPOLIA_RPC_URL}
|
|
```
|
|
|
|
See [docs/DEPLOYMENT_RUNBOOK.md](../docs/DEPLOYMENT_RUNBOOK.md) for production deployment.
|
|
|
|
## Deployments
|
|
|
|
### Base Mainnet
|
|
|
|
| Contract | Address |
|
|
|----------|---------|
|
|
| Kraiken | `0x45caa5929f6ee038039984205bdecf968b954820` |
|
|
| Stake | `0xed70707fab05d973ad41eae8d17e2bcd36192cfc` |
|
|
| LiquidityManager | `0x7fd4e645ce258dd3942eddbeb2f99137da8ba13b` |
|
|
|
|
### Base Sepolia
|
|
|
|
| Contract | Address |
|
|
|----------|---------|
|
|
| Kraiken | `0x22c264Ecf8D4E49D1E3CabD8DD39b7C4Ab51C1B8` |
|
|
| Stake | `0xe28020BCdEeAf2779dd47c670A8eFC2973316EE2` |
|
|
| LiquidityManager | `0x3d6a8797693a0bC598210782B6a889E11A2340Cd` |
|
|
|
|
## Research & Analysis
|
|
|
|
The `analysis/` directory contains fuzzing scripts, parameter sweep tools, and security analysis:
|
|
|
|
- [SECURITY_REVIEW.md](analysis/SECURITY_REVIEW.md) — Security analysis and vulnerability assessment
|
|
- [KRAIKEN_RESEARCH_REPORT.md](analysis/KRAIKEN_RESEARCH_REPORT.md) — Comprehensive research report
|
|
- [README.md](analysis/README.md) — Analysis tool usage guide
|
|
|
|
Key findings: critical sqrt price bug fixed, 1050-combo 4D parameter sweep completed, floor ratchet vulnerability identified. See the research report for details.
|
|
|
|
## ABI Architecture
|
|
|
|
Contract ABIs flow through the stack via `kraiken-lib/src/abis.ts`, which imports directly from `out/` (forge build artifacts). Run `forge build` to update ABIs across all consumers (ponder, web-app).
|
|
|
|
## References
|
|
|
|
- [AGENTS.md](AGENTS.md) — Agent guide for onchain development
|
|
- [UNISWAP_V3_MATH.md](UNISWAP_V3_MATH.md) — Uniswap V3 math reference
|
|
- [hAIrberger.md](hAIrberger.md) — Dynamic LP strategy design document
|