@defisaver/positions-sdk 2.0.15-dev.0 → 2.1.0

package/esm/liquityV2/index.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import Dec from 'decimal.js';
 import { assetAmountInEth, getAssetInfo } from '@defisaver/tokens';
 import { createViemContractFromConfigFunc, LiquityV2LegacyViewContractViem, LiquityV2ViewContractViem, } from '../contracts';
-import { NetworkNumber } from '../types/common';
+import { IncentiveKind, NetworkNumber, } from '../types/common';
 import { LIQUITY_V2_TROVE_STATUS_ENUM, LiquityV2Versions, } from '../types';
 import { getStakingApy, STAKING_ASSETS } from '../staking';
 import { getLiquityV2AggregatedPositionData } from '../helpers/liquityV2Helpers';
@@ -58,6 +58,8 @@ export const _getLiquityV2MarketData = (provider, network, selectedMarket) => __
         canBeBorrowed: true,
         leftToBorrowGlobal,
         leftToWithdrawGlobal: '0',
+        supplyIncentives: [],
+        borrowIncentives: [],
     };
     assetsData[collateralToken] = {
         symbol: collateralToken,
@@ -69,10 +71,16 @@ export const _getLiquityV2MarketData = (provider, network, selectedMarket) => __
         canBeBorrowed: false,
         leftToBorrowGlobal: '0',
         leftToWithdrawGlobal,
+        supplyIncentives: [],
+        borrowIncentives: [],
     };
     if (STAKING_ASSETS.includes(collateralToken)) {
-        assetsData[collateralToken].incentiveSupplyApy = yield getStakingApy(collateralToken);
-        assetsData[collateralToken].incentiveSupplyToken = collateralToken;
+        assetsData[collateralToken].supplyIncentives.push({
+            apy: yield getStakingApy(collateralToken),
+            token: collateralToken,
+            incentiveKind: IncentiveKind.Staking,
+            description: `Native ${collateralToken} yield.`,
+        });
     }
     return {
         assetsData,
@@ -182,40 +190,12 @@ const getAllMarketsUnbackedDebts = (markets, isLegacy, provider, network) => __a
     })));
     return Object.fromEntries(allMarketsUnbackedDebt);
 });
