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

package/cjs/maker/index.d.ts

@@ -1,9 +1,14 @@
 import { Client, PublicClient } from 'viem';
 import { Blockish, EthAddress, EthereumProvider, NetworkNumber, PositionBalances } from '../types/common';
-import { CdpData, CdpInfo } from '../types';
+import { CdpData, CdpInfo, IlkInfo } from '../types';
 export declare const _getMakerAccountBalances: (provider: PublicClient, network: NetworkNumber, block: Blockish, addressMapping: boolean, cdpId: string, _managerAddress?: EthAddress) => Promise<PositionBalances>;
 export declare const getMakerAccountBalances: (provider: EthereumProvider, network: NetworkNumber, block: Blockish, addressMapping: boolean, cdpId: string, _managerAddress?: EthAddress) => Promise<PositionBalances>;
 export declare const _getUserCdps: (provider: Client, network: NetworkNumber, userAddress: EthAddress) => Promise<CdpInfo[]>;
 export declare const getUserCdps: (provider: EthereumProvider, network: NetworkNumber, userAddress: EthAddress) => Promise<CdpInfo[]>;
-export declare const _getMakerCdpData: (provider: Client, network: NetworkNumber, cdp: CdpInfo) => Promise<CdpData>;
+export declare const _getMakerIlksData: (provider: Client, network: NetworkNumber, ilkLabels: string[]) => Promise<Record<string, IlkInfo>>;
+export declare const getMakerIlksData: (provider: EthereumProvider, network: NetworkNumber, ilkLabels: string[]) => Promise<Record<string, IlkInfo>>;
+/**
+ * @param ilkInfo optional precomputed ilk data (from `_getMakerIlksData`); when provided the per-ilk reads are skipped
+ */
+export declare const _getMakerCdpData: (provider: Client, network: NetworkNumber, cdp: CdpInfo, ilkInfo?: IlkInfo) => Promise<CdpData>;
 export declare const getMakerCdpData: (provider: EthereumProvider, network: NetworkNumber, cdp: CdpInfo) => Promise<CdpData>;

package/cjs/maker/index.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMakerCdpData = exports._getMakerCdpData = exports.getUserCdps = exports._getUserCdps = exports.getMakerAccountBalances = exports._getMakerAccountBalances = void 0;
+exports.getMakerCdpData = exports._getMakerCdpData = exports.getMakerIlksData = exports._getMakerIlksData = exports.getUserCdps = exports._getUserCdps = exports.getMakerAccountBalances = exports._getMakerAccountBalances = void 0;
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const tokens_1 = require("@defisaver/tokens");
 const contracts_1 = require("../contracts");
@@ -21,6 +21,7 @@ const utils_1 = require("../services/utils");
 const makerHelpers_1 = require("../helpers/makerHelpers");
 const viem_1 = require("../services/viem");
 const moneymarket_1 = require("../moneymarket");
