@gearbox-protocol/sdk 3.0.0-next.283 → 3.0.0-next.285

package/lib/gearboxRewards/api.d.ts

@@ -2,6 +2,7 @@ import { NetworkType, SupportedToken } from "@gearbox-protocol/sdk-gov";
 import { Address, PublicClient, WalletClient } from "viem";
 import { PoolData } from "../core/pool";
 import { TokenData } from "../tokens/tokenData";
+import { ExtraRewardApy } from "./apy";
 export interface GearboxExtraMerkleLmReward {
     pool: Address;
     poolToken: Address;
@@ -41,16 +42,15 @@ export interface FarmInfo {
     balance: bigint;
     symbol: SupportedToken;
 }
-type PoolsWithExtraRewardsList = Record<NetworkType, Array<Address>>;
 type ReportHandler = (e: unknown, description?: string) => void;
 export interface GetLmRewardsInfoProps {
     pools: Record<Address, PoolData>;
     tokensList: Record<Address, TokenData>;
     provider: PublicClient;
-    multicallAddress: Address;
-    poolsWithExtraRewards?: PoolsWithExtraRewardsList;
-    network: NetworkType;
-    reportError?: ReportHandler;
+}
+export interface GetExtraRewardsProps {
+    chainId: number;
+    tokensList: Record<Address, TokenData>;
 }
 export interface GetLmRewardsProps {
     baseRewardPoolsInfo: Record<string, FarmInfo>;
@@ -75,10 +75,10 @@ export interface ClaimLmRewardsV3Props {
     signer: WalletClient;
 }
 export declare class GearboxRewardsApi {
-    static getLmRewardsInfo({ pools, provider, multicallAddress, tokensList, poolsWithExtraRewards, network, reportError, }: GetLmRewardsInfoProps): Promise<{
+    static getExtraRewards({ chainId, tokensList }: GetExtraRewardsProps): Promise<Record<`0x${string}`, ExtraRewardApy[]>>;
+    static getLmRewardsInfo({ pools, provider, tokensList, }: GetLmRewardsInfoProps): Promise<{
         rewardPoolsInfo: Record<string, FarmInfo[]>;
         baseRewardPoolsInfo: Record<string, FarmInfo>;
-        extraRewardPoolsInfo: Record<string, FarmInfo[]>;
         rewardPoolsSupply: Record<string, bigint>;
     }>;
     static getLmRewardsV2({ provider, account, currentTokenData, network, airdropDistributorAddress, }: GetLmRewardsProps): Promise<{

package/lib/gearboxRewards/api.js

@@ -9,19 +9,56 @@ const axios_1 = __importDefault(require("axios"));
 const viem_1 = require("viem");
 const endpoint_1 = require("../core/endpoint");
 const types_1 = require("../types");
-const formatter_1 = require("../utils/formatter");
 const math_1 = require("../utils/math");
 const merklAPI_1 = require("./merklAPI");
-const DEFAULT_POOLS_WITH_EXTRA_REWARDS = {
-    Mainnet: [
-        "0x7354EC6E852108411e681D13E11185c3a2567981", // dtBTCV3
-    ],
-    Arbitrum: [],
-    Optimism: [],
-    Base: [],
-};
 class GearboxRewardsApi {
-    static async getLmRewardsInfo({ pools, provider, multicallAddress, tokensList, poolsWithExtraRewards = DEFAULT_POOLS_WITH_EXTRA_REWARDS, network, reportError, }) {
+    static async getExtraRewards({ chainId, tokensList }) {
+        const res = await axios_1.default.get(merklAPI_1.MerkleXYZApi.getGearboxCampaignsUrl());
+        const currentActiveCampaigns = res.data.filter(c => c.status === "LIVE" && c.chainId === chainId);
+        const aprIdsList = currentActiveCampaigns
+            .map(c => 
+        // apr token for campaigns with a single reward is obvious
+        c.aprRecord.breakdowns.length > 1
+            ? c.aprRecord.breakdowns.map(b => {
+                return {
+                    campaignId: c.id,
+                    aprId: b.identifier,
+                };
+            })
+            : [])
+            .flat(1);
+        const aprIdsResponse = await Promise.allSettled(aprIdsList.map(id => axios_1.default.get(merklAPI_1.MerkleXYZApi.getGearboxRewardCampaignUrl(id.aprId))));
+        const aprCampaignByAPRId = aprIdsResponse.reduce((acc, r, i) => {
+            const id = aprIdsList[i].aprId;
+            acc[id] = r.status === "fulfilled" ? r.value.data : undefined;
+            return acc;
+        }, {});
+        const r = currentActiveCampaigns.reduce((acc, campaign) => {
+            const rewardSource = (campaign.tokens[0]?.address || campaign.identifier).toLowerCase();
+            const allRewards = campaign.aprRecord.breakdowns
+                .map((r, i) => {
+                const apy = r.value;
+                const { rewardToken } = aprCampaignByAPRId[r.identifier]?.[0] || {};
+                const tokenRewardsRecord = campaign.rewardsRecord.breakdowns[i]?.token;
+                const { address = tokenRewardsRecord?.address || "" } = rewardToken || {};
+                const tokenLc = address.toLowerCase();
+                const { symbol = rewardToken?.symbol || tokenRewardsRecord?.symbol || "", } = tokensList[tokenLc] || {};
+                const apyObject = {
+                    token: rewardSource,
+                    balance: null,
+                    apy: apy,
+                    rewardToken: tokenLc,
+                    rewardTokenSymbol: symbol,
+                };
+                return apyObject;
+            })
+                .filter(r => r.apy > 0);
+            acc[rewardSource] = [...(acc[rewardSource] || []), ...allRewards];
+            return acc;
+        }, {});
+        return r;
+    }
+    static async getLmRewardsInfo({ pools, provider, tokensList, }) {
         const poolByStakedDiesel = Object.values(pools).reduce((acc, p) => {
             p.stakedDieselToken.forEach(t => {
                 if (t)
@@ -40,15 +77,6 @@ class GearboxRewardsApi {
         const poolByItsToken = { ...poolByStakedDiesel, ...poolByDiesel };
         const poolStakedTokens = sdk_gov_1.TypedObjectUtils.keys(poolByStakedDiesel);
         const allPoolTokens = sdk_gov_1.TypedObjectUtils.keys(poolByItsToken);
-        const chainId = sdk_gov_1.CHAINS[network];
-        const poolTokensWithExtraReward = (poolsWithExtraRewards[network] || []).filter(p => {
-            const token = tokensList[p.toLowerCase()];
-            if (!token) {
-                console.error(`Pool token not found ${p}`);
-                return false;
-            }
-            return true;
-        });
         const farmInfoCalls = poolStakedTokens.map(address => ({
             address,
             abi: types_1.iFarmingPoolAbi,
@@ -67,34 +95,13 @@ class GearboxRewardsApi {
             functionName: "rewardsToken",
             args: [],
         }));
-        const [mc, ...extra] = await Promise.allSettled([
-            provider.multicall({
-                allowFailure: false,
-                multicallAddress: sdk_gov_1.MULTICALL_ADDRESS,
-                contracts: [
-                    {
-                        address: multicallAddress,
-                        abi: types_1.iMulticall3Abi,
-                        functionName: "getCurrentBlockTimestamp",
-                        args: [],
-                    },
-                    ...farmInfoCalls,
-                    ...farmSupplyCalls,
-                    ...rewardTokenCalls,
-                ],
-            }),
-            ...poolTokensWithExtraReward.map(t => {
-                return axios_1.default.get(merklAPI_1.MerkleXYZApi.getRewardsCampaignsUrl({
-                    params: {
-                        chainId,
-                        mainParameter: (0, viem_1.getAddress)(t),
-                    },
-                }));
-            }),
-        ]);
-        const mcResponse = this.extractFulfilled(mc, reportError, "rewardsInfoMulticall") || [];
-        const [ts = 0n, ...restMCResponse] = mcResponse;
-        const blockTimestamp = ts || 0n;
+        const mc = await provider.multicall({
+            allowFailure: false,
+            multicallAddress: sdk_gov_1.MULTICALL_ADDRESS,
+            contracts: [...farmInfoCalls, ...farmSupplyCalls, ...rewardTokenCalls],
+        });
+        const mcResponse = mc;
+        const [...restMCResponse] = mcResponse;
         const farmInfoCallsEnd = farmInfoCalls.length;
         const farmInfo = restMCResponse.slice(0, farmInfoCallsEnd);
         const farmSupplyCallsEnd = farmInfoCallsEnd + farmSupplyCalls.length;
@@ -114,34 +121,6 @@ class GearboxRewardsApi {
             }
             return acc;
         }, {});
-        const extraRewards = extra.reduce((acc, r, index) => {
-            const p = poolTokensWithExtraReward[index].toLowerCase();
-            const safeResp = this.extractFulfilled(r, reportError, `merkleCampaign: ${p}`);
-            const l = safeResp?.data.reduce((infos, d) => {
-                const started = (0, sdk_gov_1.toBigInt)(d.startTimestamp || 0);
-                const finished = (0, sdk_gov_1.toBigInt)(d.endTimestamp || 0);
-                if (blockTimestamp >= started && blockTimestamp <= finished) {
-                    const rewardTokenLc = (d.rewardToken || "").toLowerCase();
-                    const rewardTokenData = tokensList[rewardTokenLc];
-                    const reward = (0, formatter_1.toBN)(d.amountDecimal, rewardTokenData?.decimals || 18);
-                    if (rewardTokenData && reward > 0) {
-                        infos.push({
-                            pool: poolByItsToken[p],
-                            duration: (0, sdk_gov_1.toBigInt)(d.endTimestamp - d.startTimestamp),
-                            finished,
-                            reward,
-                            balance: 0n,
-                            symbol: rewardTokenData.symbol,
-                        });
-                    }
-                }
-                return infos;
-            }, []);
-            if (l) {
-                acc[p] = l;
-            }
-            return acc;
-        }, {});
         const stakedTokenRewards = allPoolTokens.reduce((acc, pool) => {
             const info = infoByPool[pool];
             const token = rewardTokenPool[pool];
@@ -156,13 +135,11 @@ class GearboxRewardsApi {
                     symbol: tokenData.symbol,
                 }
                 : undefined;
-            const extra = extraRewards[pool] || [];
             if (baseReward)
                 acc.base[pool] = baseReward;
-            acc.extra[pool] = extra;
-            acc.all[pool] = [...(baseReward ? [baseReward] : []), ...extra];
+            acc.all[pool] = [...(baseReward ? [baseReward] : [])];
             return acc;
-        }, { base: {}, extra: {}, all: {} });
+        }, { base: {}, all: {} });
         const rewardPoolsSupply = allPoolTokens.reduce((acc, address, i) => {
             acc[address] = farmSupply[i] || 0n;
             return acc;
@@ -170,7 +147,6 @@ class GearboxRewardsApi {
         return {
             rewardPoolsInfo: stakedTokenRewards.all,
             baseRewardPoolsInfo: stakedTokenRewards.base,
-            extraRewardPoolsInfo: stakedTokenRewards.extra,
             rewardPoolsSupply,
         };
     }

package/lib/gearboxRewards/apy.d.ts

@@ -21,7 +21,8 @@ export interface ExtraRewardApy {
     token: Address;
     balance: bigint | null;
     apy: number;
-    rewardInfo: FarmInfo;
+    rewardToken: Address;
+    rewardTokenSymbol: string;
 }
 interface GetPoolExtraAPY_V3Props {
     stakedDieselToken: Address | undefined;

package/lib/gearboxRewards/apy.js

@@ -47,7 +47,8 @@ class GearboxRewardsApy {
             token: stakedDieselToken,
             balance: null,
             apy: r,
-            rewardInfo: rewardPoolsInfo,
+            rewardToken: rewardAddress,
+            rewardTokenSymbol: rewardPoolsInfo.symbol,
         };
     }
     static calculateAPY_V3({ info, supply, reward, currentTimestamp, }) {
@@ -103,7 +104,13 @@ class GearboxRewardsApy {
                 decimals: rewardDecimals,
             },
         }) / Number(sdk_gov_1.PERCENTAGE_FACTOR);
-        return { token, balance, rewardInfo, apy: r };
+        return {
+            token,
+            balance,
+            apy: r,
+            rewardToken: rewardAddress,
+            rewardTokenSymbol: rewardInfo.symbol,
+        };
     }
 }
 exports.GearboxRewardsApy = GearboxRewardsApy;

package/lib/gearboxRewards/merklAPI.d.ts

@@ -1,3 +1,4 @@
+import { Address } from "viem";
 import { BigNumberish } from "../utils/formatter";
 interface UserOptions {
     params: {
@@ -18,26 +19,109 @@ export interface MerkleXYZUserRewards {
     unclaimed: BigNumberish;
 }
 export type MerkleXYZUserRewardsResponse = Record<string, MerkleXYZUserRewards>;
-interface CampaignsOptions {
-    params: {
-        chainId: number;
-        mainParameter?: string;
-        rewardToken?: string;
+interface MerkleXYZChain {
+    id: number;
+    name: string;
+    icon: string;
+}
+interface MerkleXYZToken {
+    id: string;
+    name: string;
+    chainId: number;
+    address: Address;
+    decimals: number;
+    icon: string;
+    verified: boolean;
+    isTest: boolean;
+    price: number | null;
+    symbol: string;
+}
+export interface MerklXYZV4Campaign {
+    chainId: number;
+    type: string;
+    identifier: Address;
+    name: string;
+    status: "LIVE" | "PAST";
+    action: "LEND" | "BORROW";
+    tvl: number;
+    apr: number;
+    dailyRewards: number;
+    tags: Array<string>;
+    id: string;
+    tokens: Array<MerkleXYZToken>;
+    chain: MerkleXYZChain;
+    aprRecord: {
+        cumulated: number;
+        timestamp: string;
+        breakdowns: Array<{
+            id: number;
+            identifier: Address;
+            type: "CAMPAIGN";
+            value: number;
+            aprRecordId: string;
+        }>;
+    };
+    tvlRecord: {
+        id: string;
+        total: number;
+        timestamp: string;
+        breakdowns: [];
+    };
+    rewardsRecord: {
+        id: string;
+        total: number;
+        timestamp: string;
+        breakdowns: Array<{
+            token: MerkleXYZToken;
+            amount: string;
+            id: number;
+            value: number;
+            campaignId: string;
+            dailyRewardsRecordid: string;
+        }>;
     };
 }
-interface Campaign {
-    amountDecimal: string;
-    campaignId: string;
-    campaignType: number;
-    endTimestamp: number;
-    rewardToken: string;
-    rewardTokenSymbol: string;
-    startTimestamp: number;
+export type MerkleXYZV4CampaignsResponse = Array<MerklXYZV4Campaign>;
+export interface MerklXYZV4RewardCampaign {
+    id: string;
+    computeChainId: number;
+    distributionChainId: number;
+    campaignId: Address;
+    rewardTokenId: string;
+    amount: string;
+    opportunityId: string;
+    startTimestamp: string;
+    endTimestamp: string;
+    creatorAddress: Address;
+    params: {
+        url: string;
+        duration: number;
+        blacklist: Array<Address>;
+        whitelist: Array<Address>;
+        forwarders: Array<Address>;
+        targetToken: Address;
+        symbolRewardToken: string;
+        symbolTargetToken: string;
+        decimalsRewardToken: number;
+        decimalsTargetToken: number;
+    };
+    chain: MerkleXYZChain;
+    rewardToken: MerkleXYZToken;
+    distributionChain: MerkleXYZChain;
+    campaignStatus: {
+        campaignId: string;
+        computedUntil: string;
+        processingStarted: string;
+        status: "SUCCESS";
+        error: string;
+        details: string;
+    };
 }
-export type MerkleXYZRewardsCampaignsResponse = Array<Campaign>;
+export type MerkleXYZV4RewardCampaignResponse = Array<MerklXYZV4RewardCampaign>;
 export declare class MerkleXYZApi {
     static domain: string;
     static getUserRewardsUrl: (options: UserOptions) => string;
-    static getRewardsCampaignsUrl: (options: CampaignsOptions) => string;
+    static getGearboxCampaignsUrl: () => string;
+    static getGearboxRewardCampaignUrl: (campaignId: Address) => string;
 }
 export {};

package/lib/gearboxRewards/merklAPI.js

@@ -6,6 +6,7 @@ const endpoint_1 = require("../core/endpoint");
 class MerkleXYZApi {
     static domain = "https://api.merkl.xyz/v3";
     static getUserRewardsUrl = (options) => endpoint_1.URLApi.getRelativeUrl([this.domain, "userRewards"].join("/"), options);
-    static getRewardsCampaignsUrl = (options) => endpoint_1.URLApi.getRelativeUrl([this.domain, "campaignsForMainParameter"].join("/"), options);
+    static getGearboxCampaignsUrl = () => "https://api.merkl.xyz/v4/opportunities?name=gearbox";
+    static getGearboxRewardCampaignUrl = (campaignId) => `https://api.merkl.xyz/v4/campaigns?campaignId=${campaignId}`;
 }
 exports.MerkleXYZApi = MerkleXYZApi;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "3.0.0-next.283",
+  "version": "3.0.0-next.285",
   "description": "Gearbox SDK",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",