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

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;
@@ -19,6 +19,11 @@ export declare const nftContractCreationBlockMapping: {
     liquityv2wstethlegacy: number;
     liquityv2rethlegacy: number;
 };
+/**
+ * The trove ids of several accounts in one market: the market's NFT transfers are read once for all of them, rather
+ * than once per account as _getLiquityV2UserTroveIds does.
+ */
+export declare const _getLiquityV2UsersTroveIds: (provider: PublicClient, network: NetworkNumber, selectedMarket: LiquityV2MarketInfo, troveNFTAddress: EthAddress, limitBlocksForEventFetching: boolean, accounts: EthAddress[]) => Promise<Record<EthAddress, string[]>>;
 export declare const _getLiquityV2UserTroveIds: (provider: PublicClient, network: NetworkNumber, selectedMarket: LiquityV2MarketInfo, troveNFTAddress: EthAddress, limitBlocksForEventFetching: boolean, account: EthAddress) => Promise<{
     troves: {
         troveId: string;
@@ -52,25 +57,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/liquityV2/index.js

@@ -121,36 +121,53 @@ export const nftContractCreationBlockMapping = {
     [LiquityV2Versions.LiquityV2WstEthLegacy]: 21686238,
     [LiquityV2Versions.LiquityV2REthLegacy]: 21686257,
 };
-const getTransferredTroves = (provider, network, troveNFTAddress, limitBlocksForEventFetching, market, account) => __awaiter(void 0, void 0, void 0, function* () {
+/** Every Transfer of a market's trove NFT since the contract was created (or, on a fork, in the last 1000 blocks). */
+const getTroveTransfers = (provider, network, troveNFTAddress, limitBlocksForEventFetching, market) => __awaiter(void 0, void 0, void 0, function* () {
     const nftContract = createViemContractFromConfigFunc('LiquityV2TroveNFT', troveNFTAddress)(provider, network);
     const nftContractCreationBlock = nftContractCreationBlockMapping[market];
     const currentBlock = +(yield provider.getBlockNumber()).toString();
     const _events = yield nftContract.getEvents.Transfer({}, { fromBlock: limitBlocksForEventFetching ? BigInt(currentBlock - 1000) : BigInt(nftContractCreationBlock) });
-    const events = _events.map((event) => ({
+    return _events.map((event) => ({
         from: event.args.from, to: event.args.to, tokenId: event.args.tokenId.toString(), blockNumber: +(event.blockNumber.toString()),
     }));
-    const userTransferredTroves = events.filter((event) => compareAddresses(event.to, account));
-    // check if the last know transfer address is the user
-    userTransferredTroves.forEach((event, index) => {
-        const otherTransfers = events.filter((e) => event.blockNumber < e.blockNumber && e.tokenId === event.tokenId);
-        // @ts-ignore
-        userTransferredTroves[index].invalid = !!otherTransfers.length;
-    });
-    // @ts-ignore
-    return userTransferredTroves.filter((event) => !event.invalid).map((event) => ({ troveId: event.tokenId }));
 });
-export const _getLiquityV2UserTroveIds = (provider, network, selectedMarket, troveNFTAddress, limitBlocksForEventFetching, account) => __awaiter(void 0, void 0, void 0, function* () {
-    const [{ troves: userTroves, nextFreeTroveIndex }, userTransferredTroves] = yield Promise.all([
-        getUserTroves(provider, network, selectedMarket.isLegacy, account, selectedMarket.marketAddress),
-        getTransferredTroves(provider, network, troveNFTAddress, limitBlocksForEventFetching, selectedMarket.value, account),
-    ]);
+/** The troves transferred to an account that it still holds: no later transfer of the same trove. */
+const getAccountTransferredTroves = (events, account) => events
+    .filter((event) => compareAddresses(event.to, account))
+    .filter((event) => !events.some((e) => event.blockNumber < e.blockNumber && e.tokenId === event.tokenId))
+    .map((event) => ({ troveId: event.tokenId }));
+const getTransferredTroves = (provider, network, troveNFTAddress, limitBlocksForEventFetching, market, account) => __awaiter(void 0, void 0, void 0, function* () {
+    return (getAccountTransferredTroves(yield getTroveTransfers(provider, network, troveNFTAddress, limitBlocksForEventFetching, market), account));
+});
+/** The troves an account opened and still owns, then the ones transferred to it, each once. */
+const mergeTroveIds = (userTroves, userTransferredTroves) => {
     const troves = [...userTroves.map(({ troveId }) => ({ troveId })), ...userTransferredTroves];
     const filteredTroves = troves.filter((value, index, self) => index === self.findIndex((t) => (t.troveId === value.troveId)));
     const troveIds = filteredTroves.map((trove) => trove.troveId);
     const troveIdsSet = new Set(troveIds);
     const troveIdsArray = Array.from(troveIdsSet);
-    const trovesNoDuplicates = troveIdsArray.map((troveId) => troves.find((trove) => trove.troveId === troveId));
-    return { troves: trovesNoDuplicates, nextFreeTroveIndex };
+    return troveIdsArray.map((troveId) => troves.find((trove) => trove.troveId === troveId));
+};
+/**
+ * The trove ids of several accounts in one market: the market's NFT transfers are read once for all of them, rather
+ * than once per account as _getLiquityV2UserTroveIds does.
+ */
+export const _getLiquityV2UsersTroveIds = (provider, network, selectedMarket, troveNFTAddress, limitBlocksForEventFetching, accounts) => __awaiter(void 0, void 0, void 0, function* () {
+    const [userTroves, events] = yield Promise.all([
+        Promise.all(accounts.map((account) => getUserTroves(provider, network, selectedMarket.isLegacy, account, selectedMarket.marketAddress))),
+        getTroveTransfers(provider, network, troveNFTAddress, limitBlocksForEventFetching, selectedMarket.value),
+    ]);
+    return Object.fromEntries(accounts.map((account, i) => [
+        account,
+        mergeTroveIds(userTroves[i].troves, getAccountTransferredTroves(events, account)).map(({ troveId }) => troveId),
+    ]));
+});
+export const _getLiquityV2UserTroveIds = (provider, network, selectedMarket, troveNFTAddress, limitBlocksForEventFetching, account) => __awaiter(void 0, void 0, void 0, function* () {
+    const [{ troves: userTroves, nextFreeTroveIndex }, userTransferredTroves] = yield Promise.all([
+        getUserTroves(provider, network, selectedMarket.isLegacy, account, selectedMarket.marketAddress),
+        getTransferredTroves(provider, network, troveNFTAddress, limitBlocksForEventFetching, selectedMarket.value, account),
+    ]);
+    return { troves: mergeTroveIds(userTroves, userTransferredTroves), nextFreeTroveIndex };
 });
 export const getLiquityV2UserTroveIds = (provider, network, selectedMarket, troveNFTAddress, limitBlocksForEventFetching, account) => __awaiter(void 0, void 0, void 0, function* () { return _getLiquityV2UserTroveIds(getViemProvider(provider, network), network, selectedMarket, troveNFTAddress, limitBlocksForEventFetching, account); });
 const getDebtInFrontForSingleMarketLiquityV2 = (provider_1, network_1, isLegacy_1, marketAddress_1, troveId_1, ...args_1) => __awaiter(void 0, [provider_1, network_1, isLegacy_1, marketAddress_1, troveId_1, ...args_1], void 0, function* (provider, network, isLegacy, marketAddress, troveId, accumulatedSum = '0', iterations = 2000) {

package/esm/portfolio/index.d.ts

@@ -1,14 +1,22 @@
 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<{
-    positions: PortfolioPositionsData;
-    stakingPositions: any;
-    rewardsData: any;
-    markets: any;
-}>;
+import { PortfolioData, PortfolioDataOptions, PortfolioMarketsData, PortfolioMarketsResult, PortfolioPositionsData, PortfolioUserData, ShifterPortfolioMarketsData } from '../types';
+/**
+ * Every market the portfolio reads on a network — the markets half of getPortfolioData, for a caller that keeps
+ * markets apart from what it reads per address (a cache shared by many addresses). A market that fails is left out
+ * of `markets` and named in `errors`.
+ */
+export declare function getPortfolioMarketsData(provider: EthereumProvider, network: NetworkNumber, defaultProvider: EthereumProvider, isSim?: boolean): Promise<PortfolioMarketsResult>;
+/**
+ * What the portfolio reads per address — the other half of getPortfolioData — against `markets` from
+ * getPortfolioMarketsData. `markets` can be a promise: reads that do not need a market (Maker, Fluid, Liquity, staking,
+ * rewards) start at once, and each read on a market waits for it. A position on a market missing from `markets` is an
+ * entry with an error.
+ */
+export declare function getPortfolioUserData(provider: EthereumProvider, network: NetworkNumber, addresses: EthAddress[], markets: PortfolioMarketsData | Promise<PortfolioMarketsData>, isSim?: boolean, options?: PortfolioDataOptions): Promise<PortfolioUserData>;
+export declare function getPortfolioData(provider: EthereumProvider, network: NetworkNumber, defaultProvider: EthereumProvider, addresses: EthAddress[], isSim?: boolean, options?: PortfolioDataOptions): Promise<PortfolioData>;
 export declare function getShifterPortfolioData(provider: EthereumProvider, network: NetworkNumber, defaultProvider: EthereumProvider, addresses: EthAddress[], isSim?: boolean): Promise<{
     positions: PortfolioPositionsData;
-    markets: PortfolioMarketsData;
+    markets: ShifterPortfolioMarketsData;
 }>;
 export * from './discovery';
 export { getWalletLendingSummaries } from './lendingSummaries';