[polishing] remove old & change harvest (#181)

Author: Cast0001

README.md

@@ -702,11 +702,13 @@ Necessary to update the vault state
 
 ```ts
 type Output = {
-  reward: string
-  proof: Array<string>
   canHarvest: boolean
-  rewardsRoot: string
-  unlockedMevReward: string 
+  params: {
+    reward: string
+    proof: Array<string>
+    rewardsRoot: string
+    unlockedMevReward: string 
+  }
 }
 ```
 

changelog/next-release.md

@@ -9,31 +9,34 @@ type AddedOutput = {
     ltvPercent: string
     thresholdPercent: string
   }
+  isGenesis: boolean
 }
 ```
 
-| Name            | Description                                                                                                                                                                                                                                         |
-|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Name | Description |
+|------|-------------|
 | `osTokenConfig` | contains the `ltvPercent`, which is the percentage used to calculate how much a user can mint in OsToken shares, and `thresholdPercent`, which is the liquidation threshold percentage used to calculate the health factor for the OsToken position |
+| `isGenesis` | This vault is owned by stakewise |
 
 ---
 ### 2. `sdk.vault.getHarvestParams`
 
-#### New output field:
+#### New output format:
 
 ```ts
-type AddedOutput = {
-  canHarvest: boolean
+type Output = {
+  canHarvest: boolean // NEW
+  params: {
+    reward: string
+    proof: Array<string>
+    rewardsRoot: string
+    unlockedMevReward: string 
+  }
 }
 ```
 
 ---
 
-### 3. Removed method
-### `sdk.vault.getVault`
-
----
-
 ### 3. Removed method
 ### `sdk.osToken.getAvgRewardsPerSecond`
 
@@ -52,6 +55,7 @@ type RemovedOutput = {
 
 ### 5. Added method getStakewiseStats
 ### `sdk.utils.getStakewiseStats`
+#### Getting common stakewise data for the network
 
 ---
 
@@ -86,7 +90,6 @@ type RemovedOutput = {
 
 ---
 
-
 ### 10. Removed method `sdk.vault.getSnapshots`
 ### Use `sdk.vault.getVaultStats` instead 
 
@@ -96,13 +99,13 @@ type RemovedOutput = {
 #### Update output format:
 
 ```ts
-type Output = {
+type Output = Array<{
   date: number
   dailyRewards: number
   dailyRewardsEur: number
   dailyRewardsGbp: number
   dailyRewardsUsd: number
-}[]
+}>
 ```
 
 #### New arguments:
@@ -118,6 +121,7 @@ type Output = {
 
 ### 12. Added method getFiatRates
 ### `sdk.utils.getFiatRates`
+#### Getting fiat values for the network
 
 ---
 

src/contracts/multicall/util/getHarvestArgs.ts

@@ -7,16 +7,18 @@ type Input<T> = {
   vaultAddress: string
 }
 
-const getHarvestArgs = async <T>(props: Input<T>): Promise<HarvestParamsQueryPayload['harvestParams'] | null> => {
+type Output = Promise<Omit<HarvestParamsQueryPayload['harvestParams'], 'canHarvest'> | null>
+
+const getHarvestArgs = async <T>(props: Input<T>): Output => {
   const { options, vaultAddress } = props
 
-  const harvestParams = await getHarvestParams({
+  const { params, canHarvest } = await getHarvestParams({
     options,
     vaultAddress,
   })
 
-  if (harvestParams?.canHarvest) {
-    return harvestParams
+  if (canHarvest) {
+    return params
   }
 
   return null

src/methods/osToken/index.ts

@@ -1,6 +1,5 @@
 // Requests
 import getAPY from './requests/getOsTokenAPY'
-import getConfig from './requests/getConfig'
 import getMaxMint from './requests/getMaxMint'
 import getRate from './requests/getOsTokenRate'
 import getPosition from './requests/getPosition'
@@ -26,12 +25,6 @@ export default {
      * @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkostokengetrate
     */
     getRate,
-    /**
-     * @deprecated use sdk.vault.getVault instead to get data from osTokenConfig
-     * @description os token ltvPercent and thresholdPercent for provided vault
-     * @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkostokengetconfig
-    */
-    getConfig,
     /**
      * @description Maximum number of **shares** for minting
      * @see https://github.com/stakewise/v3-sdk/?tab=readme-ov-file#sdkostokengetmaxmint

src/methods/vault/requests/getHarvestParams.ts

@@ -17,7 +17,14 @@ const getHarvestParams = (values: GetHarvestParamsInput) => {
     variables: {
       address: vaultAddress.toLowerCase(),
     },
-    modifyResult: (data) => data.harvestParams,
+    modifyResult: (data) => {
+      const { canHarvest, ...params } = data.harvestParams
+
+      return {
+        canHarvest,
+        params,
+      }
+    },
   })
 }
 

src/methods/vault/requests/getVault/modifyVault.spec.ts

@@ -14,6 +14,7 @@ describe('modifyVault', () => {
       feePercent: 200,
       isPrivate: false,
       isRestake: true,
+      isGenesis: true,
       isBlocklist: false,
       version: '1',
       performance: '10',
@@ -56,6 +57,7 @@ describe('modifyVault', () => {
       performance: 10,
       isPrivate: false,
       isRestake: true,
+      isGenesis: true,
       isBlocklist: false,
       blocklistCount: 0,
       whitelistCount: 0,
@@ -70,7 +72,6 @@ describe('modifyVault', () => {
       depositDataRoot: 'mockValidators',
       description: 'This is a mock vault',
       vaultAdmin: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
-      whitelister: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       vaultAddress: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       feeRecipient: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',
       mevRecipient: '0xeEFFFD4C23D2E8c845870e273861e7d60Df49663',

src/methods/vault/requests/getVault/modifyVault.ts

@@ -53,7 +53,6 @@ const modifyVault = (input: ModifyVaultInput): ModifiedVault => {
     feeRecipient: getAddress(feeRecipient),
     blocklistCount: Number(blocklistCount),
     whitelistCount: Number(whitelistCount),
-    whitelister: vault.whitelister ? getAddress(vault.whitelister) : '',
     whitelistManager: vault.whitelister ? getAddress(vault.whitelister) : '',
     validatorsManager: validatorsManager ? getAddress(validatorsManager) : '',
     depositDataManager: depositDataManager ? getAddress(depositDataManager) : '',

src/methods/vault/requests/getVault/types.ts

@@ -30,9 +30,4 @@ export type ModifiedVault = Omit<
     ltvPercent: string // The percent used to calculate how much user can mint OsToken shares
     thresholdPercent: string // The liquidation threshold percent used to calculate health factor for OsToken position
   }
-
-  /**
-   * @deprecated use whitelistManager
-  */
-  whitelister: string
 }

src/methods/vault/transactions/deposit/nativeToken/common.ts

@@ -5,19 +5,18 @@ import { validateArgs } from '../../../../../utils'
 
 
 export const commonLogic = async (values: DepositInput) => {
-  const { contracts, vaultAddress, userAddress, assets } = values
+  const { contracts, vaultAddress, assets } = values
 
   validateArgs.bigint({ assets })
-  validateArgs.address({ vaultAddress, userAddress })
+  validateArgs.address({ vaultAddress })
 
   const vaultContract = contracts.helpers.createVault({ vaultAddress })
-  const canHarvest = await contracts.base.keeper.canHarvest(vaultAddress)
 
   const overrides = {
     value: assets,
   }
 
-  return { vaultContract, canHarvest, overrides }
+  return { vaultContract, overrides }
 }
 
 

src/methods/vault/transactions/deposit/nativeToken/deposit.ts

@@ -8,15 +8,14 @@ import getHarvestParams from '../../../requests/getHarvestParams'
 const deposit: Deposit = async (values) => {
   const { options, provider, vaultAddress, userAddress } = values
 
-  const { vaultContract, canHarvest, overrides } = await commonLogic(values)
+  const { params, canHarvest } = await getHarvestParams({ options, vaultAddress })
+  const { vaultContract, overrides } = await commonLogic(values)
 
   const signer = await provider.getSigner(userAddress)
   const signedContract = vaultContract.connect(signer)
 
   if (canHarvest) {
-    const harvestParams = await getHarvestParams({ options, vaultAddress })
-
-    const response = await signedContract.updateStateAndDeposit(userAddress, referrer, harvestParams, overrides)
+    const response = await signedContract.updateStateAndDeposit(userAddress, referrer, params, overrides)
 
     return response.hash
   }

src/methods/vault/transactions/deposit/nativeToken/depositEncode.ts

@@ -10,12 +10,11 @@ type DepositDataOutput = StakeWise.TransactionData & {
 const depositEncode = async (values: DepositInput): Promise<DepositDataOutput> => {
   const { options, vaultAddress, userAddress } = values
 
-  const { vaultContract, canHarvest, overrides } = await commonLogic(values)
+  const { vaultContract, overrides } = await commonLogic(values)
+  const { params, canHarvest } = await getHarvestParams({ options, vaultAddress })
 
   if (canHarvest) {
-    const harvestParams = await getHarvestParams({ options, vaultAddress })
-
-    const rx = await vaultContract.updateStateAndDeposit.populateTransaction(userAddress, referrer, harvestParams, overrides)
+    const rx = await vaultContract.updateStateAndDeposit.populateTransaction(userAddress, referrer, params, overrides)
 
     return {
       ...rx,

src/methods/vault/transactions/deposit/nativeToken/depositGas.ts

@@ -7,17 +7,16 @@ import getHarvestParams from '../../../requests/getHarvestParams'
 const depositGas = async (values: DepositInput) => {
   const { options, provider, vaultAddress, userAddress } = values
 
-  const { vaultContract, canHarvest, overrides } = await commonLogic(values)
+  const { vaultContract, overrides } = await commonLogic(values)
+  const { params, canHarvest } = await getHarvestParams({ options, vaultAddress })
 
   const signer = await provider.getSigner(userAddress)
   const signedContract = vaultContract.connect(signer)
 
   let estimatedGas = 0n
 
   if (canHarvest) {
-    const harvestParams = await getHarvestParams({ options, vaultAddress })
-
-    estimatedGas = await signedContract.updateStateAndDeposit.estimateGas(userAddress, referrer, harvestParams, overrides)
+    estimatedGas = await signedContract.updateStateAndDeposit.estimateGas(userAddress, referrer, params, overrides)
   }
   else {
     estimatedGas = await signedContract.deposit.estimateGas(userAddress, referrer, overrides)