feat(util): add MathLib and PositionLib utility libraries #133
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add MathLib.sol with safe math operations for DeFi calculations: - min, max, clamp, absDiff for value comparison - safeDiv, divUp, mulDiv, mulDivUp for safe division operations - bpsToDecimal, applyBps, applyPercentage for basis point conversions - ratio, proRata, calculateInterest for financial calculations - safeSub, isWithinTolerance, convertDecimals for utility operations - collateralizationRatio, isPositionHealthy for lending calculations - calculateLiquidationAmount for liquidation logic - currentDay helper for time-based tracking - Add PositionLib.sol for lending protocol position management: - HealthStatus enum (Healthy, AtRisk, Liquidatable, BadDebt) - PositionMetrics struct for comprehensive position data - getCollateralizationRatio, getHealthStatus for position health - getAvailableToBorrow, getLiquidationPrice, getValueAtRisk - getWithdrawableCollateral, getRepaymentForTargetRatio - getLiquidationBonus, getMaxLiquidatableAmount, getCollateralToSeize - isLiquidatable, getPositionMetrics for position analysis - Add comprehensive test suites with 48 passing tests including fuzz tests
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces two comprehensive utility libraries designed specifically for DeFi lending protocol calculations, providing reusable, well-tested building blocks for the FiRM protocol.
New Files
src/util/MathLib.solA library providing safe math operations and utilities for DeFi calculations:
min,max,clamp,absDiffsafeDiv(returns 0 on div-by-zero),divUp(rounds up),mulDiv,mulDivUpbpsToDecimal,applyBps,applyPercentageratio,proRata,calculateInterestsafeSub,isWithinTolerance,convertDecimals,currentDaycollateralizationRatio,isPositionHealthy,calculateLiquidationAmountsrc/util/PositionLib.solA library for lending protocol position management:
Healthy,AtRisk,Liquidatable,BadDebtgetCollateralizationRatio,getHealthStatus,isLiquidatablegetAvailableToBorrow,getLiquidationPrice,getValueAtRiskgetWithdrawableCollateral,getRepaymentForTargetRatiogetLiquidationBonus,getMaxLiquidatableAmount,getCollateralToSeizegetPositionMetricsreturning full position analysisTesting
Why This Matters
These libraries provide: