@aurigami/sdk 1.25.2 → 1.26.0

package/ChangeLog.md

@@ -1,384 +0,0 @@
-# Change Logs
-# 1.15.0:
-- `SDKRead(...).setUserNotificationSettings(address: string, mail: string, utilisation: number, liquidation: boolean, captchaResponse: string)`:
-  - utilisation in range (0..1)
-- `SDKRead(...).unsetUserNotificationSettings(address: string, captchaResponse: string)` use this to unsubscribe for notification
-
-# 1.14.0:
-- Fix cache bug
-- Remove `stNEAR` in `DEPOSIT_ONLY_TOKENS` (this is for monitoring bot)
-# 1.13.1
-- Add `PlyGameRead(...).overallLeaderboard(): Promise<PlyGameLeaderboardItem[]>`: overall ranking of the top 50 users by amount of PULP unlocked
-
-# 1.13.0
-- Add `SdkRead(...).getNetApyWithIncentive` and `getNetApyWithoutIncentive`.
-
-# 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