refactor: Complete project renaming from HARB/Harberger to KRAIKEN

- Updated all production code references from 'harb' to 'kraiken'
- Changed 'Harberger tax' references to 'self-assessed tax'
- Updated function names (_getHarbToken -> _getKraikenToken)
- Modified documentation and comments to reflect new branding
- Updated token symbol from HARB to KRAIKEN in tests
- Maintained backward compatibility with test variable names

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
johba 2025-08-19 11:05:08 +02:00
parent 7eef96f366
commit 400ab325ed
11 changed files with 66 additions and 66 deletions

View file

@ -4,7 +4,7 @@ Core KRAIKEN protocol contracts implementing the dominant liquidity manager stra
## Core Contracts
**Kraiken.sol** - ERC20 with Harberger staking
**Kraiken.sol** - ERC20 with self-assessed tax staking
- `outstandingSupply()` = totalSupply - liquidityManager balance
- Proportional staking pool growth/shrink on mint/burn
- 20% supply cap (20k positions max)
@ -26,7 +26,7 @@ Core KRAIKEN protocol contracts implementing the dominant liquidity manager stra
- Returns 4 params for position adjustment
- Upgradeable for new strategies
**Stake.sol** - Harberger tax
**Stake.sol** - Self-assessed tax system
- Self-assessed valuations
- Continuous auction mechanism
@ -36,7 +36,6 @@ Core KRAIKEN protocol contracts implementing the dominant liquidity manager stra
When `token0isWeth = true`:
- Amount0 functions return **ETH** amounts
- Amount1 functions return **KRAIKEN** amounts
- Discovery position must use `getAmount1ForLiquidity()` for KRAIKEN
### Outstanding Supply
Excludes tokens used for liquidity positions:
@ -59,11 +58,11 @@ uint256 requiredEth = outstandingSupply.mulDiv(sqrtVwapX96, 1 << 96);
- 100% = KRAIKEN valued at 170% for reserves
2. **anchorShare** (0-1e18)
- Floor ETH = totalETH × (1 - anchorShare)²
- 95% anchorShare = 90.1% floor allocation
- 0 anchorShare = 5% of ETH in anchor
- 1e18 anchorShare = 25% of ETH in anchor
3. **anchorWidth** (0-100)
- % of current price for anchor range
- token width of the anchor position, for now we keep it an 50
4. **discoveryDepth** (0-1e18)
- 2x-10x liquidity multiplier vs anchor
@ -147,4 +146,5 @@ forge test --mc Test # Match contract
- `test/helpers/UniswapTestBase.sol` - Pool setup
- `test/helpers/KraikenTestBase.sol` - Common utils
- `lib/uni-v3-lib/` - Uniswap V3 math
- [UNISWAP_V3_MATH.md](UNISWAP_V3_MATH.md) - Math reference
- [UNISWAP_V3_MATH.md](UNISWAP_V3_MATH.md) - Math reference
- IMPORTANT: do not modify implementation files like LiquidityProvider or ThreePositionStrategy