@defisaver/positions-sdk 2.1.142-dev → 2.1.143

package/src/services/merkl.ts

@@ -0,0 +1,31 @@
+import { MerklOpportunity } from '../types';
+import { LONGER_TIMEOUT } from './utils';
+
+const MERKL_OPPORTUNITIES_URL = 'https://fe.defisaver.com/api/merkl/opportunities';
+
+/**
+ * Fetches every page matching the query. Merkl returns 20 opportunities by default, so omitting
+ * `items` and advancing `page` avoids imposing a client-side maximum on the result set.
+ */
+export const fetchAllMerklOpportunities = async (query: Record<string, string>): Promise<MerklOpportunity[]> => {
+  const opportunities: MerklOpportunity[] = [];
+  let page = 0;
+  let pageOpportunities: MerklOpportunity[];
+
+  do {
+    const searchParams = new URLSearchParams({ ...query, page: page.toString() });
+    const res = await fetch(`${MERKL_OPPORTUNITIES_URL}?${searchParams}`, { // eslint-disable-line no-await-in-loop
+      signal: AbortSignal.timeout(LONGER_TIMEOUT),
+    });
+    if (!res.ok) throw new Error(`Failed to fetch Merkl opportunities page ${page}`);
+
+    const data = await res.json(); // eslint-disable-line no-await-in-loop
+    if (!Array.isArray(data)) throw new Error(`Invalid Merkl opportunities response on page ${page}`);
+
+    pageOpportunities = data as MerklOpportunity[];
+    opportunities.push(...pageOpportunities);
+    page += 1;
+  } while (pageOpportunities.length > 0);
+
+  return opportunities;
+};

package/src/types/claiming.ts

@@ -5,6 +5,8 @@ export enum ClaimType {
   AAVE_REWARDS = 'AAVE_REWARDS',
   /** Merit rewards from AAVE (various tokens) */
   AAVE_MERIT_REWARDS = 'AAVE_MERIT_REWARDS',
+  /** Rewards distributed through Merkl across supported protocols */
+  MERKL_REWARDS = 'MERKL_REWARDS',
   /** Rewards from Compound V3 (only in COMP) */
   COMPOUND_V3_COMP = 'COMPOUND_V3_COMP',
   /** Rewards from Spark (wstETH only for now) */
@@ -47,6 +49,16 @@ export type AaveMeritRewardsClaimableToken = _ClaimableTokenPartial & {
   };
 };
 
+export type MerklRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.MERKL_REWARDS;
+  additionalClaimFields: {
+    accumulated: string;
+    proof: string[];
+    decimals: string;
+    unclaimed: string;
+  };
+};
+
 export type SparkRewardsClaimableToken = _ClaimableTokenPartial & {
   claimType: ClaimType.SPARK_REWARDS;
   additionalClaimFields: {
@@ -102,6 +114,7 @@ export type UniswapAirdropClaimableToken = _ClaimableTokenPartial & {
 export type ClaimableToken =
     AaveRewardsClaimableToken
     | AaveMeritRewardsClaimableToken
+    | MerklRewardsClaimableToken
     | CompoundV3CompClaimableToken
     | SparkRewardsClaimableToken
     | KingRewardsClaimableToken

package/src/types/common.ts

@@ -8,6 +8,10 @@ export enum IncentiveSide {
   Borrow = 'borrow',
 }
 
+export enum IncentiveSource {
+  Merkl = 'merkl',
+}
+
 export enum IncentiveEligibilityId {
   AaveV3EthenaLiquidLeverage = '0x0dC599DBB180E64E42b87332FDeC3a551445ea44BORROW_BL',
   AaveV3ArbitrumEthSupply = '0x5d16261c6715a653248269861bbacf68a9774cde',
@@ -29,6 +33,7 @@ export interface IncentiveData {
   token: string,
   apy: string,
   incentiveKind?: IncentiveKind;
+  source?: IncentiveSource;
   description?: string;
   eligibilityId?: IncentiveEligibilityId;
 }

package/src/types/fluid.ts

@@ -340,6 +340,8 @@ export interface FluidAggregatedVaultData {
   leftToBorrowUsd: string,
   netApy: string,
   incentiveUsd: string,
+  merklSupplyIncentives: IncentiveData[],
+  merklBorrowIncentives: IncentiveData[],
   ratio: string,
   collRatio: string,
   minRatio: string,
@@ -484,4 +486,4 @@ export interface FluidFTokenDataStructOutput {
   supplyRate: bigint;
   rewardsRate: bigint;
   withdrawable: bigint;
-}
+}