[new apy]: add new VaultSnapshots request

README.md

@@ -85,9 +85,9 @@ const sdk = new StakeWiseSDK({ network: Network.Mainnet })
 
 ##### Request table:
 | **Vault** | **osToken** | **Utils** |
-|------|------|------|
+|------|-------------|------|
 | [sdk.vault.getStakerActions](#sdkvaultgetstakeractions) | [sdk.osToken.getBurnAmount](#sdkostokengetburnamount) | [sdk.utils.getRewardsPerYear](#sdkutilsgetrewardsperyear) |
-| [sdk.vault.getDaySnapshots](#sdkvaultgetdaysnapshots) | [sdk.osToken.getHealthFactor](#sdkostokengethealthfactor) | [sdk.utils.getSwiseUsdPrice](#sdkutilsgetswiseusdprice) |
+| [sdk.vault.getSnapshots](#sdkvaultgetsnapshots) | [sdk.osToken.getHealthFactor](#sdkostokengethealthfactor) | [sdk.utils.getSwiseUsdPrice](#sdkutilsgetswiseusdprice) |
 | [sdk.vault.getExitQueuePositions](#sdkvaultgetexitqueuepositions) | [sdk.osToken.getAPY](#sdkostokengetapy) | [sdk.utils.getTransactions](#sdkutilsgettransactions) |
 | [sdk.vault.getValidators](#sdkvaultgetvalidators) | [sdk.osToken.getPosition](#sdkostokengetposition) |
 | [sdk.vault.getVault](#sdkvaultgetvault) | [sdk.osToken.getMaxMint](#sdkostokengetmaxmint) | 
@@ -164,30 +164,32 @@ await sdk.vault.getStakerActions({
 })
 ```
 ---
-### `sdk.vault.getDaySnapshots`
+### `sdk.vault.getSnapshots`
 
 #### Description:
 
 TVL and APY snapshots for the vault. With the help of this data it is possible to build a chart.
 
 #### Arguments:
 
-| Name | Type | Type | Description |
-|------|------|-------------|---------|
-| unixStartOfDay | `number` | **Require** | Time to start |
-| vaultAddress | `string` | **Require** | - |
+| Name         | Type     | Type            | Description |
+|--------------|----------|-----------------|---------|
+| vaultAddress | `string` | **Require**     | - |
+| dateFrom     | `string` | **Require**     | Time to start |
+| dateTo       | `string` | Time to end     |
+| first        | `number` | Snapshots count |
 
 #### Returns:
 
 ```ts
-type DaySnapshot = {
+type Snapshot = {
   APY: number
   TVL: string
 }
 
 type Output = {
-  days: Record<number, DaySnapshot>
-  first: DaySnapshot
+  days: Record<number, Snapshot>
+  first: Snapshot
 }
 ```
 
@@ -199,9 +201,9 @@ type Output = {
 #### Example:
 
 ```ts
-await sdk.vault.getDaySnapshots({
+await sdk.vault.getSnapshots({
   vaultAddress: '0x...',
-  unixStartOfDay: 1695730032793,
+  dateFrom: 1695730032793,
 })
 ```
 ---

src/graphql/backend/vault/index.ts

@@ -1,3 +1,6 @@
+export { fetchSnapshotsQuery } from './snapshotsQuery.graphql'
+export type { SnapshotsQueryPayload, SnapshotsQueryVariables } from './snapshotsQuery.graphql'
+
 export { fetchValidatorsQuery } from './validatorsQuery.graphql'
 export type { ValidatorsQueryPayload, ValidatorsQueryVariables } from './validatorsQuery.graphql'
 

src/graphql/backend/vault/snapshotsQuery.graphql

@@ -0,0 +1,17 @@
+query Snapshots($vaultAddress: String!  $dateFrom: DateAsTimestamp!  $dateTo: DateAsTimestamp  $first: Int) {
+  vaultSnapshots(
+    vaultAddress: $vaultAddress
+    dateFrom: $dateFrom
+    dateTo: $dateTo
+    first: $first
+  ) {
+    date,
+    weeklyApy
+    totalAssets
+  }
+  firstSnapshots: vaultSnapshots(vaultAddress: $vaultAddress, first: 1) {
+    date
+    totalAssets
+    weeklyApy
+  }
+}

src/graphql/subgraph/index.ts

@@ -1,6 +1,5 @@
 export * as vault from './vault'
 export * as osToken from './osToken'
 export * as exitQueue from './exitQueue'
-export * as daySnapshots from './daySnapshots'
 export * as transactions from './transactions'
 export * as allocatorActions from './allocatorActions'

src/graphql/subgraph/vault/vaultQuery.graphql

@@ -20,7 +20,7 @@ query Vault($address: ID!) {
     tokenSymbol
     feeRecipient
     validatorsRoot
-    avgRewardPerAsset
+    weeklyApy
   }
   privateVaultAccounts(
     where: { vault: $address }

src/methods/vault/index.ts

@@ -3,11 +3,11 @@ import getVault from './requests/getVault'
 import getValidators from './requests/getValidators'
 import getUserRewards from './requests/getUserRewards'
 import getMaxWithdraw from './requests/getMaxWithdraw'
-import getDaySnapshots from './requests/getDaySnapshots'
 import getStakeBalance from './requests/getStakeBalance'
 import getHarvestParams from './requests/getHarvestParams'
 import getStakerActions from './requests/getStakerActions'
 import getExitQueuePositions from './requests/getExitQueuePositions'
+import getSnapshots from './requests/getSnapshots'
 
 // Transactions
 import { deposit } from './transactions/deposit'
@@ -21,10 +21,10 @@ export default {
     getValidators,
     getUserRewards,
     getMaxWithdraw,
-    getDaySnapshots,
     getStakeBalance,
     getHarvestParams,
     getStakerActions,
+    getSnapshots,
     getExitQueuePositions,
   },
   transactions: {

src/methods/vault/requests/getSnapshots/index.ts

@@ -0,0 +1,33 @@
+import type { SnapshotsQueryVariables } from '../../../../graphql/backend/vault'
+import { apiUrls, validateArgs } from '../../../../utils'
+import modifySnapshots from './modifySnapshots'
+import graphql from '../../../../graphql'
+import { ModifiedSnapshots } from './types'
+
+
+type GetSnapshotsInput = {
+  options: StakeWise.Options
+  vaultAddress: SnapshotsQueryVariables['vaultAddress']
+  dateFrom: SnapshotsQueryVariables['dateFrom']
+}
+
+const getSnapshots = async (input: GetSnapshotsInput) => {
+  const { options, vaultAddress, dateFrom } = input
+
+  validateArgs.address({ vaultAddress })
+  validateArgs.string({ dateFrom })
+
+  const data = await graphql.backend.vault.fetchSnapshotsQuery<ModifiedSnapshots>({
+    url: apiUrls.getBackendUrl(options),
+    variables: {
+      vaultAddress: vaultAddress.toLowerCase(),
+      dateFrom,
+    } as SnapshotsQueryVariables,
+    modifyResult: modifySnapshots,
+  })
+
+  return data
+}
+
+
+export default getSnapshots

src/methods/vault/requests/getSnapshots/modifySnapshots.spec.ts

@@ -0,0 +1,61 @@
+import type { SnapshotsQueryPayload } from '../../../../graphql/backend/vault'
+import modifySnapshots, { modifySnapshot } from './modifySnapshots'
+
+
+describe('modifyVaultSnapshot and modifyVaultSnapshots functions', () => {
+  const sampleInput: SnapshotsQueryPayload = {
+    vaultSnapshots: [
+      {
+        date: '1700870400',
+        totalAssets: '3906945363776011390139',
+        weeklyApy: '1.8793377858',
+      },
+      {
+        date: '1700956800',
+        totalAssets: '3907107984571011390139',
+        weeklyApy: '1.6767640360',
+      },
+    ],
+    firstSnapshots: [
+      {
+        date: '1700870400',
+        totalAssets: '3906945363776011390139',
+        weeklyApy: '1.8793377858',
+      },
+    ],
+  }
+
+  it('should correctly modify a single vault snapshot', () => {
+    const vaultSnapshot = sampleInput.vaultSnapshots[0]
+
+    const result = modifySnapshot(vaultSnapshot)
+
+    expect(result).toEqual({
+      APY: Number(vaultSnapshot.weeklyApy),
+      TVL: 3906.945363776011,
+    })
+  })
+
+  it('should correctly modify multiple vault snapshots', () => {
+    const expectedResult = {
+      days: {
+        1700870400: {
+          APY: Number(sampleInput.vaultSnapshots[0].weeklyApy),
+          TVL: 3906.945363776011,
+        },
+        1700956800: {
+          APY: Number(sampleInput.vaultSnapshots[1].weeklyApy),
+          TVL: 3907.1079845710115,
+        },
+      },
+      first: {
+        APY: Number(sampleInput.firstSnapshots[0].weeklyApy),
+        TVL: 3906.945363776011,
+      },
+    }
+
+    const result = modifySnapshots(sampleInput)
+
+    expect(result).toEqual(expectedResult)
+  })
+})