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 { FluidEarnPositionData, FluidMarketData, FluidVaultData } from './fluid'; import { LiquityStakingData, LiquityTroveInfo } from './liquity'; import { LiquityV2MarketData, LiquityV2SBoldYBoldData, LiquityV2StakingData, LiquityV2TroveData, LiquityV2Versions } from './liquityV2'; import { LlamaLendGlobalMarketData, LlamaLendUserData, LlamaLendVersionsType } from './llamaLend'; import { CdpData, IlkInfo } from './maker'; import { MorphoBlueEarnData, MorphoBlueMarketInfo, MorphoBluePositionData, MorphoBlueVersions } from './morphoBlue'; import { MorphoMidnightMarketInfo, MorphoMidnightPositionData, MorphoMidnightVersions } from './morphoMidnight'; import { SparkMarketsData, SparkPositionData, SparkVersions } from './spark'; export interface PortfolioProtocolData { 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 markets. */ export interface PortfolioDataOptions { /** positions (lending); default true. With false it comes back as {} and no lending position is read. */ positions?: boolean; /** stakingPositions; default true. With false it comes back as {} and no staking source is read. */ staking?: boolean; /** rewardsData; default true. With false it comes back as {} and no rewards source is read. */ rewards?: boolean; /** * Liquity V2 troves in positions[address].liquityV2; default false, as the DeFi Saver app reads them on its own. * Mainnet only: elsewhere liquityV2 is {}. Needs positions. */ liquityV2?: boolean; } /** One Liquity V2 market's troves of an address, by trove id — with an error when the ids or any trove failed to load. */ export interface PortfolioLiquityV2Troves { error: string; data: { [troveId: string]: LiquityV2TroveData; }; } export interface PortfolioPositionsDataForAddress { aaveV3: { [key in AaveVersions]?: PortfolioProtocolData; }; morphoBlue: { [key in MorphoBlueVersions]?: PortfolioProtocolData; }; morphoMidnight: { [key in MorphoMidnightVersions]?: PortfolioProtocolData; }; compoundV3: { [key in CompoundVersions]?: PortfolioProtocolData; }; spark: { [key in SparkVersions]?: PortfolioProtocolData; }; maker: { [key: string]: PortfolioProtocolData; }; aaveV2: { [key in AaveVersions]?: PortfolioProtocolData; }; compoundV2: { [key in CompoundVersions]?: PortfolioProtocolData; }; liquity: PortfolioProtocolData | {}; crvUsd: { [key in CrvUSDVersions]?: PortfolioProtocolData; }; llamaLend: { [key in LlamaLendVersionsType]?: PortfolioProtocolData; }; fluid: { error: string; data: { [key: string]: FluidVaultData; }; }; aaveV4: { [key in AaveV4SpokesType]?: PortfolioProtocolData; }; /** Only with the liquityV2 option. Every trove the address holds, by market. */ liquityV2?: { [key in LiquityV2Versions]?: PortfolioLiquityV2Troves; }; } 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; }; compoundV3: Record; spark: Record; aaveV2: Record; compoundV2: Record; /** 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; }; /** Fluid lending (fToken) deposits; `{ error: '', data: {} }` on a network without Fluid. */ fluid: FluidEarnPositionData[] | PortfolioProtocolError | { error: string; data: Record; }; /** Umbrella stakes; absent off mainnet. */ umbrella?: UmbrellaStakingData | PortfolioProtocolError; /** sBOLD, yBOLD and stYBOLD; data is null off mainnet. */ liquityV2SBoldYBold: PortfolioProtocolData; } export type PortfolioStakingPositionsData = Record; /** The claimable rewards getPortfolioData returns for an address. Off mainnet only Merkl and Aave V3 are read. */ export interface PortfolioRewardsDataForAddress { merkl: PortfolioProtocolData; aaveV3: { [key in AaveVersions]?: PortfolioProtocolData; }; spark: { [key in SparkVersions]?: PortfolioProtocolData; }; /** The SPK airdrop. */ spk: PortfolioProtocolData; king: PortfolioProtocolData; /** {} off mainnet. */ ethena: PortfolioProtocolData | {}; uniswap: PortfolioProtocolData; } export type PortfolioRewardsData = Record; /** The `markets` getPortfolioData returns: every market it read, by protocol, keyed by market or spoke. */ export interface PortfolioMarketsData { morphoMarketsData: Record; morphoMidnightMarketsData: Record; compoundV3MarketsData: Record; sparkMarketsData: Record; aaveV3MarketsData: Record; aaveV2MarketsData: Record; compoundV2MarketsData: Record; crvUsdMarketsData: Record; llamaLendMarketsData: Record; liquityV2MarketsData: Record; aaveV4SpokesData: Record; } /** * The `markets` getShifterPortfolioData returns: the portfolio's markets, plus Fluid's and Maker's, which the shifter * offers as destinations. Kept apart from PortfolioMarketsData, which getPortfolioData does not fill these into. */ export interface ShifterPortfolioMarketsData extends PortfolioMarketsData { fluidMarketsData: Record; makerMarketsData: Record; } /** The markets that could not be read, by their key in PortfolioMarketsData, then by market or spoke: the error. */ export type PortfolioMarketsErrors = { [key in keyof PortfolioMarketsData]?: Record; }; /** * What the portfolio fetch could not read and has no `{ error, data }` entry of its own to report it in. A key is * present only when something under it failed; {} when everything was read. */ export interface PortfolioErrors { /** Markets missing from `markets`; every position on such a market is an entry with an error. */ markets?: PortfolioMarketsErrors; /** Addresses whose Maker vault list could not be read: their `maker` is {}, which would otherwise read as "no vaults". */ makerCdps?: Record; } /** getPortfolioMarketsData's result. */ export interface PortfolioMarketsResult { /** Every market read; one that failed is missing and named in `errors`. */ markets: PortfolioMarketsData; errors: PortfolioMarketsErrors; } /** getPortfolioUserData's result: what is read per address. */ export interface PortfolioUserData { positions: PortfolioPositionsData; stakingPositions: PortfolioStakingPositionsData; rewardsData: PortfolioRewardsData; errors: Pick; } /** getPortfolioData's result. */ export interface PortfolioData extends Omit { markets: PortfolioMarketsData; errors: PortfolioErrors; }