Skip to content
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
13 changes: 13 additions & 0 deletions packages/widget/src/domain/types/yields.ts
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,19 @@ export const getYieldOutputToken = (yieldDto: YieldBase) =>
(outputToken) => !equalTokens(outputToken, yieldDto.token)
);

const hasPositivePricePerShare = (yieldDto: YieldBase) => {
const price = yieldDto.state?.pricePerShareState?.price;

if (price === null || price === undefined) return false;

const amount = BigNumber(price);

return amount.isFinite() && amount.isGreaterThan(0);
};

export const hasYieldBearingOutputToken = (yieldDto: YieldBase) =>
getYieldOutputToken(yieldDto).isJust() && hasPositivePricePerShare(yieldDto);

const isStakingYieldType = (yieldType: ExtendedYieldType) =>
yieldType === "staking" ||
yieldType === "native_staking" ||
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { getEffectiveYieldRewardRateDetails } from "../../../domain/types/r
import {
getDashboardYieldCategory,
getYieldActionArg,
hasYieldBearingOutputToken,
isNonZeroRewardRateYield,
type Yield,
} from "../../../domain/types/yields";
Expand Down Expand Up @@ -138,11 +139,14 @@ export const formatProviderWebsite = (website: string) => {
export const formatProviderWebsiteHref = (website: string) =>
/^https?:\/\//i.test(website) ? website : `https://${website}`;

export const formatRewardTokenLabel = (yieldDto: Yield) => {
const symbol = yieldDto.token.symbol;
export const formatRewardTokenLabel = (
yieldDto: Yield,
t: TFunction
): string => {
const symbol = yieldDto.outputToken?.symbol ?? yieldDto.token.symbol;

return yieldDto.mechanics.rewardClaiming === "auto"
? `${symbol} (PPS-bearing)`
return hasYieldBearingOutputToken(yieldDto)
? t("dashboard.earn_details.yield_bearing_reward_token", { symbol })
: symbol;
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ const getDetailRows = ({
{
id: "reward-token",
label: t("dashboard.earn_details.reward_token"),
value: formatRewardTokenLabel(yieldDto),
value: formatRewardTokenLabel(yieldDto, t),
},
...getPricePerShareRows(yieldDto, t),
...facts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ const getFillerMetric = ({
};
}

const rewardToken = formatRewardTokenLabel(integrationData);
const rewardToken = formatRewardTokenLabel(integrationData, t);

if (rewardToken) {
promotedFactIds.add("reward-token");
Expand Down Expand Up @@ -520,7 +520,7 @@ const getDetailRows = ({
: {
id: "reward-token",
label: t("dashboard.earn_details.reward_token"),
value: formatRewardTokenLabel(integrationData),
value: formatRewardTokenLabel(integrationData, t),
},
pricePerShare
? {
Expand Down
1 change: 1 addition & 0 deletions packages/widget/src/translation/English/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@
"network": "Network",
"provider": "Provider",
"reward_token": "Reward token",
"yield_bearing_reward_token": "{{symbol}} (yield-bearing)",
"price_per_share": "Price per share",
"type": "Type",
"reward_schedule": "Reward schedule",
Expand Down
1 change: 1 addition & 0 deletions packages/widget/src/translation/French/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,7 @@
"network": "Réseau",
"provider": "Fournisseur",
"reward_token": "Token de récompense",
"yield_bearing_reward_token": "{{symbol}} (porteur de rendement)",
"price_per_share": "Prix par part",
"type": "Type",
"reward_schedule": "Fréquence des récompenses",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ import type { Yield } from "../../src/domain/types/yields";
import { getEarnDetailsModel } from "../../src/pages-dashboard/overview/earn-details/earn-details-model";
import { yieldApiYieldFixture } from "../fixtures";

const t = (key: string): string => {
const t = (key: string, options?: Record<string, unknown>): string => {
const translations: Record<string, string> = {
"dashboard.earn_details.min_stake": "Min stake",
"dashboard.earn_details.minimum_subscription": "Minimum subscription",
"dashboard.earn_details.network": "Network",
"dashboard.earn_details.price_per_share": "Price per share",
"dashboard.earn_details.provider": "Provider",
"dashboard.earn_details.reward_token": "Reward token",
"dashboard.earn_details.yield_bearing_reward_token": `${options?.symbol ?? ""} (yield-bearing)`,
};

return translations[key] ?? key;
Expand Down Expand Up @@ -103,4 +104,56 @@ describe("getEarnDetailsModel", () => {
"price-per-share"
);
});

it("does not mark auto-claiming rewards as yield-bearing without price per share", () => {
const model = getEarnDetailsModel({
t: t as TFunction,
yieldDto: makeYield({
outputToken: {
...yieldApiYieldFixture().token,
symbol: "stETH",
},
}),
});

expect(model.detailRows.find((row) => row.id === "reward-token")).toEqual({
id: "reward-token",
label: "Reward token",
value: "stETH",
});
});

it("marks distinct output tokens with price per share as yield-bearing", () => {
const baseYield = yieldApiYieldFixture();
const model = getEarnDetailsModel({
t: t as TFunction,
yieldDto: makeYield({
mechanics: {
...baseYield.mechanics,
rewardClaiming: "manual",
},
outputToken: {
...baseYield.token,
symbol: "mUSDC",
},
state: {
pricePerShareState: {
price: 1.06274537,
quoteToken: baseYield.token,
shareToken: baseYield.token,
},
},
token: {
...baseYield.token,
symbol: "USDC",
},
}),
});

expect(model.detailRows.find((row) => row.id === "reward-token")).toEqual({
id: "reward-token",
label: "Reward token",
value: "mUSDC (yield-bearing)",
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ const t = (key: string, options?: Record<string, unknown>): string => {
"dashboard.earn_details.reward_rate_period": `${options?.rewardType ?? "APY"} (7D)`,
"dashboard.earn_details.reward_schedule": "Reward schedule",
"dashboard.earn_details.reward_token": "Reward token",
"dashboard.earn_details.yield_bearing_reward_token": `${options?.symbol ?? ""} (yield-bearing)`,
"dashboard.earn_details.risk": "Risk",
"dashboard.earn_details.type": "Type",
"dashboard.earn_details.vault": "Vault",
Expand Down Expand Up @@ -325,6 +326,69 @@ describe("getDashboardPositionDetailsModel", () => {
]);
});

it("does not mark auto-claiming position reward tokens as yield-bearing without price per share", () => {
const model = getDashboardPositionDetailsModel({
canUnstake: true,
integrationData: makeYield(),
pendingActions: [],
personalizedRewardRate: null,
positionBalancesByType: makePositionBalances(),
providersDetails: [{ name: "Rocket Pool", status: "active" }],
reducedStakedOrLiquidBalance: null,
rewardsSummary: undefined,
t: t as TFunction,
});

expect(model.detailRows.find((row) => row.id === "reward-token")).toEqual({
id: "reward-token",
label: "Reward token",
value: "rETH",
});
});

it("marks position output tokens with price per share as yield-bearing", () => {
const baseYield = yieldApiYieldFixture();
const model = getDashboardPositionDetailsModel({
canUnstake: true,
integrationData: makeYield({
mechanics: {
...makeYield().mechanics,
rewardClaiming: "manual",
},
outputToken: {
...baseYield.token,
address: "0x0000000000000000000000000000000000000002",
symbol: "mUSDC",
},
state: {
pricePerShareState: {
price: 1.06274537,
quoteToken: baseYield.token,
shareToken: baseYield.token,
},
},
token: {
...baseYield.token,
address: "0x0000000000000000000000000000000000000001",
symbol: "USDC",
},
}),
pendingActions: [],
personalizedRewardRate: null,
positionBalancesByType: makePositionBalances(),
providersDetails: [{ name: "Midas", status: "active" }],
reducedStakedOrLiquidBalance: null,
rewardsSummary: undefined,
t: t as TFunction,
});

expect(model.detailRows.find((row) => row.id === "reward-token")).toEqual({
id: "reward-token",
label: "Reward token",
value: "mUSDC (yield-bearing)",
});
});

it("includes price per share in details when yield state provides it", () => {
const model = getDashboardPositionDetailsModel({
canUnstake: true,
Expand Down