Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update appconfig generation script to use new reward system #1741

Merged
merged 6 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions apps/hyperdrive-trading/src/hyperdrive/getLpApy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Block } from "@delvtech/drift";
import { fixed } from "@delvtech/fixed-point-wasm";
import {
appConfig,
getAddLiquidityRewardResolverIds,
getAddLiquidityRewardConfigs,
getYieldSource,
HyperdriveConfig,
} from "@delvtech/hyperdrive-appconfig";
Expand Down Expand Up @@ -84,19 +84,19 @@ export async function getLpApy({
netLpApy = lpApy;

// Add rewards APY if available
const resolverIds = getAddLiquidityRewardResolverIds({
const rewardConfigs = getAddLiquidityRewardConfigs({
hyperdriveAddress: hyperdrive.address,
chainId: hyperdrive.chainId,
appConfig,
});

if (resolverIds?.length) {
if (rewardConfigs?.length) {
const rewards = (
await Promise.all(
resolverIds.map((resolverId) =>
rewardConfigs.map((rewardConfig) =>
queryClient.fetchQuery(
getRewardResolverQuery({
resolverId,
rewardConfig,
chainId: hyperdrive.chainId,
}),
),
Expand Down
10 changes: 5 additions & 5 deletions apps/hyperdrive-trading/src/rewards/getYieldSourceRate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
AppConfig,
getHyperdriveConfig,
getYieldSource,
getYieldSourceRewardResolverIds,
getYieldSourceRewardConfigs,
HyperdriveConfig,
} from "@delvtech/hyperdrive-appconfig";
import { ReadHyperdrive } from "@delvtech/hyperdrive-js";
Expand Down Expand Up @@ -92,19 +92,19 @@ async function calcNetRate(
) {
let netRate = rate;

const resolverIds = getYieldSourceRewardResolverIds({
const rewardConfigs = getYieldSourceRewardConfigs({
yieldSourceId: hyperdrive.yieldSource,
chainId: hyperdrive.chainId,
appConfig,
});

if (resolverIds) {
if (rewardConfigs?.length) {
const rewards = await Promise.all(
resolverIds.map((resolverId) =>
rewardConfigs.map((rewardConfig) =>
queryClient.fetchQuery(
getRewardResolverQuery({
chainId: hyperdrive.chainId,
resolverId,
rewardConfig,
}),
),
),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
AnyReward,
appConfig,
getAddLiquidityRewardResolverIds,
getAddLiquidityRewardConfigs,
HyperdriveConfig,
} from "@delvtech/hyperdrive-appconfig";
import { getHyperdrive } from "@delvtech/hyperdrive-js";
Expand Down Expand Up @@ -57,20 +57,20 @@ export function useUnpausedPools(): {

// Resolve the rewards information and include it for consumers
// Add rewards APY if available
const resolverIds = getAddLiquidityRewardResolverIds({
const rewardConfigs = getAddLiquidityRewardConfigs({
hyperdriveAddress: hyperdrive.address,
chainId: hyperdrive.chainId,
appConfig,
});

const rewards = !resolverIds?.length
const rewards = !rewardConfigs?.length
? []
: (
await Promise.all(
resolverIds.map((resolverId) =>
rewardConfigs.map((rewardConfig) =>
queryClient.fetchQuery(
getRewardResolverQuery({
resolverId,
rewardConfig,
chainId: hyperdrive.chainId,
}),
),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
import {
AnyReward,
getRewardsResolver,
RewardResolverId,
} from "@delvtech/hyperdrive-appconfig";
import { AnyReward, RewardConfig } from "@delvtech/hyperdrive-appconfig";
import { UseQueryOptions } from "@tanstack/react-query";
import { getPublicClient } from "@wagmi/core";
import { makeQueryKey2 } from "src/base/makeQueryKey";
Expand All @@ -24,31 +20,27 @@ import { PublicClient } from "viem";
* ```
*/
export function getRewardResolverQuery({
resolverId,
rewardConfig,
chainId,
}: {
chainId: number;
resolverId: RewardResolverId;
rewardConfig: RewardConfig;
}): UseQueryOptions<AnyReward[]> {
const resolver = getRewardsResolver({ resolverId });
const queryEnabled = !!resolver;
return {
queryKey: makeQueryKey2({
namespace: "rewards",
queryId: "rewardResolver",
params: {
resolverId,
rewardConfigId: rewardConfig.id,
chainId: chainId,
},
}),
enabled: queryEnabled,
staleTime: Infinity,
queryFn: queryEnabled
? async () => {
const publicClient = getPublicClient(wagmiConfig as any, {
chainId,
}) as PublicClient;
return resolver(publicClient);
}
: undefined,
queryFn: async () => {
const publicClient = getPublicClient(wagmiConfig as any, {
chainId,
}) as PublicClient;
return rewardConfig.resolver(publicClient);
},
};
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
AnyReward,
appConfig,
getAddLiquidityRewardResolverIds,
getAddLiquidityRewardConfigs,
HyperdriveConfig,
} from "@delvtech/hyperdrive-appconfig";
import { useQuery } from "@tanstack/react-query";
Expand All @@ -19,13 +19,13 @@ export function useAddLiquidityRewards({
rewards: AnyReward[] | undefined;
status: "error" | "success" | "loading";
} {
const resolverIds = getAddLiquidityRewardResolverIds({
const rewardConfigs = getAddLiquidityRewardConfigs({
hyperdriveAddress: hyperdriveConfig.address,
chainId: hyperdriveConfig.chainId,
appConfig,
});

const queryEnabled = !!resolverIds?.length && enabled;
const queryEnabled = !!rewardConfigs?.length && enabled;
const { data: rewards, status } = useQuery({
queryKey: makeQueryKey2({
namespace: "rewards",
Expand All @@ -42,10 +42,10 @@ export function useAddLiquidityRewards({
// TODO: We might be re-inventing useQueries here..
return (
await Promise.all(
resolverIds.map((resolver) =>
rewardConfigs.map((rewardConfig) =>
queryClient.fetchQuery(
getRewardResolverQuery({
resolverId: resolver,
rewardConfig,
chainId: hyperdriveConfig.chainId,
}),
),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
AnyReward,
appConfig,
getOpenShortRewardResolverIds,
getOpenShortRewardConfigs,
HyperdriveConfig,
} from "@delvtech/hyperdrive-appconfig";
import { useQuery } from "@tanstack/react-query";
Expand All @@ -19,13 +19,13 @@ export function useOpenShortRewards({
rewards: AnyReward[] | undefined;
status: "error" | "success" | "loading";
} {
const resolverIds = getOpenShortRewardResolverIds({
const rewardConfigs = getOpenShortRewardConfigs({
hyperdriveAddress: hyperdriveConfig.address,
chainId: hyperdriveConfig.chainId,
appConfig,
});

const queryEnabled = !!resolverIds?.length && enabled;
const queryEnabled = !!rewardConfigs?.length && enabled;
const { data: rewards, status } = useQuery({
queryKey: makeQueryKey2({
namespace: "rewards",
Expand All @@ -42,10 +42,10 @@ export function useOpenShortRewards({
// TODO: We might be re-inventing useQueries here..
return (
await Promise.all(
resolverIds.map((resolver) =>
rewardConfigs.map((rewardConfig) =>
queryClient.fetchQuery(
getRewardResolverQuery({
resolverId: resolver,
rewardConfig,
chainId: hyperdriveConfig.chainId,
}),
),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
AnyReward,
appConfig,
getYieldSourceRewardResolverIds,
getYieldSourceRewardConfigs,
YieldSourceId,
} from "@delvtech/hyperdrive-appconfig";
import { useQuery } from "@tanstack/react-query";
Expand All @@ -21,13 +21,13 @@ export function useYieldSourceRewards({
rewards: AnyReward[] | undefined;
status: "error" | "success" | "loading";
} {
const resolverIds = getYieldSourceRewardResolverIds({
const rewardConfigs = getYieldSourceRewardConfigs({
yieldSourceId,
chainId,
appConfig,
});

const queryEnabled = !!resolverIds?.length && enabled;
const queryEnabled = !!rewardConfigs?.length && enabled;
const { data: rewards, status } = useQuery({
queryKey: makeQueryKey2({
namespace: "rewards",
Expand All @@ -44,10 +44,10 @@ export function useYieldSourceRewards({
// TODO: We might be re-inventing useQueries here..
return (
await Promise.all(
resolverIds.map((resolver) =>
rewardConfigs.map((rewardConfig) =>
queryClient.fetchQuery(
getRewardResolverQuery({
resolverId: resolver,
rewardConfig,
chainId,
}),
),
Expand Down
8 changes: 3 additions & 5 deletions apps/hyperdrive-trading/src/ui/rewards/queryKeys.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
import {
RewardResolverId,
YieldSourceId,
} from "@delvtech/hyperdrive-appconfig";
import { RewardConfigId, YieldSourceId } from "@delvtech/hyperdrive-appconfig";
import "src/base/makeQueryKey";
import { Address } from "viem";

Expand All @@ -15,7 +12,8 @@ interface RewardsQueryKeys {
};

rewardResolver: {
resolverId: RewardResolverId;
rewardConfigId: RewardConfigId;
chainId: number;
};

// TODO: We may not need these as these queries are just list wrappers around
Expand Down
4 changes: 2 additions & 2 deletions packages/hyperdrive-appconfig/src/appconfig/AppConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { ChainConfig, ChainId } from "src/chains/chains";
import { HyperdriveConfig } from "src/hyperdrives/HyperdriveConfig";
import { protocols } from "src/protocols";
import { AnyRewardId } from "src/rewards/actions/types";
import { RewardResolverId } from "src/rewards/resolvers";
import { RewardConfigId } from "src/rewards/resolvers";
import { TokenConfig } from "src/tokens/types";
import { yieldSources } from "src/yieldSources/yieldSources";
import { ZapConfig } from "src/zaps/ZapsConfig";
Expand All @@ -19,5 +19,5 @@ export interface AppConfig {
protocols: typeof protocols;
yieldSources: typeof yieldSources;
zaps: Record<ChainId, ZapConfig>;
rewards: Record<AnyRewardId, RewardResolverId[]>;
rewards: Record<AnyRewardId, RewardConfigId[]>;
}
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import { ReadHyperdrive } from "@delvtech/hyperdrive-viem";
import { HyperdriveConfig } from "src/hyperdrives/HyperdriveConfig";
import { AnyRewardId } from "src/rewards/actions/types";
import { RewardResolverId } from "src/rewards/resolvers";
import { RewardConfigId } from "src/rewards/resolvers";
import { TokenConfig } from "src/tokens/types";
import { PublicClient } from "viem";

export interface HyperdriveConfigResolverResult {
hyperdriveConfig: HyperdriveConfig;
sharesTokenConfig?: TokenConfig;
baseTokenConfig?: TokenConfig;
rewards?: Record<AnyRewardId, RewardResolverId[]>;
rewards?: Record<AnyRewardId, RewardConfigId[]>;
}

export type HyperdriveConfigResolver = (
Expand Down
Loading
Loading