Merge pull request #353 from Anchor-Protocol/feature/deposit-apy

More precise apy calc with epoch period.

Author: simke9445

app/src/@anchor-protocol/app-fns/logics/earn/computeApy.ts

@@ -5,14 +5,13 @@ import { computeApr } from './computeApr';
 export function computeApy(
   depositRate: Rate | undefined,
   blocksPerYear: number,
+  epochPeriod: number,
 ): Rate<Big> {
+  const compoundTimes = blocksPerYear / epochPeriod;
+  const perCompound = big(depositRate ?? '0').mul(epochPeriod);
+
   const apy = big(
-    Math.pow(
-      big(depositRate ?? '0')
-        .add(1)
-        .toNumber(),
-      blocksPerYear,
-    ) - 1,
+    Math.pow(perCompound.add(1).toNumber(), compoundTimes) - 1,
   ) as Rate<Big>;
 
   if (apy.toNumber() >= 0.19) {

app/src/@anchor-protocol/app-fns/queries/earn/epochStates.ts

@@ -15,6 +15,10 @@ interface EarnEpochStatesWasmQuery {
     moneyMarket.overseer.EpochState,
     moneyMarket.overseer.EpochStateResponse
   >;
+  overseerConfig: WasmQuery<
+    moneyMarket.overseer.Config,
+    moneyMarket.overseer.ConfigResponse
+  >;
 }
 
 export type EarnEpochStates = WasmQueryData<EarnEpochStatesWasmQuery>;
@@ -45,6 +49,12 @@ export async function earnEpochStatesQuery(
           epoch_state: {},
         },
       },
+      overseerConfig: {
+        contractAddress: overseerContract,
+        query: {
+          config: {},
+        },
+      },
     },
   });
 }

app/src/hooks/useDepositApy.ts

@@ -7,12 +7,14 @@ import { useMemo } from 'react';
 
 export const useDepositApy = () => {
   const { constants } = useAnchorWebapp();
-  const { data: { overseerEpochState } = {} } = useEarnEpochStatesQuery();
+  const { data: { overseerConfig, overseerEpochState } = {} } =
+    useEarnEpochStatesQuery();
 
   return useMemo(() => {
     return computeApy(
       overseerEpochState?.deposit_rate,
       constants.blocksPerYear,
+      overseerConfig?.epoch_period ?? 1,
     );
-  }, [constants.blocksPerYear, overseerEpochState]);
+  }, [constants.blocksPerYear, overseerEpochState, overseerConfig]);
 };

app/src/pages/earn/components/InterestSection.tsx

@@ -28,7 +28,8 @@ export function InterestSection({ className }: InterestSectionProps) {
   const { constants } = useAnchorWebapp();
 
   const { data: { apyHistory } = {} } = useEarnAPYHistoryQuery();
-  const { data: { overseerEpochState } = {} } = useEarnEpochStatesQuery();
+  const { data: { overseerEpochState, overseerConfig } = {} } =
+    useEarnEpochStatesQuery();
 
   const apy = useDepositApy();
 
@@ -41,6 +42,7 @@ export function InterestSection({ className }: InterestSectionProps) {
         value: computeApy(
           DepositRate,
           constants.blocksPerYear,
+          overseerConfig?.epoch_period ?? 1,
         ).toNumber() as Rate<number>,
       }))
       .reverse();
@@ -54,7 +56,13 @@ export function InterestSection({ className }: InterestSectionProps) {
           },
         ]
       : undefined;
-  }, [apyHistory, constants.blocksPerYear, apy, overseerEpochState]);
+  }, [
+    apyHistory,
+    constants.blocksPerYear,
+    apy,
+    overseerEpochState,
+    overseerConfig,
+  ]);
 
   return (
     <Section className={className}>

app/src/queries/earn/useEarnApyProjectionQuery.ts

@@ -68,12 +68,16 @@ const computeNewRate = (
 
   const bound = (rate: Big) => {
     return max(
-      min(rate, computeApy(dyn_rate_max, blocksPerYear)),
-      computeApy(dyn_rate_min, blocksPerYear),
+      min(rate, computeApy(dyn_rate_max, blocksPerYear, config.epoch_period)),
+      computeApy(dyn_rate_min, blocksPerYear, config.epoch_period),
     );
   };
 
-  const currentRate = computeApy(threshold_deposit_rate, blocksPerYear);
+  const currentRate = computeApy(
+    threshold_deposit_rate,
+    blocksPerYear,
+    config.epoch_period,
+  );
 
   if (yr.isHigher) {
     return bound(currentRate.plus(yr.change));