@aurigami/sdk 0.3.5 → 0.4.4

package/dist/types.d.ts

@@ -46,8 +46,21 @@ export declare type UserMarketDetails = {
     isCollateral: boolean;
     maxWithdrawableAmount: TokenAmount;
     collateralRatio: number;
+    underlyingPrice: string;
 };
 export declare type PlyAuroraPoolDetails = {
     totalStakedLiquidity: TokenAmount;
     apy: string;
 };
+export declare enum MarketAction {
+    Deposit = 0,
+    Borrow = 1,
+    Withdraw = 2,
+    Repay = 3,
+    EnableCollateral = 4,
+    DisableCollateral = 5
+}
+export declare type HypotheticalStats = {
+    newBorrowLimit: CurrencyAmount;
+    newBorrowUtilization: number;
+};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.5",
+  "version": "0.4.4",
   "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

@@ -13,7 +13,7 @@ import { decimalFactor, isSameAddress, calcLMRewardApr } from './helpers';
 import { Token, PLYToken } from './token';
 import { TokenAmount } from './tokenAmount';
 import { getDecimal, validateAndParseAddress } from './helpers';
-import { fetchPrice, fetchValuation } from "./priceFetcher";
+import { fetchPrice, calcValuation } from "./priceFetcher";
 
 
 type RewardSpeeds = {
@@ -138,24 +138,22 @@ export class MoneyMarketRead extends BlockchainEntityRead {
     await Promise.all(promises);
     
     var borrowPlyApy = calcLMRewardApr(
-      await fetchValuation(
+      await calcValuation(
         new TokenAmount(
           PLYToken,
           rewardSpeeds!.plyRewardBorrowSpeed.toString()
         ), 
-        this._networkConnection.provider, 
         plyPrice!
       ),
       underlyingPrice!.multipliedBy(totalBorrowed!.formattedAmount()), 
       ONE_YEAR
     );
     var depositPlyApy = calcLMRewardApr(
-      await fetchValuation(
+      await calcValuation(
         new TokenAmount(
           PLYToken,
           rewardSpeeds!.plyRewardSupplySpeed.toString()
         ), 
-        this._networkConnection.provider, 
         plyPrice!
       ),
       underlyingPrice!.multipliedBy(totalDeposited!.formattedAmount()), 

package/src/SDK.ts

@@ -7,13 +7,15 @@ import {
   UserMarketDetails,
   Address,
   CurrencyAmount,
+  HypotheticalStats,
+  MarketAction
 } 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';
 import { MoneyMarketRead } from './MoneyMarket';
-import { fetchValuation, fetchPrice } from './priceFetcher';
+import { fetchValuation, fetchPrice, calcValuation } from './priceFetcher';
 import { AuriFairLaunch, Comptroller, TokenLock, AuriLens } from '@aurigami/contracts/typechain';
 import { TokenAmount } from './tokenAmount';
 import { AURPLYToken, PLYToken, Token } from './token';
@@ -22,7 +24,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,15 +70,17 @@ 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}));
     
     await Promise.all(promises);
     var underlyingPrices = await Promise.all(pricePromises);
-    var depositValuationPromises = [];
-
+    var depositValues = []
     for (var i = 0; i < marketCount; i ++) {
       const auToken = networkAddresses.auTokens[i];
       if (assetsIn!.find((auAddress: Address) => isSameAddress(auToken.address, auAddress)) !== undefined) {
@@ -85,10 +88,9 @@ export class SdkRead extends BlockchainEntityRead {
       } else {
         userMarketDetails[i].isCollateral = false;
       }
-      depositValuationPromises.push(fetchValuation(userMarketDetails[i].depositBalance, this._networkConnection.provider, underlyingPrices[i]));
+      depositValues.push(calcValuation(userMarketDetails[i].depositBalance,  underlyingPrices[i]));
     }
 
-    var depositValues = await Promise.all(depositValuationPromises);
     totalBorrowLimit = depositValues.reduce((p: BigNumber, v: BigNumber, index: number)=> {
       if (userMarketDetails[index].isCollateral) return p.plus(v.multipliedBy(userMarketDetails[index].collateralRatio));
       return p;
@@ -101,7 +103,12 @@ 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);
 
@@ -187,6 +194,48 @@ export class SdkRead extends BlockchainEntityRead {
       userInfo.amount.toString()
     )
   }
+
+  public calcHypotheticalStats({
+    userMarketDetail, 
+    currentBorrowLimit,
+    currentBorrowValuation,
+    action,
+    tokenAmount
+  }: {
+    userMarketDetail: UserMarketDetails,
+    currentBorrowLimit: CurrencyAmount, 
+    currentBorrowValuation: CurrencyAmount, 
+    action: MarketAction,
+    tokenAmount?: TokenAmount
+  }): HypotheticalStats {
+    var newBorrowLimit = new BigNumber(currentBorrowLimit.amount), newBorrowValuation = new BigNumber(currentBorrowValuation.amount);
+    switch (action) {
+      case MarketAction.EnableCollateral:
+      case MarketAction.DisableCollateral:
+        var deltaBorrowLimit = calcValuation(userMarketDetail.depositBalance, new BigNumber(userMarketDetail.underlyingPrice)).multipliedBy(userMarketDetail.collateralRatio).multipliedBy(BORROW_LIMIT_BUFFER);
+        newBorrowLimit = action == MarketAction.EnableCollateral ? newBorrowLimit.plus(deltaBorrowLimit) : newBorrowLimit.minus(deltaBorrowLimit);
+        break;
+
+      case MarketAction.Deposit:
+      case MarketAction.Withdraw:
+        deltaBorrowLimit = calcValuation(tokenAmount!, new BigNumber(userMarketDetail.underlyingPrice)).multipliedBy(userMarketDetail.collateralRatio).multipliedBy(BORROW_LIMIT_BUFFER);
+        newBorrowLimit = action == MarketAction.Deposit ? newBorrowLimit.plus(deltaBorrowLimit) : newBorrowLimit.minus(deltaBorrowLimit);
+        break;
+
+      case MarketAction.Borrow:
+      case MarketAction.Repay:
+        var deltaBorrowValuation = calcValuation(tokenAmount!, new BigNumber(userMarketDetail.underlyingPrice));
+        newBorrowValuation = action == MarketAction.Borrow ? newBorrowValuation.plus(deltaBorrowValuation) : newBorrowValuation.minus(deltaBorrowValuation);
+        break;
+    }
+    return {
+      newBorrowLimit: {
+        amount: newBorrowLimit!.toFixed(DECIMAL_PRECISION),
+        currency: "USD"
+      },
+      newBorrowUtilization: newBorrowValuation!.div(newBorrowLimit!).toNumber()
+    }
+  }
 }
 
 export class SdkReadWrite extends SdkRead {
@@ -213,7 +262,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,29 +1,11 @@
 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;
+export const DECIMAL_PRECISION = 10;
 
 export type NetworkAddresses = {
   auTokens: {

package/src/dummy.ts

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

package/src/priceFetcher.ts

@@ -8,8 +8,7 @@ import { TokenAmount } from "./tokenAmount";
 import { Address } from "./types";
 import IUniswapV2PairABI from './abis/IUniswapV2Pair.json';
 import AuriLensABI from '@aurigami/contracts/artifacts/contracts/AuriLens.sol/AuriLens.json';
-
-const axios = require('axios')
+import axios from 'axios';
 
 export async function fetchPriceFromCoingeckoAPI(id: string): Promise<BigNumber> {
     const price = await axios.get(
@@ -106,9 +105,11 @@ export async function fetchPrice(address: Address, provider: providers.Provider)
         return fetchPriceFromCoingecko(address);
     }
 }
-export async function fetchValuation(tokenAmount: TokenAmount, provider: providers.Provider, price?: BigNumber): Promise<BigNumber> {
-    if (price === null) {
-        price = await fetchPrice(tokenAmount.token.address, provider);
-    }
-    return new BigNumber(tokenAmount.formattedAmount()).multipliedBy(price!);
+export async function fetchValuation(tokenAmount: TokenAmount, provider: providers.Provider): Promise<BigNumber> {
+    var price = await fetchPrice(tokenAmount.token.address, provider);
+    return calcValuation(tokenAmount, price);
+}
+
+export function calcValuation(tokenAmount: TokenAmount, price: BigNumber) {
+    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,23 @@ export type UserMarketDetails = {
   isCollateral: boolean;
   maxWithdrawableAmount: TokenAmount;
   collateralRatio: number;
+  underlyingPrice: string;
 };
 
 export type PlyAuroraPoolDetails = {
   totalStakedLiquidity: TokenAmount;
   apy: string;
-};
+};
+
+export enum MarketAction {
+  Deposit = 0,
+  Borrow,
+  Withdraw,
+  Repay,
+  EnableCollateral,
+  DisableCollateral
+}
+export type HypotheticalStats = {
+  newBorrowLimit: CurrencyAmount;
+  newBorrowUtilization: number;
+}