@defisaver/positions-sdk 0.0.25 → 0.0.26

package/esm/helpers/curveUsdHelpers/index.js

@@ -10,26 +10,33 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 import Dec from 'decimal.js';
-import { getAssetsTotal } from '../../moneymarket';
+import { calcLeverageLiqPrice, getAssetsTotal, isLeveragedPos } from '../../moneymarket';
+import { mapRange } from '../../services/utils';
 export const getCrvUsdAggregatedData = (_a) => {
-    var { loanExists, usedAssets, network, selectedMarket } = _a, rest = __rest(_a, ["loanExists", "usedAssets", "network", "selectedMarket"]);
-    const _supplied = getAssetsTotal(usedAssets, ({ isSupplied }) => isSupplied, ({ supplied }) => supplied); // this is wrong if we are in soft-liquidations
-    const _borrowed = getAssetsTotal(usedAssets, ({ isBorrowed }) => isBorrowed, ({ borrowed }) => borrowed);
-    const _suppliedUsd = getAssetsTotal(usedAssets, ({ isSupplied }) => isSupplied, ({ suppliedUsd }) => suppliedUsd);
-    const _borrowedUsd = getAssetsTotal(usedAssets, ({ isBorrowed }) => isBorrowed, ({ borrowedUsd }) => borrowedUsd);
-    const ratio = loanExists
-        ? new Dec(_suppliedUsd)
-            .dividedBy(_borrowedUsd)
+    var { loanExists, usedAssets, network, selectedMarket, numOfBands } = _a, rest = __rest(_a, ["loanExists", "usedAssets", "network", "selectedMarket", "numOfBands"]);
+    const payload = {};
+    payload.supplied = getAssetsTotal(usedAssets, ({ isSupplied }) => isSupplied, ({ supplied }) => supplied); // this is wrong if we are in soft-liquidations
+    payload.borrowed = getAssetsTotal(usedAssets, ({ isBorrowed }) => isBorrowed, ({ borrowed }) => borrowed);
+    payload.suppliedUsd = getAssetsTotal(usedAssets, ({ isSupplied }) => isSupplied, ({ suppliedUsd }) => suppliedUsd);
+    payload.borrowedUsd = getAssetsTotal(usedAssets, ({ isBorrowed }) => isBorrowed, ({ borrowedUsd }) => borrowedUsd);
+    payload.ratio = loanExists
+        ? new Dec(payload.suppliedUsd)
+            .dividedBy(payload.borrowedUsd)
             .times(100)
             .toString()
         : '0';
-    // we don't have borrowLimitUsd here
-    return {
-        ratio,
-        supplied: _supplied,
-        suppliedUsd: _suppliedUsd,
-        borrowedUsd: _borrowedUsd,
-        borrowed: _borrowed,
-        safetyRatio: ratio,
-    };
+    // this is all approximation
+    payload.minAllowedRatio = mapRange(numOfBands, 4, 50, 115, 140); // collateral ratio
+    payload.collFactor = new Dec(1).div(payload.minAllowedRatio).mul(100).toString(); // collateral factor = 1 / collateral ratio
+    // only take in consideration collAsset
+    payload.borrowLimitUsd = usedAssets[selectedMarket.collAsset].isSupplied
+        ? new Dec(usedAssets[selectedMarket.collAsset].suppliedUsd).mul(payload.collFactor).toString()
+        : '0';
+    const { leveragedType, leveragedAsset } = isLeveragedPos(usedAssets);
+    payload.leveragedType = leveragedType;
+    if (leveragedType !== '') {
+        payload.leveragedAsset = leveragedAsset;
+        payload.liquidationPrice = calcLeverageLiqPrice(leveragedType, usedAssets[selectedMarket.collAsset].price, payload.borrowedUsd, payload.borrowLimitUsd);
+    }
+    return payload;
 };

package/esm/moneymarket/moneymarketCommonService.js

@@ -16,7 +16,7 @@ export const calcLeverageLiqPrice = (leverageType, assetPrice, borrowedUsd, borr
     return '0';
 };
 export const calculateBorrowingAssetLimit = (assetBorrowedUsd, borrowLimitUsd) => new Dec(assetBorrowedUsd).div(borrowLimitUsd).times(100).toString();