+const staking_1 = require("../staking");
 const _getMakerAccountBalances = (provider, network, block, addressMapping, cdpId, _managerAddress) => __awaiter(void 0, void 0, void 0, function* () {
     let balances = {
         collateral: {},
@@ -44,7 +45,7 @@ const _getMakerAccountBalances = (provider, network, block, addressMapping, cdpI
     // [urn, owner, userAddr, ilk, collateral, debt]
     const cdpInfo = yield viewContract.read.getCdpInfo((needsIlk ? [managerAddress, cdpId, ilk] : [cdpId]), (0, viem_1.setViemBlockNumber)(block));
     cdpInfo.ilk = cdpInfo[3];
-    const [par, [_, mat], [artGlobal, rate, spot, line], [duty], futureRate, chop,] = yield Promise.all([
+    const [par, [_, mat], [artGlobal, rate, spot, line, dust], [duty], futureRate, chop,] = yield Promise.all([
         spotterContract.read.par((0, viem_1.setViemBlockNumber)(block)),
         spotterContract.read.ilks(needsIlk ? [ilk] : [cdpInfo.ilk], (0, viem_1.setViemBlockNumber)(block)),
         vatContract.read.ilks(needsIlk ? [ilk] : [cdpInfo.ilk], (0, viem_1.setViemBlockNumber)(block)),
@@ -52,7 +53,7 @@ const _getMakerAccountBalances = (provider, network, block, addressMapping, cdpI
         jugContract.read.drip(needsIlk ? [ilk] : [cdpInfo.ilk], (0, viem_1.setViemBlockNumber)(block)),
         dogContract.read.chop(needsIlk ? [ilk] : [cdpInfo.ilk], (0, viem_1.setViemBlockNumber)(block)),
     ]);
-    const ilkInfo = (0, makerHelpers_1.parseCollateralInfo)(needsIlk ? ilk : cdpInfo.ilk, par.toString(), mat.toString(), artGlobal.toString(), rate.toString(), spot.toString(), line.toString(), duty.toString(), futureRate.toString(), chop.toString());
+    const ilkInfo = (0, makerHelpers_1.parseCollateralInfo)(needsIlk ? ilk : cdpInfo.ilk, par.toString(), mat.toString(), artGlobal.toString(), rate.toString(), spot.toString(), line.toString(), dust.toString(), duty.toString(), futureRate.toString(), chop.toString());
     const collateral = cdpInfo[4];
     const debt = cdpInfo[5];
     const asset = (0, utils_1.wethToEth)((0, tokens_1.ilkToAsset)(needsIlk ? ilk : cdpInfo.ilk));
@@ -90,22 +91,40 @@ const _getUserCdps = (provider, network, userAddress) => __awaiter(void 0, void
 exports._getUserCdps = _getUserCdps;
 const getUserCdps = (provider, network, userAddress) => __awaiter(void 0, void 0, void 0, function* () { return (0, exports._getUserCdps)((0, viem_1.getViemProvider)(provider, network), network, userAddress); });
 exports.getUserCdps = getUserCdps;
-const _getMakerCdpData = (provider, network, cdp) => __awaiter(void 0, void 0, void 0, function* () {
+const _getMakerIlksData = (provider, network, ilkLabels) => __awaiter(void 0, void 0, void 0, function* () {
     const vatContract = (0, contracts_1.McdVatContractViem)(provider, network);
     const spotterContract = (0, contracts_1.McdSpotterContractViem)(provider, network);
     const dogContract = (0, contracts_1.McdDogContractViem)(provider, network);
     const jugContract = (0, contracts_1.McdJugContractViem)(provider, network);
-    const [[ink, art], coll, par, [_, mat], [artGlobal, rate, spot, line], [duty], futureRate, chop,] = yield Promise.all([
+    const par = yield spotterContract.read.par();
+    const ilksInfo = yield Promise.all(ilkLabels.map((ilkLabel) => __awaiter(void 0, void 0, void 0, function* () {
+        const ilk = (0, tokens_1.stringToBytes)(ilkLabel);
+        const [[_, mat], [artGlobal, rate, spot, line, dust], [duty], futureRate, chop,] = yield Promise.all([
+            spotterContract.read.ilks([ilk]),
+            vatContract.read.ilks([ilk]),
+            jugContract.read.ilks([ilk]),
+            jugContract.read.drip([ilk]),
+            dogContract.read.chop([ilk]),
+        ]);
+        return (0, makerHelpers_1.parseCollateralInfo)(ilk, par.toString(), mat.toString(), artGlobal.toString(), rate.toString(), spot.toString(), line.toString(), dust.toString(), duty.toString(), futureRate.toString(), chop.toString());
+    })));
+    return Object.fromEntries(ilksInfo.map((ilkInfo) => [ilkInfo.ilkLabel, ilkInfo]));
+});
+exports._getMakerIlksData = _getMakerIlksData;
+const getMakerIlksData = (provider, network, ilkLabels) => __awaiter(void 0, void 0, void 0, function* () { return (0, exports._getMakerIlksData)((0, viem_1.getViemProvider)(provider, network, { batch: { multicall: true } }), network, ilkLabels); });
+exports.getMakerIlksData = getMakerIlksData;
+/**
+ * @param ilkInfo optional precomputed ilk data (from `_getMakerIlksData`); when provided the per-ilk reads are skipped
+ */
+const _getMakerCdpData = (provider, network, cdp, ilkInfo) => __awaiter(void 0, void 0, void 0, function* () {
+    const vatContract = (0, contracts_1.McdVatContractViem)(provider, network);
+    const [[ink, art], coll, fetchedIlkInfo, collStakingApy,] = yield Promise.all([
         vatContract.read.urns([cdp.ilk, cdp.urn]),
         vatContract.read.gem([cdp.ilk, cdp.urn]),
-        spotterContract.read.par(),
-        spotterContract.read.ilks([cdp.ilk]),
-        vatContract.read.ilks([cdp.ilk]),
-        jugContract.read.ilks([cdp.ilk]),
-        jugContract.read.drip([cdp.ilk]),
-        dogContract.read.chop([cdp.ilk]),
+        ilkInfo || (0, exports._getMakerIlksData)(provider, network, [cdp.ilkLabel]).then((ilks) => ilks[cdp.ilkLabel]),
+        staking_1.STAKING_ASSETS.includes(cdp.asset) ? (0, staking_1.getStakingApy)(cdp.asset) : Promise.resolve('0'),
     ]);
-    const collInfo = (0, makerHelpers_1.parseCollateralInfo)(cdp.ilk, par.toString(), mat.toString(), artGlobal.toString(), rate.toString(), spot.toString(), line.toString(), duty.toString(), futureRate.toString(), chop.toString());
+    const collInfo = fetchedIlkInfo;
     const collateral = (0, tokens_1.assetAmountInEth)(ink.toString(), `MCD-${cdp.asset}`);
     const collateralUsd = new decimal_js_1.default(collateral).mul(collInfo.assetPrice).toString();
     const debt = new decimal_js_1.default(art).times(collInfo.currentRate).div(1e27).floor()
@@ -117,7 +136,16 @@ const _getMakerCdpData = (provider, network, cdp) => __awaiter(void 0, void 0, v
         .toString();
     if (new decimal_js_1.default(debt).eq(0))
         ratio = '0';
+    const safetyRatio = (0, moneymarket_1.getSafetyRatioFromCollateralRatio)(ratio, collInfo.liqPercent);
     const debtTooLow = new decimal_js_1.default(debt).gt(0) && new decimal_js_1.default((0, tokens_1.assetAmountInEth)(debt, 'DAI')).lt(collInfo.minDebt);
+    // DAI debt accrues the ilk's stability fee. Collateral earns nothing inside the vault, except for the
+    // native yield of staked collateral (e.g. wstETH), which is tracked as an incentive.
+    const { netApy, totalInterestUsd, incentiveUsd } = (0, staking_1.calculateNetApyFromRates)({
+        suppliedUsd: collateralUsd,
+        borrowedUsd: (0, tokens_1.assetAmountInEth)(debt, 'DAI'),
+        borrowRate: collInfo.stabilityFee.toString(),
+        incentives: [{ apy: collStakingApy, amountUsd: collateralUsd }],
+    });
     return {
         owner: cdp.owner,
         id: cdp.id.toString(),
@@ -136,6 +164,7 @@ const _getMakerCdpData = (provider, network, cdp) => __awaiter(void 0, void 0, v
         debtAssetMarketPrice: '1',
         liquidationPrice,
         ratio,
+        safetyRatio,
         liqRatio: collInfo.liqRatio.toString(),
         liqPercent: parseFloat(collInfo.liqPercent.toString()),
         assetPrice: collInfo.assetPrice,
@@ -151,6 +180,9 @@ const _getMakerCdpData = (provider, network, cdp) => __awaiter(void 0, void 0, v
         liquidationFee: collInfo.liquidationFee,
         lastUpdated: Date.now(),
         exposure: (0, moneymarket_1.getExposure)((0, tokens_1.assetAmountInEth)(debt, 'DAI'), collateralUsd),
+        netApy,
+        totalInterestUsd,
+        incentiveUsd,
     };
 });
 exports._getMakerCdpData = _getMakerCdpData;

package/cjs/markets/index.d.ts

@@ -8,3 +8,4 @@ export { LlamaLendMarkets } from './llamaLend';
 export { LiquityV2Markets, findLiquityV2MarketByAddress } from './liquityV2';
 export { FluidMarkets, getFluidVersionsDataForNetwork, getFluidMarketInfoById, getFTokenAddress, getFluidMarketInfoByAddress, } from './fluid';
 export { AaveV4Spokes, findAaveV4SpokeByAddress } from './aaveV4';
+export { MakerActiveIlks } from './maker';

package/cjs/markets/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findAaveV4SpokeByAddress = exports.AaveV4Spokes = exports.getFluidMarketInfoByAddress = exports.getFTokenAddress = exports.getFluidMarketInfoById = exports.getFluidVersionsDataForNetwork = exports.FluidMarkets = exports.findLiquityV2MarketByAddress = exports.LiquityV2Markets = exports.LlamaLendMarkets = exports.morphoMidnightVisibleCollaterals = exports.morphoMidnightMarketCollateralParams = exports.isTenorMidnightMarket = exports.findMorphoMidnightMarket = exports.MorphoMidnightMarkets = exports.findMorphoBlueMarket = exports.MorphoBlueMarkets = exports.CrvUsdMarkets = exports.SparkMarkets = exports.v3USDTCollAssets = exports.v3USDCeCollAssets = exports.v3USDCCollAssets = exports.v3USDbCCollAssets = exports.v3ETHCollAssets = exports.compoundV2CollateralAssets = exports.CompoundMarkets = exports.getAaveV3MarketByMarketAddress = exports.aaveV3AssetsDefaultMarket = exports.aaveV2AssetsDefaultMarket = exports.aaveV1AssetsDefaultMarket = exports.AaveMarkets = void 0;
+exports.MakerActiveIlks = exports.findAaveV4SpokeByAddress = exports.AaveV4Spokes = exports.getFluidMarketInfoByAddress = exports.getFTokenAddress = exports.getFluidMarketInfoById = exports.getFluidVersionsDataForNetwork = exports.FluidMarkets = exports.findLiquityV2MarketByAddress = exports.LiquityV2Markets = exports.LlamaLendMarkets = exports.morphoMidnightVisibleCollaterals = exports.morphoMidnightMarketCollateralParams = exports.isTenorMidnightMarket = exports.findMorphoMidnightMarket = exports.MorphoMidnightMarkets = exports.findMorphoBlueMarket = exports.MorphoBlueMarkets = exports.CrvUsdMarkets = exports.SparkMarkets = exports.v3USDTCollAssets = exports.v3USDCeCollAssets = exports.v3USDCCollAssets = exports.v3USDbCCollAssets = exports.v3ETHCollAssets = exports.compoundV2CollateralAssets = exports.CompoundMarkets = exports.getAaveV3MarketByMarketAddress = exports.aaveV3AssetsDefaultMarket = exports.aaveV2AssetsDefaultMarket = exports.aaveV1AssetsDefaultMarket = exports.AaveMarkets = void 0;
 var aave_1 = require("./aave");
 Object.defineProperty(exports, "AaveMarkets", { enumerable: true, get: function () { return aave_1.AaveMarkets; } });
 Object.defineProperty(exports, "aaveV1AssetsDefaultMarket", { enumerable: true, get: function () { return aave_1.aaveV1AssetsDefaultMarket; } });
@@ -42,3 +42,5 @@ Object.defineProperty(exports, "getFluidMarketInfoByAddress", { enumerable: true
 var aaveV4_1 = require("./aaveV4");
 Object.defineProperty(exports, "AaveV4Spokes", { enumerable: true, get: function () { return aaveV4_1.AaveV4Spokes; } });
 Object.defineProperty(exports, "findAaveV4SpokeByAddress", { enumerable: true, get: function () { return aaveV4_1.findAaveV4SpokeByAddress; } });
+var maker_1 = require("./maker");
+Object.defineProperty(exports, "MakerActiveIlks", { enumerable: true, get: function () { return maker_1.MakerActiveIlks; } });

package/cjs/markets/maker/index.d.ts

@@ -0,0 +1 @@
+export declare const MakerActiveIlks: string[];

package/cjs/markets/maker/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MakerActiveIlks = void 0;
+exports.MakerActiveIlks = [
+    'ETH-A',
+    'ETH-B',
+    'ETH-C',
+    'WSTETH-A',
+    'WSTETH-B',
+    'WBTC-A',
+    'WBTC-B',
+    'WBTC-C',
+];

package/cjs/moneymarket/moneymarketCommonService.d.ts

@@ -11,3 +11,12 @@ export declare const isLeveragedPos: (usedAssets: MMUsedAssets, dustLimit?: numb
 };
 export declare const aprToApy: (interest: string | number, frequency?: number) => string;
 export declare const getExposure: (borrowedUsd: string, suppliedUsd: string) => string;
+/**
+ * A collateral ratio rebased so that 100 means "sitting exactly on the liquidation ratio": the scale the
+ * shared `safetyRatio` field assumes. Protocols that liquidate on a raw collateral ratio (Maker at the ilk's
+ * liquidation ratio, Liquity at 110%, crvUSD/LlamaLend at the band-derived minimum) pass through here.
+ *
+ * Yields '0' when the liquidation ratio isn't available (or is 0), the "no signal" value consumers already recognise.
+ * Mirrors `getSafetyRatioFromCollateralRatio` on the client.
+ */
+export declare const getSafetyRatioFromCollateralRatio: (collateralRatio: string | number | undefined, liquidationRatio: string | number | undefined) => string;

package/cjs/moneymarket/moneymarketCommonService.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExposure = exports.aprToApy = exports.isLeveragedPos = exports.STABLE_ASSETS = exports.calculateBorrowingAssetLimit = exports.calcLeverageLiqPrice = exports.calcShortLiqPrice = exports.calcLongLiqPrice = exports.getAssetsTotal = void 0;
+exports.getSafetyRatioFromCollateralRatio = exports.getExposure = exports.aprToApy = exports.isLeveragedPos = exports.STABLE_ASSETS = exports.calculateBorrowingAssetLimit = exports.calcLeverageLiqPrice = exports.calcShortLiqPrice = exports.calcLongLiqPrice = exports.getAssetsTotal = void 0;
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const constants_1 = require("../constants");
 const common_1 = require("../types/common");
@@ -102,3 +102,15 @@ const getExposure = (borrowedUsd, suppliedUsd) => {
     return new decimal_js_1.default(suppliedUsd).div(balanceUsd).toDecimalPlaces(2).toString();
 };
 exports.getExposure = getExposure;
+/**
+ * A collateral ratio rebased so that 100 means "sitting exactly on the liquidation ratio": the scale the
+ * shared `safetyRatio` field assumes. Protocols that liquidate on a raw collateral ratio (Maker at the ilk's
+ * liquidation ratio, Liquity at 110%, crvUSD/LlamaLend at the band-derived minimum) pass through here.
+ *
+ * Yields '0' when the liquidation ratio isn't available (or is 0), the "no signal" value consumers already recognise.
+ * Mirrors `getSafetyRatioFromCollateralRatio` on the client.
+ */
+const getSafetyRatioFromCollateralRatio = (collateralRatio, liquidationRatio) => (+(liquidationRatio !== null && liquidationRatio !== void 0 ? liquidationRatio : 0) > 0
+    ? new decimal_js_1.default(collateralRatio || 0).div(liquidationRatio).mul(100).toString()
+    : '0');
+exports.getSafetyRatioFromCollateralRatio = getSafetyRatioFromCollateralRatio;

package/cjs/portfolio/index.d.ts

@@ -1,9 +1,21 @@
 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 { 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;
-    stakingPositions: any;
-    rewardsData: any;
-    markets: PortfolioMarketsData;
+    markets: ShifterPortfolioMarketsData;
 }>;
 export * from './discovery';