@aurigami/sdk 1.12.9-hf → 1.13.0

package/src/interactors/misc.ts

@@ -25,9 +25,7 @@ export class MiscRead extends BlockchainEntityRead {
     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 consts.networkAddresses.auTokens) {
       const userMarketDetail: types.UserMarketDetails = {} as types.UserMarketDetails;
       userMarketDetails.push(userMarketDetail);
@@ -37,37 +35,21 @@ export class MiscRead extends BlockchainEntityRead {
         auToken.address,
         auToken.underlying
       );
-      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).then((res) => {
-          userMarketDetail.underlyingPrice = res.toString();
-          return res;
-        })
-      );
+      const [depositBalance, borrowBalance, collateralRatio, underlyingPrice] = await Promise.all([
+        moneyMarket.getUserDepositBalance(userAddress),
+        moneyMarket.getUserBorrowBalance(userAddress),
+        moneyMarket.getCollateralRatio(),
+        fetchPrice(moneyMarket.underlying.address, this._networkConnection.provider),
+      ]);
+
+      userMarketDetail.depositBalance = depositBalance;
+      userMarketDetail.borrowBalance = borrowBalance;
+      userMarketDetail.collateralRatio = collateralRatio.toNumber();
+      userMarketDetail.underlyingPrice = underlyingPrice.toString();
     }
 
-    promises.push(
-      this.env.comptroller.getAssetsIn(userAddress).then((res: string[]) => {
-        assetsIn = res;
-      })
-    );
+    assetsIn = await this.env.comptroller.getAssetsIn(userAddress);
 
