@aurigami/sdk 1.5.9 → 1.6.0-no-src

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,11 +1,10 @@
 {
-  "version": "1.5.9",
+  "version": "1.6.0-no-src",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "engines": {
     "node": ">=10"
@@ -41,29 +40,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/BlockchainEntity.ts

@@ -1,33 +0,0 @@
-import { Signer } from '@ethersproject/abstract-signer';
-import { NetworkConnection } from './types';
-
-export class BlockchainEntityRead {
-  protected _networkConnection: NetworkConnection;
-  public constructor(networkConnection: NetworkConnection) {
-    this._networkConnection = networkConnection;
-  }
-}
-
-export class BlockchainEntityReadWrite extends BlockchainEntityRead {
-  public constructor(networkConnection: NetworkConnection) {
-    if (!(networkConnection.signer instanceof Signer)) {
-      throw Error(
-        'Signer is not provided when constructing BlockchainEntityReadWrite'
-      );
-    }
-    super(networkConnection);
-  }
-}
-
-export class BlockchainEntity {
-  constructor() {}
-  public read(networkConnection: NetworkConnection): BlockchainEntityRead {
-    return new BlockchainEntityRead(networkConnection);
-  }
-
-  public readWrite(
-    networkConnection: NetworkConnection
-  ): BlockchainEntityReadWrite {
-    return new BlockchainEntityReadWrite(networkConnection);
-  }
-}

package/src/MoneyMarket.ts

@@ -1,510 +0,0 @@
-import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
-import {
-  MoneyMarketDetails,
-  NetworkConnection,
-  Address,
-  ComptrollerRewardType,
-} from './types';
-import { Contract, BigNumber as BN } from 'ethers';
-import AuErc20ABI from '@aurigami/contracts/artifacts/contracts/AuErc20.sol/AuErc20.json';
-import AuETHABI from '@aurigami/contracts/artifacts/contracts/AuETH.sol/AuETH.json';
-import ComptrollerABI from '@aurigami/contracts/artifacts/contracts/Comptroller.sol/Comptroller.json';
-import AuriLensABI from '@aurigami/contracts/artifacts/contracts/AuriLens.sol/AuriLens.json';
-import EthRepayHelperABI from '@aurigami/contracts/artifacts/contracts/EthRepayHelper.sol/EthRepayHelper.json';
-import {
-  AuErc20,
-  AuETH,
-  AuriLens,
-  Comptroller,
-  EthRepayHelper,
-} from '@aurigami/contracts/typechain';
-import { TransactionResponse } from '@ethersproject/abstract-provider';
-import {
-  networkAddresses,
-  ETHAddress,
-  ONE_YEAR,
-  INF,
-  ONE_DAY,
-  DEPOSIT_NEAR_REWARDS_PER_WEEK,
-  BORROW_NEAR_REWARDS_PER_WEEK,
-} from './constants';
-import BigNumber from 'bignumber.js';
-import {
-  decimalFactor,
-  isSameAddress,
-  calcLMRewardApr,
-  getCurrentTimestamp,
-} from './helpers';
-import { Token, PLYToken } from './token';
-import { TokenAmount } from './tokenAmount';
-import { getDecimal, validateAndParseAddress } from './helpers';
-import { fetchPrice, calcValuation, fetchValuation } from './priceFetcher';
-
-type RewardSpeeds = {
-  plyRewardSupplySpeed: BN;
-  plyRewardBorrowSpeed: BN;
-  auroraRewardSupplySpeed: BN;
-  auroraRewardBorrowSpeed: BN;
-};
-
-export class MoneyMarketRead extends BlockchainEntityRead {
-  public underlying: Token;
-  public auToken: AuErc20 | AuETH;
-  protected _comptroller: Comptroller;
-
-  protected _auriLens: AuriLens;
-  constructor(
-    networkConnection: NetworkConnection,
-    auToken: Address,
-    underlyingAsset: Address
-  ) {
-    super(networkConnection);
-    if (isSameAddress(underlyingAsset, ETHAddress)) {
-      this.auToken = new Contract(
-        auToken,
-        AuETHABI.abi,
-        networkConnection.provider
-      ) as AuETH;
-    } else {
-      this.auToken = new Contract(
-        auToken,
-        AuErc20ABI.abi,
-        networkConnection.provider
-      ) as AuErc20;
-    }
-    this.underlying = new Token(underlyingAsset, getDecimal(underlyingAsset));
-    this._comptroller = new Contract(
-      networkAddresses.misc.COMPTROLLER,
-      ComptrollerABI.abi,
-      networkConnection.provider
-    ) as Comptroller;
-    this._auriLens = new Contract(
-      networkAddresses.misc.AURILENS,
-      AuriLensABI.abi,
-      networkConnection.provider
-    ) as AuriLens;
-  }
-
-  protected async getRewardSpeeds(): Promise<RewardSpeeds> {
-    var speeds = await this._auriLens.getRewardSpeeds(
-      this._comptroller.address,
-      this.auToken.address
-    );
-    return speeds;
-  }
-  public async getTotalTokenBorrowed(): Promise<TokenAmount> {
-    return new TokenAmount(
-      this.underlying,
-      (await this.auToken.totalBorrows()).toString()
-    );
-  }
-  public async getTotalTokenDeposited(): Promise<TokenAmount> {
-    var promises = [];
-    var totalBorrow: TokenAmount, totalCash: TokenAmount;
-    promises.push(
-      this.getTotalTokenBorrowed().then((res: TokenAmount) => {
-        totalBorrow = res;
-      })
-    );
-    promises.push(
-      this.auToken.getCash().then((res: BN) => {
-        totalCash = new TokenAmount(this.underlying, res.toString());
-      })
-    );
-    await Promise.all(promises);
-    return new TokenAmount(
-      this.underlying,
-      BN.from(totalCash!.rawAmount()).add(totalBorrow!.rawAmount()).toString()
-    );
-  }
-
-  public async getDepositAPY(): Promise<BigNumber> {
-    const supplyRatePerTimestamp = await this.auToken.supplyRatePerTimestamp();
-    return new BigNumber(supplyRatePerTimestamp.toString())
-      .multipliedBy(60 * 60 * 24 * 365)
-      .div(decimalFactor(18));
-  }
-
-  public async getBorrowAPY(): Promise<BigNumber> {
-    const borrowRatePerTimestamp = await this.auToken.borrowRatePerTimestamp();
-    return new BigNumber(borrowRatePerTimestamp.toString())
-      .multipliedBy(60 * 60 * 24 * 365)
-      .div(decimalFactor(18));
-  }
-
-  public async getCollateralRatio(): Promise<BigNumber> {
-    return this._comptroller.markets(this.auToken.address).then((res: any) => {
-      return new BigNumber(res.collateralFactorMantissa.toString()).div(
-        decimalFactor(18)
-      );
-    });
-  }
-
-  public async getBorrowPlyAPY(): Promise<BigNumber> {
-    var promises = [];
-    var totalBorrowed: TokenAmount,
-      rewardSpeed: TokenAmount,
-      plyPrice: BigNumber,
-      underlyingPrice: BigNumber;
-    promises.push(
-      this.getTotalTokenBorrowed().then((res: TokenAmount) => {
-        totalBorrowed = res;
-      })
-    );
-    promises.push(
-      this._comptroller
-        .rewardSpeeds(ComptrollerRewardType.PLY, this.auToken.address, false)
-        .then((res) => {
-          rewardSpeed = new TokenAmount(PLYToken, res.toString());
-        })
-    );
-    promises.push(
-      fetchPrice(
-        networkAddresses.tokens.PLY,
-        this._networkConnection.provider
-      ).then((res) => {
-        plyPrice = res;
-      })
-    );
-    promises.push(
-      fetchPrice(
-        this.underlying.address,
-        this._networkConnection.provider
-      ).then((res) => {
-        underlyingPrice = res;
-      })
-    );
-    await Promise.all(promises);
-    return calcLMRewardApr(
-      plyPrice!.multipliedBy(rewardSpeed!.formattedAmount()),
-      underlyingPrice!.multipliedBy(totalBorrowed!.formattedAmount()),
-      ONE_YEAR
-    );
-  }
-
-  public async getDepositPlyAPY(): Promise<BigNumber> {
-    var promises = [];
-    var totalDeposited: TokenAmount,
-      rewardSpeed: TokenAmount,
-      plyPrice: BigNumber,
-      underlyingPrice: BigNumber;
-    promises.push(
-      this.getTotalTokenDeposited().then((res: TokenAmount) => {
-        totalDeposited = res;
-      })
-    );
-    promises.push(
-      this._comptroller
-        .rewardSpeeds(ComptrollerRewardType.PLY, this.auToken.address, true)
-        .then((res) => {
-          rewardSpeed = new TokenAmount(PLYToken, res.toString());
-        })
-    );
-    promises.push(
-      fetchPrice(
-        networkAddresses.tokens.PLY,
-        this._networkConnection.provider
-      ).then((res) => {
-        plyPrice = res;
-      })
-    );
-    promises.push(
-      fetchPrice(
-        this.underlying.address,
-        this._networkConnection.provider
-      ).then((res) => {
-        underlyingPrice = res;
-      })
-    );
-    await Promise.all(promises);
-    return calcLMRewardApr(
-      plyPrice!.multipliedBy(rewardSpeed!.formattedAmount()),
-      underlyingPrice!.multipliedBy(totalDeposited!.formattedAmount()),
-      ONE_YEAR
-    );
-  }
-  public async getDetails(): Promise<MoneyMarketDetails> {
-    var promises = [],
-      totalDeposited: TokenAmount,
-      totalBorrowed: TokenAmount,
-      depositAPY: number,
-      borrowAPY: number,
-      collateralRatio: number;
-    promises.push(
-      this.getTotalTokenDeposited().then((res: TokenAmount) => {
-        totalDeposited = res;
-      })
-    );
-    promises.push(
-      this.getTotalTokenBorrowed().then((res: TokenAmount) => {
-        totalBorrowed = res;
-      })
-    );
-    promises.push(
-      this.getDepositAPY().then((res: BigNumber) => {
-        depositAPY = res.toNumber();
-      })
-    );
-    promises.push(
-      this.getBorrowAPY().then((res: BigNumber) => {
-        borrowAPY = res.toNumber();
-      })
-    );
-    promises.push(
-      this.getCollateralRatio().then((res: BigNumber) => {
-        collateralRatio = res.toNumber();
-      })
-    );
-
-    var plyPrice: BigNumber,
-      underlyingPrice: BigNumber,
-      rewardSpeeds: RewardSpeeds;
-    promises.push(
-      this.getRewardSpeeds().then((res) => {
-        rewardSpeeds = res;
-      })
-    );
-    promises.push(
-      fetchPrice(
-        networkAddresses.tokens.PLY,
-        this._networkConnection.provider
-      ).then((res) => {
-        plyPrice = res;
-      })
-    );
-    promises.push(
-      fetchPrice(
-        this.underlying.address,
-        this._networkConnection.provider
-      ).then((res) => {
-        underlyingPrice = res;
-      })
-    );
-
-    await Promise.all(promises);
-
-    var borrowPlyApy = calcLMRewardApr(
-      calcValuation(
-        new TokenAmount(
-          PLYToken,
-          rewardSpeeds!.plyRewardBorrowSpeed.toString()
-        ),
-        plyPrice!
-      ),
-      underlyingPrice!.multipliedBy(totalBorrowed!.formattedAmount()),
-      ONE_YEAR
-    );
-    var depositPlyApy = calcLMRewardApr(
-      calcValuation(
-        new TokenAmount(
-          PLYToken,
-          rewardSpeeds!.plyRewardSupplySpeed.toString()
-        ),
-        plyPrice!
-      ),
-      underlyingPrice!.multipliedBy(totalDeposited!.formattedAmount()),
-      ONE_YEAR
-    );
-
-    var depositNEARApy = calcLMRewardApr(
-      await fetchValuation(
-        this.getDepositNEARRewardPerWeek(),
-        this._networkConnection.provider
-      ),
-      underlyingPrice!.multipliedBy(totalDeposited!.formattedAmount()),
-      52
-    );
-    var borrowNEARApy = calcLMRewardApr(
-      await fetchValuation(
-        this.getBorrowNEARRewardPerWeek(),
-        this._networkConnection.provider
-      ),
-      underlyingPrice!.multipliedBy(totalBorrowed!.formattedAmount()),
-      52
-    );
-    var depositMETAApy;
-    if (
-      isSameAddress(this.underlying.address, networkAddresses.tokens.stNEAR)
-    ) {
-      depositMETAApy = calcLMRewardApr(
-        new BigNumber(50000),
-        underlyingPrice!.multipliedBy(totalDeposited!.formattedAmount()),
-        12
-      );
-    } else {
-      depositMETAApy = new BigNumber(0);
-    }
-
-    return {
-      auTokenAddress: this.auToken.address,
-      totalTokenDeposited: totalDeposited!,
-      totalTokenBorrowed: totalBorrowed!,
-      depositApy: depositAPY!,
-      depositPlyApy: depositPlyApy.toNumber(),
-      borrowApy: borrowAPY!,
-      borrowPlyApy: borrowPlyApy.toNumber() * -1,
-      collateralRatio: collateralRatio!,
-      depositPlyPerWeek: new TokenAmount(
-        PLYToken,
-        rewardSpeeds!.plyRewardSupplySpeed.mul(ONE_DAY).mul(7).toString()
-      ),
-      borrowPlyPerWeek: new TokenAmount(
-        PLYToken,
-        rewardSpeeds!.plyRewardBorrowSpeed.mul(ONE_DAY).mul(7).toString()
-      ),
-      depositNEARApy: depositNEARApy.toNumber(),
-      borrowNEARApy: borrowNEARApy.toNumber() * -1,
-      depositMETAApy: depositMETAApy.toNumber(),
-    };
-  }
-
-  public async getUserBorrowBalance(userAddress: string): Promise<TokenAmount> {
-    const totalBorrow: BN = await this.auToken.callStatic.borrowBalanceCurrent(
-      userAddress
-    );
-    return new TokenAmount(this.underlying, totalBorrow.toString());
-  }
-
-  public async getUserDepositBalance(
-    userAddress: string
-  ): Promise<TokenAmount> {
-    const totalDeposit: BN = await this.auToken.callStatic.balanceOfUnderlying(
-      userAddress
-    );
-    return new TokenAmount(this.underlying, totalDeposit.toString());
-  }
-
-  private getDepositNEARRewardPerWeek(): TokenAmount {
-    const NEARToken = new Token(
-      networkAddresses.tokens.WNEAR,
-      getDecimal(networkAddresses.tokens.WNEAR)
-    );
-    const rewardStartTime = 1650636000;
-    const rewardStopTime = 1651845600; // May 06, 2022 2 PM GMT
-    const currentTime = getCurrentTimestamp();
-    if (currentTime <= rewardStopTime && currentTime > rewardStartTime) {
-      const reward =
-        DEPOSIT_NEAR_REWARDS_PER_WEEK[
-          this.underlying.address.toLocaleLowerCase()
-        ] ?? '0';
-      return new TokenAmount(NEARToken, reward, false);
-    } else {
-      return new TokenAmount(NEARToken, '0');
-    }
-  }
-
-  private getBorrowNEARRewardPerWeek(): TokenAmount {
-    const NEARToken = new Token(
-      networkAddresses.tokens.WNEAR,
-      getDecimal(networkAddresses.tokens.WNEAR)
-    );
-    const rewardStartTime = 1650636000;
-    const rewardStopTime = 1651845600; // May 06, 2022 2 PM GMT
-    const currentTime = getCurrentTimestamp();
-    if (currentTime <= rewardStopTime && currentTime > rewardStartTime) {
-      const reward =
-        BORROW_NEAR_REWARDS_PER_WEEK[
-          this.underlying.address.toLocaleLowerCase()
-        ] ?? '0';
-      return new TokenAmount(NEARToken, reward, false);
-    } else {
-      return new TokenAmount(NEARToken, '0');
-    }
-  }
-}
-
-export class MoneyMarketReadWrite extends MoneyMarketRead {
-  protected _EthRepayHelper: EthRepayHelper;
-  constructor(
-    networkConnection: NetworkConnection,
-    auToken: Address,
-    underlyingAsset: Address
-  ) {
-    super(networkConnection, auToken, underlyingAsset);
-    this._EthRepayHelper = new Contract(
-      networkAddresses.misc.ETHREPAYHELPER,
-      EthRepayHelperABI.abi,
-      networkConnection.provider
-    ) as EthRepayHelper;
-  }
-
-  public async deposit(amount: TokenAmount): Promise<TransactionResponse> {
-    if (isSameAddress(amount.token.address, ETHAddress)) {
-      return (this.auToken as AuETH)
-        .connect(this._networkConnection.signer!)
-        .mint({ value: amount.rawAmount() });
-    } else {
-      return (this.auToken as AuErc20)
-        .connect(this._networkConnection.signer!)
-        .mint(amount.rawAmount());
-    }
-  }
-  public async borrow(amount: TokenAmount): Promise<TransactionResponse> {
-    return this.auToken
-      .connect(this._networkConnection.signer!)
-      .borrow(amount.rawAmount());
-  }
-  public async withdraw(amount: TokenAmount): Promise<TransactionResponse> {
-    if (new BigNumber(amount.rawAmount()).lt(0)) {
-      return this.auToken
-        .connect(this._networkConnection.signer!)
-        .redeemUnderlying(INF);
-    }
-    return this.auToken
-      .connect(this._networkConnection.signer!)
-      .redeemUnderlying(amount.rawAmount());
-  }
-  public async repay(amount: TokenAmount): Promise<TransactionResponse> {
-    if (isSameAddress(amount.token.address, ETHAddress)) {
-      return this._EthRepayHelper
-        .connect(this._networkConnection.signer!)
-        .repayBorrow({ value: amount.rawAmount() });
-    } else {
-      if (new BigNumber(amount.rawAmount()).lt(0)) {
-        return this.auToken
-          .connect(this._networkConnection.signer!)
-          .repayBorrow(INF);
-      } else {
-        return this.auToken
-          .connect(this._networkConnection.signer!)
-          .repayBorrow(amount.rawAmount());
-      }
-    }
-  }
-  public async enableCollateral(): Promise<TransactionResponse> {
-    return this._comptroller
-      .connect(this._networkConnection.signer!)
-      .enterMarkets([this.auToken.address]);
-  }
-  public async disableCollateral(): Promise<TransactionResponse> {
-    return this._comptroller
-      .connect(this._networkConnection.signer!)
-      .exitMarket(this.auToken.address);
-  }
-}
-
-export class MoneyMarket extends BlockchainEntity {
-  protected address: Address;
-
-  protected underlying: Address;
-  constructor(address: string, underlying: string) {
-    super();
-    this.address = validateAndParseAddress(address);
-    this.underlying = validateAndParseAddress(underlying);
-  }
-  public read(networkConnection: NetworkConnection): MoneyMarketRead {
-    return new MoneyMarketRead(
-      networkConnection,
-      this.address,
-      this.underlying
-    );
-  }
-
-  public readWrite(networkConnection: NetworkConnection): MoneyMarketReadWrite {
-    return new MoneyMarketReadWrite(
-      networkConnection,
-      this.address,
-      this.underlying
-    );
-  }
-}