@defisaver/positions-sdk 2.1.168 → 2.1.169-portfolio-api-dev

package/esm/portfolio/lendingProtocols.d.ts

@@ -0,0 +1,184 @@
+import { Client } from 'viem';
+import { EthAddress, NetworkNumber } from '../types/common';
+import { AaveMarketInfo, AaveV4SpokeInfo, CompoundMarketData, CrvUSDMarketData, LlamaLendMarketData, MorphoBlueMarketData, MorphoMidnightMarketData, PortfolioMarketsData, PortfolioPositionsData, PortfolioPositionsDataForAddress, PortfolioProtocolData, SparkMarketData } from '../types';
+/**
+ * The lending protocols the portfolio reads the same way — a market's data, then each address's position on it — one
+ * entry each. Adding such a protocol is its types (its key in PortfolioPositionsDataForAddress and in
+ * PortfolioMarketsData) and its entry in LENDING_PROTOCOLS; the portfolio reads, errors and options follow. Maker,
+ * Liquity, Fluid and Liquity V2 have shapes of their own and are read by their own code in ./index.ts.
+ */
+/** What a position read gets. */
+export interface PortfolioReadContext {
+    client: Client;
+    network: NetworkNumber;
+}
+/** What a market read gets: also the default client, on Ethereum (Compound V3 reads its prices there). */
+export interface PortfolioMarketsReadContext extends PortfolioReadContext {
+    defaultClient: Client;
+}
+type PositionKey = keyof PortfolioPositionsDataForAddress;
+type MarketsKey = keyof PortfolioMarketsData;
+type PositionsOf<K extends PositionKey> = NonNullable<PortfolioPositionsDataForAddress[K]>;
+/** The data of one of a protocol's positions: what positions[address][K][market] holds as `{ error, data }`. */
+export type LendingPositionData<K extends PositionKey> = NonNullable<PositionsOf<K>[keyof PositionsOf<K>]> extends PortfolioProtocolData<infer D> ? D : never;
+export interface LendingProtocol<K extends PositionKey, M extends MarketsKey, Market extends {
+    value: string;
+}> {
+    /** Its key in PortfolioMarketsData. */
+    marketsKey: M;
+    /** Its name in error messages. */
+    label: string;
+    /** Its markets on a network; none where it is not deployed. */
+    markets: (network: NetworkNumber) => Market[];
+    readMarket: (context: PortfolioMarketsReadContext, market: Market) => Promise<PortfolioMarketsData[M][string]>;
+    /** An address's position on a market; undefined when the market can hold none. */
+    readPosition: (context: PortfolioReadContext, address: EthAddress, market: Market, marketData: PortfolioMarketsData[M][string]) => Promise<LendingPositionData<K> | undefined>;
+    /** Whether there is a position to list: an address without one gets no entry for that market. */
+    holds: (position: LendingPositionData<K>) => boolean;
+}
+/**
+ * A market's data, or a throw that the caller's catch turns into the position's error entry: read against a missing
+ * market, a position would otherwise come back empty and read as "no position".
+ */
+export declare const requireMarket: <T>(marketsData: Record<string, T>, market: string) => T;
+export declare const aaveV3Lending: {
+    key: "aaveV3";
+    marketsKey: "aaveV3MarketsData";
+    markets: (network: NetworkNumber) => AaveMarketInfo[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const aaveV4Lending: {
+    key: "aaveV4";
+    marketsKey: "aaveV4SpokesData";
+    markets: (network: NetworkNumber) => AaveV4SpokeInfo[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const morphoBlueLending: {
+    key: "morphoBlue";
+    marketsKey: "morphoMarketsData";
+    markets: (network: NetworkNumber) => MorphoBlueMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const morphoMidnightLending: {
+    key: "morphoMidnight";
+    marketsKey: "morphoMidnightMarketsData";
+    markets: (network: NetworkNumber) => MorphoMidnightMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const compoundV3Lending: {
+    key: "compoundV3";
+    marketsKey: "compoundV3MarketsData";
+    markets: (network: NetworkNumber) => CompoundMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const sparkLending: {
+    key: "spark";
+    marketsKey: "sparkMarketsData";
+    markets: (network: NetworkNumber) => SparkMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const aaveV2Lending: {
+    key: "aaveV2";
+    marketsKey: "aaveV2MarketsData";
+    markets: (network: NetworkNumber) => AaveMarketInfo[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const compoundV2Lending: {
+    key: "compoundV2";
+    marketsKey: "compoundV2MarketsData";
+    markets: (network: NetworkNumber) => CompoundMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const crvUsdLending: {
+    key: "crvUsd";
+    marketsKey: "crvUsdMarketsData";
+    markets: (network: NetworkNumber) => CrvUSDMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+export declare const llamaLendLending: {
+    key: "llamaLend";
+    marketsKey: "llamaLendMarketsData";
+    markets: (network: NetworkNumber) => LlamaLendMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+};
+/** Every lending protocol read through its entry, in the order positions list them. */
+export declare const LENDING_PROTOCOLS: readonly [{
+    key: "aaveV3";
+    marketsKey: "aaveV3MarketsData";
+    markets: (network: NetworkNumber) => AaveMarketInfo[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "aaveV4";
+    marketsKey: "aaveV4SpokesData";
+    markets: (network: NetworkNumber) => AaveV4SpokeInfo[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "morphoBlue";
+    marketsKey: "morphoMarketsData";
+    markets: (network: NetworkNumber) => MorphoBlueMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "morphoMidnight";
+    marketsKey: "morphoMidnightMarketsData";
+    markets: (network: NetworkNumber) => MorphoMidnightMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "compoundV3";
+    marketsKey: "compoundV3MarketsData";
+    markets: (network: NetworkNumber) => CompoundMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "spark";
+    marketsKey: "sparkMarketsData";
+    markets: (network: NetworkNumber) => SparkMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "aaveV2";
+    marketsKey: "aaveV2MarketsData";
+    markets: (network: NetworkNumber) => AaveMarketInfo[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "compoundV2";
+    marketsKey: "compoundV2MarketsData";
+    markets: (network: NetworkNumber) => CompoundMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "crvUsd";
+    marketsKey: "crvUsdMarketsData";
+    markets: (network: NetworkNumber) => CrvUSDMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}, {
+    key: "llamaLend";
+    marketsKey: "llamaLendMarketsData";
+    markets: (network: NetworkNumber) => LlamaLendMarketData[];
+    readMarkets: (context: PortfolioMarketsReadContext, markets: PortfolioMarketsData) => Promise<Record<string, string>>;
+    readPositions: (context: PortfolioReadContext, addresses: EthAddress[], marketsData: Promise<PortfolioMarketsData>, positions: PortfolioPositionsData) => Promise<void>[];
+}];
+export type LendingKey = typeof LENDING_PROTOCOLS[number]['key'];
+/** The keys ./index.ts reads with code of its own. */
+export type SpecialPositionKey = 'maker' | 'liquity' | 'fluid' | 'liquityV2';
+type SpecialMarketsKey = 'liquityV2MarketsData';
+type UnreadPositionKey = Exclude<PositionKey, LendingKey | SpecialPositionKey>;
+type UnreadMarketsKey = Exclude<MarketsKey, typeof LENDING_PROTOCOLS[number]['marketsKey'] | SpecialMarketsKey>;
+export declare const EVERY_POSITION_KEY_IS_READ: [UnreadPositionKey] extends [never] ? true : UnreadPositionKey;
+export declare const EVERY_MARKETS_KEY_IS_READ: [UnreadMarketsKey] extends [never] ? true : UnreadMarketsKey;
+export {};

package/esm/portfolio/lendingProtocols.js

@@ -0,0 +1,189 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Dec from 'decimal.js';
+import { NetworkNumber } from '../types/common';
+import { AaveMarkets, AaveV4Spokes, CompoundMarkets, CrvUsdMarkets, LlamaLendMarkets, MorphoBlueMarkets, MorphoMidnightMarkets, SparkMarkets, } from '../markets';
+import { AaveVersions, CompoundVersions, } from '../types';
+import { _getAaveV3AccountData, _getAaveV3MarketData } from '../aaveV3';
+import { _getAaveV4AccountData, _getAaveV4SpokeData } from '../aaveV4';
+import { _getAaveV2AccountData, _getAaveV2MarketsData } from '../aaveV2';
+import { _getCompoundV2AccountData, _getCompoundV2MarketsData } from '../compoundV2';
+import { _getCompoundV3AccountData, _getCompoundV3MarketsData } from '../compoundV3';
+import { _getCurveUsdGlobalData, _getCurveUsdUserData } from '../curveUsd';
+import { _getLlamaLendGlobalData, _getLlamaLendUserData } from '../llamaLend';
+import { _getMorphoBlueAccountData, _getMorphoBluePortfolioMarketData } from '../morphoBlue';
+import { _getMorphoMidnightAccountData, _getMorphoMidnightMarketData } from '../morphoMidnight';
+import { _getSparkAccountData, _getSparkMarketsData } from '../spark';
+import { ZERO_ADDRESS } from '../constants';
+/**
+ * A market's data, or a throw that the caller's catch turns into the position's error entry: read against a missing
+ * market, a position would otherwise come back empty and read as "no position".
+ */
+export const requireMarket = (marketsData, market) => {
+    const marketData = marketsData[market];
+    if (!marketData)
+        throw new Error(`Market data for ${market} is not available`);
+    return marketData;
+};
+/** requireMarket for one protocol's key, typed by that key's market data. */
+const requireMarketOf = (marketsData, key, market) => {
+    // TypeScript reads marketsData[key][market] as any protocol's market data; the key's own is what is stored there.
+    const marketData = marketsData[key][market];
+    if (!marketData)
+        throw new Error(`Market data for ${market} is not available`);
+    return marketData;
+};
+/** A protocol's entry with its reads, typed by its own market and position types. */
+const lendingProtocol = (key, protocol) => {
+    /** Every market of the protocol into `markets`; resolves to the ones that failed (left out), with their errors. */
+    const readMarkets = (context, markets) => __awaiter(void 0, void 0, void 0, function* () {
+        const protocolMarkets = markets[protocol.marketsKey];
+        const failed = {};
+        yield Promise.all(protocol.markets(context.network).map((market) => __awaiter(void 0, void 0, void 0, function* () {
+            try {
+                protocolMarkets[market.value] = yield protocol.readMarket(context, market);
+            }
+            catch (error) {
+                console.error(`Error fetching ${protocol.marketsKey} for market ${market.value}:`, error);
+                failed[market.value] = `Error fetching ${protocol.marketsKey} for market ${market.value}`;
+            }
+        })));
+        return failed;
+    });
+    /**
+     * Every address's position on every market into `positions`, each read once its market is in: an entry with the data
+     * where the address holds a position, an entry with an error where the read or its market failed, none otherwise.
+     */
+    const readPositions = (context, addresses, marketsData, positions) => protocol.markets(context.network).flatMap((market) => addresses.map((address) => __awaiter(void 0, void 0, void 0, function* () {
+        // Keyed by the protocol's market type in PortfolioPositionsDataForAddress; written here by market.value.
+        const byMarket = positions[address.toLowerCase()][key];
+        try {
+            const marketData = requireMarketOf(yield marketsData, protocol.marketsKey, market.value);
+            const position = yield protocol.readPosition(context, address, market, marketData);
+            if (position && protocol.holds(position))
+                byMarket[market.value] = { error: '', data: position };
+        }
+        catch (error) {
+            console.error(`Error fetching ${protocol.label} account data for address ${address} on market ${market.value}:`, error);
+            byMarket[market.value] = { error: `Error fetching ${protocol.label} account data for address ${address} on market ${market.value}`, data: null };
+        }
+    })));
+    return {
+        key, marketsKey: protocol.marketsKey, markets: protocol.markets, readMarkets, readPositions,
+    };
+};
+const onNetwork = (network, markets) => markets.filter((market) => market.chainIds.includes(network));
+const suppliesAnything = (position) => new Dec(position.suppliedUsd).gt(0);
+const suppliesOrBorrowsAnything = (position) => new Dec(position.suppliedUsd).gt(0) || new Dec(position.borrowedUsd).gt(0);
+export const aaveV3Lending = lendingProtocol('aaveV3', {
+    marketsKey: 'aaveV3MarketsData',
+    label: 'AaveV3',
+    markets: (network) => onNetwork(network, [AaveVersions.AaveV3, AaveVersions.AaveV3Lido, AaveVersions.AaveV3Etherfi].map((version) => AaveMarkets(network)[version])),
+    readMarket: ({ client, network }, market) => _getAaveV3MarketData(client, network, market),
+    readPosition: ({ client, network }, address, market, marketData) => _getAaveV3AccountData(client, network, address, Object.assign({ selectedMarket: market }, marketData)),
+    holds: suppliesAnything,
+});
+export const aaveV4Lending = lendingProtocol('aaveV4', {
+    marketsKey: 'aaveV4SpokesData',
+    label: 'AaveV4',
+    markets: (network) => onNetwork(network, Object.values(AaveV4Spokes(network))),
+    readMarket: ({ client, network }, spoke) => _getAaveV4SpokeData(client, network, spoke),
+    readPosition: ({ client, network }, address, _spoke, spokeData) => _getAaveV4AccountData(client, network, spokeData, address),
+    holds: suppliesAnything,
+});
+export const morphoBlueLending = lendingProtocol('morphoBlue', {
+    marketsKey: 'morphoMarketsData',
+    label: 'MorphoBlue',
+    markets: (network) => onNetwork(network, Object.values(MorphoBlueMarkets(network))),
+    readMarket: ({ client, network }, market) => _getMorphoBluePortfolioMarketData(client, network, market),
+    readPosition: ({ client, network }, address, market, marketData) => _getMorphoBlueAccountData(client, network, address, market, marketData),
+    holds: suppliesAnything,
+});
+export const morphoMidnightLending = lendingProtocol('morphoMidnight', {
+    marketsKey: 'morphoMidnightMarketsData',
+    label: 'MorphoMidnight',
+    markets: (network) => onNetwork(network, Object.values(MorphoMidnightMarkets(network))),
+    readMarket: ({ client, network }, market) => _getMorphoMidnightMarketData(client, network, market),
+    // Markets are created lazily on the first position, so an uncreated one can hold no position.
+    readPosition: (_a, address_1, market_1, marketData_1) => __awaiter(void 0, [_a, address_1, market_1, marketData_1], void 0, function* ({ client, network }, address, market, marketData) {
+        return (marketData.isCreated
+            ? _getMorphoMidnightAccountData(client, network, address, market, marketData)
+            : undefined);
+    }),
+    holds: suppliesAnything,
+});
+export const compoundV3Lending = lendingProtocol('compoundV3', {
+    marketsKey: 'compoundV3MarketsData',
+    label: 'CompoundV3',
+    markets: (network) => onNetwork(network, Object.values(CompoundMarkets(network)).filter((market) => market.value !== CompoundVersions.CompoundV2)),
+    readMarket: ({ client, defaultClient, network }, market) => _getCompoundV3MarketsData(client, network, market, defaultClient),
+    readPosition: ({ client, network }, address, market, marketData) => _getCompoundV3AccountData(client, network, address, ZERO_ADDRESS, { selectedMarket: market, assetsData: marketData.assetsData }),
+    holds: suppliesAnything,
+});
+export const sparkLending = lendingProtocol('spark', {
+    marketsKey: 'sparkMarketsData',
+    label: 'Spark',
+    markets: (network) => onNetwork(network, Object.values(SparkMarkets(network))),
+    readMarket: ({ client, network }, market) => _getSparkMarketsData(client, network, market),
+    readPosition: ({ client, network }, address, market, marketData) => _getSparkAccountData(client, network, address, {
+        selectedMarket: market, assetsData: marketData.assetsData, eModeCategoriesData: marketData.eModeCategoriesData,
+    }),
+    holds: suppliesAnything,
+});
+export const aaveV2Lending = lendingProtocol('aaveV2', {
+    marketsKey: 'aaveV2MarketsData',
+    label: 'AaveV2',
+    markets: (network) => onNetwork(network, [AaveMarkets(network)[AaveVersions.AaveV2]]),
+    readMarket: ({ client, network }, market) => _getAaveV2MarketsData(client, network, market),
+    readPosition: ({ client, network }, address, market, marketData) => _getAaveV2AccountData(client, network, address, marketData.assetsData, market),
+    holds: suppliesAnything,
+});
+export const compoundV2Lending = lendingProtocol('compoundV2', {
+    marketsKey: 'compoundV2MarketsData',
+    label: 'CompoundV2',
+    markets: (network) => onNetwork(network, [CompoundMarkets(network)[CompoundVersions.CompoundV2]]),
+    readMarket: ({ client, network }) => _getCompoundV2MarketsData(client, network),
+    readPosition: ({ client, network }, address, _market, marketData) => _getCompoundV2AccountData(client, network, address, marketData.assetsData),
+    holds: suppliesAnything,
+});
+export const crvUsdLending = lendingProtocol('crvUsd', {
+    marketsKey: 'crvUsdMarketsData',
+    label: 'Curve USD',
+    markets: (network) => onNetwork(network, Object.values(CrvUsdMarkets(network))),
+    readMarket: ({ client, network }, market) => _getCurveUsdGlobalData(client, network, market),
+    // The market's borrow rate is passed in, so the read does not fetch it again.
+    readPosition: ({ client, network }, address, market, marketData) => _getCurveUsdUserData(client, network, address, market, marketData.activeBand, marketData.borrowRate),
+    holds: suppliesOrBorrowsAnything,
+});
+export const llamaLendLending = lendingProtocol('llamaLend', {
+    marketsKey: 'llamaLendMarketsData',
+    label: 'LlamaLend',
+    markets: (network) => ([NetworkNumber.Eth, NetworkNumber.Arb].includes(network) ? onNetwork(network, Object.values(LlamaLendMarkets(network))) : []),
+    readMarket: ({ client, network }, market) => _getLlamaLendGlobalData(client, network, market),
+    readPosition: (_a, address_1, market_1, marketData_1) => __awaiter(void 0, [_a, address_1, market_1, marketData_1], void 0, function* ({ client, network }, address, market, marketData) {
+        return (Object.assign(Object.assign({}, yield _getLlamaLendUserData(client, network, address, market, marketData)), { borrowRate: marketData.borrowRate }));
+    }),
+    holds: suppliesOrBorrowsAnything,
+});
+/** Every lending protocol read through its entry, in the order positions list them. */
+export const LENDING_PROTOCOLS = [
+    aaveV3Lending,
+    aaveV4Lending,
+    morphoBlueLending,
+    morphoMidnightLending,
+    compoundV3Lending,
+    sparkLending,
+    aaveV2Lending,
+    compoundV2Lending,
+    crvUsdLending,
+    llamaLendLending,
+];
+export const EVERY_POSITION_KEY_IS_READ = true;
+export const EVERY_MARKETS_KEY_IS_READ = true;

package/esm/savings/index.d.ts

@@ -1,4 +1,4 @@
-import { MakerDsrType, MorphoVaultType, SkySavingsType, SparkSavingsVaultType, SummerVaultType, YearnV3VaultType, YearnVaultType } from '../types';
+import { SavingsData, SavingsDataWithErrors } from '../types';
 import { EthAddress, EthereumProvider, NetworkNumber } from '../types/common';
 import * as morphoVaults from './morphoVaults';
 import * as yearnVaults from './yearnVaults';
@@ -8,4 +8,10 @@ import * as sparkSavingsVaults from './sparkSavingsVaults';
 import * as summerVaults from './summerVaults';
 import * as yearnV3Vaults from './yearnV3Vaults';
 export { morphoVaults, yearnVaults, makerDsr, skyOptions, sparkSavingsVaults, summerVaults, yearnV3Vaults, };
-export declare const getSavingsData: (provider: EthereumProvider, network: NetworkNumber, accounts: EthAddress[]) => Promise<Partial<Record<MakerDsrType | MorphoVaultType | SkySavingsType | SparkSavingsVaultType | SummerVaultType | YearnV3VaultType | YearnVaultType, import("../types").SavingsVaultData>>>;
+/**
+ * Every savings vault of a network for the given accounts, and, for each vault that came back without data, why — so
+ * a vault that failed is never mistaken for one the accounts have nothing in.
+ */
+export declare const getSavingsDataWithErrors: (provider: EthereumProvider, network: NetworkNumber, accounts: EthAddress[]) => Promise<SavingsDataWithErrors>;
+/** Every savings vault of a network for the given accounts. A vault that failed is left out: use getSavingsDataWithErrors to tell why. */
+export declare const getSavingsData: (provider: EthereumProvider, network: NetworkNumber, accounts: EthAddress[]) => Promise<SavingsData>;

package/esm/savings/index.js

@@ -17,7 +17,12 @@ import * as sparkSavingsVaults from './sparkSavingsVaults';
 import * as summerVaults from './summerVaults';
 import * as yearnV3Vaults from './yearnV3Vaults';
 export { morphoVaults, yearnVaults, makerDsr, skyOptions, sparkSavingsVaults, summerVaults, yearnV3Vaults, };
-export const getSavingsData = (provider, network, accounts) => __awaiter(void 0, void 0, void 0, function* () {
+/**
+ * Every savings vault of a network for the given accounts, and, for each vault that came back without data, why — so
+ * a vault that failed is never mistaken for one the accounts have nothing in.
+ */
+export const getSavingsDataWithErrors = (provider, network, accounts) => __awaiter(void 0, void 0, void 0, function* () {
+    const isMainnet = network === NetworkNumber.Eth;
     const morphoVaultsList = Object.keys(morphoVaults.morphoVaultsOptions.MORPHO_VAULTS)
         .filter((key) => morphoVaults.morphoVaultsOptions.getMorphoVault(key).network === network);
     const yearnVaultsList = Object.keys(yearnVaults.yearnVaultsOptions.YEARN_VAULTS);
@@ -25,7 +30,16 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
     const yearnV3VaultsList = Object.keys(yearnV3Vaults.yearnV3VaultsOptions.YEARN_V3_VAULTS);
     const summerVaultsList = Object.keys(summerVaults.summerVaultsOptions.SUMMER_VAULTS)
         .filter((key) => summerVaults.summerVaultsOptions.getSummerVault(key).network === network);
+    // Every vault read on this network, so one left without data or an error can still be reported.
+    const vaultKeys = [
+        ...morphoVaultsList,
+        ...(isMainnet ? [
+            ...yearnVaultsList, ...sparkSavingsVaultsList, ...yearnV3VaultsList, MakerDsrType.MakerDsrVault, SkySavingsType.SkySavings,
+        ] : []),
+        ...summerVaultsList,
+    ];
     const savingsData = {};
+    const errors = {};
     yield Promise.all([
         ...(morphoVaultsList.length ? [
             (() => __awaiter(void 0, void 0, void 0, function* () {
@@ -36,10 +50,11 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
                 }
                 catch (err) {
                     console.error('[getSavingsData] Error fetching morpho vaults:', err);
+                    morphoVaultsList.forEach((vaultKey) => { errors[vaultKey] = `Error fetching morpho vault ${vaultKey}`; });
                 }
             }))(),
         ] : []),
-        ...(network === NetworkNumber.Eth ? [
+        ...(isMainnet ? [
             ...yearnVaultsList.map((vaultKey) => __awaiter(void 0, void 0, void 0, function* () {
                 try {
                     const vault = yearnVaults.yearnVaultsOptions.getYearnVault(vaultKey);
@@ -48,6 +63,7 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
                 }
                 catch (err) {
                     console.error(`[getSavingsData] Error fetching yearn vault ${vaultKey}:`, err);
+                    errors[vaultKey] = `Error fetching yearn vault ${vaultKey}`;
                 }
             })),
             ...sparkSavingsVaultsList.map((vaultKey) => __awaiter(void 0, void 0, void 0, function* () {
@@ -58,6 +74,7 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
                 }
                 catch (err) {
                     console.error(`[getSavingsData] Error fetching spark savings vault ${vaultKey}:`, err);
+                    errors[vaultKey] = `Error fetching spark savings vault ${vaultKey}`;
                 }
             })),
             ...yearnV3VaultsList.map((vaultKey) => __awaiter(void 0, void 0, void 0, function* () {
@@ -68,6 +85,7 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
                 }
                 catch (err) {
                     console.error(`[getSavingsData] Error fetching yearn v3 vault ${vaultKey}:`, err);
+                    errors[vaultKey] = `Error fetching yearn v3 vault ${vaultKey}`;
                 }
             })),
             (() => __awaiter(void 0, void 0, void 0, function* () {
@@ -77,6 +95,7 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
                 }
                 catch (err) {
                     console.error('[getSavingsData] Error fetching maker DSR data:', err);
+                    errors[MakerDsrType.MakerDsrVault] = 'Error fetching maker DSR data';
                 }
             }))(),
             (() => __awaiter(void 0, void 0, void 0, function* () {
@@ -86,6 +105,7 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
                 }
                 catch (err) {
                     console.error('[getSavingsData] Error fetching Sky savings data:', err);
+                    errors[SkySavingsType.SkySavings] = 'Error fetching Sky savings data';
                 }
             }))(),
         ] : []),
@@ -97,8 +117,16 @@ export const getSavingsData = (provider, network, accounts) => __awaiter(void 0,
             }
             catch (err) {
                 console.error(`[getSavingsData] Error fetching summer vault ${vaultKey}:`, err);
+                errors[vaultKey] = `Error fetching summer vault ${vaultKey}`;
             }
         })),
     ]);
-    return savingsData;
+    // getMorphoVaultsData leaves out, without throwing, a vault whose on-chain reads failed or that the Morpho API did not return.
+    vaultKeys.forEach((vaultKey) => {
+        if (!savingsData[vaultKey] && !errors[vaultKey])
+            errors[vaultKey] = `No data returned for savings vault ${vaultKey}`;
+    });
+    return { data: savingsData, errors };
 });
+/** Every savings vault of a network for the given accounts. A vault that failed is left out: use getSavingsDataWithErrors to tell why. */
+export const getSavingsData = (provider, network, accounts) => __awaiter(void 0, void 0, void 0, function* () { return (yield getSavingsDataWithErrors(provider, network, accounts)).data; });

package/esm/types/aave.d.ts

@@ -1,4 +1,4 @@
-import { IncentiveData, LeverageType, MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber } from './common';
+import { EthAddress, IncentiveData, LeverageType, MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber } from './common';
 export declare enum AaveVersions {
     AaveV1 = "v1",
     AaveV2 = "v2default",
@@ -85,6 +85,8 @@ export interface AaveV3AssetData extends AaveAssetData {
     liquidationBonus: string;
     supplyIncentives: IncentiveData[];
     borrowIncentives: IncentiveData[];
+    aTokenAddress?: EthAddress;
+    vTokenAddress?: EthAddress;
 }
 export type EModeCategoriesData = Record<number, EModeCategoryData>;
 export type AaveAssetsData<T> = {
@@ -122,7 +124,12 @@ export type AaveUsedAssets<T> = {
 };
 export type AaveV2UsedAssets = AaveUsedAssets<AaveV2UsedAsset>;
 export type AaveV3UsedAssets = AaveUsedAssets<AaveV3UsedAsset>;
-export interface AavePositionData extends MMPositionData {
+/**
+ * Fields aaveAnyGetAggregatedPositionData adds to every Aave V2/V3 position at runtime, on top of those declared
+ * below. Optional, so code that builds a position by hand keeps compiling.
+ */
+export type AavePositionAggregatedFields = Partial<Omit<AaveV3AggregatedPositionData, keyof MMPositionData | 'ratio' | 'collRatio' | 'safetyRatioWithLtvZeroFallback' | 'suppliedUsd' | 'borrowedUsd' | 'borrowLimitUsd' | 'suppliedCollateralUsd' | 'incentiveUsd' | 'totalInterestUsd'>>;
+export interface AavePositionData extends MMPositionData, AavePositionAggregatedFields {
     ratio: string;
     minRatio: string;
     collRatio: string;
@@ -140,6 +147,12 @@ export interface AavePositionData extends MMPositionData {
 }
 export interface AaveV2PositionData extends AavePositionData {
     usedAssets: AaveV2UsedAssets;
+    eModeCategory?: number;
+    isInIsolationMode?: boolean;
+    isInSiloedMode?: boolean;
+    eModeCategories?: {
+        [key: number]: EModeCategoryDataMapping;
+    };
 }
 export interface AaveV3PositionData extends AavePositionData {
     usedAssets: AaveV3UsedAssets;
@@ -188,3 +201,86 @@ export interface AaveHelperCommon {
     selectedMarket: Partial<AaveMarketInfo>;
     network?: NetworkNumber;
 }
+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;
+}
+/** stkAAVE, stkGHO and sGHO of an address, from getStakeAaveData. */
+export interface StakeAaveData {
+    activatedCooldown: string;
+    activatedCooldownAmount: string;
+    stkAaveRewardsBalance: string;
+    aaveRewardsBalance: string;
+    stkAaveBalance: string;
+    stkGhoBalance: string;
+    ghoMeritApy: string;
+    stkAaveApy: string;
+    sgho: SghoData;
+}
+export interface UmbrellaTokenInfo {
+    token: EthAddress;
+    /** USD, converted from the oracle's 8 decimals. */
+    price: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+}
+export interface UmbrellaRewardTokenData {
+    rewardTokenData: UmbrellaTokenInfo;
+    maxEmissionPerSecond: bigint;
+    distributionEnd: bigint;
+}
+export interface UmbrellaStakingAccountData {
+    stakeUserBalance: string;
+    rewardsTokenUserData: {
+        reward: EthAddress;
+        currentReward: string;
+    }[];
+    userCooldownAmount: string;
+    userEndOfCooldown: bigint | string;
+    userWithdrawalWindow: bigint | string;
+}
+/**
+ * One Umbrella stake token of an address, from getUmbrellaData: the view contracts' structs merged, with the amounts
+ * the app reads converted to decimal strings. The bigint fields are the views' raw values, as the SDK passes them.
+ */
+export interface UmbrellaStakingTokenData {
+    stakeTokenData: UmbrellaTokenInfo;
+    totalAssets: string;
+    targetLiquidity: string;
+    isStakeConfigured: boolean;
+    rewardsTokenData: UmbrellaRewardTokenData[];
+    stakeToken: EthAddress;
+    stakeUserBalance: bigint;
+    rewardsTokenUserData: {
+        reward: EthAddress;
+        currentReward: bigint;
+    }[];
+    stkToken: EthAddress;
+    totalShares: string;
+    stkUnderlyingToken: EthAddress;
+    aToken: EthAddress;
+    cooldownPeriod: bigint;
+    unstakeWindow: bigint;
+    stkTokenToWaTokenRate: string;
+    waTokenToATokenRate: string;
+    rewardsEmissionRates: string[];
+    userCooldownAmount: bigint;
+    userEndOfCooldown: bigint;
+    userWithdrawalWindow: bigint;
+    account: UmbrellaStakingAccountData;
+}
+/** Keyed by Umbrella stake (UmbrellaGHO, UmbrellaUSDC, UmbrellaUSDT, UmbrellaETH). */
+export type UmbrellaStakingData = Record<string, UmbrellaStakingTokenData>;