@aurigami/sdk 1.6.4 → 1.6.6

package/ChangeLog.md

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

package/dist/SDK.d.ts

@@ -1,13 +1,11 @@
-import { AuriFairLaunch, AuriLens, Comptroller } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { StakingRead } from './contracts';
-import { BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from './entities';
+import { MiscRead, StakingRead } from './contracts';
+import { AuriEnv, BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from './entities';
 import * as types from './types';
 export declare class SdkRead extends BlockchainEntityRead {
-    protected _comptroller: Comptroller;
-    protected _auriFairLaunch: AuriFairLaunch;
-    protected _auriLens: AuriLens;
+    protected env: AuriEnv;
     protected _stakingRead: StakingRead;
+    protected _misc: MiscRead;
     constructor(networkConnection: types.NetworkConnection);
     getUserDetails(userAddress: string): Promise<types.UserDetails>;
     getPLYWNEARPoolDetails(): Promise<types.PLYWNEARPoolDetails>;
@@ -46,7 +44,6 @@ export declare class SdkReadWrite extends SdkRead {
     claimLpRewards(): Promise<TransactionResponse>;
     stake(amount: TokenAmount): Promise<TransactionResponse>;
     unstake(amount: TokenAmount): Promise<TransactionResponse>;
-    faucetDrip(): Promise<TransactionResponse>;
 }
 export declare class SDK extends BlockchainEntity {
     constructor();

package/dist/abis/index.d.ts

@@ -0,0 +1,14 @@
+import AuErc20ABI from '@aurigami/contracts/artifacts/contracts/AuErc20.sol/AuErc20.json';
+import AuETHABI from '@aurigami/contracts/artifacts/contracts/AuETH.sol/AuETH.json';
+import AuriAirdropABI from '@aurigami/contracts/artifacts/contracts/AuriAirdrop.sol/AuriAirdrop.json';
+import AuriFairLaunchABI from '@aurigami/contracts/artifacts/contracts/AuriFairLaunch.sol/AuriFairLaunch.json';
+import AuriLensABI from '@aurigami/contracts/artifacts/contracts/AuriLens.sol/AuriLens.json';
+import AuriOracleABI from '@aurigami/contracts/artifacts/contracts/AuriOracle.sol/AuriOracle.json';
+import ComptrollerABI from '@aurigami/contracts/artifacts/contracts/Comptroller.sol/Comptroller.json';
+import EthRepayHelperABI from '@aurigami/contracts/artifacts/contracts/EthRepayHelper.sol/EthRepayHelper.json';
+import EIP20InterfaceABI from '@aurigami/contracts/artifacts/contracts/interfaces/EIP20Interface.sol/EIP20Interface.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 PulpABI from '@aurigami/contracts/artifacts/contracts/PULP.sol/PULP.json';
+import ReferralDirectoryABI from '@aurigami/contracts/artifacts/contracts/ReferralDirectory.sol/ReferralDirectory.json';
+export { AuriOracleABI, IUniswapV2PairABI, AuriAirdropABI, AuriFairLaunchABI, AuriLensABI, ComptrollerABI, EIP20InterfaceABI, ReferralDirectoryABI, AuErc20ABI, AuETHABI, EthRepayHelperABI, Multicall2ABI, PulpABI, };

package/dist/consts/constants.d.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js';
-import { ethers } from 'ethers';
+import { BigNumber as BN } from 'ethers';
 export declare const dummyAddress: string;
 export declare const ETHAddress: string;
 export declare const AURORA_CHAINID = 1313161554;
@@ -23,7 +23,7 @@ export declare const ONE_YEAR: number;
 export declare const PLYWNEAR_POOL_ID = 0;
 export declare const PLYWNEAR_REWARD_TOKENS: string[];
 export declare const ALL_STAKING_POOLS: number[];
-export declare const INF: ethers.BigNumber;
+export declare const INF: BN;
 export declare const AIRDROP_START_TIMESTAMP = 1649858400;
 export declare const AIRDROP_END_TIMESTAMP = 1651068000;
 export declare const AIRDROP_KEEP_THRESHOLD: number;

package/dist/consts/dummy.d.ts

@@ -1,5 +1,4 @@
-import { Token } from '../entities';
-import { TokenAmount } from '../entities';
+import { Token, TokenAmount } from '../entities';
 import { UserMarketDetails } from '../types';
 export declare const dummyToken: Token;
 export declare const dummyPly: Token;

package/dist/contracts/{airdrop-lottery.d.ts → Airdrop.d.ts}

@@ -3,13 +3,8 @@ import { TransactionResponse } from '@ethersproject/abstract-provider';
 import { BlockchainEntity, BlockchainEntityRead, TokenAmount } from '../entities';
 import { Address, NetworkConnection } from '../types';
 export declare class AirdropRead extends BlockchainEntityRead {
-    protected _airDrop: AuriAirdrop;
-    private _whitelistedAddresses;
-    private keepTrackers;
+    readonly airDrop: AuriAirdrop;
     constructor(networkConnection: NetworkConnection);
-    countWhitelistedAddresses(): number;
-    isWhitelisted(user: string): boolean;
-    hasCompletedChallenge(user: string): Promise<boolean>;
     /**
      * Get redeemable rewards amount of user
      */

package/dist/contracts/MoneyMarket.d.ts

@@ -1,8 +1,8 @@
-import { AuErc20, AuETH, AuriLens, Comptroller, EthRepayHelper } from '@aurigami/contracts/typechain';
+import { AuErc20, AuETH, EthRepayHelper } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
 import BigNumber from 'bignumber.js';
 import { BigNumber as BN } from 'ethers';
-import { BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
+import { AuriEnv, BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
 import { Address, MoneyMarketDetails, NetworkConnection } from '../types';
 declare type RewardSpeeds = {
     plyRewardSupplySpeed: BN;
@@ -13,8 +13,7 @@ declare type RewardSpeeds = {
 export declare class MoneyMarketRead extends BlockchainEntityRead {
     underlying: Token;
     auToken: AuErc20 | AuETH;
-    protected _comptroller: Comptroller;
-    protected _auriLens: AuriLens;
+    readonly env: AuriEnv;
     constructor(networkConnection: NetworkConnection, auToken: Address, underlyingAsset: Address);
     protected getRewardSpeeds(): Promise<RewardSpeeds>;
     getTotalTokenBorrowed(): Promise<TokenAmount>;

package/dist/contracts/Multicall.d.ts

@@ -1,10 +1,10 @@
 import { Multicall2 } from '@aurigami/contracts/typechain';
 import { Contract } from 'ethers';
+import { Result } from 'ethers/lib/utils';
 import { BlockchainEntityRead } from '../entities';
 import { NetworkConnection } from '../types';
-import { Result } from 'ethers/lib/utils';
 export declare class MulticallRead extends BlockchainEntityRead {
-    protected _multicall: Multicall2;
+    readonly multicall: Multicall2;
     constructor(networkConnection: NetworkConnection);
     /**
      * Run multiple calls via multicall contract

package/dist/contracts/Papermill.d.ts

@@ -1,15 +1,10 @@
-import { AuriFairLaunch, AuriLens, Comptroller, IERC20, PULP } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
+import { AuriEnv, BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
 import { Address, NetworkConnection, UserLockingDetails } from '../types';
 export declare class PapermillRead extends BlockchainEntityRead {
-    plyToken: Token;
-    pulpToken: Token;
-    protected _ply: IERC20;
-    protected _pulp: PULP;
-    protected _comptroller: Comptroller;
-    protected _auriFairLaunch: AuriFairLaunch;
-    protected _auriLens: AuriLens;
+    readonly plyToken: Token;
+    readonly pulpToken: Token;
+    readonly env: AuriEnv;
     constructor(networkConnection: NetworkConnection);
     getPlyBalance(userAddress: Address): Promise<TokenAmount>;
     getPulpBalance(userAddress: Address): Promise<TokenAmount>;

package/dist/contracts/Referral.d.ts

@@ -3,7 +3,7 @@ import { TransactionResponse } from '@ethersproject/abstract-provider';
 import { BlockchainEntity, BlockchainEntityRead } from '../entities';
 import { Address, NetworkConnection } from '../types';
 export declare class ReferralRead extends BlockchainEntityRead {
-    protected _referral: ReferralDirectory;
+    readonly referral: ReferralDirectory;
     constructor(networkConnection: NetworkConnection);
     /**
      * Generate a 10-character referral code

package/dist/contracts/Staking.d.ts

@@ -1,11 +1,8 @@
-import { AuriFairLaunch, AuriLens, Comptroller } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { BlockchainEntity, BlockchainEntityRead, TokenAmount } from '../entities';
+import { AuriEnv, BlockchainEntity, BlockchainEntityRead, TokenAmount } from '../entities';
 import { NetworkConnection, PLYWNEARPoolDetails } from '../types';
 export declare class StakingRead extends BlockchainEntityRead {
-    protected _comptroller: Comptroller;
-    protected _auriFairLaunch: AuriFairLaunch;
-    protected _auriLens: AuriLens;
+    readonly env: AuriEnv;
     constructor(networkConnection: NetworkConnection);
     getPLYWNEARPoolDetails(): Promise<PLYWNEARPoolDetails>;
     /**

package/dist/contracts/index.d.ts

@@ -1,4 +1,5 @@
-export * from './airdrop-lottery';
+export * from './Airdrop';
+export * from './misc';
 export * from './MoneyMarket';
 export * from './Papermill';
 export * from './Referral';

package/dist/contracts/misc.d.ts

@@ -0,0 +1,26 @@
+import { StakingRead } from '../contracts';
+import { AuriEnv, BlockchainEntityRead, Token, TokenAmount } from '../entities';
+import * as types from '../types';
+export declare class MiscRead extends BlockchainEntityRead {
+    readonly env: AuriEnv;
+    readonly stakingRead: StakingRead;
+    constructor(networkConnection: types.NetworkConnection);
+    getUserDetails(userAddress: string): Promise<types.UserDetails>;
+    getTokenPrice(token: Token): Promise<types.CurrencyAmount>;
+    calcHypotheticalStats({ userMarketDetail, currentBorrowLimit, currentBorrowValuation, action, tokenAmount, }: {
+        userMarketDetail: types.UserMarketDetails;
+        currentBorrowLimit: types.CurrencyAmount;
+        currentBorrowValuation: types.CurrencyAmount;
+        action: types.MarketAction;
+        tokenAmount?: TokenAmount;
+    }): types.HypotheticalStats;
+    /**
+     * Get ply circulating supply.
+     * It is calculated by the total supply, minus:
+     *  - Ply in team multisig contract
+     *  - Ply in comptroller contract
+     *  - Ply in fairlaunch contract
+     *  - Ply in vesting contract
+     */
+    getPlyCirculatingSupply(): Promise<TokenAmount>;
+}

package/dist/entities/auriEnv.d.ts

@@ -0,0 +1,13 @@
+import { AuriFairLaunch, AuriLens, Comptroller, IERC20, PULP } from '@aurigami/contracts/typechain';
+import { Contract } from 'ethers';
+import { NetworkConnection } from '../types';
+import { BlockchainEntityRead } from './BlockchainEntity';
+export declare class AuriEnv extends BlockchainEntityRead {
+    comptroller: Comptroller;
+    auriFairLaunch: AuriFairLaunch;
+    auriLens: AuriLens;
+    ply: IERC20;
+    pulp: PULP;
+    getContract<CType extends Contract>(address: string, abi: any): CType;
+    constructor(networkConnection: NetworkConnection);
+}

package/dist/entities/index.d.ts

@@ -1,3 +1,4 @@
+export * from './auriEnv';
 export * from './BlockchainEntity';
 export * from './token';
 export * from './tokenAmount';

package/dist/entities/tokenAmount.d.ts

@@ -1,5 +1,5 @@
-import { Token } from './token';
 import { Address } from '../types';
+import { Token } from './token';
 export declare class TokenAmount {
     readonly token: Token;
     private rawAmnt;

package/dist/helpers/priceFetcher.d.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js';
-import { providers, BigNumber as BN } from 'ethers';
+import { BigNumber as BN, providers } from 'ethers';
 import { TokenAmount } from '../entities/tokenAmount';
 import { Address, TokenValuation } from '../types';
 export declare function fetchPriceFromCoingeckoAPI(id: string): Promise<BigNumber>;

package/dist/helpers/transfer-event-query.d.ts

@@ -1,7 +1,7 @@
-import { BlockchainEntityRead } from '../entities/BlockchainEntity';
-import { NetworkConnection } from '../types';
 import { AuToken } from '@aurigami/contracts/typechain';
 import { BigNumber as BN } from 'ethers';
+import { BlockchainEntityRead } from '../entities/BlockchainEntity';
+import { NetworkConnection } from '../types';
 declare type SimpleTransfer = {
     from: string;
     to: string;

package/dist/index.d.ts

@@ -2,5 +2,5 @@ export * from './consts';
 export * from './contracts';
 export * from './entities';
 export * from './helpers';
-export * from './types';
 export * from './SDK';
+export * from './types';