-export const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront) => {
-    // Sanity check to avoid division by 0. Very unlikely to ever happen.
-    const selectedMarketTotalBorrow = new Dec(markets[selectedMarket].assetsData[LiquityV2Markets(NetworkNumber.Eth)[selectedMarket].debtToken].totalBorrow);
-    if (selectedMarketTotalBorrow.eq(0))
-        return new Dec(0).toString();
+const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront) => {
     const selectedMarketUnbackedDebt = new Dec(allMarketsUnbackedDebts[selectedMarket]);
     const { isLegacy } = LiquityV2Markets(NetworkNumber.Eth)[selectedMarket];
-    const totalUnbackedDebt = Object.values(allMarketsUnbackedDebts).reduce((acc, val) => acc.plus(new Dec(val)), new Dec(0));
-    // When totalUnbackedDebt is 0, redemptions will be proportional with the branch size and not to unbacked debt.
-    // When unbacked debt is 0 for branch, next redemption call won't touch that branch, so in order to estimate total debt in front we will:
-    // - First add up all the unbacked debt from other branches, as that will be the only debt that will be redeemed on the fist redemption call
-    // - Perform split the same way as we would do when totalUnbackedDebt == 0, this would represent the second call to the redemption function
-    if (selectedMarketUnbackedDebt.eq(0)) {
-        // Special case if the branch debt in front is 0, it means that all debt in front is unbacked debt from other branches.
-        if (new Dec(interestRateDebtInFront).eq(0))
-            return totalUnbackedDebt.toString();
-        // Then calculate how much of that estimated amount would go to each branch
-        // Second redemption call - calculate proportional redemption based on updated total debt
-        const amountBeingRedeemedOnEachMarketByTotalBorrow = Object.entries(markets).map(([version, market]) => {
-            const { isLegacy: isLegacyMarket } = LiquityV2Markets(NetworkNumber.Eth)[version];
-            if (version === selectedMarket && isLegacyMarket !== isLegacy)
-                return new Dec(interestRateDebtInFront);
-            const { assetsData } = market;
-            const { debtToken } = LiquityV2Markets(NetworkNumber.Eth)[version];
-            // For other markets, subtract their unbacked debt as it will be cleared in first redemption call
-            const marketUnbackedDebt = new Dec(allMarketsUnbackedDebts[version]);
-            const totalBorrow = new Dec(assetsData[debtToken].totalBorrow).sub(marketUnbackedDebt);
-            const amountToRedeem = new Dec(interestRateDebtInFront).mul(totalBorrow).div(selectedMarketTotalBorrow);
-            return Dec.min(amountToRedeem, totalBorrow);
-        });
-        const redemptionAmount = amountBeingRedeemedOnEachMarketByTotalBorrow.reduce((acc, val) => acc.plus(val), new Dec(0));
-        return totalUnbackedDebt.plus(redemptionAmount).toString();
-    }
-    const amountBeingRedeemedOnEachMarketByUnbackedDebt = Object.entries(markets).map(([version, market]) => {
+    if (selectedMarketUnbackedDebt.eq(0))
+        return interestRateDebtInFront;
+    const amountBeingReedemedOnEachMarket = Object.entries(markets).map(([version, market]) => {
         const { isLegacy: isLegacyMarket } = LiquityV2Markets(NetworkNumber.Eth)[version];
         if (version === selectedMarket && isLegacyMarket !== isLegacy)
             return new Dec(interestRateDebtInFront);
@@ -223,24 +203,11 @@ export const calculateDebtInFrontLiquityV2 = (markets, selectedMarket, allMarket
         const { debtToken } = LiquityV2Markets(NetworkNumber.Eth)[version];
         const unbackedDebt = new Dec(allMarketsUnbackedDebts[version]);
         const totalBorrow = new Dec(assetsData[debtToken].totalBorrow);
-        const amountToRedeem = new Dec(interestRateDebtInFront).mul(unbackedDebt).div(selectedMarketUnbackedDebt);
-        return Dec.min(amountToRedeem, totalBorrow);
+        const amountToReedem = new Dec(interestRateDebtInFront).mul(unbackedDebt).div(selectedMarketUnbackedDebt);
+        return Dec.min(amountToReedem, totalBorrow);
     });
-    return amountBeingRedeemedOnEachMarketByUnbackedDebt.reduce((acc, val) => acc.plus(val), new Dec(0)).toString();
+    return amountBeingReedemedOnEachMarket.reduce((acc, val) => acc.plus(val), new Dec(0)).toString();
 };
-// @dev The amount redeemed on each branch depends on the unbacked debt of every branch (the difference between total borrow and stability pool deposits).
-// When new debt is generated on the selected market, the unbacked debt will increase, resulting in a higher redemption amount on that branch.
-// This function accepts the new debt that's about to be generated (e.g., trove creation) and estimates the debt in front based on the new state.
-export const getDebtInFrontForInterestRateIncludingNewDebtLiquityV2 = (newDebt, markets, selectedMarket, provider, network, interestRate) => __awaiter(void 0, void 0, void 0, function* () {
-    const marketsWithNewDebt = structuredClone(markets);
-    const selectedMarketDebtToken = LiquityV2Markets(network)[selectedMarket].debtToken;
-    const currentTotalBorrow = new Dec(marketsWithNewDebt[selectedMarket].assetsData[selectedMarketDebtToken].totalBorrow);
-    marketsWithNewDebt[selectedMarket].assetsData[selectedMarketDebtToken].totalBorrow = currentTotalBorrow.add(newDebt).toString();
-    const { isLegacy } = LiquityV2Markets(NetworkNumber.Eth)[selectedMarket];
-    const allMarketsUnbackedDebts = yield getAllMarketsUnbackedDebts(marketsWithNewDebt, isLegacy, provider, network);
-    const interestRateDebtInFront = new Dec(yield getDebtInFrontForInterestRateSingleMarketLiquityV2(provider, network, isLegacy, LiquityV2Markets(network)[selectedMarket].marketAddress, interestRate));
-    return calculateDebtInFrontLiquityV2(marketsWithNewDebt, selectedMarket, allMarketsUnbackedDebts, interestRateDebtInFront.toString());
-});
 const getDebtInFrontLiquityV2 = (markets, selectedMarket, provider, network, viewContract, troveId) => __awaiter(void 0, void 0, void 0, function* () {
     const { isLegacy } = LiquityV2Markets(NetworkNumber.Eth)[selectedMarket];
     const allMarketsUnbackedDebts = yield getAllMarketsUnbackedDebts(markets, isLegacy, provider, network);

package/esm/llamaLend/index.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import Dec from 'decimal.js';
 import { assetAmountInEth, getAssetInfo } from '@defisaver/tokens';
 import { LlamaLendStatus, } from '../types';
-import { NetworkNumber, } from '../types/common';
+import { IncentiveKind, NetworkNumber, } from '../types/common';
 import { LlamaLendViewContractViem } from '../contracts';
 import { getLlamaLendAggregatedData } from '../helpers/llamaLendHelpers';
 import { getEthAmountForDecimals, wethToEth } from '../services/utils';
@@ -89,6 +89,8 @@ export const _getLlamaLendGlobalData = (provider, network, selectedMarket) => __
         borrowRate,
         canBeSupplied: true,
         canBeBorrowed: true,
+        supplyIncentives: [],
+        borrowIncentives: [],
     };
     assetsData[collAsset] = {
         symbol: collAsset,
@@ -98,10 +100,16 @@ export const _getLlamaLendGlobalData = (provider, network, selectedMarket) => __
         borrowRate: '0',
         canBeSupplied: true,
         canBeBorrowed: false,
+        supplyIncentives: [],
+        borrowIncentives: [],
     };
     if (STAKING_ASSETS.includes(collAsset)) {
-        assetsData[collAsset].incentiveSupplyApy = yield getStakingApy(collAsset);
-        assetsData[collAsset].incentiveSupplyToken = collAsset;
+        assetsData[collAsset].supplyIncentives.push({
+            apy: yield getStakingApy(collAsset),
+            token: collAsset,
+            incentiveKind: IncentiveKind.Staking,
+            description: `Native ${collAsset} yield.`,
+        });
     }
     return {
         A: data.A.toString(),

package/esm/morphoBlue/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import Dec from 'decimal.js';
 import { assetAmountInEth, getAssetInfoByAddress } from '@defisaver/tokens';
-import { NetworkNumber, } from '../types/common';
+import { IncentiveKind, NetworkNumber, } from '../types/common';
 import { DFSFeedRegistryContractViem, FeedRegistryContractViem, MorphoBlueViewContractViem, } from '../contracts';
 import { USD_QUOTE, WAD } from '../constants';
 import { getStakingApy, STAKING_ASSETS } from '../staking';
@@ -77,10 +77,18 @@ export function _getMorphoBlueMarketData(provider, network, selectedMarket) {
             totalBorrow: new Dec(marketInfo.totalBorrowAssets.toString()).div(scale).toString(),
             canBeSupplied: true,
             canBeBorrowed: true,
-            incentiveSupplyApy: morphoSupplyApy,
-            incentiveBorrowApy: morphoBorrowApy,
-            incentiveSupplyToken: 'MORPHO',
-            incentiveBorrowToken: 'MORPHO',
+            supplyIncentives: [{
+                    token: 'MORPHO',
+                    apy: morphoSupplyApy,
+                    incentiveKind: IncentiveKind.Reward,
+                    description: 'Eligible for protocol-level MORPHO incentives.',
+                }],
+            borrowIncentives: [{
+                    token: 'MORPHO',
+                    apy: morphoBorrowApy,
+                    incentiveKind: IncentiveKind.Reward,
+                    description: 'Eligible for protocol-level MORPHO incentives.',
+                }],
         };
         assetsData[wethToEth(collateralTokenInfo.symbol)] = {
             symbol: wethToEth(collateralTokenInfo.symbol),
@@ -90,10 +98,16 @@ export function _getMorphoBlueMarketData(provider, network, selectedMarket) {
             borrowRate: '0',
             canBeSupplied: true,
             canBeBorrowed: false,
+            supplyIncentives: [],
+            borrowIncentives: [],
         };
         if (STAKING_ASSETS.includes(collateralTokenInfo.symbol)) {
-            assetsData[collateralTokenInfo.symbol].incentiveSupplyApy = yield getStakingApy(collateralTokenInfo.symbol);
-            assetsData[collateralTokenInfo.symbol].incentiveSupplyToken = collateralTokenInfo.symbol;
+            assetsData[collateralTokenInfo.symbol].supplyIncentives = [{
+                    apy: yield getStakingApy(collateralTokenInfo.symbol),
+                    token: collateralTokenInfo.symbol,
+                    incentiveKind: IncentiveKind.Staking,
+                    description: `Native ${collateralTokenInfo.symbol} yield.`,
+                }];
         }
         return {
             id: marketInfo.id,

package/esm/spark/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import Dec from 'decimal.js';
 import { assetAmountInEth, assetAmountInWei, getAssetInfo } from '@defisaver/tokens';
-import { NetworkNumber, } from '../types/common';
+import { IncentiveKind, NetworkNumber, } from '../types/common';
 import { ethToWeth, wethToEth, wethToEthByAddress, } from '../services/utils';
 import { calculateNetApy, getStakingApy, STAKING_ASSETS, } from '../staking';
 import { SparkViewContractViem, SparkIncentiveDataProviderContractViem, createViemContractFromConfigFunc, } from '../contracts';
@@ -116,36 +116,32 @@ export const _getSparkMarketsData = (provider, network, selectedMarket) => __awa
                 collateralFactor: new Dec(market.ltv).div(10000).toString(),
                 priceSource: market.priceSource,
             },
+            supplyIncentives: [],
+            borrowIncentives: [],
         });
     })));
     yield Promise.all(assetsData.map((market) => __awaiter(void 0, void 0, void 0, function* () {
         /* eslint-disable no-param-reassign */
         const rewardForMarket = rewardInfo[market.underlyingTokenAddress];
         if (STAKING_ASSETS.includes(market.symbol)) {
-            market.incentiveSupplyApy = yield getStakingApy(market.symbol);
-            market.incentiveSupplyToken = market.symbol;
-            if (!market.supplyIncentives) {
-                market.supplyIncentives = [];
-            }
+            const yieldApy = yield getStakingApy(market.symbol);
             market.supplyIncentives.push({
-                apy: market.incentiveSupplyApy || '0',
+                apy: yieldApy,
                 token: market.symbol,
+                incentiveKind: IncentiveKind.Staking,
+                description: `Native ${market.symbol} yield.`,
             });
-        }
-        if (market.symbol === 'sDAI') {
-            market.incentiveSupplyApy = yield getStakingApy('sDAI');
-            market.incentiveSupplyToken = 'sDAI';
-        }
-        if (market.canBeBorrowed && market.incentiveSupplyApy) {
-            market.incentiveBorrowApy = market.incentiveSupplyApy;
-            market.incentiveBorrowToken = market.incentiveSupplyToken;
-            if (!market.borrowIncentives) {
-                market.borrowIncentives = [];
+            if (market.canBeBorrowed) {
+                if (!market.borrowIncentives) {
+                    market.borrowIncentives = [];
+                }
+                market.borrowIncentives.push({
+                    apy: new Dec(yieldApy).mul(-1).toString(),
+                    token: market.symbol,
+                    incentiveKind: IncentiveKind.Reward,
+                    description: `Due to the native yield of ${market.symbol}, the value of the debt would increase over time.`,
+                });
             }
-            market.borrowIncentives.push({
-                apy: market.incentiveBorrowApy,
-                token: market.incentiveBorrowToken,
-            });
         }
         if (!rewardForMarket)
             return;
@@ -153,7 +149,6 @@ export const _getSparkMarketsData = (provider, network, selectedMarket) => __awa
             if (supplyRewardData) {
                 if (supplyRewardData.emissionEndTimestamp * 1000 < Date.now())
                     return;
-                market.incentiveSupplyToken = supplyRewardData.rewardTokenSymbol;
                 const supplyEmissionPerSecond = supplyRewardData.emissionPerSecond;
                 const supplyRewardPrice = new Dec(supplyRewardData.rewardPriceFeed).div(Math.pow(10, supplyRewardData.priceFeedDecimals))
                     .toString();
@@ -163,13 +158,11 @@ export const _getSparkMarketsData = (provider, network, selectedMarket) => __awa
                     .div(market.price)
                     .div(market.totalSupply)
                     .toString();
-                market.incentiveSupplyApy = new Dec(market.incentiveSupplyApy || '0').add(rewardApy).toString();
-                if (!market.supplyIncentives) {
-                    market.supplyIncentives = [];
-                }
                 market.supplyIncentives.push({
                     token: supplyRewardData.rewardTokenSymbol,
                     apy: rewardApy,
+                    incentiveKind: IncentiveKind.Reward,
+                    description: 'Eligible for protocol-level incentives.',
                 });
             }
         });
@@ -177,7 +170,6 @@ export const _getSparkMarketsData = (provider, network, selectedMarket) => __awa
             if (borrowRewardData) {
                 if (borrowRewardData.emissionEndTimestamp * 1000 < Date.now())
                     return;
-                market.incentiveBorrowToken = borrowRewardData.rewardTokenSymbol;
                 const supplyEmissionPerSecond = borrowRewardData.emissionPerSecond;
                 const supplyRewardPrice = new Dec(borrowRewardData.rewardPriceFeed).div(Math.pow(10, borrowRewardData.priceFeedDecimals))
                     .toString();
@@ -187,13 +179,11 @@ export const _getSparkMarketsData = (provider, network, selectedMarket) => __awa
                     .div(market.price)
                     .div(market.totalBorrowVar)
                     .toString();
-                market.incentiveBorrowApy = new Dec(market.incentiveBorrowApy || '0').add(rewardApy).toString();
-                if (!market.borrowIncentives) {
-                    market.borrowIncentives = [];
-                }
                 market.borrowIncentives.push({
                     token: borrowRewardData.rewardTokenSymbol,
                     apy: rewardApy,
+                    incentiveKind: IncentiveKind.Reward,
+                    description: 'Eligible for protocol-level incentives.',
                 });
             }
         });

package/esm/staking/eligibility.d.ts

@@ -0,0 +1,19 @@
+import { IncentiveEligibilityId, MMUsedAssets } from '../types/common';
+export declare const isEligibleForEthenaUSDeRewards: (usedAssets: MMUsedAssets) => {
+    isEligible: boolean;
+    eligibleUSDAmount: string;
+};
+export declare const isEligibleForAaveV3ArbitrumEthSupply: (usedAssets: MMUsedAssets) => {
+    isEligible: boolean;
+    eligibleUSDAmount: string;
+};
+export declare const isEligibleForAaveV3ArbitrumETHLSBorrow: (usedAssets: MMUsedAssets) => {
+    isEligible: boolean;
+    eligibleUSDAmount: string;
+};
+export declare const EligibilityMapping: {
+    [key in IncentiveEligibilityId]: (usedAssets: MMUsedAssets) => {
+        isEligible: boolean;
+        eligibleUSDAmount: string;
+    };
+};

package/esm/staking/eligibility.js

@@ -0,0 +1,58 @@
+import Dec from 'decimal.js';
+import { IncentiveEligibilityId } from '../types/common';
+export const isEligibleForEthenaUSDeRewards = (usedAssets) => {
+    var _a, _b;
+    const USDeUSDAmountSupplied = ((_a = usedAssets.USDe) === null || _a === void 0 ? void 0 : _a.suppliedUsd) || '0';
+    const sUSDeUSDAmountSupplied = ((_b = usedAssets.sUSDe) === null || _b === void 0 ? void 0 : _b.suppliedUsd) || '0';
+    const anythingElseSupplied = Object.values(usedAssets).some((asset) => asset.symbol !== 'USDe' && asset.symbol !== 'sUSDe' && asset.isSupplied);
+    if (anythingElseSupplied)
+        return { isEligible: false, eligibleUSDAmount: '0' };
+    const totalAmountSupplied = new Dec(USDeUSDAmountSupplied).add(sUSDeUSDAmountSupplied).toString();
+    const percentageInUSDe = new Dec(USDeUSDAmountSupplied).div(totalAmountSupplied).toNumber();
+    if (percentageInUSDe < 0.45 || percentageInUSDe > 0.55)
+        return { isEligible: false, eligibleUSDAmount: '0' }; // 45% - 55% of total amount supplied must be in USDe
+    const percentageInSUSDe = new Dec(sUSDeUSDAmountSupplied).div(totalAmountSupplied).toNumber();
+    if (percentageInSUSDe < 0.45 || percentageInSUSDe > 0.55)
+        return { isEligible: false, eligibleUSDAmount: '0' }; // 45% - 55% of total amount supplied must be in sUSDe
+    const allowedBorrowAssets = ['USDC', 'USDT', 'USDS'];
+    const anythingBorrowedNotAllowed = Object.values(usedAssets).some((asset) => asset.isBorrowed && !allowedBorrowAssets.includes(asset.symbol));
+    if (anythingBorrowedNotAllowed)
+        return { isEligible: false, eligibleUSDAmount: '0' };
+    const totalAmountBorrowed = Object.values(usedAssets).reduce((acc, asset) => {
+        if (asset.isBorrowed) {
+            return acc.add(asset.borrowedUsd);
+        }
+        return acc;
+    }, new Dec(0)).toString();
+    const borrowPercentage = new Dec(totalAmountBorrowed).div(totalAmountSupplied).toNumber();
+    if (borrowPercentage < 0.5)
+        return { isEligible: false, eligibleUSDAmount: '0' }; // must be looped at least once
+    const halfAmountSupplied = new Dec(totalAmountSupplied).div(2).toString();
+    const USDeAmountEligibleForRewards = Dec.min(USDeUSDAmountSupplied, halfAmountSupplied).toString(); // rewards are given to amount of USDe supplied up to half of total amount supplied
+    return { isEligible: true, eligibleUSDAmount: USDeAmountEligibleForRewards };
+};
+export const isEligibleForAaveV3ArbitrumEthSupply = (usedAssets) => {
+    var _a, _b;
+    const ETHAmountSupplied = ((_a = usedAssets.ETH) === null || _a === void 0 ? void 0 : _a.suppliedUsd) || '0';
+    const ETHAmountBorrowed = ((_b = usedAssets.ETH) === null || _b === void 0 ? void 0 : _b.borrowedUsd) || '0';
+    const delta = new Dec(ETHAmountSupplied).sub(ETHAmountBorrowed).toString();
+    return { isEligible: true, eligibleUSDAmount: Dec.max(delta, 0).toString() };
+};
+export const isEligibleForAaveV3ArbitrumETHLSBorrow = (usedAssets) => {
+    var _a;
+    const allowedBorrowAssets = ['ETH'];
+    const anythingBorrowedNotAllowed = Object.values(usedAssets).some((asset) => asset.isBorrowed && !allowedBorrowAssets.includes(asset.symbol));
+    if (anythingBorrowedNotAllowed)
+        return { isEligible: false, eligibleUSDAmount: '0' };
+    const allowedSupplyAssets = ['wstETH', 'ezETH', 'weETH', 'rsETH'];
+    const anythingSuppliedNotAllowed = Object.values(usedAssets).some((asset) => asset.isSupplied && !allowedSupplyAssets.includes(asset.symbol));
+    if (anythingSuppliedNotAllowed)
+        return { isEligible: false, eligibleUSDAmount: '0' };
+    const ETHAmountBorrowed = ((_a = usedAssets.ETH) === null || _a === void 0 ? void 0 : _a.borrowedUsd) || '0';
+    return { isEligible: true, eligibleUSDAmount: ETHAmountBorrowed };
+};
+export const EligibilityMapping = {
+    [IncentiveEligibilityId.AaveV3EthenaLiquidLeverage]: isEligibleForEthenaUSDeRewards,
+    [IncentiveEligibilityId.AaveV3ArbitrumEthSupply]: isEligibleForAaveV3ArbitrumEthSupply,
+    [IncentiveEligibilityId.AaveV3ArbitrumETHLSBorrow]: isEligibleForAaveV3ArbitrumETHLSBorrow,
+};

package/esm/staking/index.d.ts

@@ -1 +1,2 @@
 export * from './staking';
+export * from './eligibility';

package/esm/staking/index.js

@@ -1 +1,2 @@
 export * from './staking';
+export * from './eligibility';

package/esm/staking/staking.d.ts

@@ -3,15 +3,9 @@ import { MMAssetsData, MMUsedAssets } from '../types/common';
 export declare const STAKING_ASSETS: string[];
 export declare const getStakingApy: ((asset: string) => Promise<string>) & memoize.Memoized<(asset: string) => Promise<string>>;
 export declare const calculateInterestEarned: (principal: string, interest: string, type: string, apy?: boolean) => number;
-export declare const isEligibleForEthenaUSDeRewards: (usedAssets: MMUsedAssets) => {
-    isEligible: boolean;
-    eligibleUSDAmount: string;
-};
-export declare const calculateNetApy: ({ usedAssets, assetsData, isMorpho, isAave, }: {
+export declare const calculateNetApy: ({ usedAssets, assetsData, }: {
     usedAssets: MMUsedAssets;
     assetsData: MMAssetsData;
-    isMorpho?: boolean;
-    isAave?: boolean;
 }) => {
     netApy: string;
     totalInterestUsd: string;

package/esm/staking/staking.js

@@ -11,6 +11,7 @@ import Dec from 'decimal.js';
 import memoize from 'memoizee';
 import { BLOCKS_IN_A_YEAR } from '../constants';
 import { DEFAULT_TIMEOUT } from '../services/utils';
+import { EligibilityMapping } from './eligibility';
 const getSsrApy = () => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const res = yield fetch('https://fe.defisaver.com/api/sky/data', { signal: AbortSignal.timeout(DEFAULT_TIMEOUT) });
@@ -128,74 +129,48 @@ export const calculateInterestEarned = (principal, interest, type, apy = false)
     }
     return (+principal * (Math.pow(((1 + (+interest / 100) / BLOCKS_IN_A_YEAR)), (BLOCKS_IN_A_YEAR * interval)))) - +principal; // eslint-disable-line
 };
-export const isEligibleForEthenaUSDeRewards = (usedAssets) => {
-    var _a, _b;
-    const USDeUSDAmountSupplied = ((_a = usedAssets.USDe) === null || _a === void 0 ? void 0 : _a.suppliedUsd) || '0';
-    const sUSDeUSDAmountSupplied = ((_b = usedAssets.sUSDe) === null || _b === void 0 ? void 0 : _b.suppliedUsd) || '0';
-    const anythingElseSupplied = Object.values(usedAssets).some((asset) => asset.symbol !== 'USDe' && asset.symbol !== 'sUSDe' && asset.isSupplied);
-    if (anythingElseSupplied)
-        return { isEligible: false, eligibleUSDAmount: '0' };
-    const totalAmountSupplied = new Dec(USDeUSDAmountSupplied).add(sUSDeUSDAmountSupplied).toString();
-    const percentageInUSDe = new Dec(USDeUSDAmountSupplied).div(totalAmountSupplied).toNumber();
-    if (percentageInUSDe < 0.45 || percentageInUSDe > 0.55)
-        return { isEligible: false, eligibleUSDAmount: '0' }; // 45% - 55% of total amount supplied must be in USDe
-    const percentageInSUSDe = new Dec(sUSDeUSDAmountSupplied).div(totalAmountSupplied).toNumber();
-    if (percentageInSUSDe < 0.45 || percentageInSUSDe > 0.55)
-        return { isEligible: false, eligibleUSDAmount: '0' }; // 45% - 55% of total amount supplied must be in sUSDe
-    const allowedBorrowAssets = ['USDC', 'USDT', 'USDS'];
-    const anythingBorrowedNotAllowed = Object.values(usedAssets).some((asset) => asset.isBorrowed && !allowedBorrowAssets.includes(asset.symbol));
-    if (anythingBorrowedNotAllowed)
-        return { isEligible: false, eligibleUSDAmount: '0' };
-    const totalAmountBorrowed = Object.values(usedAssets).reduce((acc, asset) => {
-        if (asset.isBorrowed) {
-            return acc.add(asset.borrowedUsd);
-        }
-        return acc;
-    }, new Dec(0)).toString();
-    const borrowPercentage = new Dec(totalAmountBorrowed).div(totalAmountSupplied).toNumber();
-    if (borrowPercentage < 0.5)
-        return { isEligible: false, eligibleUSDAmount: '0' }; // must be looped at least once
-    const halfAmountSupplied = new Dec(totalAmountSupplied).div(2).toString();
-    const USDeAmountEligibleForRewards = Dec.min(USDeUSDAmountSupplied, halfAmountSupplied).toString(); // rewards are given to amount of USDe supplied up to half of total amount supplied
-    return { isEligible: true, eligibleUSDAmount: USDeAmountEligibleForRewards };
-};
-export const calculateNetApy = ({ usedAssets, assetsData, isMorpho = false, isAave = false, }) => {
-    const { isEligible, eligibleUSDAmount } = isAave ? isEligibleForEthenaUSDeRewards(usedAssets) : { isEligible: true, eligibleUSDAmount: '0' };
+export const calculateNetApy = ({ usedAssets, assetsData, }) => {
     const sumValues = Object.values(usedAssets).reduce((_acc, usedAsset) => {
-        var _a, _b;
         const acc = Object.assign({}, _acc);
         const assetData = assetsData[usedAsset.symbol];
         if (usedAsset.isSupplied) {
             const amount = usedAsset.suppliedUsd;
             acc.suppliedUsd = new Dec(acc.suppliedUsd).add(amount).toString();
-            const rate = isMorpho
-                ? usedAsset.supplyRate === '0' ? assetData.supplyRateP2P : usedAsset.supplyRate
-                : assetData.supplyRate;
+            const rate = assetData.supplyRate;
             const supplyInterest = calculateInterestEarned(amount, rate, 'year', true);
             acc.supplyInterest = new Dec(acc.supplyInterest).add(supplyInterest.toString()).toString();
-            if (assetData.incentiveSupplyApy) {
-                // take COMP/AAVE yield into account
-                const incentiveInterest = calculateInterestEarned(amount, assetData.incentiveSupplyApy, 'year', true);
-                acc.incentiveUsd = new Dec(acc.incentiveUsd).add(incentiveInterest).toString();
-            }
-            if (usedAsset.symbol === 'USDe' && isEligible) {
-                // @ts-ignore
-                const incentiveInterest = calculateInterestEarned(eligibleUSDAmount, ((_b = (_a = assetData.supplyIncentives) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.apy) || '0', 'year', true);
-                acc.incentiveUsd = new Dec(acc.incentiveUsd).add(incentiveInterest).toString();
+            for (const supplyIncentive of assetData.supplyIncentives) {
+                const { apy, eligibilityId } = supplyIncentive;
+                const eligibilityCheck = eligibilityId ? EligibilityMapping[eligibilityId] : null;
+                if (eligibilityCheck) {
+                    const { isEligible, eligibleUSDAmount } = eligibilityCheck(usedAssets);
+                    const incentiveInterest = isEligible ? calculateInterestEarned(eligibleUSDAmount, apy, 'year', true) : '0';
+                    acc.incentiveUsd = new Dec(acc.incentiveUsd).add(incentiveInterest).toString();
+                }
+                else {
+                    const incentiveInterest = calculateInterestEarned(amount, apy, 'year', true);
+                    acc.incentiveUsd = new Dec(acc.incentiveUsd).add(incentiveInterest).toString();
+                }
             }
         }
         if (usedAsset.isBorrowed) {
             const amount = usedAsset.borrowedUsd;
             acc.borrowedUsd = new Dec(acc.borrowedUsd).add(amount).toString();
-            const rate = isMorpho
-                ? usedAsset.borrowRate === '0' ? assetData.borrowRateP2P : usedAsset.borrowRate
-                : ((usedAsset === null || usedAsset === void 0 ? void 0 : usedAsset.interestMode) === '1' ? usedAsset.stableBorrowRate : assetData.borrowRate);
+            const rate = assetData.borrowRate;
             const borrowInterest = calculateInterestEarned(amount, rate, 'year', true);
             acc.borrowInterest = new Dec(acc.borrowInterest).sub(borrowInterest.toString()).toString();
-            if (assetData.incentiveBorrowApy) {
-                // take COMP/AAVE yield into account
-                const incentiveInterest = calculateInterestEarned(amount, assetData.incentiveBorrowApy, 'year', true);
-                acc.incentiveUsd = new Dec(acc.incentiveUsd).sub(incentiveInterest).toString();
+            for (const borrowIncentive of assetData.borrowIncentives) {
+                const { apy, eligibilityId } = borrowIncentive;
+                const eligibilityCheck = eligibilityId ? EligibilityMapping[eligibilityId] : null;
+                if (eligibilityCheck) {
+                    const { isEligible, eligibleUSDAmount } = eligibilityCheck(usedAssets);
+                    const incentiveInterest = isEligible ? calculateInterestEarned(eligibleUSDAmount, apy, 'year', true) : '0';
+                    acc.incentiveUsd = new Dec(acc.incentiveUsd).add(incentiveInterest).toString();
+                }
+                else {
+                    const incentiveInterest = calculateInterestEarned(amount, apy, 'year', true);
+                    acc.incentiveUsd = new Dec(acc.incentiveUsd).add(incentiveInterest).toString();
+                }
             }
         }
         return acc;

package/esm/types/aave.d.ts

@@ -1,4 +1,4 @@
-import { MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber } from './common';
+import { IncentiveData, MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber } from './common';
 export declare enum AaveVersions {
     AaveV1 = "v1",
     AaveV2 = "v2default",
@@ -62,11 +62,6 @@ export interface AaveV2AssetData extends AaveAssetData {
     priceInEth: string;
     isFrozen: boolean;
 }
-export interface IncentiveData {
-    token: string;
-    apy: string;
-    incentiveKind?: 'staking' | 'reward';
-}
 export interface AaveV3AssetData extends AaveAssetData {
     isIsolated: boolean;
     isSiloed: boolean;
@@ -80,8 +75,8 @@ export interface AaveV3AssetData extends AaveAssetData {
     isFlashLoanEnabled: boolean;
     assetId: string | number | null;
     liquidationBonus: string;
-    supplyIncentives?: IncentiveData[];
-    borrowIncentives?: IncentiveData[];
+    supplyIncentives: IncentiveData[];
+    borrowIncentives: IncentiveData[];
 }
 export type EModeCategoriesData = Record<number, EModeCategoryData>;
 export type AaveAssetsData<T> = {

package/esm/types/common.d.ts

@@ -1,3 +1,19 @@
+export declare enum IncentiveKind {
+    Staking = "staking",
+    Reward = "reward"
+}
+export declare enum IncentiveEligibilityId {
+    AaveV3EthenaLiquidLeverage = "0x8772bb231f3af13ead41d7ecf6abd60f5f716ec8BORROW_BL",
+    AaveV3ArbitrumEthSupply = "0x5d16261c6715a653248269861bbacf68a9774cde",
+    AaveV3ArbitrumETHLSBorrow = "0x0c84331e39d6658Cd6e6b9ba04736cC4c4734351"
+}
+export interface IncentiveData {
+    token: string;
+    apy: string;
+    incentiveKind?: IncentiveKind;
+    description?: string;
+    eligibilityId?: IncentiveEligibilityId;
+}
 export type EthAddress = HexString;
 export type Blockish = number | 'latest';
 export type AssetSymbol = string;
@@ -24,12 +40,10 @@ export interface MMAssetData {
     canBeBorrowed: boolean;
     canBeSupplied: boolean;
     totalBorrow: string;
-    incentiveBorrowApy?: string;
-    incentiveBorrowToken?: string;
-    incentiveSupplyApy?: string;
-    incentiveSupplyToken?: string;
     borrowRateP2P?: string;
     supplyRateP2P?: string;
+    supplyIncentives: IncentiveData[];
+    borrowIncentives: IncentiveData[];
 }
 export interface MMAssetsData {
     [token: string]: MMAssetData;

package/esm/types/common.js

@@ -1,3 +1,14 @@
+export var IncentiveKind;
+(function (IncentiveKind) {
+    IncentiveKind["Staking"] = "staking";
+    IncentiveKind["Reward"] = "reward";
+})(IncentiveKind || (IncentiveKind = {}));
+export var IncentiveEligibilityId;
+(function (IncentiveEligibilityId) {
+    IncentiveEligibilityId["AaveV3EthenaLiquidLeverage"] = "0x8772bb231f3af13ead41d7ecf6abd60f5f716ec8BORROW_BL";
+    IncentiveEligibilityId["AaveV3ArbitrumEthSupply"] = "0x5d16261c6715a653248269861bbacf68a9774cde";
+    IncentiveEligibilityId["AaveV3ArbitrumETHLSBorrow"] = "0x0c84331e39d6658Cd6e6b9ba04736cC4c4734351";
+})(IncentiveEligibilityId || (IncentiveEligibilityId = {}));
 export var NetworkNumber;
 (function (NetworkNumber) {
     NetworkNumber[NetworkNumber["Eth"] = 1] = "Eth";

package/esm/types/euler.d.ts

@@ -1,4 +1,4 @@
-import { EthAddress, MMPositionData, NetworkNumber } from './common';
+import { EthAddress, IncentiveData, MMPositionData, NetworkNumber } from './common';
 export declare enum EulerV2Versions {
     eUSDC2 = "eUSDC-2",
     eWETH2 = "eWETH-2"
@@ -42,8 +42,8 @@ export interface EulerV2AssetData {
     borrowCap: string;
     canBeBorrowed: boolean;
     canBeSupplied: boolean;
-    incentiveSupplyApy?: string;
-    incentiveSupplyToken?: string;
+    supplyIncentives: IncentiveData[];
+    borrowIncentives: IncentiveData[];
     totalBorrow: string;
     collateralFactor: string;
     borrowRate: string;

package/esm/types/fluid.d.ts

@@ -1,4 +1,4 @@
-import { EthAddress, NetworkNumber } from './common';
+import { EthAddress, IncentiveData, NetworkNumber } from './common';
 export interface FluidMarketInfo {
     chainIds: number[];
     label: string;
@@ -181,10 +181,8 @@ export interface FluidAssetData {
     symbol: string;
     address: string;
     price: string;
-    incentiveSupplyApy?: string;
-    incentiveSupplyToken?: string;
-    incentiveBorrowApy?: string;
-    incentiveBorrowToken?: string;
+    supplyIncentives: IncentiveData[];
+    borrowIncentives: IncentiveData[];
     totalSupply: string;
     totalBorrow: string;
     canBeSupplied: boolean;