@aurigami/sdk 1.5.10 → 1.6.0

package/dist/{types.d.ts → types/index.d.ts}

@@ -1,5 +1,5 @@
 import type { providers, Signer } from 'ethers';
-import { TokenAmount } from './tokenAmount';
+import { TokenAmount } from '../entities/tokenAmount';
 export declare enum ComptrollerRewardType {
     PLY = 0,
     AURORA = 1
@@ -40,12 +40,26 @@ export declare type UserDetails = {
 };
 export declare type UserLockingDetails = {
     vestingStart: number;
+    /** % of reward they will receive in PLY, if they claim this week */
     currentUnlockPortion: number;
     accruedPly: TokenAmount;
+    /** Amount of PLY they will receive, if they claim this week */
     currentPly: TokenAmount;
+    /** Amount of PULP they will receive, if they claim this week */
     currentPulp: TokenAmount;
+    /** % of reward they will receive in PLY, if they claim next week */
     nextUnlockPortion: number;
+    /**
+     * Amount of PLY they will receive, if they claim next week.
+     * This doesn't include the additional reward that they will earn
+     * in the next week.
+     */
     nextPly: TokenAmount;
+    /**
+     * Amount of PULP they will receive, if they claim next week.
+     * This doesn't include the additional reward that they will earn
+     * in the next week.
+     */
     nextPulp: TokenAmount;
 };
 export declare type UserMarketDetails = {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.10",
+  "version": "1.6.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -41,29 +41,29 @@
     }
   ],
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^7.0.5",
+    "@nomiclabs/hardhat-ethers": "^2.0.5",
+    "@nomiclabs/hardhat-etherscan": "^3.0.3",
+    "@nomiclabs/hardhat-waffle": "^2.0.3",
+    "@size-limit/preset-small-lib": "^7.0.8",
+    "@types/mocha": "^9.1.0",
+    "chai": "^4.3.6",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "ethereum-waffle": "^3.4.4",
+    "hardhat": "^2.9.3",
     "husky": "^7.0.4",
     "prettier": "^2.5.1",
     "size-limit": "^7.0.5",
+    "ts-node": "^10.7.0",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",
     "typescript": "^4.5.4"
   },
   "dependencies": {
     "@aurigami/contracts": "3.3.0",
-    "@nomiclabs/hardhat-ethers": "^2.0.5",
-    "@nomiclabs/hardhat-etherscan": "^3.0.3",
-    "@nomiclabs/hardhat-waffle": "^2.0.3",
-    "@types/mocha": "^9.1.0",
     "axios": "^0.26.1",
     "bignumber.js": "^9.0.2",
-    "chai": "^4.3.6",
     "dotenv": "^16.0.0",
-    "ethereum-waffle": "^3.4.4",
-    "ethers": "^5.6.4",
-    "hardhat": "^2.9.3",
-    "ts-node": "^10.7.0"
+    "ethers": "^5.6.4"
   }
 }

package/src/SDK.ts

