@defisaver/positions-sdk 2.1.161-portfolio-api-1-dev → 2.1.161-portfolio-api-2-dev

package/cjs/types/portfolio.d.ts

@@ -1,20 +1,33 @@
-import { AaveV2MarketData, AaveV2PositionData, AaveV3MarketData, AaveV3PositionData, AaveVersions } from './aave';
+import { AaveV2MarketData, AaveV2PositionData, AaveV3MarketData, AaveV3PositionData, AaveVersions, StakeAaveData, UmbrellaStakingData } from './aave';
 import { AaveV4AccountData, AaveV4SpokeData, AaveV4SpokesType } from './aaveV4';
+import { AaveRewardsClaimableToken, EthenaAirdropClaimableToken, KingRewardsClaimableToken, MerklRewardsClaimableToken, SparkAirdropClaimableToken, SparkRewardsClaimableToken, UniswapAirdropClaimableToken } from './claiming';
 import { EthAddress } from './common';
 import { CompoundV2MarketsData, CompoundV2PositionData, CompoundV3MarketsData, CompoundV3PositionData, CompoundVersions } from './compound';
 import { CrvUSDGlobalMarketData, CrvUSDUserData, CrvUSDVersions } from './curveUsd';
-import { FluidVaultData } from './fluid';
-import { LiquityTroveInfo } from './liquity';
-import { LiquityV2MarketData } from './liquityV2';
+import { FluidEarnPositionData, FluidVaultData } from './fluid';
+import { LiquityStakingData, LiquityTroveInfo } from './liquity';
+import { LiquityV2MarketData, LiquityV2SBoldYBoldData, LiquityV2StakingData, LiquityV2Versions } from './liquityV2';
 import { LlamaLendGlobalMarketData, LlamaLendUserData, LlamaLendVersionsType } from './llamaLend';
 import { CdpData } from './maker';
-import { MorphoBlueMarketInfo, MorphoBluePositionData, MorphoBlueVersions } from './morphoBlue';
+import { MorphoBlueEarnData, MorphoBlueMarketInfo, MorphoBluePositionData, MorphoBlueVersions } from './morphoBlue';
 import { MorphoMidnightMarketInfo, MorphoMidnightPositionData, MorphoMidnightVersions } from './morphoMidnight';
 import { SparkMarketsData, SparkPositionData, SparkVersions } from './spark';
 export interface PortfolioProtocolData<T> {
     error: string;
     data: T | null;
 }