-    await Promise.all(promises);
-    var underlyingPrices = await Promise.all(pricePromises);
     var depositValues = [];
     for (var i = 0; i < marketCount; i++) {
       const auToken = consts.networkAddresses.auTokens[i];
@@ -79,7 +61,12 @@ export class MiscRead extends BlockchainEntityRead {
       } else {
         userMarketDetails[i].isCollateral = false;
       }
-      depositValues.push(calcValuation(userMarketDetails[i].depositBalance, underlyingPrices[i]));
+      depositValues.push(
+        calcValuation(
+          userMarketDetails[i].depositBalance,
+          new BigNumber(userMarketDetails[i].underlyingPrice)
+        )
+      );
     }
 
     totalBorrowLimit = depositValues.reduce((p: BigNumber, v: BigNumber, index: number) => {
@@ -88,10 +75,7 @@ export class MiscRead extends BlockchainEntityRead {
       return p;
     }, new BigNumber(0));
 
-    var accountLiquidity: [BN, BN] = await this.env.comptroller.getAccountLiquidity(userAddress).catch((e) => {
-      console.log(e);
-      return [BN.from(0), BN.from(0)]
-    });
+    var accountLiquidity: [BN, BN] = await this.env.comptroller.getAccountLiquidity(userAddress);
 
     var borrowedvaluation: BigNumber = totalBorrowLimit.minus(
       new BigNumber(accountLiquidity[0].toString()).div(decimalFactor(18))
@@ -126,15 +110,15 @@ export class MiscRead extends BlockchainEntityRead {
         : new BigNumber(0);
       const maxWithdrawCap: BigNumber = borrowLimitMargin
         .div(userMarketDetails[i].collateralRatio)
-        .div(underlyingPrices[i]);
+        .div(userMarketDetails[i].underlyingPrice);
       userMarketDetails[i].maxWithdrawableAmount =
         userMarketDetails[i].isCollateral &&
-          maxWithdrawCap.lt(userMarketDetails[i].depositBalance.formattedAmount())
+        maxWithdrawCap.lt(userMarketDetails[i].depositBalance.formattedAmount())
           ? new TokenAmount(moneyMarket.underlying, maxWithdrawCap.toFixed(24), false)
           : new TokenAmount(
-            moneyMarket.underlying,
-            userMarketDetails[i].depositBalance.rawAmount()
-          );
+              moneyMarket.underlying,
+              userMarketDetails[i].depositBalance.rawAmount()
+            );
     }
 
     return {
@@ -323,4 +307,67 @@ export class MiscRead extends BlockchainEntityRead {
     }
     return res;
   }
+
+  public async getNetApyWithoutIncentive(userAddress: types.Address): Promise<BigNumber> {
+    let sum = new BigNumber(0);
+    let totalSuppliedValue = new BigNumber(0);
+    let totalBorrowedValue = new BigNumber(0);
+    let netApy = new BigNumber(0);
+
+    const apys = await Promise.all(
+      consts.networkAddresses.auTokens.map((auToken) => {
+        const moneyMarket: MoneyMarketRead = new MoneyMarketRead(
+          this._networkConnection,
+          auToken.address,
+          auToken.underlying
+        );
+        const apyWithoutIncentive = moneyMarket.getApyWithoutIncentive(userAddress);
+        return apyWithoutIncentive;
+      })
+    );
+
+    for (const apy of apys) {
+      sum = sum.plus(apy.sum);
+      totalSuppliedValue = totalSuppliedValue.plus(apy.suppliedValue);
+      totalBorrowedValue = totalBorrowedValue.plus(apy.borrowedValue);
+    }
+
+    if (sum.gt(0)) {
+      netApy = sum.div(totalSuppliedValue);
+    } else if (sum.lt(0)) {
+      netApy = sum.div(totalBorrowedValue);
+    }
+    return netApy;
+  }
+
+  public async getNetApyWithIncentive(userAddress: types.Address): Promise<BigNumber> {
+    let sum = new BigNumber(0);
+    let totalSuppliedValue = new BigNumber(0);
+    let totalBorrowedValue = new BigNumber(0);
+    let netApy = new BigNumber(0);
+    const apys = await Promise.all(
+      consts.networkAddresses.auTokens.map((auToken) => {
+        const moneyMarket: MoneyMarketRead = new MoneyMarketRead(
+          this._networkConnection,
+          auToken.address,
+          auToken.underlying
+        );
+        const apyWithIncentive = moneyMarket.getApyWithIncentive(userAddress);
+        return apyWithIncentive;
+      })
+    );
+
+    for (const apy of apys) {
+      sum = sum.plus(apy.sum);
+      totalSuppliedValue = totalSuppliedValue.plus(apy.suppliedValue);
+      totalBorrowedValue = totalBorrowedValue.plus(apy.borrowedValue);
+    }
+
+    if (sum.gt(0)) {
+      netApy = sum.div(totalSuppliedValue);
+    } else if (sum.lt(0)) {
+      netApy = sum.div(totalBorrowedValue);
+    }
+    return netApy;
+  }
 }

package/src/types/index.ts

