fix: personal rewards fetching

Author: essserrr

src/sdk/sdk-legacy/gearboxRewards/api.ts

@@ -11,11 +11,10 @@ import { GearboxBackendApi } from "../core/endpoint";
 import type { PoolData_Legacy } from "../core/pool";
 import type { TokenData } from "../tokens/tokenData";
 import { iAirdropDistributorAbi, iFarmingPoolAbi } from "../types";
-import { toBN } from "../utils/formatter";
 import { BigIntMath } from "../utils/math";
 import type { ExtraRewardApy } from "./apy";
 import type {
-  MerkleXYZUserRewardsResponse,
+  MerkleXYZUserRewardsV4Response,
   MerkleXYZV4CampaignsResponse,
   MerkleXYZV4RewardCampaignResponse,
   MerklXYZV4RewardCampaign,
@@ -25,22 +24,34 @@ import { MerkleXYZApi } from "./merklAPI";
 export interface GearboxExtraMerkleLmReward {
   pool: Address;
   poolToken: Address;
+
+  rewardTokenSymbol: string;
+  rewardTokenDecimals: number;
   rewardToken: Address;
   amount: bigint;
+
   type: "extraMerkle";
 }
 export interface GearboxStakedV3LmReward {
   pool: Address;
   poolToken: Address;
+
+  rewardTokenSymbol: string;
+  rewardTokenDecimals: number;
   rewardToken: Address;
   amount: bigint;
+
   type: "stakedV3";
 }
 export interface GearboxMerkleV2LmReward {
   pool?: undefined;
   poolToken?: undefined;
+
+  rewardTokenSymbol: string;
+  rewardTokenDecimals: number;
   rewardToken: Address;
   amount: bigint;
+
   type: "merkleV2";
 }
 
@@ -102,6 +113,8 @@ export interface GetExtraRewardsProps {
 }
 
 export interface GetLmRewardsProps {
+  pools: Array<PoolData_Legacy>;
+
   baseRewardPoolsInfo: Record<string, FarmInfo>;
   currentTokenData: Record<SupportedToken, Address>;
   tokensList: Record<Address, TokenData>;
@@ -387,14 +400,19 @@ export class GearboxRewardsApi {
       {
         amount: availableToClaimV2,
         type: "merkleV2",
+
         rewardToken: currentTokenData.GEAR,
+        rewardTokenDecimals: 18,
+        rewardTokenSymbol: "GEAR",
       },
     ];
 
     return { rewards: rewards };
   }
 
   static async getLmRewardsV3({
+    pools,
+
     baseRewardPoolsInfo,
     currentTokenData,
     tokensList,
@@ -417,7 +435,7 @@ export class GearboxRewardsApi {
           args: [account],
         })),
       }),
