Add rewards field to HyperdriveConfig (#1695)

DannyDelott · web-flow · commit c611a59d91f9 · 2024-12-19T09:14:19.000-08:00
* Add rewards to HyperdriveConfig

* Fix type

* Remove stray
diff --git a/apps/hyperdrive-trading/src/ui/hyperdrive/hooks/useUnpausedPools.ts b/apps/hyperdrive-trading/src/ui/hyperdrive/hooks/useUnpausedPools.ts
@@ -39,7 +39,9 @@ export function useUnpausedPools(): {
       params: { chainId: connectedChainId },
     }),
     queryFn: async () => {
-      const unpausedPools: (HyperdriveConfig & { rewards: AnyReward[] })[] = (
+      const unpausedPools: (HyperdriveConfig & {
+        rewardsAmount: AnyReward[];
+      })[] = (
         await Promise.all(
           appConfigForConnectedChain.hyperdrives
             .filter((hyperdrive) => !HIDDEN_POOLS.includes(hyperdrive.address))
@@ -70,7 +72,7 @@ export function useUnpausedPools(): {
                 ? []
                 : await rewardsFn(publicClient).catch(() => []);
 
-              return { ...hyperdrive, rewards };
+              return { ...hyperdrive, rewardsAmount: rewards };
             }),
         )
       ).filter((pool) => !!pool);
diff --git a/apps/hyperdrive-trading/src/ui/markets/PointsMarkets/PointsMarkets.tsx b/apps/hyperdrive-trading/src/ui/markets/PointsMarkets/PointsMarkets.tsx
@@ -41,7 +41,7 @@ export function PointsMarkets(): ReactElement | null {
   // Only show pools that have a points reward type
   const poolsWithPoints = pools
     ? pools.filter((pool) =>
-        pool.rewards?.find(({ type }) => type === "pointMultiplier"),
+        pool.rewardsAmount?.find(({ type }) => type === "pointMultiplier"),
       )
     : [];
 
diff --git a/apps/hyperdrive-trading/src/ui/markets/hooks/usePoolsList.ts b/apps/hyperdrive-trading/src/ui/markets/hooks/usePoolsList.ts
@@ -50,7 +50,7 @@ export function usePoolsList({
   selectedAssets: string[] | undefined;
   selectedChains: number[] | undefined;
 }): {
-  pools: (HyperdriveConfig & { rewards?: AnyReward[] })[] | undefined;
+  pools: (HyperdriveConfig & { rewardsAmount?: AnyReward[] })[] | undefined;
   filters: PoolListFilters | undefined;
   status: QueryStatus;
   isSortingEnabled: boolean;
diff --git a/packages/hyperdrive-appconfig/src/appconfig/getAppConfig.ts b/packages/hyperdrive-appconfig/src/appconfig/getAppConfig.ts
@@ -77,6 +77,10 @@ const hyperdriveKindResolvers: Record<
         isBaseTokenWithdrawalEnabled: false,
         isShareTokenWithdrawalEnabled: true,
       },
+      rewards: {
+        short: ["fetchLineaRewards"],
+        lp: ["fetchLineaRewards"],
+      },
       earliestBlock,
     });
   },
@@ -93,6 +97,10 @@ const hyperdriveKindResolvers: Record<
         isBaseTokenDepositEnabled: false,
         isShareTokenDepositsEnabled: true,
       },
+      rewards: {
+        short: ["fetchLineaRewards"],
+        lp: ["fetchLineaRewards"],
+      },
       withdrawalOptions: {
         isBaseTokenWithdrawalEnabled: false,
         isShareTokenWithdrawalEnabled: true,
@@ -139,6 +147,10 @@ const hyperdriveKindResolvers: Record<
         isBaseTokenDepositEnabled: true,
         isShareTokenDepositsEnabled: true,
       },
+      rewards: {
+        short: ["fetchEtherfiRewards"],
+        lp: ["fetchEtherfiRewards"],
+      },
       withdrawalOptions: {
         isBaseTokenWithdrawalEnabled: false,
         isShareTokenWithdrawalEnabled: true,
@@ -218,6 +230,10 @@ const hyperdriveKindResolvers: Record<
           isBaseTokenWithdrawalEnabled: true,
           isShareTokenWithdrawalEnabled: true,
         },
+        rewards: {
+          short: ["fetchGyroscopeRewards"],
+          lp: ["fetchGyroscopeRewards"],
+        },
         earliestBlock,
       });
     }
