refactor: remove request from pool math for readability (#51)

Author: sakulstra

packages/math-utils/src/formatters/compounded-interest/calculate-compounded-interest.ts

@@ -9,14 +9,12 @@ export interface CalculateCompoundedInterestRequest {
   lastUpdateTimestamp: number;
 }
 
-export function calculateCompoundedInterest(
-  request: CalculateCompoundedInterestRequest,
-): BigNumber {
-  const timeDelta = valueToZDBigNumber(
-    request.currentTimestamp - request.lastUpdateTimestamp,
-  );
-  const ratePerSecond = valueToZDBigNumber(request.rate).dividedBy(
-    SECONDS_PER_YEAR,
-  );
+export function calculateCompoundedInterest({
+  rate,
+  currentTimestamp,
+  lastUpdateTimestamp,
+}: CalculateCompoundedInterestRequest): BigNumber {
+  const timeDelta = valueToZDBigNumber(currentTimestamp - lastUpdateTimestamp);
+  const ratePerSecond = valueToZDBigNumber(rate).dividedBy(SECONDS_PER_YEAR);
   return binomialApproximatedRayPow(ratePerSecond, timeDelta);
 }

packages/math-utils/src/formatters/incentive/calculate-incentive-apy.ts

@@ -9,13 +9,17 @@ export interface CalculateIncentiveAPYRequest {
   tokenPriceInEth: string;
 }
 
-export function calculateIncentiveAPY(
-  request: CalculateIncentiveAPYRequest,
-): string {
+export function calculateIncentiveAPY({
+  emissionPerSecond,
+  rewardTokenPriceInEth,
+  tokenPriceInEth,
+  totalTokenSupply,
+  decimals,
+}: CalculateIncentiveAPYRequest): string {
   const emissionPerSecondNormalized = normalizeBN(
-    request.emissionPerSecond,
+    emissionPerSecond,
     ETH_DECIMALS,
-  ).multipliedBy(request.rewardTokenPriceInEth);
+  ).multipliedBy(rewardTokenPriceInEth);
 
   if (emissionPerSecondNormalized.eq(0)) {
     return '0';
@@ -26,8 +30,8 @@ export function calculateIncentiveAPY(
   );
 
   const totalSupplyNormalized = valueToBigNumber(
-    normalize(request.totalTokenSupply, request.decimals),
-  ).multipliedBy(request.tokenPriceInEth);
+    normalize(totalTokenSupply, decimals),
+  ).multipliedBy(tokenPriceInEth);
 
   return emissionPerYear.dividedBy(totalSupplyNormalized).toFixed();
 }

packages/math-utils/src/formatters/reserve/index.ts

@@ -48,21 +48,22 @@ export interface ReserveData {
   lastUpdateTimestamp: number;
 }
 
-export function formatReserve(
-  request: FormatReserveRequest,
-): FormatReserveResponse {
+export function formatReserve({
+  reserve,
+  currentTimestamp,
+}: FormatReserveRequest): FormatReserveResponse {
   const calculateReserveDebtResult = calculateReserveDebt(
-    request.reserve,
-    request.currentTimestamp,
+    reserve,
+    currentTimestamp,
   );
 
   const totalLiquidity = calculateTotalLiquidity(
     calculateReserveDebtResult.totalDebt,
-    request.reserve.availableLiquidity,
+    reserve.availableLiquidity,
   );
 
   const normalizeWithReserve = (n: BigNumberValue) =>
-    normalize(n, request.reserve.decimals);
+    normalize(n, reserve.decimals);
 
   return {
     totalVariableDebt: normalizeWithReserve(
@@ -72,48 +73,37 @@ export function formatReserve(
       calculateReserveDebtResult.totalStableDebt,
     ),
     totalLiquidity: normalizeWithReserve(totalLiquidity),
-    availableLiquidity: normalizeWithReserve(
-      request.reserve.availableLiquidity,
-    ),
+    availableLiquidity: normalizeWithReserve(reserve.availableLiquidity),
     utilizationRate: totalLiquidity.eq(0)
       ? '0'
       : valueToBigNumber(calculateReserveDebtResult.totalDebt)
           .dividedBy(totalLiquidity)
           .toFixed(),
     totalDebt: normalizeWithReserve(calculateReserveDebtResult.totalDebt),
-    baseLTVasCollateral: normalize(
-      request.reserve.baseLTVasCollateral,
-      LTV_PRECISION,
-    ),
-    reserveFactor: normalize(request.reserve.reserveFactor, LTV_PRECISION),
-    variableBorrowRate: normalize(
-      request.reserve.variableBorrowRate,
-      RAY_DECIMALS,
-    ),
-    stableBorrowRate: normalize(request.reserve.stableBorrowRate, RAY_DECIMALS),
-    liquidityRate: normalize(request.reserve.liquidityRate, RAY_DECIMALS),
-    liquidityIndex: normalize(request.reserve.liquidityIndex, RAY_DECIMALS),
+    baseLTVasCollateral: normalize(reserve.baseLTVasCollateral, LTV_PRECISION),
+    reserveFactor: normalize(reserve.reserveFactor, LTV_PRECISION),
+    variableBorrowRate: normalize(reserve.variableBorrowRate, RAY_DECIMALS),
+    stableBorrowRate: normalize(reserve.stableBorrowRate, RAY_DECIMALS),
+    liquidityRate: normalize(reserve.liquidityRate, RAY_DECIMALS),
+    liquidityIndex: normalize(reserve.liquidityIndex, RAY_DECIMALS),
     reserveLiquidationThreshold: normalize(
-      request.reserve.reserveLiquidationThreshold,
+      reserve.reserveLiquidationThreshold,
       4,
     ),
     // https://github.com/aave/protocol-v2/blob/baeb455fad42d3160d571bd8d3a795948b72dd85/contracts/protocol/lendingpool/LendingPoolConfigurator.sol#L284
     reserveLiquidationBonus: normalize(
-      valueToBigNumber(request.reserve.reserveLiquidationBonus).minus(
+      valueToBigNumber(reserve.reserveLiquidationBonus).minus(
         10 ** LTV_PRECISION,
       ),
       LTV_PRECISION,
     ),
     totalScaledVariableDebt: normalizeWithReserve(
-      request.reserve.totalScaledVariableDebt,
+      reserve.totalScaledVariableDebt,
     ),
     totalPrincipalStableDebt: normalizeWithReserve(
-      request.reserve.totalPrincipalStableDebt,
-    ),
-    variableBorrowIndex: normalize(
-      request.reserve.variableBorrowIndex,
-      RAY_DECIMALS,
+      reserve.totalPrincipalStableDebt,
     ),
+    variableBorrowIndex: normalize(reserve.variableBorrowIndex, RAY_DECIMALS),
   };
 }