+/** A failed fetch of a protocol that, when it succeeds, getPortfolioData returns unwrapped rather than as `{ error, data }`. */
+export interface PortfolioProtocolError {
+    error: string;
+    data: null;
+}
+/** What getPortfolioData reads besides positions and markets. Both default to true. */
+export interface PortfolioDataOptions {
+    /** stakingPositions; with false it comes back as {} and no staking source is read. */
+    staking?: boolean;
+    /** rewardsData; with false it comes back as {} and no rewards source is read. */
+    rewards?: boolean;
+}
 export interface PortfolioPositionsDataForAddress {
     aaveV3: {
         [key in AaveVersions]?: PortfolioProtocolData<AaveV3PositionData>;
@@ -60,6 +73,56 @@ export interface PortfolioPositionsDataForAddress {
 export interface PortfolioPositionsData {
     [key: EthAddress]: PortfolioPositionsDataForAddress;
 }
+/**
+ * The staking positions getPortfolioData returns for an address. The shapes are uneven, and the DeFi Saver app
+ * parses them as they are: a protocol read once per address comes back unwrapped on success, as
+ * `{ error, data: null }` on failure, and as {} (or Fluid's `{ error: '', data: {} }`) on a network it is not read on.
+ */
+export interface PortfolioStakingPositionsDataForAddress {
+    /** stkAAVE, stkGHO and sGHO; mainnet only. */
+    aaveV3: StakeAaveData | PortfolioProtocolError | {};
+    /** Morpho Blue supply without a borrow (Earn), by market; only markets with a deposit or an error. */
+    morphoBlue: {
+        [key in MorphoBlueVersions]?: PortfolioProtocolData<MorphoBlueEarnData>;
+    };
+    compoundV3: Record<string, never>;
+    spark: Record<string, never>;
+    aaveV2: Record<string, never>;
+    compoundV2: Record<string, never>;
+    /** LQTY staking and the LUSD stability pool; mainnet only. */
+    liquity: LiquityStakingData | PortfolioProtocolError | {};
+    /** Stability pool deposits, by market; mainnet only, legacy markets left out. */
+    liquityV2: {
+        [key in LiquityV2Versions]?: PortfolioProtocolData<LiquityV2StakingData>;
+    };
+    /** Fluid lending (fToken) deposits; `{ error: '', data: {} }` on a network without Fluid. */
+    fluid: FluidEarnPositionData[] | PortfolioProtocolError | {
+        error: string;
+        data: Record<string, never>;
+    };
+    /** Umbrella stakes; absent off mainnet. */
+    umbrella?: UmbrellaStakingData | PortfolioProtocolError;
+    /** sBOLD, yBOLD and stYBOLD; data is null off mainnet. */
+    liquityV2SBoldYBold: PortfolioProtocolData<LiquityV2SBoldYBoldData>;
+}
+export type PortfolioStakingPositionsData = Record<EthAddress, PortfolioStakingPositionsDataForAddress>;
+/** The claimable rewards getPortfolioData returns for an address. Off mainnet only Merkl and Aave V3 are read. */
+export interface PortfolioRewardsDataForAddress {
+    merkl: PortfolioProtocolData<MerklRewardsClaimableToken[]>;
+    aaveV3: {
+        [key in AaveVersions]?: PortfolioProtocolData<AaveRewardsClaimableToken[]>;
+    };
+    spark: {
+        [key in SparkVersions]?: PortfolioProtocolData<SparkRewardsClaimableToken[]>;
+    };
+    /** The SPK airdrop. */
+    spk: PortfolioProtocolData<SparkAirdropClaimableToken[]>;
+    king: PortfolioProtocolData<KingRewardsClaimableToken[]>;
+    /** {} off mainnet. */
+    ethena: PortfolioProtocolData<EthenaAirdropClaimableToken[]> | {};
+    uniswap: PortfolioProtocolData<UniswapAirdropClaimableToken[]>;
+}
+export type PortfolioRewardsData = Record<EthAddress, PortfolioRewardsDataForAddress>;
 /** The `markets` getPortfolioData returns: every market it read, by protocol, keyed by market or spoke. */
 export interface PortfolioMarketsData {
     morphoMarketsData: Record<string, MorphoBlueMarketInfo>;

package/cjs/umbrella/index.d.ts

@@ -1,5 +1,4 @@
 import { Client } from 'viem';
 import { EthAddress, NetworkNumber } from '../types/common';
-export declare const getUmbrellaData: (provider: Client, network: NetworkNumber, address: EthAddress) => Promise<{
-    [k: string]: any;
-}>;
+import { UmbrellaStakingData } from '../types/aave';
+export declare const getUmbrellaData: (provider: Client, network: NetworkNumber, address: EthAddress) => Promise<UmbrellaStakingData>;

package/esm/aaveV3/index.d.ts

@@ -1,5 +1,5 @@
 import { Client } from 'viem';
-import { AaveMarketInfo, AaveV3MarketData, AaveV3PositionData, AaveV3UsedAssets, EModeCategoryDataMapping } from '../types';
+import { AaveMarketInfo, AaveV3MarketData, AaveV3PositionData, AaveV3UsedAssets, EModeCategoryDataMapping, StakeAaveData } from '../types';
 import { Blockish, EthAddress, EthereumProvider, NetworkNumber, PositionBalances } from '../types/common';
 import { getMeritCampaigns } from './merit';
 import { getMerkleCampaigns } from './merkl';
@@ -37,17 +37,7 @@ export declare const getAaveV3AccountData: (provider: EthereumProvider, network:
 export declare const getAaveV3FullPositionData: (provider: EthereumProvider, network: NetworkNumber, address: EthAddress, market: AaveMarketInfo) => Promise<AaveV3PositionData>;
 export declare const REWARDABLE_ASSETS: readonly ["0x028171bCA77440897B824Ca71D1c56caC55b68A3", "0x6C3c78838c761c6Ac7bE9F59fe808ea2A6E4379d", "0xD37EE7e4f452C6638c96536e68090De8cBcdb583", "0x279AF5b99540c1A3A7E3CDd326e19659401eF99e", "0xBcca60bB61934080951369a648Fb03DF4F96263C", "0x619beb58998eD2278e08620f97007e1116D5D25b", "0x3Ed3B47Dd13EC9a98b44e6204A523E766B225811", "0x531842cEbbdD378f8ee36D171d6cC9C4fcf475Ec", "0x9ff58f4fFB29fA2266Ab25e75e2A8b3503311656", "0x9c39809Dec7F95F5e0713634a4D0701329B3b4d2", "0x030bA81f1c18d280636F32af80b9AAd02Cf0854e", "0xF63B34710400CAd3e044cFfDcAb00a0f32E33eCf", "0xa06bC25B5805d5F8d82847D191Cb4Af5A3e873E0", "0x0b8f12b1788BFdE65Aa1ca52E3e9F3Ba401be16D", "0x6C5024Cd4F8A59110119C56f8933403A539555EB", "0xdC6a3Ab17299D9C2A412B0e0a4C1f55446AE0817", "0x5165d24277cD063F5ac44Efd447B27025e888f37", "0x7EbD09022Be45AD993BAA1CEc61166Fcc8644d97", "0xF256CC7847E919FAc9B808cC216cAc87CCF2f47a", "0xfAFEDF95E21184E3d880bd56D4806c4b8d31c69A", "0xB9D7CB55f463405CDfBe4E90a6D2Df01C2B92BF1", "0x5BdB050A92CADcCfCDcCCBFC17204a1C9cC0Ab73", "0xc713e5E149D5D0715DcD1c156a020976e7E56B88", "0xba728eAd5e496BE00DCF66F650b6d7758eCB50f8", "0x101cc05f4A51C0319f570d5E146a8C625198e636", "0x01C0eb1f8c6F1C1bF74ae028697ce7AA2a8b0E92", "0xc9BC48c72154ef3e5425641a3c747242112a46AF", "0xB5385132EE8321977FfF44b60cDE9fE9AB0B4e6b", "0x272F97b7a56a387aE942350bBC7Df5700f8a4576", "0x13210D4Fe0d5402bd7Ecbc4B5bC5cFcA3b71adB0", "0x2e8f4bdbe3d47d7d7de490437aea9915d930f1a3", "0xfdb93b3b10936cf81fa59a02a7523b6e2149b2b7", "0xA361718326c15715591c299427c62086F69923D9", "0xbA429f7011c9fa04cDd46a2Da24dc0FF0aC6099c", "0xd4937682df3C8aEF4FE912A96A74121C0829E664", "0xfE8F19B17fFeF0fDbfe2671F248903055AFAA8Ca", "0x683923dB55Fead99A79Fa01A27EeC3cB19679cC3", "0xC2e10006AccAb7B45D9184FcF5b7EC7763f5BaAe", "0x8dAE6Cb04688C62d939ed9B68d32Bc62e49970b1", "0x00ad8eBF64F141f1C81e9f8f792d3d1631c6c684", "0x6F634c6135D2EBD550000ac92F494F9CB8183dAe", "0x4dDff5885a67E4EffeC55875a3977D7E60F82ae0"];
 export declare const fetchYearlyMeritApyForStakingGho: () => Promise<string>;
-export declare const getStakeAaveData: (provider: Client, network: NetworkNumber, address: EthAddress) => Promise<{
-    activatedCooldown: string;
-    activatedCooldownAmount: string;
-    stkAaveRewardsBalance: string;
-    aaveRewardsBalance: string;
-    stkAaveBalance: string;
-    stkGhoBalance: string;
-    ghoMeritApy: string;
-    stkAaveApy: string;
-    sgho: import("./sgho").SghoData;
-}>;
+export declare const getStakeAaveData: (provider: Client, network: NetworkNumber, address: EthAddress) => Promise<StakeAaveData>;
 export { getMeritCampaigns, getMerkleCampaigns, };
 export { getSghoData } from './sgho';
 export type { SghoData, SghoUserData } from './sgho';

package/esm/aaveV3/sgho.d.ts

@@ -1,18 +1,4 @@
 import { EthAddress, NetworkNumber } from '../types/common';
-export interface SghoUserData {
-    shares: string;
-    balance: string;
-    maxDeposit: string;
-    maxWithdraw: string;
-    underlyingBalance: string;
-}
-export interface SghoData {
-    totalAssets: string;
-    totalSupply: string;
-    supplyCap: string;
-    /** Target savings rate as an APY percent (e.g. "4.25" for 4.25%). */
-    targetRate: string;
-    paused: boolean;
-    user: SghoUserData;
-}
+import { SghoData } from '../types/aave';
+export type { SghoData, SghoUserData } from '../types/aave';
 export declare const getSghoData: (network: NetworkNumber, address?: EthAddress) => Promise<SghoData>;

package/esm/claiming/aaveV3.d.ts

@@ -1,6 +1,6 @@
 import { Client } from 'viem';
 import { EthAddress, NetworkNumber } from '../types';
-import { ClaimableToken, MerklRewardsClaimableToken } from '../types/claiming';
-export declare function getUnclaimedRewardsForAllMarkets(provider: Client, network: NetworkNumber, walletAddress: EthAddress, marketAddress: EthAddress): Promise<ClaimableToken[]>;
+import { AaveRewardsClaimableToken, ClaimableToken, MerklRewardsClaimableToken } from '../types/claiming';
+export declare function getUnclaimedRewardsForAllMarkets(provider: Client, network: NetworkNumber, walletAddress: EthAddress, marketAddress: EthAddress): Promise<AaveRewardsClaimableToken[]>;
 export declare function getMerklUnclaimedRewards(account: EthAddress, network: NetworkNumber): Promise<MerklRewardsClaimableToken[]>;
 export declare function getMeritUnclaimedRewards(account: EthAddress, network: NetworkNumber): Promise<ClaimableToken[]>;

package/esm/claiming/aaveV3.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import Dec from 'decimal.js';
-import { ClaimType } from '../types/claiming';
+import { ClaimType, } from '../types/claiming';
 import { AaveIncentiveDataProviderV3ContractViem, AaveRewardsControllerViem, } from '../contracts';
 import { compareAddresses, getEthAmountForDecimals, LONGER_TIMEOUT } from '../services/utils';
 import { getAaveUnderlyingSymbol } from '../helpers/aaveHelpers';

package/esm/claiming/ethena.d.ts

@@ -1,3 +1,4 @@
 import { EthAddress } from '../types/common';
+import { EthenaAirdropClaimableToken } from '../types/claiming';
 export declare const fetchEthenaAirdropReward: (address: EthAddress) => Promise<any>;
-export declare const fetchEthenaAirdropRewards: (walletAddresses: EthAddress[]) => Promise<Record<string, any[]>>;
+export declare const fetchEthenaAirdropRewards: (walletAddresses: EthAddress[]) => Promise<Record<string, EthenaAirdropClaimableToken[]>>;

package/esm/claiming/king.d.ts

@@ -1,4 +1,5 @@
 import { Client } from 'viem';
 import { EthAddress, NetworkNumber } from '../types/common';
+import { KingRewardsClaimableToken } from '../types/claiming';
 export declare const fetchKingRewards: (walletAddress: EthAddress) => Promise<any>;
-export declare const getKingRewards: (provider: Client, network: NetworkNumber, walletAddresses: EthAddress[]) => Promise<Record<string, any[]>>;
+export declare const getKingRewards: (provider: Client, network: NetworkNumber, walletAddresses: EthAddress[]) => Promise<Record<string, KingRewardsClaimableToken[]>>;

package/esm/claiming/spark.d.ts

@@ -1,6 +1,6 @@
 import { Client } from 'viem';
 import { EthAddress, NetworkNumber } from '../types/common';
-import { SparkRewardsClaimableToken } from '../types/claiming';
+import { SparkAirdropClaimableToken, SparkRewardsClaimableToken } from '../types/claiming';
 export declare const fetchSpkAirdropRewards: (walletAddress: EthAddress) => Promise<any>;
-export declare const fetchSparkAirdropRewards: (provider: Client, network: NetworkNumber, walletAddresses: EthAddress[]) => Promise<Record<string, any[]>>;
+export declare const fetchSparkAirdropRewards: (provider: Client, network: NetworkNumber, walletAddresses: EthAddress[]) => Promise<Record<string, SparkAirdropClaimableToken[]>>;
 export declare const fetchSparkRewards: (provider: Client, network: NetworkNumber, walletAddress: EthAddress, marketAddress: EthAddress) => Promise<SparkRewardsClaimableToken[]>;

package/esm/claiming/spark.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { assetAmountInEth, getAssetInfoByAddress } from '@defisaver/tokens';
 import Dec from 'decimal.js';
 import { createViemContractFromConfigFunc, SparkIncentiveDataProviderContractViem, SparkRewardsControllerViem, } from '../contracts';
-import { ClaimType, SparkAirdropType } from '../types/claiming';
+import { ClaimType, SparkAirdropType, } from '../types/claiming';
 import { compareAddresses, getEthAmountForDecimals } from '../services/utils';
 const IGNITION_REWARDS = '0xCBA0C0a2a0B6Bb11233ec4EA85C5bFfea33e724d';
 const PFL3_REWARDS = '0x7ac96180C4d6b2A328D3a19ac059D0E7Fc3C6d41';

package/esm/fluid/index.d.ts

@@ -1,6 +1,6 @@
 import { Client, PublicClient } from 'viem';
 import { EthAddress, EthereumProvider, NetworkNumber } from '../types/common';
-import { FluidAssetsData, FluidMarketData, FluidMarketInfo, FluidUsedAssets, FluidVaultData, InnerFluidMarketData } from '../types';
+import { FluidAssetsData, FluidEarnPositionData, FluidMarketData, FluidMarketInfo, FluidUsedAssets, FluidVaultData, InnerFluidMarketData } from '../types';
 export { FluidMerklOpportunityType, buildFluidMerklRewardMap, getFluidMerklCampaigns, attachFluidMerklIncentives, } from './merkl';
 export declare const EMPTY_USED_ASSET: {
     isSupplied: boolean;
@@ -71,54 +71,10 @@ export declare const getFluidTokenData: (provider: EthereumProvider, network: Ne
     depositRate: string;
     withdrawRate: string;
 }>;
-export declare const _getFluidDepositData: (provider: Client, network: NetworkNumber, token: string, address: EthAddress) => Promise<{
-    fTokenAddress: string | undefined;
-    fTokenSymbol: string;
-    decimals: string;
-    totalDeposited: string;
-    withdrawable: string;
-    apy: string;
-    depositRate: string;
-    withdrawRate: string;
-    deposited: string;
-    depositedShares: string;
-}>;
-export declare const getFluidDepositData: (provider: EthereumProvider, network: NetworkNumber, token: string, address: EthAddress) => Promise<{
-    fTokenAddress: string | undefined;
-    fTokenSymbol: string;
-    decimals: string;
-    totalDeposited: string;
-    withdrawable: string;
-    apy: string;
-    depositRate: string;
-    withdrawRate: string;
-    deposited: string;
-    depositedShares: string;
-}>;
-export declare const _getAllUserEarnPositionsWithFTokens: (provider: Client, network: NetworkNumber, user: EthAddress) => Promise<{
-    fTokenAddress: string | undefined;
-    fTokenSymbol: string;
-    decimals: string;
-    totalDeposited: string;
-    withdrawable: string;
-    apy: string;
-    depositRate: string;
-    withdrawRate: string;
-    deposited: string;
-    depositedShares: string;
-}[]>;
-export declare const getAllUserEarnPositionsWithFTokens: (provider: EthereumProvider, network: NetworkNumber, user: EthAddress) => Promise<{
-    fTokenAddress: string | undefined;
-    fTokenSymbol: string;
-    decimals: string;
-    totalDeposited: string;
-    withdrawable: string;
-    apy: string;
-    depositRate: string;
-    withdrawRate: string;
-    deposited: string;
-    depositedShares: string;
-}[]>;
+export declare const _getFluidDepositData: (provider: Client, network: NetworkNumber, token: string, address: EthAddress) => Promise<FluidEarnPositionData>;
+export declare const getFluidDepositData: (provider: EthereumProvider, network: NetworkNumber, token: string, address: EthAddress) => Promise<FluidEarnPositionData>;
+export declare const _getAllUserEarnPositionsWithFTokens: (provider: Client, network: NetworkNumber, user: EthAddress) => Promise<FluidEarnPositionData[]>;
+export declare const getAllUserEarnPositionsWithFTokens: (provider: EthereumProvider, network: NetworkNumber, user: EthAddress) => Promise<FluidEarnPositionData[]>;
 export declare const _getUserPositions: (provider: PublicClient, network: NetworkNumber, user: EthAddress) => Promise<{
     marketData: FluidMarketData | undefined;
     userData: {

package/esm/liquity/index.d.ts

@@ -1,6 +1,6 @@
 import { Client } from 'viem';
 import { Blockish, EthAddress, EthereumProvider, NetworkNumber, PositionBalances } from '../types/common';
-import { LiquityTroveInfo } from '../types';
+import { LiquityStakingData, LiquityTroveInfo } from '../types';
 export declare const LIQUITY_NORMAL_MODE_RATIO = 110;
 export declare const LIQUITY_RECOVERY_MODE_RATIO = 150;
 export declare const _getLiquityAccountBalances: (provider: Client, network: NetworkNumber, block: Blockish, addressMapping: boolean, address: EthAddress) => Promise<PositionBalances>;
@@ -8,14 +8,4 @@ export declare const getLiquityAccountBalances: (provider: EthereumProvider, net
 export declare const getDebtInFront: (provider: EthereumProvider, address: EthAddress) => Promise<string>;
 export declare const _getLiquityTroveInfo: (provider: Client, network: NetworkNumber, address: EthAddress) => Promise<LiquityTroveInfo>;
 export declare const getLiquityTroveInfo: (provider: EthereumProvider, network: NetworkNumber, address: EthAddress) => Promise<LiquityTroveInfo>;
-export declare const getLiquityStakingData: (provider: Client, network: NetworkNumber, address: EthAddress) => Promise<{
-    totalLUSDDeposited: string;
-    totalLQTYStaked: string;
-    stakedLQTY: string;
-    stakedLUSDBalance: string;
-    rewardETH: string;
-    rewardLUSD: string;
-    stabilityRewardETH: string;
-    stabilityRewardLQTY: string;
-    showStakingBalances: boolean;
-}>;
+export declare const getLiquityStakingData: (provider: Client, network: NetworkNumber, address: EthAddress) => Promise<LiquityStakingData>;

package/esm/liquityV2/index.d.ts

@@ -1,6 +1,6 @@
 import { Client, PublicClient } from 'viem';
 import { EthAddress, EthereumProvider, NetworkNumber } from '../types/common';
-import { LiquityV2AssetsData, LiquityV2MarketData, LiquityV2MarketInfo, LiquityV2TroveData, LiquityV2Versions } from '../types';
+import { LiquityV2AssetsData, LiquityV2MarketData, LiquityV2MarketInfo, LiquityV2SBoldYBoldData, LiquityV2StakingData, LiquityV2TroveData, LiquityV2Versions } from '../types';
 export type SPYieldGainParameters = {
     P: string;
     aggWeightedDebtSum: string;
@@ -44,25 +44,5 @@ export type sBoldYieldParameters = {
     wsETH: string;
     rETH: string;
 };
-export declare const getLiquityV2Staking: (provider: Client, network: NetworkNumber, market: LiquityV2Versions, user: EthAddress) => Promise<{
-    totalBOLDDeposited: string;
-    stakedBOLDBalance: string;
-    stabilityRewardColl: string;
-    stabilityRewardYield: string;
-    showStakingBalances: boolean;
-    debtTokenBalance: string;
-    stabilityPoolApy: string;
-}>;
-export declare const getLiquitySAndYBold: (provider: Client, network: NetworkNumber, markets: any, user: EthAddress) => Promise<{
-    spApy: string;
-    yBoldApy: string;
-    totalBoldDepositedSBold: string;
-    boldRateSBold: string;
-    maxWithdrawSBold: string;
-    totalBoldDepositedYBold: string;
-    boldRateYBold: string;
-    maxWithdrawYBold: string;
-    sBoldBalance: string;
-    yBoldBalance: string;
-    stYBoldBalance: string;
-}>;
+export declare const getLiquityV2Staking: (provider: Client, network: NetworkNumber, market: LiquityV2Versions, user: EthAddress) => Promise<LiquityV2StakingData>;
+export declare const getLiquitySAndYBold: (provider: Client, network: NetworkNumber, markets: any, user: EthAddress) => Promise<LiquityV2SBoldYBoldData>;

package/esm/portfolio/index.d.ts

@@ -1,9 +1,9 @@
 import { EthAddress, EthereumProvider, NetworkNumber } from '../types/common';
-import { PortfolioMarketsData, PortfolioPositionsData } from '../types';
-export declare function getPortfolioData(provider: EthereumProvider, network: NetworkNumber, defaultProvider: EthereumProvider, addresses: EthAddress[], isSim?: boolean): Promise<{
+import { PortfolioDataOptions, PortfolioMarketsData, PortfolioPositionsData, PortfolioRewardsData, PortfolioStakingPositionsData } from '../types';
+export declare function getPortfolioData(provider: EthereumProvider, network: NetworkNumber, defaultProvider: EthereumProvider, addresses: EthAddress[], isSim?: boolean, options?: PortfolioDataOptions): Promise<{
     positions: PortfolioPositionsData;
-    stakingPositions: any;
-    rewardsData: any;
+    stakingPositions: PortfolioStakingPositionsData;
+    rewardsData: PortfolioRewardsData;
     markets: PortfolioMarketsData;
 }>;
 export * from './discovery';

package/esm/portfolio/index.js

@@ -34,8 +34,13 @@ import { fetchEthenaAirdropRewards } from '../claiming/ethena';
 import { _getAaveV4AccountData, _getAaveV4SpokeData } from '../aaveV4';
 import { getUniswapRewards } from '../claiming/uniswap';
 export function getPortfolioData(provider_1, network_1, defaultProvider_1, addresses_1) {
-    return __awaiter(this, arguments, void 0, function* (provider, network, defaultProvider, addresses, isSim = false) {
+    return __awaiter(this, arguments, void 0, function* (provider, network, defaultProvider, addresses, isSim = false, options = {}) {
         const isMainnet = network === NetworkNumber.Eth;
+        const includeStaking = options.staking !== false;
+        const includeRewards = options.rewards !== false;
+        // The addresses staking and rewards are read for: none when left out, so their fetches below make no calls.
+        const stakingAddresses = includeStaking ? addresses : [];
+        const rewardsAddresses = includeRewards ? addresses : [];
         const isFluidSupported = [NetworkNumber.Eth, NetworkNumber.Arb, NetworkNumber.Base, NetworkNumber.Plasma].includes(network);
         const morphoMarkets = Object.values(MorphoBlueMarkets(network)).filter((market) => market.chainIds.includes(network));
         const morphoMidnightMarkets = Object.values(MorphoMidnightMarkets(network)).filter((market) => market.chainIds.includes(network));
@@ -107,7 +112,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
             };
         }
         // TODO: check default values, probably needed when fetching portfolio on unsupported networks
-        for (const address of addresses) {
+        for (const address of stakingAddresses) {
             stakingPositions[address.toLowerCase()] = {
                 aaveV3: {},
                 morphoBlue: {},
@@ -121,14 +126,20 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     error: '',
                     data: {},
                 },
+                // Set by the sBOLD/yBOLD fetch below, whether it succeeds or fails.
+                liquityV2SBoldYBold: { error: '', data: null },
             };
+        }
+        for (const address of rewardsAddresses) {
+            // merkl, spk, king and uniswap are set by their fetches below, whether they succeed or fail.
             rewardsData[address.toLowerCase()] = {
-                merkl: {},
+                merkl: { error: '', data: null },
                 aaveV3: {},
                 spark: {},
-                spk: {},
-                king: {},
+                spk: { error: '', data: null },
+                king: { error: '', data: null },
                 ethena: {},
+                uniswap: { error: '', data: null },
             };
         }
         yield Promise.allSettled([
@@ -204,7 +215,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 }
             })),
             // === STAKING DATA (independent of market data) ===
-            ...addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...stakingAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isFluidSupported)
                         return;
@@ -215,7 +226,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     stakingPositions[address.toLowerCase()].fluid = { error: `Error fetching Fluid lend data for address ${address}`, data: null };
                 }
             })),
-            ...addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...stakingAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet)
                         return;
@@ -226,7 +237,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     stakingPositions[address.toLowerCase()].liquity = { error: `Error fetching Liquity staking data for address ${address}`, data: null };
                 }
             })),
-            ...addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...stakingAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet)
                         return;
@@ -237,7 +248,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     stakingPositions[address.toLowerCase()].aaveV3 = { error: `Error fetching Aave V3 staking data for address ${address}`, data: null };
                 }
             })),
