@aurigami/sdk 1.5.0-dummy-2 → 1.5.1

package/dist/token.d.ts

@@ -4,4 +4,4 @@ export declare class Token {
     constructor(address: string, decimals: number);
 }
 export declare const PLYToken: Token;
-export declare const PLYUSDCToken: Token;
+export declare const PLYWNEARToken: Token;

package/dist/types.d.ts

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

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.0-dummy-2",
+  "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

@@ -1,6 +1,6 @@
 import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
 import {
-  PlyUsdcPoolDetails,
+  PLYWNEARPoolDetails,
   NetworkConnection,
   UserDetails,
   UserMarketDetails,
@@ -9,15 +9,16 @@ import {
   HypotheticalStats,
   MarketAction,
   TokenValuation,
+  TokenAPY,
 } from './types';
 import {
   networkAddresses,
   BORROW_LIMIT_BUFFER,
   DECIMAL_PRECISION,
   ONE_DAY,
-  PlyUsdcPid,
+  PLYWNEAR_POOL_ID,
   ALL_STAKING_POOLS,
-  PLYUSDCRewardTokens,
+  PLYWNEAR_REWARD_TOKENS,
 } from './constants';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
 import { Contract, BigNumber as BN } from 'ethers';
@@ -41,7 +42,7 @@ import {
   IERC20,
 } from '@aurigami/contracts/typechain';
 import { TokenAmount } from './tokenAmount';
-import { PLYUSDCToken, PLYToken, Token } from './token';
+import { PLYWNEARToken, PLYToken, Token } from './token';
 import BigNumber from 'bignumber.js';
 import AuriLensABI from '@aurigami/contracts/artifacts/contracts/AuriLens.sol/AuriLens.json';
 import ComptrollerABI from '@aurigami/contracts/artifacts/contracts/Comptroller.sol/Comptroller.json';
@@ -224,21 +225,28 @@ export class SdkRead extends BlockchainEntityRead {
     };
   }
 
