@defisaver/positions-sdk 2.1.52 → 2.1.53-aave-v4

package/.mocharc.json

@@ -1,4 +1,4 @@
-{
-    "require": "ts-node/register",
-    "extension": ["ts"]
-}
+{
+    "require": "ts-node/register",
+    "extension": ["ts"]
+}

package/.nvmrc

@@ -1 +1 @@
-v20.17.0
+v20.17.0

package/README.md

@@ -1,64 +1,64 @@
-# DeFi Saver Positions SDK
-
-Supported protocols: 
-- [Maker](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/maker)
-- [Spark](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/spark)
-- [CrvUSD](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/curveUsd)
-- [Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV2)
-- [Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV3)
-- [Compound V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV2)
-- [Compound V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV3)
-- [Liquity](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/liquity)
-
-## Setup
-Supported Node version is v10.
-
-- run `npm install` (first time)
-- run `npm run build`
-
-`build` command will generate contracts and build ejs and esm folders
-
-## How to use
-[All available imports](https://github.com/defisaver/defisaver-positions-sdk/blob/main/src/index.ts)
-
-This is a Compound V3 example, and every other protocol is similar
-```js
-import { compoundV3 } from '@defisaver/positions-sdk';
-
-
-// every protocol has market data and user data getters
-const {
-    getCompoundV3MarketsData,
-    getCompoundV3AccountData,
-} = compoundV3;
-
-const provider = 'Your RPC provider';
-
-const user = '0x123...';
-
-const { assetsData } = await getCompoundV3MarketsData(
-    provider, // rpc for the network you are using (note: can be tenderly or any other testnet rpc)
-    1, // network
-    selectedMarket, // market object like in /src/markets/compound/index.ts
-    provider, // this must be mainnet rpc - used for getting prices onchain and calculating apys
-);
-
-const userData = await getCompoundV3AccountData(
-    provider,
-    1, // network
-    userAddress, // EOA or DSProxy
-    '', // proxy address of the user, or just empty string if checking for EOA
-    {
-        selectedMarket, // market object as in /src/markets/compound/index.ts
-        assetsData,
-    }
-);
-```
-
-More examples found [here](https://github.com/defisaver/defisaver-positions-sdk/tree/main/tests)
-
-## Testing
-
-`npm run test` - Run all tests
-
-`npm run test-single --name=your_test_name` - Run single test for specified name e.g. for MyTest.js test name is MyTest
+# DeFi Saver Positions SDK
+
+Supported protocols: 
+- [Maker](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/maker)
+- [Spark](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/spark)
+- [CrvUSD](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/curveUsd)
+- [Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV2)
+- [Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV3)
+- [Compound V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV2)
+- [Compound V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV3)
+- [Liquity](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/liquity)
+
+## Setup
+Supported Node version is v10.
+
+- run `npm install` (first time)
+- run `npm run build`
+
+`build` command will generate contracts and build ejs and esm folders
+
+## How to use
+[All available imports](https://github.com/defisaver/defisaver-positions-sdk/blob/main/src/index.ts)
+
+This is a Compound V3 example, and every other protocol is similar
+```js
+import { compoundV3 } from '@defisaver/positions-sdk';
+
+
+// every protocol has market data and user data getters
+const {
+    getCompoundV3MarketsData,
+    getCompoundV3AccountData,
+} = compoundV3;
+
+const provider = 'Your RPC provider';
+
+const user = '0x123...';
+
+const { assetsData } = await getCompoundV3MarketsData(
+    provider, // rpc for the network you are using (note: can be tenderly or any other testnet rpc)
+    1, // network
+    selectedMarket, // market object like in /src/markets/compound/index.ts
+    provider, // this must be mainnet rpc - used for getting prices onchain and calculating apys
+);
+
+const userData = await getCompoundV3AccountData(
+    provider,
+    1, // network
+    userAddress, // EOA or DSProxy
+    '', // proxy address of the user, or just empty string if checking for EOA
+    {
+        selectedMarket, // market object as in /src/markets/compound/index.ts
+        assetsData,
+    }
+);
+```
+
+More examples found [here](https://github.com/defisaver/defisaver-positions-sdk/tree/main/tests)
+
+## Testing
+
+`npm run test` - Run all tests
+
+`npm run test-single --name=your_test_name` - Run single test for specified name e.g. for MyTest.js test name is MyTest

package/cjs/aaveV4/index.d.ts

@@ -0,0 +1,7 @@
+import { Client } from 'viem';
+import { AaveV4AccountData, AaveV4SpokeData, AaveV4SpokeInfo } from '../types';
+import { EthAddress, EthereumProvider, NetworkNumber } from '../types/common';
+export declare function _getAaveV4SpokeData(provider: Client, network: NetworkNumber, market: AaveV4SpokeInfo, blockNumber?: 'latest' | number): Promise<AaveV4SpokeData>;
+export declare function getAaveV4SpokeData(provider: EthereumProvider, network: NetworkNumber, spoke: AaveV4SpokeInfo, blockNumber?: 'latest' | number): Promise<AaveV4SpokeData>;
+export declare function _getAaveV4AccountData(provider: Client, network: NetworkNumber, spokeData: AaveV4SpokeData, address: EthAddress, blockNumber?: 'latest' | number): Promise<AaveV4AccountData>;
+export declare function getAaveV4AccountData(provider: EthereumProvider, network: NetworkNumber, marketData: AaveV4SpokeData, address: EthAddress, blockNumber?: 'latest' | number): Promise<any>;

package/cjs/aaveV4/index.js

@@ -0,0 +1,174 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._getAaveV4SpokeData = _getAaveV4SpokeData;
+exports.getAaveV4SpokeData = getAaveV4SpokeData;
+exports._getAaveV4AccountData = _getAaveV4AccountData;
+exports.getAaveV4AccountData = getAaveV4AccountData;
+const decimal_js_1 = __importDefault(require("decimal.js"));
+const tokens_1 = require("@defisaver/tokens");
+const viem_1 = require("../services/viem");
+const common_1 = require("../types/common");
+const contracts_1 = require("../contracts");
+const staking_1 = require("../staking");
+const utils_1 = require("../services/utils");
+const aaveV4Helpers_1 = require("../helpers/aaveV4Helpers");
+const aaveV4_1 = require("../markets/aaveV4");
+const fetchHubData = (viewContract, hubAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const hubData = yield viewContract.read.getHubAllAssetsData([hubAddress]);
+    return {
+        assets: hubData.reduce((acc, assetOnChainData) => {
+            acc[assetOnChainData.assetId] = {
+                assetId: assetOnChainData.assetId,
+                drawnRate: assetOnChainData.drawnRate,
+            };
+            return acc;
+        }, {}),
+    };
+});
+const formatReserveAsset = (reserveAsset, hubAsset, reserveId, oracleDecimals, network) => __awaiter(void 0, void 0, void 0, function* () {
+    const assetInfo = (0, tokens_1.getAssetInfoByAddress)(reserveAsset.underlying, network);
+    const symbol = (0, utils_1.wethToEth)(assetInfo.symbol);
+    const hubInfo = (0, aaveV4_1.getAaveV4HubByAddress)(network, reserveAsset.hub);
+    if (!hubInfo) {
+        throw new Error(`Hub not found with address: ${reserveAsset.hub}`);
+    }
+    const isStakingAsset = staking_1.STAKING_ASSETS.includes(symbol);
+    const supplyIncentives = [];
+    const borrowIncentives = [];
+    if (isStakingAsset) {
+        const yieldApy = yield (0, staking_1.getStakingApy)(symbol, network);
+        supplyIncentives.push({
+            apy: yieldApy,
+            token: symbol,
+            incentiveKind: common_1.IncentiveKind.Staking,
+            description: `Native ${symbol} yield.`,
+        });
+        if (reserveAsset.borrowable) {
+            // when borrowing assets whose value increases over time
+            borrowIncentives.push({
+                apy: new decimal_js_1.default(yieldApy).mul(-1).toString(),
+                token: symbol,
+                incentiveKind: common_1.IncentiveKind.Reward,
+                description: `Due to the native yield of ${symbol}, the value of the debt would increase over time.`,
+            });
+        }
+    }
+    return ({
+        symbol,
+        underlying: reserveAsset.underlying,
+        hub: hubInfo.address,
+        hubName: hubInfo === null || hubInfo === void 0 ? void 0 : hubInfo.label,
+        assetId: reserveAsset.assetId,
+        reserveId,
+        paused: reserveAsset.paused,
+        frozen: reserveAsset.frozen,
+        borrowable: reserveAsset.borrowable,
+        collateralRisk: new decimal_js_1.default(reserveAsset.collateralRisk).div(10000).toNumber(),
+        collateralFactor: new decimal_js_1.default(reserveAsset.collateralFactor).div(10000).toNumber(),
+        liquidationFee: new decimal_js_1.default(reserveAsset.liquidationFee).div(10000).toNumber(),
+        price: new decimal_js_1.default(reserveAsset.price).div(new decimal_js_1.default(10).pow(oracleDecimals)).toString(),
+        totalSupplied: (0, tokens_1.assetAmountInEth)(reserveAsset.totalSupplied.toString(), symbol),
+        totalDrawn: (0, tokens_1.assetAmountInEth)(reserveAsset.totalDrawn.toString(), symbol),
+        totalPremium: (0, tokens_1.assetAmountInEth)(reserveAsset.totalPremium.toString(), symbol),
+        totalDebt: (0, tokens_1.assetAmountInEth)(reserveAsset.totalDebt.toString(), symbol),
+        supplyCap: (0, tokens_1.assetAmountInEth)(reserveAsset.supplyCap.toString(), symbol),
+        borrowCap: (0, tokens_1.assetAmountInEth)(reserveAsset.borrowCap.toString(), symbol),
+        spokeActive: reserveAsset.spokeActive,
+        spokePaused: reserveAsset.spokePaused,
+        drawnRate: new decimal_js_1.default(hubAsset.drawnRate).div(new decimal_js_1.default(10).pow(27)).toString(),
+        supplyRate: '0', // To be implemented
+        supplyIncentives,
+        borrowIncentives,
+        canBeBorrowed: reserveAsset.spokeActive && !reserveAsset.spokePaused && !reserveAsset.paused && !reserveAsset.frozen,
+        canBeSupplied: reserveAsset.spokeActive && !reserveAsset.spokePaused && !reserveAsset.paused && !reserveAsset.frozen,
+        canBeWithdrawn: reserveAsset.spokeActive && !reserveAsset.spokePaused && !reserveAsset.paused,
+        canBePayBacked: reserveAsset.spokeActive && !reserveAsset.spokePaused && !reserveAsset.paused,
+        utilization: new decimal_js_1.default(reserveAsset.totalDrawn.toString()).times(100).div(new decimal_js_1.default(reserveAsset.totalSupplied.toString())).toString(),
+    });
+});
+function _getAaveV4SpokeData(provider_1, network_1, market_1) {
+    return __awaiter(this, arguments, void 0, function* (provider, network, market, blockNumber = 'latest') {
+        const viewContract = (0, contracts_1.AaveV4ViewContractViem)(provider, network, blockNumber);
+        const hubsData = {};
+        const [spokeData] = yield Promise.all([
+            viewContract.read.getSpokeDataFull([market.address]),
+            ...market.hubs.map((hubAddress) => __awaiter(this, void 0, void 0, function* () {
+                hubsData[hubAddress] = yield fetchHubData(viewContract, hubAddress);
+            })),
+        ]);
+        const reserveAssetsArray = yield Promise.all(spokeData[1].map((reserveAssetOnChain, index) => __awaiter(this, void 0, void 0, function* () { return formatReserveAsset(reserveAssetOnChain, hubsData[reserveAssetOnChain.hub].assets[reserveAssetOnChain.assetId], index, +spokeData[0].oracleDecimals.toString(), network); })));
+        return {
+            assetsData: reserveAssetsArray.reduce((acc, reserveAsset) => {
+                acc[`${reserveAsset.symbol}-${reserveAsset.reserveId}`] = reserveAsset;
+                return acc;
+            }, {}),
+            oracle: spokeData[0].oracle,
+            oracleDecimals: +spokeData[0].oracleDecimals.toString(),
+            address: market.address,
+        };
+    });
+}
+function getAaveV4SpokeData(provider_1, network_1, spoke_1) {
+    return __awaiter(this, arguments, void 0, function* (provider, network, spoke, blockNumber = 'latest') {
+        return _getAaveV4SpokeData((0, viem_1.getViemProvider)(provider, network), network, spoke, blockNumber);
+    });
+}
+function _getAaveV4AccountData(provider_1, network_1, spokeData_1, address_1) {
+    return __awaiter(this, arguments, void 0, function* (provider, network, spokeData, address, blockNumber = 'latest') {
+        const viewContract = (0, contracts_1.AaveV4ViewContractViem)(provider, network, blockNumber);
+        const loanData = yield viewContract.read.getLoanData([spokeData.address, address]);
+        const healthFactor = new decimal_js_1.default(loanData.healthFactor).div(1e18).toString();
+        const usedAssets = loanData.reserves.reduce((acc, usedReserveAsset) => {
+            const identifier = `${(0, utils_1.wethToEth)((0, tokens_1.getAssetInfoByAddress)(usedReserveAsset.underlying, network).symbol)}-${+usedReserveAsset.reserveId.toString()}`;
+            const reserveData = spokeData.assetsData[identifier];
+            const price = reserveData.price;
+            const supplied = (0, tokens_1.assetAmountInEth)(usedReserveAsset.supplied.toString(), reserveData.symbol);
+            const drawn = (0, tokens_1.assetAmountInEth)(usedReserveAsset.drawn.toString(), reserveData.symbol);
+            const premium = (0, tokens_1.assetAmountInEth)(usedReserveAsset.premium.toString(), reserveData.symbol);
+            const borrowed = (0, tokens_1.assetAmountInEth)(usedReserveAsset.totalDebt.toString(), reserveData.symbol);
+            acc[identifier] = {
+                symbol: reserveData.symbol,
+                hubName: reserveData.hubName,
+                assetId: reserveData.assetId,
+                reserveId: +usedReserveAsset.reserveId.toString(),
+                supplied,
+                suppliedUsd: new decimal_js_1.default(supplied).mul(price).toString(),
+                drawn,
+                drawnUsd: new decimal_js_1.default(drawn).mul(price).toString(),
+                premium,
+                premiumUsd: new decimal_js_1.default(premium).mul(price).toString(),
+                borrowed,
+                borrowedUsd: new decimal_js_1.default(borrowed).mul(price).toString(),
+                isSupplied: !new decimal_js_1.default(supplied).eq(0),
+                isBorrowed: usedReserveAsset.isBorrowing,
+                collateral: usedReserveAsset.isUsingAsCollateral,
+                collateralFactor: new decimal_js_1.default(usedReserveAsset.collateralFactor).div(10000).toNumber(),
+            };
+            return acc;
+        }, {});
+        return Object.assign({ usedAssets,
+            healthFactor }, (0, aaveV4Helpers_1.aaveV4GetAggregatedPositionData)({
+            usedAssets,
+            assetsData: spokeData.assetsData,
+            network,
+            useUserCollateralFactor: true,
+        }));
+    });
+}
+function getAaveV4AccountData(provider_1, network_1, marketData_1, address_1) {
+    return __awaiter(this, arguments, void 0, function* (provider, network, marketData, address, blockNumber = 'latest') {
+        return _getAaveV4AccountData((0, viem_1.getViemProvider)(provider, network), network, marketData, address, blockNumber);
+    });
+}