@@ -354,6 +370,10 @@ const hyperdriveKindResolvers: Record<
           isShareTokenWithdrawalEnabled: true,
         },
         tokenPlaces: 4,
+        rewards: {
+          short: ["fetchMorphoMwethRewards"],
+          lp: ["fetchMorphoMwethRewards"],
+        },
       });
     }
 
@@ -373,6 +393,10 @@ const hyperdriveKindResolvers: Record<
           isShareTokenWithdrawalEnabled: true,
         },
         tokenPlaces: 2,
+        rewards: {
+          short: ["fetchMorphoMwusdcRewards"],
+          lp: ["fetchMorphoMwusdcRewards"],
+        },
       });
     }
 
@@ -392,6 +416,10 @@ const hyperdriveKindResolvers: Record<
           isShareTokenWithdrawalEnabled: true,
         },
         tokenPlaces: 2,
+        rewards: {
+          short: ["fetchMorphoMweurcRewards"],
+          lp: ["fetchMorphoMweurcRewards"],
+        },
       });
     }
 
@@ -465,6 +493,10 @@ const hyperdriveKindResolvers: Record<
         yieldSourceId: "aeroUsdcAero",
         baseTokenPlaces: 9, // aero lp tokens are super small
         baseTokenTags: [],
+        rewards: {
+          short: ["fetchAeroRewards"],
+          lp: ["fetchAeroRewards"],
+        },
       });
     }
     throw new Error(
@@ -536,6 +568,10 @@ const hyperdriveKindResolvers: Record<
         baseTokenIconUrl: USDC_ICON_URL,
         baseTokenPlaces: 2,
         yieldSourceId: "morphoCbethUsdc",
+        rewards: {
+          short: ["fetchMorphoCbethUsdcRewards"],
+          lp: ["fetchMorphoCbethUsdcRewards"],
+        },
       });
     }
 
diff --git a/packages/hyperdrive-appconfig/src/generated/all.appconfig.ts b/packages/hyperdrive-appconfig/src/generated/all.appconfig.ts
diff --git a/packages/hyperdrive-appconfig/src/generated/mainnet.appconfig.ts b/packages/hyperdrive-appconfig/src/generated/mainnet.appconfig.ts
diff --git a/packages/hyperdrive-appconfig/src/generated/testnet.appconfig.ts b/packages/hyperdrive-appconfig/src/generated/testnet.appconfig.ts
diff --git a/packages/hyperdrive-appconfig/src/hyperdrives/HyperdriveConfig.ts b/packages/hyperdrive-appconfig/src/hyperdrives/HyperdriveConfig.ts
@@ -1,4 +1,5 @@
 import { PoolConfig } from "@delvtech/hyperdrive-viem";
+import { rewardFunctions } from "src/rewards/rewards";
 import { YieldSourceId } from "src/yieldSources/types";
 import { Address } from "viem";
 
@@ -40,6 +41,12 @@ export interface HyperdriveConfig {
     isShareTokenWithdrawalEnabled?: boolean;
   };
 