-      axios.get<MerkleXYZUserRewardsResponse>(
+      axios.get<MerkleXYZUserRewardsV4Response>(
         MerkleXYZApi.getUserRewardsUrl({
           params: {
             chainId: chains[network].id,
@@ -432,48 +450,77 @@ export class GearboxRewardsApi {
       reportError,
       "v3Rewards",
     ) || []) as Array<bigint>;
-    const merkleXYZLM = this.extractFulfilled(
+    const merkleXYZLm = this.extractFulfilled(
       merkleXYZLMResponse,
       reportError,
       "merkleRewards",
     )?.data;
 
-    const PREFIX = "ERC20";
-    const REWARD_KEYS_RECORD = poolTokens.reduce<Record<string, Address>>(
-      (acc, t) => {
-        const key = [PREFIX, getAddress(t)].join("_");
-        acc[key] = t;
-        return acc;
-      },
-      {},
-    );
-
-    const extraRewards = Object.entries(merkleXYZLM || {}).reduce<
-      Array<GearboxLmReward>
-    >((acc, [k, v]) => {
-      const rewardToken = k.toLowerCase() as Address;
-
-      Object.entries(v.reasons).forEach(([key, reason]) => {
-        const poolToken = REWARD_KEYS_RECORD[key];
-        if (poolToken && tokensList[rewardToken]) {
-          acc.push({
-            pool: baseRewardPoolsInfo[poolToken].pool,
-            poolToken,
-            rewardToken,
-            amount: toBigInt(reason.unclaimed || 0n),
-            type: "extraMerkle",
-          });
-        }
+    const poolByItsToken = Object.values(pools).reduce<
+      Record<Address, Address>
+    >((acc, p) => {
+      p.stakedDieselToken.forEach(t => {
+        if (t) acc[t] = p.address;
       });
+      p.stakedDieselToken_old.forEach(t => {
+        if (t) acc[t] = p.address;
+      });
+
+      acc[p.dieselToken] = p.address;
 
       return acc;
-    }, []);
+    }, {});
+
+    const extraRewards = (merkleXYZLm || []).reduce<Array<GearboxLmReward>>(
+      (acc, chainRewards) => {
+        chainRewards.rewards.forEach(reward => {
+          const rewardToken = reward.token.address.toLowerCase() as Address;
+
+          reward.breakdowns.forEach(reason => {
+            const poolToken = (
+              (reason.reason || "").split("_")[1] || ""
+            ).toLowerCase() as Address;
+
+            const pool = (
+              baseRewardPoolsInfo[poolToken]?.pool ||
+              poolToken ||
+              ""
+            ).toLowerCase() as Address;
+
+            if (poolByItsToken[poolToken] && poolByItsToken[pool]) {
+              const total = toBigInt(reason.amount || 0);
+              const claimed = toBigInt(reason.claimed || 0);
+
+              acc.push({
+                pool,
+                poolToken,
+                rewardToken,
+                rewardTokenSymbol: reward.token.symbol,
+                rewardTokenDecimals: reward.token.decimals || 18,
+                amount: BigIntMath.max(total - claimed, 0n),
+                type: "extraMerkle",
+              });
+            }
+          });
+        });
+
+        return acc;
+      },
+      [],
+    );
 
     const gearboxLmRewards = poolTokens.map((address, i): GearboxLmReward => {
+      const info = baseRewardPoolsInfo[address];
+      const rewardToken = currentTokenData[info.symbol];
+
       return {
-        pool: baseRewardPoolsInfo[address].pool,
+        pool: info.pool,
         poolToken: address,
-        rewardToken: currentTokenData[baseRewardPoolsInfo[address].symbol],
+
+        rewardToken,
+        rewardTokenDecimals: tokensList[rewardToken]?.decimals || 18,
+        rewardTokenSymbol: info.symbol,
+
         amount: gearboxLm[i] || 0n,
         type: "stakedV3",
       };

src/sdk/sdk-legacy/gearboxRewards/merklAPI.ts

@@ -1,33 +1,39 @@
 import type { Address } from "viem";
 
-import { URLApi } from "../core/endpoint";
 import type { BigNumberish } from "../utils/formatter";
 
 interface UserOptions {
   params: {
     user: string;
     chainId: number;
-
-    mainParameter?: string;
-    rewardToken?: string;
   };
 }
 
-export interface MerkleXYZUserRewards {
-  accumulated: BigNumberish;
-  decimals: number;
-  reasons: Record<
-    string,
-    {
-      accumulated: BigNumberish;
-      unclaimed: BigNumberish;
-    }
-  >;
-  symbol: string;
-  unclaimed: BigNumberish;
+export interface MerkleXYZUserRewardsV4 {
+  chain: MerkleXYZChain;
+  rewards: Array<{
+    root: Address;
+    recipient: Address;
+    amount: BigNumberish;
+    claimed: BigNumberish;
+    pending: BigNumberish;
+    proofs: Array<Address>;
+    token: {
+      address: Address;
+      chainId: number;
+      symbol: string;
+      decimals: number;
+    };
+    breakdowns: Array<{
+      reason: string;
+      amount: BigNumberish;
+      claimed: BigNumberish;
+      pending: BigNumberish;
+      campaignId: Address;
+    }>;
+  }>;
 }
-
-export type MerkleXYZUserRewardsResponse = Record<string, MerkleXYZUserRewards>;
+export type MerkleXYZUserRewardsV4Response = Array<MerkleXYZUserRewardsV4>;
 
 interface MerkleXYZChain {
   id: number;
@@ -135,10 +141,8 @@ export type MerkleXYZV4RewardCampaignResponse = Array<MerklXYZV4RewardCampaign>;
 // https://api.merkl.xyz/v3/campaignsForMainParameter?chainId=1&mainParameter=0xE2037090f896A858E3168B978668F22026AC52e7
 
 export class MerkleXYZApi {
-  static domain = "https://api.merkl.xyz/v3";
-
   static getUserRewardsUrl = (options: UserOptions) =>
-    URLApi.getRelativeUrl([this.domain, "userRewards"].join("/"), options);
+    `https://api.merkl.xyz/v4/users/${options.params.user}/rewards?chainId=${options.params.chainId}`;
 
   static getGearboxCampaignsUrl = () =>
     "https://api.merkl.xyz/v4/opportunities?name=gearbox";