-            ...addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...stakingAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet)
                         return;
@@ -249,7 +260,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 }
             })),
             // Liquity V2 staking
-            ...liquityV2MarketsStaking.map(market => addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...liquityV2MarketsStaking.map(market => stakingAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet) {
                         stakingPositions[address.toLowerCase()].liquityV2[market.value] = { error: '', data: null };
@@ -268,13 +279,13 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
             (() => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet) {
-                        for (const address of addresses) {
+                        for (const address of rewardsAddresses) {
                             rewardsData[address.toLowerCase()].king = { error: '', data: [] };
                         }
                         return;
                     }
-                    const kingRewards = yield getKingRewards(client, network, addresses);
-                    for (const address of addresses) {
+                    const kingRewards = yield getKingRewards(client, network, rewardsAddresses);
+                    for (const address of rewardsAddresses) {
                         const lowerAddress = address.toLowerCase();
                         rewardsData[lowerAddress].king = {
                             error: '',
@@ -284,7 +295,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 }
                 catch (error) {
                     console.error('Error fetching King rewards data in batch:', error);
-                    for (const address of addresses) {
+                    for (const address of rewardsAddresses) {
                         rewardsData[address.toLowerCase()].king = {
                             error: 'Error fetching King rewards data in batch',
                             data: null,
@@ -296,13 +307,13 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
             (() => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet) {
-                        for (const address of addresses) {
+                        for (const address of rewardsAddresses) {
                             rewardsData[address.toLowerCase()].uniswap = { error: '', data: [] };
                         }
                         return;
                     }
-                    const uniswapRewards = yield getUniswapRewards(client, network, addresses);
-                    for (const address of addresses) {
+                    const uniswapRewards = yield getUniswapRewards(client, network, rewardsAddresses);
+                    for (const address of rewardsAddresses) {
                         const lowerAddress = address.toLowerCase();
                         rewardsData[lowerAddress].uniswap = {
                             error: '',
@@ -312,7 +323,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 }
                 catch (error) {
                     console.error('Error fetching Uniswap rewards data in batch:', error);
-                    for (const address of addresses) {
+                    for (const address of rewardsAddresses) {
                         rewardsData[address.toLowerCase()].uniswap = {
                             error: 'Error fetching Uniswap rewards data in batch',
                             data: null,
@@ -320,7 +331,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     }
                 }
             }))(),
-            ...sparkMarkets.map((market) => addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...sparkMarkets.map((market) => rewardsAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet) {
                         rewardsData[address.toLowerCase()].spark[market.value] = { error: '', data: [] };
@@ -334,7 +345,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     rewardsData[address.toLowerCase()].spark[market.value] = { error: `Error fetching Spark rewards data for address ${address}`, data: null };
                 }
             }))).flat(),
-            ...addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...rewardsAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const merklData = yield getMerklUnclaimedRewards(address, network);
                     rewardsData[address.toLowerCase()].merkl = { error: '', data: merklData };
@@ -344,27 +355,28 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     rewardsData[address.toLowerCase()].merkl = { error: `Error fetching Merkl rewards data for address ${address}`, data: null };
                 }
             })),
-            ...aaveV3Markets.map(market => addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...aaveV3Markets.map(market => rewardsAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const aaveData = yield getUnclaimedRewardsForAllMarkets(client, network, address, market.providerAddress);
                     rewardsData[address.toLowerCase()].aaveV3[market.value] = { error: '', data: aaveData };
                 }
                 catch (error) {
                     console.error(`Error fetching Aave V3 Merit rewards data for address ${address}:`, error);
-                    rewardsData[address.toLowerCase()].aaveV3 = { error: `Error fetching Aave V3 rewards data for address ${address}`, data: null };
+                    // This market only: the other markets keep their rewards.
+                    rewardsData[address.toLowerCase()].aaveV3[market.value] = { error: `Error fetching Aave V3 rewards data for address ${address} on market ${market.value}`, data: null };
                 }
             }))).flat(),
             // Batch Spark Airdrop rewards
             (() => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet) {
-                        for (const address of addresses) {
+                        for (const address of rewardsAddresses) {
                             rewardsData[address.toLowerCase()].spk = { error: '', data: [] };
                         }
                         return;
                     }
-                    const sparkAirdropRewards = yield fetchSparkAirdropRewards(client, network, addresses);
-                    for (const address of addresses) {
+                    const sparkAirdropRewards = yield fetchSparkAirdropRewards(client, network, rewardsAddresses);
+                    for (const address of rewardsAddresses) {
                         const lowerAddress = address.toLowerCase();
                         rewardsData[lowerAddress].spk = {
                             error: '',
@@ -374,7 +386,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 }
                 catch (error) {
                     console.error('Error fetching Spark Airdrop rewards data in batch:', error);
-                    for (const address of addresses) {
+                    for (const address of rewardsAddresses) {
                         rewardsData[address.toLowerCase()].spk = {
                             error: 'Error fetching Spark Airdrop rewards data in batch',
                             data: null,
@@ -387,8 +399,8 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                     if (!isMainnet) {
                         return;
                     }
-                    const ethenaAirdropRewards = yield fetchEthenaAirdropRewards(addresses);
-                    for (const address of addresses) {
+                    const ethenaAirdropRewards = yield fetchEthenaAirdropRewards(rewardsAddresses);
+                    for (const address of rewardsAddresses) {
                         const lowerAddress = address.toLowerCase();
                         rewardsData[lowerAddress].ethena = {
                             error: '',
@@ -398,7 +410,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 }
                 catch (error) {
                     console.error('Error fetching Ethena Airdrop rewards data:', error);
-                    for (const address of addresses) {
+                    for (const address of rewardsAddresses) {
                         rewardsData[address.toLowerCase()].ethena = {
                             error: 'Error fetching Ethena Airdrop rewards data in batch',
                             data: null,
@@ -434,15 +446,16 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 try {
                     const [accDataPromise, earnDataPromise] = yield Promise.allSettled([
                         _getMorphoBlueAccountData(client, network, address, market, morphoMarketsData[market.value]),
-                        getMorphoEarn(client, network, address, market, morphoMarketsData[market.value]),
+                        includeStaking ? getMorphoEarn(client, network, address, market, morphoMarketsData[market.value]) : null,
                     ]);
                     if (accDataPromise.status === 'rejected') {
                         console.error(`Error fetching MorphoBlue account data for address ${address} on market ${market.value}:`, accDataPromise.reason);
                         positions[address.toLowerCase()].morphoBlue[market.value] = { error: `Error fetching MorphoBlue account data for address ${address} on market ${market.value}`, data: null };
                     }
                     if (earnDataPromise.status === 'rejected') {
-                        console.error(`Error fetching MorphoBlue account data for address ${address} on market ${market.value}:`, earnDataPromise.reason);
-                        positions[address.toLowerCase()].morphoBlue[market.value] = { error: `Error fetching MorphoBlue account data for address ${address} on market ${market.value}`, data: null };
+                        // An Earn failure belongs to the staking entry: the lending position is not the one that failed.
+                        console.error(`Error fetching MorphoBlue earn data for address ${address} on market ${market.value}:`, earnDataPromise.reason);
+                        stakingPositions[address.toLowerCase()].morphoBlue[market.value] = { error: `Error fetching MorphoBlue earn data for address ${address} on market ${market.value}`, data: null };
                     }
                     if (accDataPromise.status !== 'rejected') {
                         const accData = accDataPromise.value;
@@ -578,7 +591,7 @@ export function getPortfolioData(provider_1, network_1, defaultProvider_1, addre
                 }
             }))).flat(),
             // liquity sBold/yBold and staking options
-            ...addresses.map((address) => __awaiter(this, void 0, void 0, function* () {
+            ...stakingAddresses.map((address) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     if (!isMainnet) {
                         stakingPositions[address.toLowerCase()].liquityV2SBoldYBold = { error: '', data: null };