@aurigami/sdk 1.5.0 → 1.5.1

package/dist/types.d.ts

@@ -57,9 +57,13 @@ export declare type UserMarketDetails = {
     collateralRatio: number;
     underlyingPrice: string;
 };
+export declare type TokenAPY = {
+    address: string;
+    apy: string;
+};
 export declare type PLYWNEARPoolDetails = {
     totalStakedLiquidity: TokenValuation;
-    apy: string;
+    APYs: TokenAPY[];
 };
 export declare enum MarketAction {
     Deposit = 0,

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.0",
+  "version": "1.5.1",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/Papermill.ts

@@ -27,6 +27,7 @@ import { TokenAmount } from './tokenAmount';
 import { getDecimal } from './helpers';
 import BigNumber from 'bignumber.js';
 
+const LOCKING_DENOMINATOR = BN.from(10000);
 export class PapermillRead extends BlockchainEntityRead {
   public plyToken: Token;
   public pulpToken: Token;
@@ -102,17 +103,18 @@ export class PapermillRead extends BlockchainEntityRead {
     );
   }
 
+  private getWeek(timestamp: number): number {
+    return BN.from(timestamp - REWARD_CLAIM_START)
+      .div(ONE_WEEK)
+      .toNumber();
+  }
   /**
    * Get all locking details of the user in all markets + all staking pools
    */
   public async getLockingDetails(
     userAddress: Address
   ): Promise<UserLockingDetails> {
-    const currentTime = getCurrentTimestamp();
-    const currentWeek = BN.from(currentTime - REWARD_CLAIM_START)
-      .div(ONE_WEEK)
-      .toNumber();
-    const denominator = BN.from(10000);
+    const currentWeek = this.getWeek(getCurrentTimestamp());
     var promises: any[] = [];
 
     promises.push(
@@ -144,17 +146,18 @@ export class PapermillRead extends BlockchainEntityRead {
     // This doesn't take (the reward that user might earn in the next week) into account
     let plyAmountNextWeek = percentLockNextWeek
       .mul(totalRewards.rawAmount())
-      .div(denominator);
+      .div(LOCKING_DENOMINATOR);
     let pulpAmountNextWeek = BN.from(totalRewards.rawAmount()).sub(
       plyAmountNextWeek
     );
 
     // we need to divide these two number by 10000 and multiple by 100 to get the percentage
     // I need to use BigNumber to do this because BN of ethers.js doesn't support floating point
-    let currentUnlockPortion = denominator
-      .sub(percentLockCurrentWeek)
-      .toString();
-    let nextUnlockPortion = denominator.sub(percentLockNextWeek).toString();
+    let currentUnlockPortion = LOCKING_DENOMINATOR.sub(
+      percentLockCurrentWeek
+    ).toString();
+    let nextUnlockPortion =
+      LOCKING_DENOMINATOR.sub(percentLockNextWeek).toString();
 
     return {
       vestingStart: REWARD_CLAIM_START,
@@ -197,6 +200,21 @@ export class PapermillRead extends BlockchainEntityRead {
 
     return REWARD_CLAIM_START + ONE_WEEK * weekId.toNumber();
   }
+
+  public async getUnlockPortionAt(
+    userAddress: Address,
+    timestamp: number
+  ): Promise<number> {
+    let lockPortion = await this._auriLens.getPercentLock(
+      this._pulp.address,
+      userAddress,
+      this.getWeek(timestamp)
+    );
+
+    let unlockPortion = LOCKING_DENOMINATOR.sub(lockPortion);
+
+    return unlockPortion.toNumber() / 100;
+  }
 }
 
 export class PapermillReadWrite extends PapermillRead {

package/src/SDK.ts

@@ -9,6 +9,7 @@ import {
   HypotheticalStats,
   MarketAction,
   TokenValuation,
+  TokenAPY,
 } from './types';
 import {
   networkAddresses,
@@ -236,6 +237,11 @@ export class SdkRead extends BlockchainEntityRead {
       stakedLiquidity!.toString()
     );
 
+    var totalStakeValuation: BigNumber = await fetchValuation(
+      stakedLiquidityAmount,
+      this._networkConnection.provider
+    );
+
     var promises = [];
 
     // Calculate the reward per second in USD
@@ -254,15 +260,20 @@ export class SdkRead extends BlockchainEntityRead {
       );
     }
 
-    const rewardPerSecondValuation = (await Promise.all(promises)).reduce(
-      (p: BigNumber, v: BigNumber) => p.plus(v),
-      new BigNumber(0)
-    );
+    let APYs: TokenAPY[] = [];
+    (await Promise.all(promises)).forEach((rewardPerSecondValuation, i) => {
+      let rewardTokenAddress = PLYWNEAR_REWARD_TOKENS[i];
+      let apy = calcLMRewardApr(
+        rewardPerSecondValuation,
+        totalStakeValuation,
+        ONE_DAY * 365
+      ).toFixed(DECIMAL_PRECISION);
 
-    var totalStakeValuation: BigNumber = await fetchValuation(
-      stakedLiquidityAmount,
-      this._networkConnection.provider
-    );
+      APYs.push({
+        address: rewardTokenAddress,
+        apy: apy,
+      });
+    });
 
     return {
       totalStakedLiquidity: {
@@ -272,11 +283,7 @@ export class SdkRead extends BlockchainEntityRead {
           amount: totalStakeValuation!.toFixed(DECIMAL_PRECISION),
         },
       },
-      apy: calcLMRewardApr(
-        rewardPerSecondValuation,
-        totalStakeValuation,
-        ONE_DAY * 365
-      ).toFixed(DECIMAL_PRECISION),
+      APYs: APYs,
     };
   }
 

package/src/types.ts

@@ -81,9 +81,14 @@ export type UserMarketDetails = {
   underlyingPrice: string;
 };
 
+export type TokenAPY = {
+  address: string;
+  apy: string;
+};
+
 export type PLYWNEARPoolDetails = {
   totalStakedLiquidity: TokenValuation;
-  apy: string;
+  APYs: TokenAPY[];
 };
 
 export enum MarketAction {