@@ -183,3 +183,9 @@ export type PlyGameLeaderboardItem = {
 export type PlyBetMadeEvent = TypedEvent<
   [string, BN, number] & { player: string; amount: BN; outcome: number }
 >;
+
+export type Apy = {
+  sum: BigNumber;
+  suppliedValue: BigNumber;
+  borrowedValue: BigNumber;
+};

package/ChangeLog.md

@@ -1,371 +0,0 @@
-# Change Logs
-
-# 1.12.8:
-
-- Add `mintCap(): Promise<TokenAmount>` return the mint cap of the autoken
-- Add `borrowCap(): Promise<TokenAmount>)` return the borrow cap of the autoken
-
-# 1.12.7:
-
-- Add `(...).queuePosition(address: Address): Promise<number>` return the position of the address in referral queue. -1 if not in queue,
-  999 if not in top 600.
-- `slotsInUse()` now will not accept any param, and return the total slots in total.
-
-## 1.12.6:
-
-- Remove `getJackpotResult`, use `getLastJackpotResult` instead.
-- Hide winner address in jackpot result.
-
-## 1.12.3
-
-- Add `PlyGameRead(...).getJackpotResult(round:number): Promise<{amount: TokenAmount, winner: Address}>`: return jackpot winner of the given round
-
-## 1.12.2
-
-- Use DefiLlama API as an backup for Coingecko
-
-## 1.12.0 + 1.12.1
-
-- Use new referral contract
-- Remove referral V1 data
-
-- `ReferralRead(...).isNewUserAtReferralTime(address: Address): Promise<boolean>`: Return true if this is a new user of aurigami
-  when he got referred
-- `...(...).depositedMoreThanMinimumAmount(address: Address): Promise<boolean>`: Return true if the user has deposited more than the minimum amount (100$)
-
-- `ReferralRead(...).isWhitelistedAddress(address: Address): Promise<boolean>`: check whether a user is a whitelisted referrer or not
-- `ReferralRead(...).isOnAuroraPlus(address: Address): Promise<boolean>`: Check whether a user on Aurora+ or not
-
-- `ReferralRead(...).slotsInUse(referralCode: string): Promise<number>`
-- `(...).totalReferralSlots(): number` -> return 500
-- `(...).userReferralStatus(userAddr: Address): Promise<string>` -> return `notReferred`, `notQualified`, `Qualified`, or `Withdrawn` base on the user status
-- Type changes: `ReferralReward` now will have `refereeAddress: string | null`
-
-## 1.11.1
-
-- PlyGame `getPlyGameResultsInTransaction` get result faster by using `getTransactionReceipt` instead of `waitForTransaction`
-
-## 1.11.0
-
-- Add support for Plygame with testing contract
-- Type:
-
-```ts
-export type PlyGameBetResult = {
-  player: string;
-  outcome: string;
-  lostAmount: TokenAmount;
-  unlockedPulpAmount: TokenAmount;
-
-  block: number;
-  timestamp: number;
-  transactionHash: string;
-};
-
-type PlyGameLeaderboardItem = {
-  player: string;
-  gamesPlayed: number;
-  unlockedPulpAmount: TokenAmount;
-};
-```
-
-- Read functions:
-
-  - `PlyGameRead(...).getUserPlyGameHistory(user) -> Promise<PlyGameBetResult[]>`: Get 100 most recent bets of the market users
-  - `(...).currentJackpotAmount(): Promise<TokenAmount>`
-  - `(...).earlyUnlockedPulpAmount(user): Promise<TokenAmount>`: get total unlocked pulp amount since launch.
-  - `(...).getPlyGameResultsInTransaction(txHash): Promise<PlyGameBetResult[]>`: Return list of bet made from the given transaction.
-  - `PlyGameRead(...).leaderboard(): Promise<PlyGameLeaderboardItem[]>`: ranking list of the top 100 users by amount of PULP unlocked
-
-- Write functions:
-
-  - `PlyGameReadWrite(...).makeBetOnce(amount: TokenAmount)`
-  - `(...).approve(amount: TokenAmount)`: approve plygame contract spending user's PLY
-
-## 1.10.0
-
-- Public `PapermillRead(...).getWeek(timestamp: number): number`
-
-## 1.9.7
-
-- Change oracle address
-
-## 1.9.6
-
-- Add oracle to ENV
-
-## 1.9.5
-
-- Use compound formular to calculate market APY.
-
-## 1.9.4
-
-- Allow to set custom dust in sneak account
-
-## 1.9.3
-
-- Change ply circulating supply
-
-## 1.9.2
-
-- Use 10B for PLY total supply
-
-## 1.9.1
-
-- Handle error in fetching LP price
-
-## 1.9.0
-
-- Rename `contracts` folder to `interactors`.
-- Catching fetch price error
-
-## 1.8.6
-
-- Fix bug in `formattedAmount` when using custom format.
-
-## 1.8.5
-
-- Able to customize format in TokenAmount.formattedAmount()
-
-## 1.8.4
-
-- Add campaign ids for referrals
-
-## 1.8.3
-
-- Markets rewards + staking rewards can be claim in one txn by `SdkReadWrite(...).claim()`
-- Remove `SdkReadWrite(...).claimLpRewards()`
-
-## 1.8.2
-
-Bug fix on missing txnHash in referralReward type
-
-## 1.8.1
-
-- Change campaign id
-
-## 1.8.0
-
-- Return actual data for referral rewards.
-- Change `ReferralRead(...).leaderboard()` to `ReferralRead(...).leaderboard(campaign: string)`: now can get the leaderboard of a given campaign.
-
-## 1.7.9-dummy
-
-- Add `userAddr` in ReferralReward type
-
-## 1.7.8-dummy
-
-- Update Meta rewards for stNEAR to `1,250,000` META.
-
-## 1.7.7-dummy
-
-- [Dummy data] Add `ReferralRead(...).referralRewards(userAddr: Address): Promise<ReferralReward[]>`: Array of rewards, sorted by time of the referral period (from latest to oldest)
-- [Dummy data] Add `ReferralRead(...).leaderboard(): Promise<ReferralReward[]>`: Top 50 reward earners from the last round, sorted by token amount.
-
-- Add `ReferralReadWrite(...).claimReferralRewards()`: Claim all unclaimed rewards for a given user
-
-New type:
-
-```ts
-export type ReferralReward = {
-  campaign: string;
-  /**
-   * start timetamp of the referral round
-   */
-  startTime: number;
-  /**
-   * end timetamp of the referral round
-   */
-  endTime: number;
-  /**
-   * referrer's rewards
-   */
-  isReferrer: boolean;
-  /**
-   * reward amount
-   */
-  rewardTokenAmount: TokenAmount;
-  /**
-   * hash of the transaction on aurorascan (if no, return null)
-   */
-  transactionHash: string | null;
-};
-```
-
-## 1.7.3
-
-- Add helper functions for Auri monitoring system
-
-## 1.7.1 & 1.7.2
-
-- Return correct timestamp in referrals list
-
-## 1.7.0
-
-- Add `ReferralRead(...).getReferralsList(userAddr: Address): Promise<{ user: string; timestamp: number }[]>`: Get 50 latest referrals of the given address, sorted descending by timestamp. Currently the timestamp is dummy data.
-
-## 1.6.9
-
-Support internal aurilens
-
-## 1.6.6
-
-Use `public readonly` modifier instead of `private/protected` in SDK.
-
-## 1.6.5
-
-SDK refactor #2, remove support for loterry campaign. Package size reduced from 3MB -> 200KB
-
-## 1.6.4
-
-Return meaningful result instead of INF in `calcLMRewardApr`
-
-## 1.6.3
-
-Add USN supports. Hardcoded USN price to $1.
-
-## 1.6.2
-
-- Add `ReferralRead(...).getUserReferralCode(userAddr: Address): Promise<string>`: Get the referral code for a given address, returns empty string if not found. Called to check if a user has a referral code.
-- Add `ReferralRead(...).getReferralCodeOwner(code: string): Promise<Address>`: Get owner of a referral code, returns zero address if not found.
-- Add `ReferralRead(...).getReferralCodeUsed(userAddr: Address): Promise<string>`: Get referral code that a user was referred by, returns empty string if not found.
-- Add `ReferralReadWrite(...).registerNewReferralCode(): Promise<TransactionResponse>`: Generate a referral code for a given address. Called when an user want to creates his own referral code
-- Add `ReferralReadWrite(...).useReferralCode(code: string): Promise<TransactionResponse>`: Called when an user confirms he is referred by a specified code
-
-## 1.6.1
-
-Add `PapermillRead(...).getNextWeekTimestamp(): number`: get the start timestamp of next week of the papermill contract.
-
-Add `SdkRead(...).getPlyCirculatingSupply(): Promise<TokenAmount>`: get the ply's circulating supply
-
-## 1.6.0
-
-SDK refactor - Why?:
-
-- more modular and less coupled.
-- more testable.
-- more maintainable.
-
-Things to do:
-
-- [x] Restructure the folder structure.
-- Refactor the code - Use composition pattern to SDK class
-- [x] Use address from contract package instead of hardcoded address.
-
-## 1.5.8 + 1.5.9
-
-Fix gas error on claim rewards: Instead of claim all the rewards in all market in 1 txns, we will claim rewards in 2 txns.
-
-## 1.5.7
-
-- Change return type of `SdkRead(...).LpBalanceOf` and `stakeBalanceOf` from `TokenValuation` to `TokenAmount` to match other functions in the SDK.
-- `totalStakedLiquidity` field in `PLYWNEARPoolDetails` is now `TokenAmount` instead of `TokenValuation`.
-
-```ts
-export type PLYWNEARPoolDetails = {
-  totalStakedLiquidity: TokenAmount;
-  APYs: TokenAPY[];
-};
-```
-
-## 1.5.6
-
-Add PLYWNEAR pool to ALL_STAKING_POOLS
-
-## 1.5.5
-
-Add auPLY market, integrate new fair launch contract
-
-Hard code PULP price to 0
-
-## 1.5.4
-
-Use browser-friendly assert
-
-## 1.5.2
-
-Added `SdkRead(...).unclaimedRewardsOf(userAddress: Address): Promise<TokenAmount[]>` to get unclaimed rewards of a user in LP staking.
-
-## 1.5.1
-
-Added `PapermillRead(...).getUnlockPortionAt(userAddress: Address, timestamp: number)`
-
-```ts
-export type TokenAPY = {
-  address: string;
-  apy: string;
-};
-
-export type PLYWNEARPoolDetails = {
-  totalStakedLiquidity: TokenValuation;
-  APYs: TokenAPY[];
-  //apy: string; removed
-};
-```
-
-## 1.5.0 For staking PLYWNEAR
-
-### Unchanged:
-
-- Stake/unstake: Use `SdkReadWrite(...).stake(amount: TokenAmount)` (or `unstake`)
-
-### Rename:
-
-- `SdkRead(...).getPlyAuroraPoolDetails` -> `SdkRead(...).getPLYWNEARPoolDetails`
-
-### Add
-
-- Read:
-  - `SdkRead(...).LpBalanceOf(user: Address):TokenValuation` => amount and $ value of LP token in wallet. To get amount staked, use the old `stakeBalanceOf()` above
-- Type:
-  - `TokenValuation` is a type that contains amount and $ value of token.
-
-```ts
-export type TokenValuation = {
-  tokenAmount: TokenAmount;
-  currencyAmount: CurrencyAmount;
-};
-```
-
-```ts
-export type PLYWNEARPoolDetails = {
-  totalStakedLiquidity: TokenValuation;
-  apy: string;
-};
-```
-
-### Return type changed:
-
-- `SdkRead(...).stakeBalanceOf()` will return `TokenValuation` instead of `TokenAmount`
-
-### Remove:
-
-- Type `PlyAuroraPoolDetails` removed.
-
-## 1.5.0 For Papermill
-
-### Add
-
-- Read functions:
-
-  - `new PapermillRead(...).getPlyBalance(address: Address): TokenAmount` => PLY balance in user wallet
-  - `new PapermillRead(...).getPulpBalance(address: Address): TokenAmount` => PULP balance in user wallet
-  - `new PapermillRead(...).getLockingDetails(address: Address): UserLockingDetails`: Get locking details. This function is for convenience only, because the locking details are already available in the `UserLockingDetails` result (which you can get by calling the old `SdkRead(...).getUserDetails()`)
-
-- Write functions:
-
-  - `new PapermillReadWrite(...).redeem(recipient: Address, amount: TokenAmount)` => Redeem Ply from PULP. Set `amount` to `ethers.constants.MaxUint256` for max redeem.
-  - `new PapermillReadWrite(...).selfRedeem(amount: TokenAmount)` => Redeem Ply from PULP to msg.sender. This is just a shortcut for the redeem function above.
-  - Collect all PLY reward from all markets + staking pool: No added functions, using the old `SdkReadWrite(...).claim()`
-
-- Type:
-  - `UserLockingDetails` to store all user locking details
-
-### Update
-
-- `SdkRead(...).getUserDetails()`: this will include the result from `getLockingDetails`.
-
-### Remove
-
-- `SdkRead(...).getLockingDetails()`: Use the `getLockingDetails` in papermill instead if needed.
-- Remove `LockingDetails` type