feat: adds test for supply APY values

Author: cesarenaldi

package.json

@@ -26,6 +26,7 @@
     "test:vaultDeploy": "vitest --project client packages/client/src/actions/vaultDeploy.test.ts",
     "test:857": "vitest --project client packages/client/src/actions/eMode.test.ts -t \"Then the market's reserves should have user state that reflects the selected E-Mode category settings\"",
     "test:858": "vitest --project client packages/client/src/actions/eMode.test.ts -t \"Then any user supply position that are not included in the E-Mode category should not be able to be used as collateral\"",
+    "test:867": "vitest --project client packages/client/src/actions/markets.test.ts -t \"Then it should return supply reserves APYs in the expected order of magnitude\"",
     "test:withdraw": "vitest --project client packages/client/src/actions/withdraw.test.ts",
     "test": "vitest"
   },

packages/client/src/actions/__snapshots__/markets.test.ts.snap

@@ -22,7 +22,7 @@ exports[`Given the Aave Protocol v3 > When fetching a single market > Then it sh
 }
 `;
 
-exports[`Given the Aave Protocol v3 > When fetching markets across one or more chains > Then it should return the expected data for each market 1`] = `
+exports[`Given the Aave Protocol v3 > When fetching markets by chain ID(s) > Then it should return the expected data for each market 1`] = `
 {
   "__typename": "Market",
   "address": "0x0AA97c284e98396202b6A04024F5E2c65026F3c0",
@@ -44,7 +44,7 @@ exports[`Given the Aave Protocol v3 > When fetching markets across one or more c
 }
 `;
 
-exports[`Given the Aave Protocol v3 > When fetching markets across one or more chains > Then it should return the expected data for each market 2`] = `
+exports[`Given the Aave Protocol v3 > When fetching markets by chain ID(s) > Then it should return the expected data for each market 2`] = `
 {
   "__typename": "Market",
   "address": "0x4e033931ad43597d96D6bcc25c280717730B58B1",
@@ -66,7 +66,7 @@ exports[`Given the Aave Protocol v3 > When fetching markets across one or more c
 }
 `;
 
-exports[`Given the Aave Protocol v3 > When fetching markets across one or more chains > Then it should return the expected data for each market 3`] = `
+exports[`Given the Aave Protocol v3 > When fetching markets by chain ID(s) > Then it should return the expected data for each market 3`] = `
 {
   "__typename": "Market",
   "address": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",

packages/client/src/actions/markets.test.ts

@@ -1,4 +1,5 @@
-import { assertOk, chainId, evmAddress } from '@aave/types';
+import { OrderDirection } from '@aave/graphql';
+import { assertOk, chainId, evmAddress, nonNullable } from '@aave/types';
 import { describe, expect, it } from 'vitest';
 import {
   client,
@@ -11,7 +12,7 @@ import { market, markets, userMarketState } from './markets';
 describe('Given the Aave Protocol v3', () => {
   const wallet = createNewWallet();
 
-  describe('When fetching markets across one or more chains', () => {
+  describe('When fetching markets by chain ID(s)', () => {
     it('Then it should return the expected data for each market', async () => {
       const result = await markets(client, {
         chainIds: [chainId(1)],
@@ -48,6 +49,42 @@ describe('Given the Aave Protocol v3', () => {
         eModeCategories: expect.any(Array),
       });
     });
+
+    it('Then it should return supply reserves APYs in the expected order of magnitude', async () => {
+      const result = await market(client, {
+        address: ETHEREUM_MARKET_ADDRESS,
+        chainId: ETHEREUM_FORK_ID,
+        suppliesOrderBy: {
+          supplyApy: OrderDirection.Desc,
+        },
+      }).map(nonNullable);
+
+      assertOk(result);
+
+      expect(
+        result.value.supplyReserves.map((r) => ({
+          token: r.underlyingToken.symbol,
+          apy: r.supplyInfo.apy.value,
+        })),
+      ).toEqual([
+        {
+          token: 'WETH',
+          apy: expect.toBeBigDecimalCloseTo('4', 0), // ~4% APY at the time of the Tenderly fork
+        },
+
+        {
+          token: 'USDC',
+          apy: expect.toBeBigDecimalCloseTo('3', 0), // ~3% APY at the time of the Tenderly fork
+        },
+
+        {
+          token: 'USDS',
+          apy: expect.toBeBigDecimalCloseTo('3', 0), // ~3% APY at the time of the Tenderly fork
+        },
+
+        ...new Array(46).fill(expect.any(Object)),
+      ]);
+    });
   });
 
   describe('When fetching user market state for a new user', () => {

vitest.d.ts

@@ -1,5 +1,7 @@
 import 'vitest';
 
 declare module 'vitest' {
-  interface AsymmetricMatchersContaining extends JestExtendedMatchers {}
+  interface AsymmetricMatchersContaining extends JestExtendedMatchers {
+    toBeBigDecimalCloseTo: (expected: number | string, precision?: number) => R;
+  }
 }