@@ -10,66 +10,58 @@ import {
 import { TransactionResponse } from '@ethersproject/abstract-provider';
 import BigNumber from 'bignumber.js';
 import { BigNumber as BN, Contract } from 'ethers';
-import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
+import * as consts from './consts';
 import {
-  ALL_STAKING_POOLS,
-  BORROW_LIMIT_BUFFER,
-  DECIMAL_PRECISION,
-  INF,
-  networkAddresses,
-} from './constants';
-import { decimalFactor, isSameAddress } from './helpers';
-import { MoneyMarketRead } from './MoneyMarket';
-import { PapermillRead } from './Papermill';
-import { calcValuation, fetchPrice } from './priceFetcher';
-import { StakingRead, StakingReadWrite } from './Staking';
-import { Token } from './token';
-import { TokenAmount } from './tokenAmount';
+  MoneyMarketRead,
+  PapermillRead,
+  StakingRead,
+  StakingReadWrite,
+} from './contracts';
 import {
-  Address,
-  CurrencyAmount,
-  HypotheticalStats,
-  MarketAction,
-  NetworkConnection,
-  PLYWNEARPoolDetails,
-  UserDetails,
-  UserMarketDetails,
-} from './types';
+  BlockchainEntity,
+  BlockchainEntityRead,
+  Token,
+  TokenAmount,
+} from './entities';
+import { decimalFactor, isSameAddress } from './helpers/helpers';
+import { calcValuation, fetchPrice } from './helpers/priceFetcher';
+import * as types from './types';
 
 export class SdkRead extends BlockchainEntityRead {
   protected _comptroller: Comptroller;
   protected _auriFairLaunch: AuriFairLaunch;
   protected _auriLens: AuriLens;
   protected _stakingRead: StakingRead;
-  constructor(networkConnection: NetworkConnection) {
+  constructor(networkConnection: types.NetworkConnection) {
     super(networkConnection);
     this._stakingRead = new StakingRead(networkConnection);
     this._comptroller = new Contract(
-      networkAddresses.misc.COMPTROLLER,
+      consts.networkAddresses.misc.COMPTROLLER,
       ComptrollerABI.abi,
       networkConnection.provider
     ) as Comptroller;
     this._auriFairLaunch = new Contract(
-      networkAddresses.misc.AURIFAIRLAUNCH,
+      consts.networkAddresses.misc.AURIFAIRLAUNCH,
       AuriFairLaunchABI.abi,
       networkConnection.provider
     ) as AuriFairLaunch;
     this._auriLens = new Contract(
-      networkAddresses.misc.AURILENS,
+      consts.networkAddresses.misc.AURILENS,
       AuriLensABI.abi,
       networkConnection.provider
     ) as AuriLens;
   }
 
-  public async getUserDetails(userAddress: string): Promise<UserDetails> {
-    const marketCount = networkAddresses.auTokens.length;
-    var userMarketDetails: UserMarketDetails[] = [],
+  public async getUserDetails(userAddress: string): Promise<types.UserDetails> {
+    const marketCount = consts.networkAddresses.auTokens.length;
+    var userMarketDetails: types.UserMarketDetails[] = [],
       assetsIn: string[];
     var promises = [];
     var totalBorrowLimit = new BigNumber(0);
     var pricePromises = [];
-    for (const auToken of networkAddresses.auTokens) {
-      const userMarketDetail: UserMarketDetails = {} as UserMarketDetails;
+    for (const auToken of consts.networkAddresses.auTokens) {
+      const userMarketDetail: types.UserMarketDetails =
+        {} as types.UserMarketDetails;
       userMarketDetails.push(userMarketDetail);
       userMarketDetail.market = auToken.underlying;
       const moneyMarket: MoneyMarketRead = new MoneyMarketRead(
@@ -117,9 +109,9 @@ export class SdkRead extends BlockchainEntityRead {
     var underlyingPrices = await Promise.all(pricePromises);
     var depositValues = [];
     for (var i = 0; i < marketCount; i++) {
-      const auToken = networkAddresses.auTokens[i];
+      const auToken = consts.networkAddresses.auTokens[i];
       if (
-        assetsIn!.find((auAddress: Address) =>
+        assetsIn!.find((auAddress: types.Address) =>
           isSameAddress(auToken.address, auAddress)
         ) !== undefined
       ) {
@@ -155,10 +147,12 @@ export class SdkRead extends BlockchainEntityRead {
       borrowedvaluation = new BigNumber(0);
     }
 
-    const bufferedBorrowLimit: BigNumber =
-      totalBorrowLimit.multipliedBy(BORROW_LIMIT_BUFFER);
-    const minimumBorrowLimitAllowed =
-      borrowedvaluation.div(BORROW_LIMIT_BUFFER);
+    const bufferedBorrowLimit: BigNumber = totalBorrowLimit.multipliedBy(
+      consts.BORROW_LIMIT_BUFFER
+    );
+    const minimumBorrowLimitAllowed = borrowedvaluation.div(
+      consts.BORROW_LIMIT_BUFFER
+    );
 
     var borrowableAmount: BigNumber;
     if (bufferedBorrowLimit.lte(borrowedvaluation)) {
@@ -168,7 +162,7 @@ export class SdkRead extends BlockchainEntityRead {
     }
 
     for (var i = 0; i < marketCount; i++) {
-      const auToken = networkAddresses.auTokens[i];
+      const auToken = consts.networkAddresses.auTokens[i];
       const moneyMarket: MoneyMarketRead = new MoneyMarketRead(
         this._networkConnection,
         auToken.address,
@@ -200,30 +194,30 @@ export class SdkRead extends BlockchainEntityRead {
       markets: userMarketDetails,
       borrowLimit: {
         currency: 'USD',
-        amount: bufferedBorrowLimit.toFixed(DECIMAL_PRECISION),
+        amount: bufferedBorrowLimit.toFixed(consts.DECIMAL_PRECISION),
       },
       userLockingDetails: await new PapermillRead(
         this._networkConnection
       ).getLockingDetails(userAddress),
       borrowableAmount: {
         currency: 'USD',
-        amount: borrowableAmount.toFixed(DECIMAL_PRECISION),
+        amount: borrowableAmount.toFixed(consts.DECIMAL_PRECISION),
       },
     };
   }
 
-  public async getPLYWNEARPoolDetails(): Promise<PLYWNEARPoolDetails> {
+  public async getPLYWNEARPoolDetails(): Promise<types.PLYWNEARPoolDetails> {
     return this._stakingRead.getPLYWNEARPoolDetails();
   }
 
-  public async getTokenPrice(token: Token): Promise<CurrencyAmount> {
+  public async getTokenPrice(token: Token): Promise<types.CurrencyAmount> {
     const price = await fetchPrice(
       token.address,
       this._networkConnection.provider
     );
     return {
       currency: 'USD',
-      amount: price.toFixed(DECIMAL_PRECISION),
+      amount: price.toFixed(consts.DECIMAL_PRECISION),
     };
   }
 
@@ -252,58 +246,58 @@ export class SdkRead extends BlockchainEntityRead {
     action,
     tokenAmount,
   }: {
-    userMarketDetail: UserMarketDetails;
-    currentBorrowLimit: CurrencyAmount;
-    currentBorrowValuation: CurrencyAmount;
-    action: MarketAction;
+    userMarketDetail: types.UserMarketDetails;
+    currentBorrowLimit: types.CurrencyAmount;
+    currentBorrowValuation: types.CurrencyAmount;
+    action: types.MarketAction;
     tokenAmount?: TokenAmount;
-  }): HypotheticalStats {
+  }): types.HypotheticalStats {
     var newBorrowLimit = new BigNumber(currentBorrowLimit.amount),
       newBorrowValuation = new BigNumber(currentBorrowValuation.amount);
     switch (action) {
-      case MarketAction.EnableCollateral:
-      case MarketAction.DisableCollateral:
+      case types.MarketAction.EnableCollateral:
+      case types.MarketAction.DisableCollateral:
         var deltaBorrowLimit = calcValuation(
           userMarketDetail.depositBalance,
           new BigNumber(userMarketDetail.underlyingPrice)
         )
           .multipliedBy(userMarketDetail.collateralRatio)
-          .multipliedBy(BORROW_LIMIT_BUFFER);
+          .multipliedBy(consts.BORROW_LIMIT_BUFFER);
         newBorrowLimit =
-          action == MarketAction.EnableCollateral
+          action == types.MarketAction.EnableCollateral
             ? newBorrowLimit.plus(deltaBorrowLimit)
             : newBorrowLimit.minus(deltaBorrowLimit);
         break;
 
-      case MarketAction.Deposit:
-      case MarketAction.Withdraw:
+      case types.MarketAction.Deposit:
+      case types.MarketAction.Withdraw:
         deltaBorrowLimit = calcValuation(
           tokenAmount!,
           new BigNumber(userMarketDetail.underlyingPrice)
         )
           .multipliedBy(userMarketDetail.collateralRatio)
-          .multipliedBy(BORROW_LIMIT_BUFFER);
+          .multipliedBy(consts.BORROW_LIMIT_BUFFER);
         newBorrowLimit =
-          action == MarketAction.Deposit
+          action == types.MarketAction.Deposit
             ? newBorrowLimit.plus(deltaBorrowLimit)
             : newBorrowLimit.minus(deltaBorrowLimit);
         break;
 
-      case MarketAction.Borrow:
-      case MarketAction.Repay:
+      case types.MarketAction.Borrow:
+      case types.MarketAction.Repay:
         var deltaBorrowValuation = calcValuation(
           tokenAmount!,
           new BigNumber(userMarketDetail.underlyingPrice)
         );
         newBorrowValuation =
-          action == MarketAction.Borrow
+          action == types.MarketAction.Borrow
             ? newBorrowValuation.plus(deltaBorrowValuation)
             : newBorrowValuation.minus(deltaBorrowValuation);
         break;
     }
     return {
       newBorrowLimit: {
-        amount: newBorrowLimit!.toFixed(DECIMAL_PRECISION),
+        amount: newBorrowLimit!.toFixed(consts.DECIMAL_PRECISION),
         currency: 'USD',
       },
       newBorrowUtilization: newBorrowLimit.eq(0)
@@ -331,7 +325,11 @@ export class SdkReadWrite extends SdkRead {
   public async claimLpRewards(): Promise<TransactionResponse> {
     return this._auriFairLaunch
       .connect(this._networkConnection.signer!)
-      .harvest(await this._networkConnection.signer!.getAddress(), 0, INF);
+      .harvest(
+        await this._networkConnection.signer!.getAddress(),
+        0,
+        consts.INF
+      );
   }
 
   public async stake(amount: TokenAmount): Promise<TransactionResponse> {
@@ -344,7 +342,7 @@ export class SdkReadWrite extends SdkRead {
 
   public async faucetDrip(): Promise<TransactionResponse> {
     const faucet = new Contract(
-      networkAddresses.misc.FAUCET,
+      consts.networkAddresses.misc.FAUCET,
       FaucetABI.abi,
       this._networkConnection.provider
     );
@@ -356,11 +354,11 @@ export class SDK extends BlockchainEntity {
   constructor() {
     super();
   }
-  public read(networkConnection: NetworkConnection): SdkRead {
+  public read(networkConnection: types.NetworkConnection): SdkRead {
     return new SdkRead(networkConnection);
   }
 
-  public readWrite(networkConnection: NetworkConnection): SdkReadWrite {
+  public readWrite(networkConnection: types.NetworkConnection): SdkReadWrite {
     return new SdkReadWrite(networkConnection);
   }
 }

package/src/{constants.ts → consts/constants.ts}

@@ -1,5 +1,6 @@
 import BigNumber from 'bignumber.js';
 import { ethers, Signer, BigNumber as BN } from 'ethers';
+import { MAINNET_ADDRESSES } from './deployments';
 export const dummyAddress: string =
   '0xDEADbeEfEEeEEEeEEEeEEeeeeeEeEEeeeeEEEEeE';
 export const ETHAddress: string = '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
@@ -21,63 +22,62 @@ export const networkAddresses: NetworkAddresses = {
   auTokens: [
     {
       name: 'auUSDC',
-      address: '0x4f0d864b1ABf4B701799a0b30b57A22dFEB5917b'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.USDC.toLowerCase(),
       underlying: '0xb12bfca5a55806aaf64e99521918a4bf0fc40802'.toLowerCase(),
     },
     {
       name: 'auETH',
-      address: '0xca9511B610bA5fc7E311FDeF9cE16050eE4449E9'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.ETH.toLowerCase(),
       underlying: ETHAddress.toLowerCase(),
     },
     {
       name: 'auWBTC',
-      address: '0xCFb6b0498cb7555e7e21502E0F449bf28760Adbb'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.WBTC.toLowerCase(),
       underlying: '0xf4eb217ba2454613b15dbdea6e5f22276410e89e'.toLowerCase(),
     },
     {
       name: 'auUSDT',
-      address: '0xaD5A2437Ff55ed7A8Cad3b797b3eC7c5a19B1c54'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.USDT.toLowerCase(),
       underlying: '0x4988a896b1227218e4a686fde5eabdcabd91571f'.toLowerCase(),
     },
     {
       name: 'auDAI',
-      address: '0xCE4166363E3a584DAc84A47bCD3414B43EfCDd1c'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.DAI.toLowerCase(),
       underlying: '0xe3520349f477a5f6eb06107066048508498a291b'.toLowerCase(),
     },
     {
       name: 'auWNEAR',
-      address: '0xaE4fac24dCdAE0132C6d04f564dCf059616E9423'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.WNEAR.toLowerCase(),
       underlying: '0xC42C30aC6Cc15faC9bD938618BcaA1a1FaE8501d'.toLowerCase(),
     },
     {
       name: 'auSTNEAR',
-      address: '0x3195949f267702723bc614cAE037cdc8D1E94786'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.STNEAR.toLowerCase(),
       underlying: '0x07F9F7f963C5cD2BBFFd30CcfB964Be114332E30'.toLowerCase(),
     },
     {
       name: 'auAURORA',
-      address: '0x8888682E24dd4Df7B7Ff2B91fccB575737E433bf'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.AURORA.toLowerCase(),
       underlying: '0x8bec47865ade3b172a928df8f990bc7f2a3b9f79'.toLowerCase(),
     },
     {
       name: 'auTRI',
-      address: '0x6Ea6C03061bDdCE23d4Ec60B6E6e880c33d24dca'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.TRI.toLowerCase(),
       underlying: '0xFa94348467f64D5A457F75F8bc40495D33c65aBB'.toLowerCase(),
     },
     {
       name: 'auPLY',
-      address: '0xC9011e629c9d0b8B1e4A2091e123fBB87B3A792c'.toLowerCase(),
+      address: MAINNET_ADDRESSES.auTokens.PLY.toLowerCase(),
       underlying: '0x09c9d464b58d96837f8d8b6f4d9fe4ad408d3a4f'.toLowerCase(),
     },
   ],
   misc: {
-    COMPTROLLER: '0x817af6cfAF35BdC1A634d6cC94eE9e4c68369Aeb'.toLowerCase(),
-    oracle: '0xC6e5185438e1730959c1eF3551059A3feC744E90'.toLowerCase(),
-    AURIFAIRLAUNCH: '0xC9A848AC73e378516B16E4EeBBa5ef6aFbC0BBc2'.toLowerCase(),
-    AURILENS: '0xFfdFfBDB966Cb84B50e62d70105f2Dbf2e0A1e70'.toLowerCase(),
-    TOKENLOCK: '0xDACC02a4Ff16Ea3c1515AdbfdCeb7B1F448B79c8'.toLowerCase(),
-    ETHREPAYHELPER: '0xa308A5003fA1A25BFdD9418FcEE51d48Dbe441e6'.toLowerCase(),
-    AURI_AIRDROP: '0x6C42aA5b128B62D6CCf357726D7d13F3888335EC'.toLowerCase(),
+    COMPTROLLER: MAINNET_ADDRESSES.comptroller.toLowerCase(),
+    oracle: MAINNET_ADDRESSES.oracle.toLowerCase(),
+    AURIFAIRLAUNCH: MAINNET_ADDRESSES.fairLaunch.toLowerCase(),
+    AURILENS: MAINNET_ADDRESSES.auriLens.toLowerCase(),
+    ETHREPAYHELPER: MAINNET_ADDRESSES.ethRepayHelper.toLowerCase(),
+    AURI_AIRDROP: MAINNET_ADDRESSES.auriAirdrop.toLowerCase(),
   },
   tokens: {
     AURORA: '0x8bec47865ade3b172a928df8f990bc7f2a3b9f79'.toLowerCase(),
@@ -87,8 +87,8 @@ export const networkAddresses: NetworkAddresses = {
     WNEAR: '0xC42C30aC6Cc15faC9bD938618BcaA1a1FaE8501d'.toLowerCase(),
     TRI: '0xFa94348467f64D5A457F75F8bc40495D33c65aBB'.toLowerCase(),
     META: '0xc21ff01229e982d7c8b8691163b0a3cb8f357453'.toLocaleLowerCase(),
-    PULP: '0x04Ac48711BCdc45b4d223fb021E09DA73c71095e'.toLowerCase(),
-    PLYWNEAR: '0x044b6B0CD3Bb13D2b9057781Df4459C66781dCe7'.toLowerCase(),
+    PULP: MAINNET_ADDRESSES.PULP.toLowerCase(),
+    PLYWNEAR: MAINNET_ADDRESSES.ply_wnear_lp.toLowerCase(),
   },
 };
 

package/src/consts/deployments.ts

@@ -0,0 +1,4 @@
+import MAINNET_ADDRESSES from '@aurigami/contracts/deployments/aurora_mainnet.json';
+import TESTNET_ADDRESSES from '@aurigami/contracts/deployments/aurora_testnet.json';
+
+export { MAINNET_ADDRESSES, TESTNET_ADDRESSES };

package/src/{dummy.ts → consts/dummy.ts}

@@ -1,6 +1,6 @@
-import { Token } from './token';
-import { TokenAmount } from './tokenAmount';
-import { UserMarketDetails } from './types';
+import { Token } from '../entities';
+import { TokenAmount } from '../entities';
+import { UserMarketDetails } from '../types';
 
 export const dummyToken = new Token(
   '0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',

package/src/consts/index.ts

@@ -0,0 +1,4 @@
+export * from './constants';
+export * from './decimals';
+export * from './dummy';
+export * from './deployments';