@defisaver/positions-sdk 0.0.19 → 0.0.21

package/README.md

@@ -0,0 +1,63 @@
+# 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)
+- [Morpho Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/morphoAaveV2)
+- [Morpho Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/morphoAaveV3)
+- [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)
+- [Chicken Bonds](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/chickenBonds)
+
+## 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 Web3 from 'web3';
+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 web3 = new Web3(provider);
+
+const user = '0x123...';
+
+const { assetsData } = await getCompoundV3MarketsData(
+    web3, // 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
+    web3, // this must be mainnet rpc - used for getting prices onchain and calculating apys
+);
+
+const userData = await getCompoundV3AccountData(
+    web3,
+    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)

package/cjs/aaveV2/index.js

@@ -23,6 +23,7 @@ const aaveV3_1 = require("../aaveV3");
 const aave_1 = require("../markets/aave");
 const aaveHelpers_1 = require("../helpers/aaveHelpers");
 const priceService_1 = require("../services/priceService");
+const contracts_2 = __importDefault(require("../config/contracts"));
 const getAaveV2MarketsData = (web3, network, selectedMarket, mainnetWeb3) => __awaiter(void 0, void 0, void 0, function* () {
     const ethPrice = yield (0, priceService_1.getEthPrice)(mainnetWeb3);
     const _addresses = selectedMarket.assets.map(a => (0, tokens_1.getAssetInfo)((0, utils_1.ethToWeth)(a)).address);
@@ -94,18 +95,24 @@ const getAaveV2AccountBalances = (web3, network, block, addressMapping, address)
     const market = aave_1.AAVE_V2;
     const loanInfoContract = (0, contracts_1.AaveLoanInfoV2Contract)(web3, network, block);
     const marketAddress = market.providerAddress;
-    const _addresses = market.assets.map(a => (0, tokens_1.getAssetInfo)((0, utils_1.ethToWeth)(a), network).address);
+    const protocolDataProviderContract = new web3.eth.Contract(
+    // @ts-ignore
+    contracts_2.default[market.protocolData].abi, market.protocolDataAddress);
+    const reserveTokens = yield protocolDataProviderContract.methods.getAllReservesTokens().call({}, block);
+    const symbols = reserveTokens.map(({ symbol }) => symbol);
+    const _addresses = reserveTokens.map(({ tokenAddress }) => tokenAddress);
     const loanInfo = yield loanInfoContract.methods.getTokenBalances(marketAddress, address, _addresses).call({}, block);
     loanInfo.forEach((_tokenInfo, i) => {
-        const asset = (0, utils_1.wethToEth)(market.assets[i]);
+        const asset = (0, utils_1.wethToEth)(symbols[i]);
+        const assetAddr = (0, utils_1.wethToEthByAddress)(_addresses[i], network).toLowerCase();
         const tokenInfo = Object.assign({}, _tokenInfo);
         // known bug: stETH leaves 1 wei on every transfer
         if (asset === 'stETH' && tokenInfo.balance.toString() === '1') {
             tokenInfo.balance = '0';
         }
         balances = {
-            collateral: Object.assign(Object.assign({}, balances.collateral), { [addressMapping ? (0, tokens_1.getAssetInfo)(asset, network).address.toLowerCase() : asset]: tokenInfo.balance.toString() }),
-            debt: Object.assign(Object.assign({}, balances.debt), { [addressMapping ? (0, tokens_1.getAssetInfo)(asset, network).address.toLowerCase() : asset]: new decimal_js_1.default(tokenInfo.borrowsStable.toString()).add(tokenInfo.borrowsVariable.toString()).toString() }),
+            collateral: Object.assign(Object.assign({}, balances.collateral), { [addressMapping ? assetAddr : asset]: tokenInfo.balance.toString() }),
+            debt: Object.assign(Object.assign({}, balances.debt), { [addressMapping ? assetAddr : asset]: new decimal_js_1.default(tokenInfo.borrowsStable.toString()).add(tokenInfo.borrowsVariable.toString()).toString() }),
         };
     });
     return balances;

package/cjs/aaveV3/index.js

@@ -15,7 +15,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAaveV3FullPositionData = exports.getAaveV3AccountData = exports.getAaveV3AccountBalances = exports.EMPTY_AAVE_DATA = exports.getAaveV3MarketData = exports.aaveV3EmodeCategoriesMapping = exports.aaveV3CalculateDiscountRate = exports.test = void 0;
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const tokens_1 = require("@defisaver/tokens");
-const contracts_1 = require("../contracts");
+const contracts_1 = __importDefault(require("../config/contracts"));
+const contracts_2 = require("../contracts");
 const utils_1 = require("../services/utils");
 const common_1 = require("../types/common");
 const staking_1 = require("../staking");
@@ -25,7 +26,7 @@ const moneymarket_1 = require("../moneymarket");
 const aaveHelpers_1 = require("../helpers/aaveHelpers");
 const aave_1 = require("../markets/aave");
 const test = (web3, network) => {
-    const contract = (0, contracts_1.AaveV3ViewContract)(web3, 1);
+    const contract = (0, contracts_2.AaveV3ViewContract)(web3, 1);
     return contract.methods.AAVE_REFERRAL_CODE().call();
 };
 exports.test = test;
@@ -79,12 +80,12 @@ function getAaveV3MarketData(web3, network, market, defaultWeb3) {
     return __awaiter(this, void 0, void 0, function* () {
         const _addresses = market.assets.map(a => (0, tokens_1.getAssetInfo)((0, utils_1.ethToWeth)(a), network).address);
         const isL2 = (0, utils_1.isLayer2Network)(network);
-        const loanInfoContract = (0, contracts_1.AaveV3ViewContract)(web3, network);
-        const aaveIncentivesContract = (0, contracts_1.AaveIncentiveDataProviderV3Contract)(web3, network);
+        const loanInfoContract = (0, contracts_2.AaveV3ViewContract)(web3, network);
+        const aaveIncentivesContract = (0, contracts_2.AaveIncentiveDataProviderV3Contract)(web3, network);
         const marketAddress = market.providerAddress;
-        const GhoDiscountRateStrategyAddress = (0, contracts_1.getConfigContractAddress)('GhoDiscountRateStrategy', common_1.NetworkNumber.Eth);
-        const GhoDiscountRateStrategyAbi = (0, contracts_1.getConfigContractAbi)('GhoDiscountRateStrategy');
-        const GhoTokenAbi = (0, contracts_1.getConfigContractAbi)('GHO');
+        const GhoDiscountRateStrategyAddress = (0, contracts_2.getConfigContractAddress)('GhoDiscountRateStrategy', common_1.NetworkNumber.Eth);
+        const GhoDiscountRateStrategyAbi = (0, contracts_2.getConfigContractAbi)('GhoDiscountRateStrategy');
+        const GhoTokenAbi = (0, contracts_2.getConfigContractAbi)('GHO');
         const multicallCallsObject = [
             {
                 target: GhoDiscountRateStrategyAddress,
@@ -112,7 +113,7 @@ function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                 params: [],
             },
         ];
-        const ghoContract = (0, contracts_1.GhoTokenContract)(web3, network);
+        const ghoContract = (0, contracts_2.GhoTokenContract)(web3, network);
         // eslint-disable-next-line prefer-const
         let [loanInfo, isBorrowAllowed, multiRes] = yield Promise.all([
             loanInfoContract.methods.getFullTokensInfo(marketAddress, _addresses).call(),
@@ -258,10 +259,15 @@ const getAaveV3AccountBalances = (web3, network, block, addressMapping, address)
     if (!address) {
         return balances;
     }
-    const loanInfoContract = (0, contracts_1.AaveV3ViewContract)(web3, network, block);
+    const loanInfoContract = (0, contracts_2.AaveV3ViewContract)(web3, network, block);
     const market = (0, aave_1.AAVE_V3)(network);
     const marketAddress = market.providerAddress;
-    const _addresses = market.assets.map(a => (0, tokens_1.getAssetInfo)((0, utils_1.ethToWeth)(a), network).address);
+    const protocolDataProviderContract = new web3.eth.Contract(
+    // @ts-ignore
+    contracts_1.default[market.protocolData].abi, market.protocolDataAddress);
+    const reserveTokens = yield protocolDataProviderContract.methods.getAllReservesTokens().call({}, block);
+    const symbols = reserveTokens.map(({ symbol }) => symbol);
+    const _addresses = reserveTokens.map(({ tokenAddress }) => tokenAddress);
     // split addresses in half to avoid gas limit by multicall
     const middleAddressIndex = Math.floor(_addresses.length / 2);
     const multicallData = [
@@ -279,10 +285,11 @@ const getAaveV3AccountBalances = (web3, network, block, addressMapping, address)
     const multicallRes = yield (0, multicall_1.multicall)(multicallData, web3, network, block);
     const loanInfo = [...multicallRes[0][0], ...multicallRes[1][0]];
     loanInfo.forEach((tokenInfo, i) => {
-        const asset = (0, utils_1.wethToEth)(market.assets[i]);
+        const asset = (0, utils_1.wethToEth)(symbols[i]);
+        const assetAddr = (0, utils_1.wethToEthByAddress)(_addresses[i], network).toLowerCase();
         balances = {
-            collateral: Object.assign(Object.assign({}, balances.collateral), { [addressMapping ? (0, tokens_1.getAssetInfo)(asset, network).address.toLowerCase() : asset]: tokenInfo.balance.toString() }),
-            debt: Object.assign(Object.assign({}, balances.debt), { [addressMapping ? (0, tokens_1.getAssetInfo)(asset, network).address.toLowerCase() : asset]: new decimal_js_1.default(tokenInfo.borrowsStable.toString()).add(tokenInfo.borrowsVariable.toString()).toString() }),
+            collateral: Object.assign(Object.assign({}, balances.collateral), { [addressMapping ? assetAddr : asset]: tokenInfo.balance.toString() }),
+            debt: Object.assign(Object.assign({}, balances.debt), { [addressMapping ? assetAddr : asset]: new decimal_js_1.default(tokenInfo.borrowsStable.toString()).add(tokenInfo.borrowsVariable.toString()).toString() }),
         };
     });
     return balances;
@@ -299,11 +306,11 @@ const getAaveV3AccountData = (web3, network, address, extractedState) => __await
         return payload;
     }
     const isL2 = (0, utils_1.isLayer2Network)(network);
-    const loanInfoContract = (0, contracts_1.AaveV3ViewContract)(web3, network);
+    const loanInfoContract = (0, contracts_2.AaveV3ViewContract)(web3, network);
     const marketAddress = market.providerAddress;
     const _addresses = market.assets.map((a) => (0, tokens_1.getAssetInfo)((0, utils_1.ethToWeth)(a), network).address);
     const middleAddressIndex = Math.floor(_addresses.length / 2); // split addresses in half to avoid gas limit by multicall
-    const LendingPoolAbi = (0, contracts_1.getConfigContractAbi)(market.lendingPool);
+    const LendingPoolAbi = (0, contracts_2.getConfigContractAbi)(market.lendingPool);
     const multicallData = [
         {
             target: market.lendingPoolAddress,

package/cjs/compoundV2/index.d.ts

@@ -16,6 +16,7 @@ export declare const EMPTY_COMPOUND_DATA: {
     borrowStableSupplyUnstable: boolean;
 };
 export declare const getCollateralAssetsAddresses: (web3: Web3, network: NetworkNumber, account: string) => Promise<string[]>;
+export declare const getAllMarketAddresses: (web3: Web3, network: NetworkNumber, block: Blockish) => Promise<string[]>;
 export declare const getCompoundV2AccountBalances: (web3: Web3, network: NetworkNumber, block: Blockish, addressMapping: boolean, address: EthAddress) => Promise<PositionBalances>;
 export declare const getCompoundV2AccountData: (web3: Web3, network: NetworkNumber, address: string, assetsData: CompoundV2AssetsData) => Promise<CompoundV2PositionData>;
 export declare const getCompoundV2FullPositionData: (web3: Web3, network: NetworkNumber, address: string) => Promise<CompoundV2PositionData>;

package/cjs/compoundV2/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.getCompoundV2FullPositionData = exports.getCompoundV2AccountData = exports.getCompoundV2AccountBalances = exports.getCollateralAssetsAddresses = exports.EMPTY_COMPOUND_DATA = exports.getCompoundV2MarketsData = void 0;
+exports.getCompoundV2FullPositionData = exports.getCompoundV2AccountData = exports.getCompoundV2AccountBalances = exports.getAllMarketAddresses = exports.getCollateralAssetsAddresses = exports.EMPTY_COMPOUND_DATA = exports.getCompoundV2MarketsData = void 0;
 const tokens_1 = require("@defisaver/tokens");
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const constants_1 = require("../constants");
@@ -96,6 +96,11 @@ const getCollateralAssetsAddresses = (web3, network, account) => __awaiter(void
     return contract.methods.getAssetsIn(account).call();
 });
 exports.getCollateralAssetsAddresses = getCollateralAssetsAddresses;
+const getAllMarketAddresses = (web3, network, block) => __awaiter(void 0, void 0, void 0, function* () {
+    const contract = (0, contracts_1.ComptrollerContract)(web3, network);
+    return contract.methods.getAllMarkets().call({}, block);
+});
+exports.getAllMarketAddresses = getAllMarketAddresses;
 const getCompoundV2AccountBalances = (web3, network, block, addressMapping, address) => __awaiter(void 0, void 0, void 0, function* () {
     let balances = {
         collateral: {},
@@ -104,20 +109,22 @@ const getCompoundV2AccountBalances = (web3, network, block, addressMapping, addr
     if (!address) {
         return balances;
     }
+    const assets = yield (0, exports.getAllMarketAddresses)(web3, network, block);
+    const assetInfo = assets.map(a => (0, tokens_1.getAssetInfoByAddress)(a, network));
     const loanInfoContract = (0, contracts_1.CompoundLoanInfoContract)(web3, network, block);
-    const loanInfo = yield loanInfoContract.methods.getTokenBalances(address, marketsAssets_1.compoundV2CollateralAssets.map(a => a.address)).call({}, block);
+    const loanInfo = yield loanInfoContract.methods.getTokenBalances(address, assets).call({}, block);
     loanInfo.balances.forEach((weiAmount, i) => {
-        const asset = (0, utils_1.wethToEth)(marketsAssets_1.compoundV2CollateralAssets[i].symbol === 'cWBTC Legacy'
-            ? `${marketsAssets_1.compoundV2CollateralAssets[i].underlyingAsset} Legacy`
-            : marketsAssets_1.compoundV2CollateralAssets[i].underlyingAsset);
+        const asset = (0, utils_1.wethToEth)(assetInfo[i].symbol === 'cWBTC Legacy'
+            ? `${assetInfo[i].underlyingAsset} Legacy`
+            : assetInfo[i].underlyingAsset);
         balances = {
             collateral: Object.assign(Object.assign({}, balances.collateral), { [addressMapping ? (0, tokens_1.getAssetInfo)(asset, network).address.toLowerCase() : asset]: weiAmount.toString() }),
         };
     });
     loanInfo.borrows.forEach((weiAmount, i) => {
-        const asset = (0, utils_1.wethToEth)(marketsAssets_1.compoundV2CollateralAssets[i].symbol === 'cWBTC Legacy'
-            ? `${marketsAssets_1.compoundV2CollateralAssets[i].underlyingAsset} Legacy`
-            : marketsAssets_1.compoundV2CollateralAssets[i].underlyingAsset);
+        const asset = (0, utils_1.wethToEth)(assetInfo[i].symbol === 'cWBTC Legacy'
+            ? `${assetInfo[i].underlyingAsset} Legacy`
+            : assetInfo[i].underlyingAsset);
         balances = Object.assign(Object.assign({}, balances), { debt: Object.assign(Object.assign({}, balances.debt), { [addressMapping ? (0, tokens_1.getAssetInfo)(asset, network).address.toLowerCase() : asset]: weiAmount.toString() }) });
     });
     return balances;

package/cjs/compoundV3/index.js

@@ -68,6 +68,11 @@ const getCompoundV3MarketsData = (web3, network, selectedMarket, defaultWeb3) =>
                 coll.incentiveSupplyApy = yield (0, staking_1.getCbETHApr)(defaultWeb3);
                 coll.incentiveSupplyToken = 'cbETH';
             }
+            if (coll.symbol === 'rETH') {
+                // eslint-disable-next-line no-await-in-loop
+                coll.incentiveSupplyApy = yield (0, staking_1.getREthApr)(defaultWeb3);
+                coll.incentiveSupplyToken = 'rETH';
+            }
         }
     }
     const base = (0, compoundHelpers_1.formatBaseData)(data[0].baseToken, network, baseAssetPrice);