-export const STABLE_ASSETS = ['DAI', 'USDC', 'USDT', 'TUSD', 'USDP', 'GUSD', 'BUSD', 'SUSD', 'FRAX', 'LUSD', 'USDC.e', 'GHO', 'sDAI'];
+export const STABLE_ASSETS = ['DAI', 'USDC', 'USDT', 'TUSD', 'USDP', 'GUSD', 'BUSD', 'SUSD', 'FRAX', 'LUSD', 'USDC.e', 'GHO', 'sDAI', 'crvUSD'];
 export const isLeveragedPos = (usedAssets, dustLimit = 5) => {
     let borrowUnstable = 0;
     let supplyStable = 0;

package/esm/services/utils.d.ts

@@ -14,3 +14,7 @@ export declare const handleWbtcLegacy: (asset: string) => string;
 export declare const wethToEthByAddress: (maybeWethAddr: string, chainId?: NetworkNumber) => string;
 export declare const ethToWethByAddress: (maybeEthAddr: string, chainId?: NetworkNumber) => string;
 export declare const bytesToString: (hex: string) => string;
+/**
+ * Map an input value from one range (minInput, maxInput) to a value in another range (minOutput, maxOutput)
+ */
+export declare const mapRange: (input: number | string, minInput: number | string, maxInput: number | string, minOutput: number | string, maxOutput: number | string) => number;

package/esm/services/utils.js

@@ -19,3 +19,14 @@ export const bytesToString = (hex) => Buffer.from(hex.replace(/^0x/, ''), 'hex')
     .toString()
     // eslint-disable-next-line no-control-regex
     .replace(/\x00/g, '');
+/**
+ * Map an input value from one range (minInput, maxInput) to a value in another range (minOutput, maxOutput)
+ */
+export const mapRange = (input, minInput, maxInput, minOutput, maxOutput) => {
+    // slope = 1.0 * (output_end - output_start) / (input_end - input_start)
+    const inputDiff = new Dec(maxInput).minus(minInput);
+    const outputDiff = new Dec(maxOutput).minus(minOutput);
+    const slope = new Dec(outputDiff).div(inputDiff);
+    // output = output_start + slope * (input - input_start)
+    return new Dec(minOutput).plus(new Dec(slope).mul(new Dec(input).minus(minInput))).toDP(2).toNumber();
+};

package/esm/types/contracts/generated/CrvUSDView.d.ts

@@ -138,7 +138,9 @@ export declare namespace CurveUsdView {
         [
             number | string | BN[],
             number | string | BN[]
-        ]
+        ],
+        number | string | BN,
+        boolean
     ] | {
         loanExists: boolean;
         collateralPrice: number | string | BN;
@@ -152,6 +154,8 @@ export declare namespace CurveUsdView {
         health: number | string | BN;
         bandRange: [number | string | BN, number | string | BN];
         usersBands: [number | string | BN[], number | string | BN[]];
+        collRatio: number | string | BN;
+        isInSoftLiquidation: boolean;
     };
     type UserDataStructOutputArray = [
         boolean,
@@ -171,7 +175,9 @@ export declare namespace CurveUsdView {
         [
             string[],
             string[]
-        ]
+        ],
+        string,
+        boolean
     ];
     type UserDataStructOutputStruct = {
         loanExists: boolean;
@@ -186,6 +192,8 @@ export declare namespace CurveUsdView {
         health: string;
         bandRange: [string, string];
         usersBands: [string[], string[]];
+        collRatio: string;
+        isInSoftLiquidation: boolean;
     };
     type UserDataStructOutput = UserDataStructOutputArray & UserDataStructOutputStruct;
 }
@@ -193,15 +201,33 @@ export interface CrvUSDView extends BaseContract {
     constructor(jsonInterface: any[], address?: string, options?: ContractOptions): CrvUSDView;
     clone(): CrvUSDView;
     methods: {
+        WBTC_HEALTH_ZAP(): NonPayableTransactionObject<string>;
+        WBTC_MARKET(): NonPayableTransactionObject<string>;
         createLoanData(market: string, collateral: number | string | BN, debt: number | string | BN, N: number | string | BN): NonPayableTransactionObject<CurveUsdView.CreateLoanDataStructOutput>;
         getBandData(market: string, n: number | string | BN): NonPayableTransactionObject<CurveUsdView.BandStructOutput>;
-        "getBandsData(address,uint256,uint256,uint256)"(market: string, collateral: number | string | BN, debt: number | string | BN, N: number | string | BN): NonPayableTransactionObject<CurveUsdView.BandStructOutput[]>;
-        "getBandsData(address,int256,int256)"(market: string, from: number | string | BN, to: number | string | BN): NonPayableTransactionObject<CurveUsdView.BandStructOutput[]>;
+        getBandsData(market: string, from: number | string | BN, to: number | string | BN): NonPayableTransactionObject<CurveUsdView.BandStructOutput[]>;
+        getBandsDataForPosition(market: string, collateral: number | string | BN, debt: number | string | BN, N: number | string | BN): NonPayableTransactionObject<CurveUsdView.BandStructOutput[]>;
+        getCollAmountsFromAMM(_controllerAddress: string, _user: string): NonPayableTransactionObject<[
+            string,
+            string
+        ] & {
+            crvUsdAmount: string;
+            collAmount: string;
+        }>;
+        getCollateralRatio(_user: string, _controllerAddr: string): NonPayableTransactionObject<[
+            string,
+            boolean
+        ] & {
+            collRatio: string;
+            isInSoftLiquidation: boolean;
+        }>;
         globalData(market: string): NonPayableTransactionObject<CurveUsdView.GlobalDataStructOutput>;
         healthCalculator(market: string, user: string, collChange: number | string | BN, debtChange: number | string | BN, isFull: boolean, numBands: number | string | BN): NonPayableTransactionObject<string>;
+        isControllerValid(_controllerAddr: string): NonPayableTransactionObject<boolean>;
         maxBorrow(market: string, collateral: number | string | BN, N: number | string | BN): NonPayableTransactionObject<string>;
         minCollateral(market: string, debt: number | string | BN, N: number | string | BN): NonPayableTransactionObject<string>;
         userData(market: string, user: string): NonPayableTransactionObject<CurveUsdView.UserDataStructOutput>;
+        userMaxWithdraw(_controllerAddress: string, _user: string): NonPayableTransactionObject<string>;
     };
     events: {
         allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;

package/esm/types/curveUsd.d.ts

@@ -67,6 +67,12 @@ export interface CrvUSDAggregatedPositionData {
     borrowedUsd: string;
     borrowed: string;
     safetyRatio: string;
+    borrowLimitUsd: string;
+    minAllowedRatio: number;
+    collFactor: string;
+    leveragedType: string;
+    leveragedAsset?: string;
+    liquidationPrice?: string;
 }
 export interface CrvUSDUsedAsset {
     isSupplied: boolean;

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@defisaver/positions-sdk",
-  "version": "0.0.25",
-  "description": "",
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./esm/index.d.ts",
-  "scripts": {
-    "build:esm": "rm -rf esm && tsc -p tsconfig.json",
-    "build:cjs": "rm -rf cjs && tsc -p tsconfig.cjs.json",
-    "build": "npm run generate-contracts && npm run build:cjs && npm run build:esm",
-    "dev": "npm run generate-contracts && tsc -p tsconfig.cjs.json --watch",
-    "lint": "eslint src/ --fix",
-    "generate-contracts": "node scripts/generateContracts.js",
-    "test": "mocha tests/*",
-    "build-test": "npm run build && mocha tests/*"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@defisaver/tokens": "^1.5.5",
-    "@ethersproject/bignumber": "^5.7.0",
-    "@morpho-org/morpho-aave-v3-sdk": "^1.5.3",
-    "decimal.js": "^10.4.3"
-  },
-  "devDependencies": {
-    "@defisaver/eslint-config": "^1.0.1",
-    "chai": "^4.3.8",
-    "dotenv": "^16.3.1",
-    "eslint": "^8.49.0",
-    "mocha": "^10.2.0",
-    "typechain": "^8.3.1",
-    "typechain-target-web3-v1-3mihai3": "^6.0.2",
-    "typescript": "^5.2.2"
-  },
-  "peerDependencies": {
-    "web3": "^1.10.2"
-  }
-}
+{
+  "name": "@defisaver/positions-sdk",
+  "version": "0.0.26",
+  "description": "",
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "./esm/index.d.ts",
+  "scripts": {
+    "build:esm": "rm -rf esm && tsc -p tsconfig.json",
+    "build:cjs": "rm -rf cjs && tsc -p tsconfig.cjs.json",
+    "build": "npm run generate-contracts && npm run build:cjs && npm run build:esm",
+    "dev": "npm run generate-contracts && tsc -p tsconfig.cjs.json --watch",
+    "lint": "eslint src/ --fix",
+    "generate-contracts": "node scripts/generateContracts.js",
+    "test": "mocha tests/*",
+    "build-test": "npm run build && mocha tests/*"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@defisaver/tokens": "^1.5.5",
+    "@ethersproject/bignumber": "^5.7.0",
+    "@morpho-org/morpho-aave-v3-sdk": "^1.5.3",
+    "decimal.js": "^10.4.3"
+  },
+  "devDependencies": {
+    "@defisaver/eslint-config": "^1.0.1",
+    "chai": "^4.3.8",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.49.0",
+    "mocha": "^10.2.0",
+    "typechain": "^8.3.1",
+    "typechain-target-web3-v1-3mihai3": "^6.0.2",
+    "typescript": "^5.2.2"
+  },
+  "peerDependencies": {
+    "web3": "^1.10.2"
+  }
+}