@aurigami/sdk 0.3.4 → 0.4.2

package/dist/types.d.ts

@@ -46,8 +46,13 @@ export declare type UserMarketDetails = {
     isCollateral: boolean;
     maxWithdrawableAmount: TokenAmount;
     collateralRatio: number;
+    underlyingPrice: string;
 };
 export declare type PlyAuroraPoolDetails = {
     totalStakedLiquidity: TokenAmount;
     apy: string;
 };
+export declare type HypotheticalStats = {
+    newBorrowLimit: CurrencyAmount;
+    newBorrowUtilization: number;
+};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.4",
+  "version": "0.4.2",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -60,6 +60,7 @@
     "@aurigami/contracts": "^1.1.1",
     "axios": "^0.24.0",
     "bignumber.js": "^9.0.2",
+    "dotenv": "^16.0.0",
     "ethers": "^5.0.0"
   }
 }

package/src/MoneyMarket.ts

@@ -32,7 +32,7 @@ export class MoneyMarketRead extends BlockchainEntityRead {
   constructor(networkConnection: NetworkConnection, auToken: Address, underlyingAsset: Address) {
     super(networkConnection);
     if (isSameAddress(underlyingAsset, ETHAddress)) {
-      this.auToken = new Contract(auToken, AuETHABI.abi, networkConnection.provider) as AuETH
+      this.auToken = new Contract(auToken, AuETHABI.abi, networkConnection.provider) as AuETH;
     } else {
       this.auToken = new Contract(auToken, AuErc20ABI.abi, networkConnection.provider) as AuErc20;
     }

package/src/SDK.ts

@@ -7,8 +7,9 @@ import {
   UserMarketDetails,
   Address,
   CurrencyAmount,
+  HypotheticalStats
 } from './types';
-import { AVAX_DEFAULT_PROVIDER_URL, networkAddresses, BORROW_LIMIT_BUFFER, DECIMAL_PRECISION, REWARDCLAIMSTART, ONE_DAY, AurPlyPid } from './constants';
+import { networkAddresses, BORROW_LIMIT_BUFFER, DECIMAL_PRECISION, REWARDCLAIMSTART, ONE_DAY, AurPlyPid } from './constants';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
 import { Contract, BigNumber as BN, ethers, providers } from 'ethers';
 import { isSameAddress, decimalFactor, getCurrentTimestamp, calcLMRewardApr } from './helpers';
@@ -22,7 +23,6 @@ import AuriLensABI from '@aurigami/contracts/artifacts/contracts/AuriLens.sol/Au
 import ComptrollerABI from '@aurigami/contracts/artifacts/contracts/Comptroller.sol/Comptroller.json';
 import TokenLockABI from "@aurigami/contracts/artifacts/contracts/TokenLock.sol/TokenLock.json";
 import AuriFairLaunchABI from "@aurigami/contracts/artifacts/contracts/AuriFairLaunch.sol/AuriFairLaunch.json";
-import dummyABI from "./abis/dummy.json";
 
 export class SdkRead extends BlockchainEntityRead {
 
@@ -69,7 +69,10 @@ export class SdkRead extends BlockchainEntityRead {
       promises.push(moneyMarket.getUserDepositBalance(userAddress).then((res: TokenAmount) => {userMarketDetail.depositBalance = res}));
       promises.push(moneyMarket.getUserBorrowBalance(userAddress).then((res: TokenAmount) => {userMarketDetail.borrowBalance = res}));
       promises.push(moneyMarket.getCollateralRatio().then((res: BigNumber) => {userMarketDetail.collateralRatio = res.toNumber()}));
-      pricePromises.push(fetchPrice(moneyMarket.underlying.address, this._networkConnection.provider));
+      pricePromises.push(fetchPrice(moneyMarket.underlying.address, this._networkConnection.provider).then((res) => {
+        userMarketDetail.underlyingPrice = res.toString();
+        return res;
+      }));
     }
 
     promises.push(this._comptroller.getAssetsIn(userAddress).then((res: string[]) => {assetsIn = res}));
@@ -101,8 +104,14 @@ export class SdkRead extends BlockchainEntityRead {
     promises.push(this._tokenLock.lockedAmounts(userAddress));
     var values = await Promise.all(promises);
     accountLiquidity = values[0]; rewardBalancesMetadata = values[1]; lockedAmount = values[2];
-    const borrowedvaluation: BigNumber = totalBorrowLimit.minus(new BigNumber(accountLiquidity[1].toString()).div(decimalFactor(18)));
+    var borrowedvaluation: BigNumber = totalBorrowLimit.minus(new BigNumber(accountLiquidity[1].toString()).div(decimalFactor(18)));
+
+    if (borrowedvaluation.lt("0.00001")) { // Igore dust, dust could be the result of network delay causing collateral valuation calc to be different on vs off chain
+      borrowedvaluation = new BigNumber(0);
+    } 
+    
     const bufferedBorrowLimit: BigNumber = totalBorrowLimit.multipliedBy(BORROW_LIMIT_BUFFER);
+    const minimumBorrowLimitAllowed = borrowedvaluation.div(BORROW_LIMIT_BUFFER);
 
     var borrowableAmount: BigNumber;
     if (bufferedBorrowLimit.lte(borrowedvaluation)) {
@@ -114,10 +123,17 @@ export class SdkRead extends BlockchainEntityRead {
     for (var i = 0; i < marketCount; i ++) {
       const auToken = networkAddresses.auTokens[i];
       const moneyMarket: MoneyMarketRead = new MoneyMarketRead(this._networkConnection, auToken.address, auToken.underlying);
-      userMarketDetails[i].maxWithdrawableAmount = new TokenAmount(
-        moneyMarket.underlying,
-        borrowableAmount.div(underlyingPrices[i]).toFixed(18)
-      )
+      const maxWithdrawCap: BigNumber = (totalBorrowLimit.minus(minimumBorrowLimitAllowed)).div(userMarketDetails[i].collateralRatio).div(underlyingPrices[i]);
+      userMarketDetails[i].maxWithdrawableAmount = userMarketDetails[i].isCollateral && maxWithdrawCap.lt(userMarketDetails[i].depositBalance.formattedAmount()) 
+      ?  new TokenAmount(
+          moneyMarket.underlying,
+          maxWithdrawCap.toFixed(24),
+          false
+        )
+      : new TokenAmount(
+          moneyMarket.underlying,
+          userMarketDetails[i].depositBalance.rawAmount()
+        );
     }
 
     return {
@@ -179,6 +195,18 @@ export class SdkRead extends BlockchainEntityRead {
       userInfo.amount.toString()
     )
   }
+
+  public calcHypotheticalStats(args: {userMarketDetail: UserMarketDetails, currentBorrowLimit: CurrencyAmount, currentBorrowValuation: CurrencyAmount, isEnable: boolean}): HypotheticalStats {
+    const deltaBorrowLimit = new BigNumber(args.userMarketDetail.depositBalance.formattedAmount()).multipliedBy(args.userMarketDetail.underlyingPrice).multipliedBy(args.userMarketDetail.collateralRatio).multipliedBy(BORROW_LIMIT_BUFFER);
+    const newBorrowLimit = args.isEnable ? new BigNumber(args.currentBorrowLimit.amount).plus(deltaBorrowLimit) : new BigNumber(args.currentBorrowLimit.amount).minus(deltaBorrowLimit);
+    return {
+      newBorrowLimit: {
+        amount: newBorrowLimit.toFixed(DECIMAL_PRECISION),
+        currency: "USD"
+      },
+      newBorrowUtilization: new BigNumber(args.currentBorrowValuation.amount).div(newBorrowLimit).toNumber()
+    }
+  }
 }
 
 export class SdkReadWrite extends SdkRead {
@@ -205,7 +233,7 @@ export class SDK extends BlockchainEntity {
     return new SdkRead(networkConnection);
   }
 
-  public static defaultProvider(): providers.Provider {
-    return new ethers.providers.JsonRpcProvider(AVAX_DEFAULT_PROVIDER_URL);
+  public readWrite(networkConnection: NetworkConnection): SdkReadWrite {
+    return new SdkReadWrite(networkConnection);
   }
 }

package/src/constants.ts

@@ -1,26 +1,8 @@
 import BigNumber from 'bignumber.js';
-// import ethers from 'ethers';
-const ethers = require('ethers');
-import { Signer } from 'ethers';
-export const AVAX_DEFAULT_PROVIDER_URL =
-  'https://api.avax.network/ext/bc/C/rpc';
-
-export const AVAX_DEFAULT_PROVIDER = new ethers.providers.JsonRpcProvider(
-  AVAX_DEFAULT_PROVIDER_URL
-);
-
-export const AURORA_DEFAULT_PROVIDER_URL = "https://mainnet.aurora.dev";
-
-export const AURORA_DEFAULT_PROVIDER = new ethers.providers.JsonRpcProvider(
-  AURORA_DEFAULT_PROVIDER_URL
-);
+import { ethers, Signer} from 'ethers';
 export const dummyAddress: string = "0xDEADbeEfEEeEEEeEEEeEEeeeeeEeEEeeeeEEEEeE";
 export const ETHAddress: string = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
 
-const dummyPrivateKey =
-  '1111111111111111111111111111111111111111111111111111111111111111';
-export const AURORA_DEFAULT_SIGNER: Signer = new ethers.Wallet(dummyPrivateKey, AURORA_DEFAULT_PROVIDER);
-
 export const AURORA_CHAINID = 1313161554;
 
 export const DECIMAL_PRECISION = 6;

package/src/dummy.ts

@@ -39,4 +39,6 @@ export const dummyUserMarketDetails: UserMarketDetails = {
   borrowBalance: dummyZeroTokenAmount,
   isCollateral: true,
   maxWithdrawableAmount: dummyTokenAmount,
+  collateralRatio: 0.5,
+  underlyingPrice: "1"
 };

package/src/priceFetcher.ts

@@ -7,9 +7,8 @@ import { PriceOracle } from "@aurigami/contracts/typechain";
 import { TokenAmount } from "./tokenAmount";
 import { Address } from "./types";
 import IUniswapV2PairABI from './abis/IUniswapV2Pair.json';
-import dummyABI from "./abis/dummy.json";
-
-const axios = require('axios')
+import AuriLensABI from '@aurigami/contracts/artifacts/contracts/AuriLens.sol/AuriLens.json';
+import axios from 'axios';
 
 export async function fetchPriceFromCoingeckoAPI(id: string): Promise<BigNumber> {
     const price = await axios.get(
@@ -78,8 +77,11 @@ export async function fetchPriceFromOracle(auTokenAddress: Address, underlyingDe
     return processPriceFromOracle(rawPrice, underlyingDecimal)
 }
 
-export async function fetchUnderlyingTokensPrices(provider: providers.Provider) {
-    const auriLens: Contract = new Contract(networkAddresses.misc.AURILENS, dummyABI.abi, provider);
+export async function fetchUnderlyingTokensPrices(provider: providers.Provider): Promise<{
+    auToken: string,
+    underlyingPrice: BigNumber
+}[]> {
+    const auriLens: Contract = new Contract(networkAddresses.misc.AURILENS, AuriLensABI.abi, provider);
     const auTokenAddresses = networkAddresses.auTokens.map((auToken) => auToken.address);
     const underlyingDecimals = networkAddresses.auTokens.map((auToken) => getDecimal(auToken.underlying));
     const rawPrices = await auriLens.auTokenUnderlyingPriceAll(auTokenAddresses);
@@ -104,7 +106,7 @@ export async function fetchPrice(address: Address, provider: providers.Provider)
     }
 }
 export async function fetchValuation(tokenAmount: TokenAmount, provider: providers.Provider, price?: BigNumber): Promise<BigNumber> {
-    if (price === null) {
+    if (price === undefined) {
         price = await fetchPrice(tokenAmount.token.address, provider);
     }
     return new BigNumber(tokenAmount.formattedAmount()).multipliedBy(price!);

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { providers, Signer } from 'ethers';
+import type { BigNumber, providers, Signer } from 'ethers';
 import { TokenAmount } from './tokenAmount';
 
 export enum ComptrollerRewardType {
@@ -54,9 +54,15 @@ export type UserMarketDetails = {
   isCollateral: boolean;
   maxWithdrawableAmount: TokenAmount;
   collateralRatio: number;
+  underlyingPrice: string;
 };
 
 export type PlyAuroraPoolDetails = {
   totalStakedLiquidity: TokenAmount;
   apy: string;
-};
+};
+
+export type HypotheticalStats = {
+  newBorrowLimit: CurrencyAmount;
+  newBorrowUtilization: number;
+}