@aurigami/sdk 1.6.5 → 1.6.7

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.5",
+  "version": "1.6.7",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -62,7 +62,7 @@
     "typescript": "^4.5.4"
   },
   "dependencies": {
-    "@aurigami/contracts": "3.6.0",
+    "@aurigami/contracts": "3.8.0",
     "axios": "^0.26.1",
     "bignumber.js": "^9.0.2",
     "ethers": "^5.6.4"

package/src/SDK.ts

@@ -1,4 +1,8 @@
+import { UltilizationHelper } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
+import BigNumber from 'bignumber.js';
+import { Contract } from 'ethers';
+import * as abis from './abis';
 import * as consts from './consts';
 import { MiscRead, StakingRead, StakingReadWrite } from './contracts';
 import { AuriEnv, BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from './entities';
@@ -78,6 +82,18 @@ export class SdkRead extends BlockchainEntityRead {
   public async getPlyCirculatingSupply(): Promise<TokenAmount> {
     return this._misc.getPlyCirculatingSupply();
   }
+
+  public async getUltilizations(userAddr: types.Address): Promise<BigNumber> {
+    let helper: UltilizationHelper = new Contract(
+      consts.networkAddresses.misc.ultilizationHelper,
+      abis.UltilizationHelperABI.abi,
+      this._networkConnection.provider
+    ) as UltilizationHelper;
+    let accountDetail = await helper.getAccountLiquidity(userAddr);
+    let sumBorrow = new BigNumber(accountDetail.sumBorrowPlusEffects.toString());
+    let sumCol = new BigNumber(accountDetail.sumCollateral.toString());
+    return sumBorrow.dividedBy(sumCol);
+  }
 }
 
 export class SdkReadWrite extends SdkRead {

package/src/abis/index.ts

@@ -10,6 +10,7 @@ import EIP20InterfaceABI from '@aurigami/contracts/artifacts/contracts/interface
 // import FaucetABI from '@aurigami/contracts/artifacts/contracts/mock/Faucet.sol/Faucet.json';
 import IUniswapV2PairABI from '@aurigami/contracts/artifacts/contracts/mock/IUniswapV2Pair.sol/IUniswapV2Pair.json';
 import Multicall2ABI from '@aurigami/contracts/artifacts/contracts/mock/Multicall2.sol/Multicall2.json';
+import UltilizationHelperABI from '@aurigami/contracts/artifacts/contracts/mock/UltilizationHelper.sol/UltilizationHelper.json';
 import PulpABI from '@aurigami/contracts/artifacts/contracts/PULP.sol/PULP.json';
 import ReferralDirectoryABI from '@aurigami/contracts/artifacts/contracts/ReferralDirectory.sol/ReferralDirectory.json';
 export {
@@ -27,4 +28,5 @@ export {
   EthRepayHelperABI,
   Multicall2ABI,
   PulpABI,
+  UltilizationHelperABI
 };

package/src/contracts/Airdrop.ts

@@ -8,12 +8,12 @@ import * as helpers from '../helpers';
 import { Address, NetworkConnection } from '../types';
 
 export class AirdropRead extends BlockchainEntityRead {
-  protected _airDrop: AuriAirdrop;
+  public readonly airDrop: AuriAirdrop;
 
   public constructor(networkConnection: NetworkConnection) {
     super(networkConnection);
 
-    this._airDrop = new Contract(
+    this.airDrop = new Contract(
       consts.networkAddresses.misc.AURI_AIRDROP,
       AuriAirdropABI.abi,
       networkConnection.provider
@@ -30,7 +30,7 @@ export class AirdropRead extends BlockchainEntityRead {
   ): Promise<TokenAmount> {
     let tokenInstance: Token = new Token(token, helpers.getDecimal(token));
 
-    let rewards: BN = await this._airDrop.getRedeemableReward(
+    let rewards: BN = await this.airDrop.getRedeemableReward(
       utils.formatBytes32String(campaign),
       token,
       user
@@ -52,7 +52,7 @@ export class AirdropReadWrite extends AirdropRead {
       campaigns.length == tokens.length,
       'campaigns and tokens must have the same length'
     );
-    return this._airDrop.connect(this._networkConnection.signer!).redeem(
+    return this.airDrop.connect(this._networkConnection.signer!).redeem(
       campaigns.map((e) => utils.formatBytes32String(e)),
       tokens,
       await this._networkConnection.signer!.getAddress()

package/src/contracts/MoneyMarket.ts

@@ -26,7 +26,7 @@ type RewardSpeeds = {
 export class MoneyMarketRead extends BlockchainEntityRead {
   public underlying: Token;
   public auToken: AuErc20 | AuETH;
-  protected env: AuriEnv;
+  public readonly env: AuriEnv;
   constructor(networkConnection: NetworkConnection, auToken: Address, underlyingAsset: Address) {
     super(networkConnection);
     this.env = new AuriEnv(networkConnection);

package/src/contracts/Multicall.ts

@@ -7,10 +7,10 @@ import { BlockchainEntityRead } from '../entities';
 import { NetworkConnection } from '../types';
 
 export class MulticallRead extends BlockchainEntityRead {
-  protected _multicall: Multicall2;
+  public readonly multicall: Multicall2;
   constructor(networkConnection: NetworkConnection) {
     super(networkConnection);
-    this._multicall = new Contract(
+    this.multicall = new Contract(
       consts.networkAddresses.misc.MULTICALL,
       abis.Multicall2ABI.abi,
       networkConnection.provider
@@ -36,7 +36,7 @@ export class MulticallRead extends BlockchainEntityRead {
       txns.push({ target: txn.to!, callData: txn.data! });
     }
 
-    const response = await this._multicall.callStatic.aggregate(txns);
+    const response = await this.multicall.callStatic.aggregate(txns);
 
     // parse results
     const decodedReturn = [];

package/src/contracts/Papermill.ts

@@ -8,9 +8,9 @@ import { Address, NetworkConnection, UserLockingDetails } from '../types';
 
 const LOCKING_DENOMINATOR = BN.from(10000);
 export class PapermillRead extends BlockchainEntityRead {
-  public plyToken: Token;
-  public pulpToken: Token;
-  protected env: AuriEnv;
+  public readonly plyToken: Token;
+  public readonly pulpToken: Token;
+  public readonly env: AuriEnv;
 
   constructor(networkConnection: NetworkConnection) {
     super(networkConnection);

package/src/contracts/Referral.ts

@@ -7,10 +7,10 @@ import { BlockchainEntity, BlockchainEntityRead } from '../entities';
 import { Address, NetworkConnection } from '../types';
 
 export class ReferralRead extends BlockchainEntityRead {
-  protected _referral: ReferralDirectory;
+  public readonly referral: ReferralDirectory;
   constructor(networkConnection: NetworkConnection) {
     super(networkConnection);
-    this._referral = new Contract(
+    this.referral = new Contract(
       consts.networkAddresses.misc.REFERRAL,
       abis.ReferralDirectoryABI.abi,
       networkConnection.provider
@@ -36,7 +36,7 @@ export class ReferralRead extends BlockchainEntityRead {
    * Called to check if a user has a referral code.
    */
   public async getUserReferralCode(userAddr: Address): Promise<string> {
-    const result = await this._referral.userReferralCode(userAddr);
+    const result = await this.referral.userReferralCode(userAddr);
     return ethers.utils.parseBytes32String(result);
   }
 
@@ -44,7 +44,7 @@ export class ReferralRead extends BlockchainEntityRead {
    * Get referral code that a user was referred by, returns empty string if not found.
    */
   public async getReferralCodeUsed(userAddr: Address): Promise<string> {
-    const result = await this._referral.referralCodeUsed(userAddr);
+    const result = await this.referral.referralCodeUsed(userAddr);
     return ethers.utils.parseBytes32String(result);
   }
 
@@ -53,7 +53,7 @@ export class ReferralRead extends BlockchainEntityRead {
    */
   public async getReferralCodeOwner(code: string): Promise<Address> {
     const referralCode = ethers.utils.formatBytes32String(code);
-    return this._referral.referralCodeOwner(referralCode);
+    return this.referral.referralCodeOwner(referralCode);
   }
 }
 
@@ -65,7 +65,7 @@ export class ReferralReadWrite extends ReferralRead {
    */
   public async registerNewReferralCode(): Promise<TransactionResponse> {
     const referralCode = ethers.utils.formatBytes32String(this.generateReferralCode());
-    return this._referral
+    return this.referral
       .connect(this._networkConnection.signer!)
       .registerNewUserReferralCode(referralCode);
   }
@@ -75,7 +75,7 @@ export class ReferralReadWrite extends ReferralRead {
    */
   public async useReferralCode(code: string): Promise<TransactionResponse> {
     const referralCode = ethers.utils.formatBytes32String(code);
-    return this._referral
+    return this.referral
       .connect(this._networkConnection.signer!)
       .registerReferralCodeUsed(referralCode);
   }

package/src/contracts/Staking.ts

@@ -17,7 +17,7 @@ import { fetchValuation } from '../helpers/priceFetcher';
 import { NetworkConnection, PLYWNEARPoolDetails, TokenAPY } from '../types';
 
 export class StakingRead extends BlockchainEntityRead {
-  protected env: AuriEnv;
+  public readonly env: AuriEnv;
   constructor(networkConnection: NetworkConnection) {
     super(networkConnection);
     this.env = new AuriEnv(networkConnection);

package/src/contracts/misc.ts

@@ -1,19 +1,21 @@
 import BigNumber from 'bignumber.js';
 import { BigNumber as BN } from 'ethers';
 import * as consts from '../consts';
-import { MoneyMarketRead, PapermillRead, StakingRead } from '../contracts';
-import { MulticallRead } from '../contracts/Multicall';
 import { AuriEnv, BlockchainEntityRead, PLYToken, Token, TokenAmount } from '../entities';
 import { decimalFactor, isSameAddress } from '../helpers/helpers';
 import { calcValuation, fetchPrice } from '../helpers/priceFetcher';
 import * as types from '../types';
+import { MoneyMarketRead } from './MoneyMarket';
+import { MulticallRead } from './Multicall';
+import { PapermillRead } from './Papermill';
+import { StakingRead } from './Staking';
 
 export class MiscRead extends BlockchainEntityRead {
-  protected env: AuriEnv;
-  protected _stakingRead: StakingRead;
+  public readonly env: AuriEnv;
+  public readonly stakingRead: StakingRead;
   constructor(networkConnection: types.NetworkConnection) {
     super(networkConnection);
-    this._stakingRead = new StakingRead(networkConnection);
+    this.stakingRead = new StakingRead(networkConnection);
     this.env = new AuriEnv(networkConnection);
   }
 

package/ChangeLog.md

@@ -1,159 +0,0 @@
-# Change Logs
-
-## 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