-  public async getPlyUsdcPoolDetails(): Promise<PlyUsdcPoolDetails> {
+  public async getPLYWNEARPoolDetails(): Promise<PLYWNEARPoolDetails> {
     var stakedLiquidity: BN, rewardPerSeconds: BN[];
-    await this._auriFairLaunch.getPoolInfo(PlyUsdcPid).then((res) => {
+    await this._auriFairLaunch.getPoolInfo(PLYWNEAR_POOL_ID).then((res) => {
       stakedLiquidity = res.totalStake;
       rewardPerSeconds = res.rewardPerSeconds;
     });
 
     let stakedLiquidityAmount = new TokenAmount(
-      PLYUSDCToken,
+      PLYWNEARToken,
       stakedLiquidity!.toString()
     );
 
+    var totalStakeValuation: BigNumber = await fetchValuation(
+      stakedLiquidityAmount,
+      this._networkConnection.provider
+    );
+
     var promises = [];
+
+    // Calculate the reward per second in USD
     for (let i = 0; i < rewardPerSeconds!.length; i++) {
-      let rewardTokenAddress = PLYUSDCRewardTokens[i];
+      let rewardTokenAddress = PLYWNEAR_REWARD_TOKENS[i];
       let rewardToken = new Token(
         rewardTokenAddress,
         getDecimal(rewardTokenAddress)
@@ -252,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: {
@@ -270,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,
     };
   }
 
@@ -293,8 +302,14 @@ export class SdkRead extends BlockchainEntityRead {
    * Get amount and value in $ of staked LP tokens
    */
   public async stakeBalanceOf(user: string): Promise<TokenValuation> {
-    const userInfo = await this._auriFairLaunch.getUserInfo(PlyUsdcPid, user);
-    let stakeAmount = new TokenAmount(PLYUSDCToken, userInfo.amount.toString());
+    const userInfo = await this._auriFairLaunch.getUserInfo(
+      PLYWNEAR_POOL_ID,
+      user
+    );
+    let stakeAmount = new TokenAmount(
+      PLYWNEARToken,
+      userInfo.amount.toString()
+    );
 
     return valuateToken(stakeAmount, this._networkConnection.provider);
   }
@@ -303,15 +318,15 @@ export class SdkRead extends BlockchainEntityRead {
    * Get amount and value in $ of LP token in user wallet
    */
   public async LpBalanceOf(user: string): Promise<TokenValuation> {
-    let lpERC20 = new Contract(
-      networkAddresses.tokens.PLYUSDC,
+    let lpContract = new Contract(
+      networkAddresses.tokens.PLYWNEAR,
       EIP20InterfaceABI.abi,
       this._networkConnection.provider
     ) as IERC20;
-    let balance = await lpERC20.balanceOf(user);
+    let balance = await lpContract.balanceOf(user);
 
     return valuateToken(
-      new TokenAmount(PLYUSDCToken, balance.toString()),
+      new TokenAmount(PLYWNEARToken, balance.toString()),
       this._networkConnection.provider
     );
   }
@@ -403,13 +418,13 @@ export class SdkReadWrite extends SdkRead {
   public async stake(amount: TokenAmount): Promise<TransactionResponse> {
     return this._auriFairLaunch
       .connect(this._networkConnection.signer!)
-      .deposit(PlyUsdcPid, amount.rawAmount());
+      .deposit(PLYWNEAR_POOL_ID, amount.rawAmount());
   }
 
   public async unstake(amount: TokenAmount): Promise<TransactionResponse> {
     return this._auriFairLaunch
       .connect(this._networkConnection.signer!)
-      .withdraw(PlyUsdcPid, amount.rawAmount());
+      .withdraw(PLYWNEAR_POOL_ID, amount.rawAmount());
   }
 
   public async faucetDrip(): Promise<TransactionResponse> {

package/src/constants.ts

@@ -83,7 +83,7 @@ export const networkAddresses: NetworkAddresses = {
     TRI: '0xFa94348467f64D5A457F75F8bc40495D33c65aBB'.toLowerCase(),
     META: '0xc21ff01229e982d7c8b8691163b0a3cb8f357453'.toLocaleLowerCase(),
     PULP: '0x04Ac48711BCdc45b4d223fb021E09DA73c71095e'.toLowerCase(),
-    PLYUSDC: '0x37cae2b29c18e05ece60111fa01d3ca217046016'.toLowerCase(),
+    PLYWNEAR: '0x044b6B0CD3Bb13D2b9057781Df4459C66781dCe7'.toLowerCase(), //TODO: changes this
   },
 };
 
@@ -104,15 +104,15 @@ export const ONE_DAY = 86400;
 export const ONE_WEEK = ONE_DAY * 7;
 export const ONE_YEAR = ONE_DAY * 365;
 
-export const PlyUsdcPid = 0;
-export const PLYUSDCRewardTokens = [
+export const PLYWNEAR_POOL_ID = 0;
+export const PLYWNEAR_REWARD_TOKENS = [
   '0x09C9D464b58d96837f8d8b6f4d9fE4aD408d3A4f', // PLY
   '0xC42C30aC6Cc15faC9bD938618BcaA1a1FaE8501d', // WNEAR
   '0x8BEc47865aDe3B172A928df8f990Bc7f2A3b9f79', // AURORA
   '0xFa94348467f64D5A457F75F8bc40495D33c65aBB', // TRI
 ];
 // could call RPC to get all the staking pools but it's not necessary for now
-// export const ALL_STAKING_POOLS = [PlyUsdcPid];
+// export const ALL_STAKING_POOLS = [PLYWNEAR_POOL_ID];
 // TODO: fix this
 export const ALL_STAKING_POOLS = [];
 export const INF = BN.from(2).pow(256).sub(1);

package/src/decimals.ts

@@ -20,5 +20,5 @@ export const decimalRecords: Record<string, number> = {
   '0xf4eb217ba2454613b15dbdea6e5f22276410e89e': 8,
   '0xc21ff01229e982d7c8b8691163b0a3cb8f357453': 24,
   '0x04ac48711bcdc45b4d223fb021e09da73c71095e': 18, // PULP
-  '0x37cae2b29c18e05ece60111fa01d3ca217046016': 18, // PLYUSDC
+  '0x044b6b0cd3bb13d2b9057781df4459c66781dce7': 18, // PLYWNEAR
 };

package/src/deployments/aurora_mainnet.json

@@ -24,7 +24,7 @@
   "configReader": "0x347B321c466663D6A0fE9C0ccfCF8cEa86F8ecD3",
   "auriAirdropImpl": "0x94cdA0Da833b384B901d33D5c56FccDE21D5E6e7",
   "auriAirdrop": "0x6C42aA5b128B62D6CCf357726D7d13F3888335EC",
-  "ply_usdc_lp": "0x37cAe2B29c18E05ece60111Fa01d3ca217046016",
+  "ply_wnear_lp": "0x044b6B0CD3Bb13D2b9057781Df4459C66781dCe7",
   "PULP": "0x04Ac48711BCdc45b4d223fb021E09DA73c71095e",
   "test": {}
 }

package/src/priceFetcher.ts

@@ -233,7 +233,7 @@ export async function fetchPrice(
   address: Address,
   provider: providers.Provider
 ): Promise<BigNumber> {
-  if (isSameAddress(address, networkAddresses.tokens.PLYUSDC)) {
+  if (isSameAddress(address, networkAddresses.tokens.PLYWNEAR)) {
     return fetchLPPrice(address, provider);
   } else if (isSameAddress(address, networkAddresses.tokens.PLY)) {
     return fetchPLYPrice(provider);
@@ -244,8 +244,10 @@ export async function fetchPrice(
 export async function fetchPLYPrice(
   provider: providers.Provider
 ): Promise<BigNumber> {
+  //TODO: Fetch PLY price from CEX?
+  return new BigNumber(0);
   const LPInfo = await fetchLPPositions(
-    networkAddresses.tokens.PLYUSDC,
+    networkAddresses.tokens.PLYWNEAR,
     provider
   );
 
@@ -257,16 +259,16 @@ export async function fetchPLYPrice(
   assert(isSameAddress(plyAddress, networkAddresses.tokens.PLY));
   const plyDecimal = getDecimal(plyAddress);
 
-  const usdcAddress = LPInfo.token1;
-  assert(isSameAddress(usdcAddress, networkAddresses.tokens.USDC));
-  const usdcDecimal = getDecimal(usdcAddress);
+  const wnearAddress = LPInfo.token1;
+  assert(isSameAddress(wnearAddress, networkAddresses.tokens.WNEAR));
+  const wnearDecimal = getDecimal(wnearAddress);
 
   // (token0Price * reserve0) / 10^decimal0 = (token1Price * reserve1) / 10^decimal1
   // token0Price = (token1Price * reserve1) * 10^decimal0 / 10^decimal1  / reserve0
-  return (await fetchPrice(usdcAddress, provider))
+  return (await fetchPrice(wnearAddress, provider))
     .multipliedBy(LPInfo.reserve1.toString())
     .multipliedBy(decimalFactor(plyDecimal))
-    .dividedBy(decimalFactor(usdcDecimal))
+    .dividedBy(decimalFactor(wnearDecimal))
     .dividedBy(LPInfo.reserve0.toString());
 }
 

package/src/token.ts

@@ -15,7 +15,7 @@ export const PLYToken = new Token(
   getDecimal(networkAddresses.tokens.PLY)
 );
 
-export const PLYUSDCToken = new Token(
-  networkAddresses.tokens.PLYUSDC,
-  getDecimal(networkAddresses.tokens.PLYUSDC)
+export const PLYWNEARToken = new Token(
+  networkAddresses.tokens.PLYWNEAR,
+  getDecimal(networkAddresses.tokens.PLYWNEAR)
 );

package/src/types.ts

@@ -81,11 +81,16 @@ export type UserMarketDetails = {
   underlyingPrice: string;
 };
 
-export type PlyUsdcPoolDetails = {
-  totalStakedLiquidity: TokenValuation;
+export type TokenAPY = {
+  address: string;
   apy: string;
 };
 
+export type PLYWNEARPoolDetails = {
+  totalStakedLiquidity: TokenValuation;
+  APYs: TokenAPY[];
+};
+
 export enum MarketAction {
   Deposit = 0,
   Borrow,