+  rewards?: {
+    long?: (keyof typeof rewardFunctions)[];
+    short?: (keyof typeof rewardFunctions)[];
+    lp?: (keyof typeof rewardFunctions)[];
+  };
+
   poolConfig: PoolConfig;
 
   /**
diff --git a/packages/hyperdrive-appconfig/src/hyperdrives/aero/getAeroHyperdrive.ts b/packages/hyperdrive-appconfig/src/hyperdrives/aero/getAeroHyperdrive.ts
@@ -12,12 +12,14 @@ export async function getAeroLpHyperdrive({
   baseTokenTags,
   baseTokenIconUrl,
   baseTokenPlaces,
+  rewards,
 }: {
   hyperdrive: ReadHyperdrive;
   yieldSourceId: YieldSourceId;
   baseTokenTags: string[];
   baseTokenIconUrl: string;
   baseTokenPlaces: number;
+  rewards?: HyperdriveConfig["rewards"];
 }): Promise<{
   baseTokenConfig: TokenConfig;
   hyperdriveConfig: HyperdriveConfig;
@@ -63,6 +65,10 @@ export async function getAeroLpHyperdrive({
     poolConfig,
   };
 
+  if (rewards) {
+    hyperdriveConfig.rewards = rewards;
+  }
+
   return {
     baseTokenConfig,
     hyperdriveConfig,
diff --git a/packages/hyperdrive-appconfig/src/hyperdrives/custom/getCustomHyperdrive.ts b/packages/hyperdrive-appconfig/src/hyperdrives/custom/getCustomHyperdrive.ts
@@ -19,6 +19,7 @@ interface GetHyperdriveConfigParams {
   tokenPlaces: number;
   sharesTokenTags?: string[];
   baseTokenTags?: string[];
+  rewards?: HyperdriveConfig["rewards"];
 }
 
 export async function getCustomHyperdrive({
@@ -32,6 +33,7 @@ export async function getCustomHyperdrive({
   tokenPlaces,
   sharesTokenTags = [],
   baseTokenTags = [],
+  rewards,
 }: GetHyperdriveConfigParams): Promise<{
   sharesTokenConfig: TokenConfig;
   baseTokenConfig: TokenConfig;
@@ -82,6 +84,10 @@ export async function getCustomHyperdrive({
     poolConfig,
   };
 
+  if (rewards) {
+    hyperdriveConfig.rewards = rewards;
+  }
+
   return {
     sharesTokenConfig,
     baseTokenConfig,
diff --git a/packages/hyperdrive-appconfig/src/hyperdrives/morpho/getMorphoHyperdrive.ts b/packages/hyperdrive-appconfig/src/hyperdrives/morpho/getMorphoHyperdrive.ts
@@ -12,12 +12,14 @@ export async function getMorphoHyperdrive({
   baseTokenTags,
   baseTokenIconUrl,
   baseTokenPlaces,
+  rewards,
 }: {
   hyperdrive: ReadHyperdrive;
   yieldSourceId: YieldSourceId;
   baseTokenTags: string[];
   baseTokenIconUrl: string;
   baseTokenPlaces: number;
+  rewards?: HyperdriveConfig["rewards"];
 }): Promise<{
   baseTokenConfig: TokenConfig;
   hyperdriveConfig: HyperdriveConfig;
@@ -65,6 +67,10 @@ export async function getMorphoHyperdrive({
     poolConfig,
   };
 
+  if (rewards) {
+    hyperdriveConfig.rewards = rewards;
+  }
+
   return {
     baseTokenConfig,
     hyperdriveConfig,
diff --git a/packages/hyperdrive-appconfig/src/index.ts b/packages/hyperdrive-appconfig/src/index.ts
@@ -30,7 +30,7 @@ export type { TokenConfig } from "src/tokens/types";
 export type { YieldSourceConfig, YieldSourceId } from "src/yieldSources/types";
 
 // rewards
-export { getRewardsFn } from "src/rewards/selectors";
+export { getRewardsFn, getRewardsFn2 } from "src/rewards/selectors";
 export type {
   AnyReward,
   ApyReward,
diff --git a/packages/hyperdrive-appconfig/src/rewards/selectors.ts b/packages/hyperdrive-appconfig/src/rewards/selectors.ts
@@ -6,6 +6,8 @@ import { YieldSourceId } from "src/yieldSources/types";
 /**
  * Find the rewards resolver for a given yield source. This will return
  * `undefined` if no rewards function exists for this yield source.
+ *
+ * @deprecated rewards have moved to HyperdriveConfig
  */
 export function getRewardsFn({
   yieldSourceId,
@@ -20,3 +22,11 @@ export function getRewardsFn({
   }
   return rewardFunctions[yieldSource.rewardsFn];
 }
+
+export function getRewardsFn2({
+  rewardFn,
+}: {
+  rewardFn: keyof typeof rewardFunctions;
+}): RewardsResolver | undefined {
+  return rewardFunctions[rewardFn];
+}
diff --git a/packages/hyperdrive-appconfig/src/yieldSources/types.ts b/packages/hyperdrive-appconfig/src/yieldSources/types.ts
@@ -47,5 +47,8 @@ export interface YieldSourceConfig {
    * used to calculate LP APY and Yield Source APYs.
    */
   historicalRatePeriod: number;
+  /**
+   * @deprecated rewards has moved to HyperdriveConfig
+   */
   rewardsFn?: keyof typeof rewardFunctions;
 }

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ export function PointsMarkets(): ReactElement \| null {`
`41`	`41`	`// Only show pools that have a points reward type`
`42`	`42`	`const poolsWithPoints = pools`
`43`	`43`	`? pools.filter((pool) =>`
`44`		`- pool.rewards?.find(({ type }) => type === "pointMultiplier"),`
	`44`	`+ pool.rewardsAmount?.find(({ type }) => type === "pointMultiplier"),`
`45`	`45`	`)`
`46`	`46`	`: [];`
`47`	`47`