Merge pull request #133 from aave/feat/expose-user-earned-debt-apys

feat: expose user earned/debt APY in MarketUserState

Author: AGMASO

.changeset/short-steaks-allow.md

@@ -0,0 +1,6 @@
+---
+"@aave/graphql": minor
+"@aave/client": minor
+---
+
+feat: expose user earned/debt APY in MarketUserState

.gitignore

@@ -27,6 +27,7 @@ examples/*/pnpm-lock.yaml
 
 # local env files
 .env
+.env.local
 
 # typescript
 *.tsbuildinfo

biome.json

@@ -74,7 +74,11 @@
 			}
 		},
 		{
-			"includes": ["packages/**/*.spec.ts", "packages/**/*.test.ts", "packages/**/*.helpers.ts"],
+			"includes": [
+				"packages/**/*.spec.ts",
+				"packages/**/*.test.ts",
+				"packages/**/*.helpers.ts"
+			],
 			"linter": {
 				"rules": {
 					"style": {
@@ -109,9 +113,9 @@
 					"style": {
 						"noNonNullAssertion": "off"
 					},
-          "a11y": {
-            "noLabelWithoutControl": "off"
-          }
+					"a11y": {
+						"noLabelWithoutControl": "off"
+					}
 				}
 			}
 		}

packages/graphql/schema.graphql

@@ -566,6 +566,12 @@ type MarketUserState {
   """The user's net annual percentage yield across all positions"""
   netAPY: PercentValue!
 
+  """The user's earned annual percentage yield across all supply positions"""
+  userEarnedAPY: PercentValue!
+
+  """The user's debt annual percentage yield across all borrow positions"""
+  userDebtAPY: PercentValue!
+
   """
   The user's health factor (risk metric for liquidation) - if null, the user does not have a borrow
   """
@@ -679,7 +685,7 @@ enum OperationType {
   VAULT_FEE_UPDATED
   VAULT_FEE_WITHDRAWN
   VAULT_WITHDRAW
-  VAULT_TRANSFER
+  VAULT_OWNERSHIP_TRANSFERRED
   REVENUE_SPLITTER_OWNER_DEPLOYED
   REVENUE_SPLITTER_OWNER_TRANSFER
   LIQUIDATION

packages/graphql/src/fragments/market.ts

@@ -11,6 +11,12 @@ export const MarketUserStateFragment = graphql(
     netAPY {
       ...PercentValue
     }
+    userEarnedAPY {
+      ...PercentValue
+    }
+    userDebtAPY {
+      ...PercentValue
+    }
     healthFactor
     eModeEnabled
     totalCollateralBase
@@ -84,7 +90,6 @@ export const MarketFragment = graphql(
     userState {
       ...MarketUserState
     }
-
     borrowReserves: reserves(request: { reserveType: BORROW, orderBy: $borrowsOrderBy }) {
       ...Reserve
     }

packages/graphql/src/graphql-env.d.ts

@@ -56,14 +56,14 @@ export type introspection_types = {
     'MarketReservesRequestType': { name: 'MarketReservesRequestType'; enumValues: 'SUPPLY' | 'BORROW' | 'BOTH'; };
     'MarketUserReserveBorrowPosition': { kind: 'OBJECT'; name: 'MarketUserReserveBorrowPosition'; fields: { 'apy': { name: 'apy'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'currency': { name: 'currency'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'Currency'; ofType: null; }; } }; 'debt': { name: 'debt'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'TokenAmount'; ofType: null; }; } }; 'market': { name: 'market'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'MarketInfo'; ofType: null; }; } }; }; };
     'MarketUserReserveSupplyPosition': { kind: 'OBJECT'; name: 'MarketUserReserveSupplyPosition'; fields: { 'apy': { name: 'apy'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'balance': { name: 'balance'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'TokenAmount'; ofType: null; }; } }; 'canBeCollateral': { name: 'canBeCollateral'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'currency': { name: 'currency'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'Currency'; ofType: null; }; } }; 'isCollateral': { name: 'isCollateral'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'market': { name: 'market'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'MarketInfo'; ofType: null; }; } }; }; };
-    'MarketUserState': { kind: 'OBJECT'; name: 'MarketUserState'; fields: { 'availableBorrowsBase': { name: 'availableBorrowsBase'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; 'currentLiquidationThreshold': { name: 'currentLiquidationThreshold'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'eModeEnabled': { name: 'eModeEnabled'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'healthFactor': { name: 'healthFactor'; type: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; } }; 'isInIsolationMode': { name: 'isInIsolationMode'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'ltv': { name: 'ltv'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'netAPY': { name: 'netAPY'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'netWorth': { name: 'netWorth'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; 'totalCollateralBase': { name: 'totalCollateralBase'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; 'totalDebtBase': { name: 'totalDebtBase'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; }; };
+    'MarketUserState': { kind: 'OBJECT'; name: 'MarketUserState'; fields: { 'availableBorrowsBase': { name: 'availableBorrowsBase'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; 'currentLiquidationThreshold': { name: 'currentLiquidationThreshold'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'eModeEnabled': { name: 'eModeEnabled'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'healthFactor': { name: 'healthFactor'; type: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; } }; 'isInIsolationMode': { name: 'isInIsolationMode'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'ltv': { name: 'ltv'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'netAPY': { name: 'netAPY'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'netWorth': { name: 'netWorth'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; 'totalCollateralBase': { name: 'totalCollateralBase'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; 'totalDebtBase': { name: 'totalDebtBase'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigDecimal'; ofType: null; }; } }; 'userDebtAPY': { name: 'userDebtAPY'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'userEarnedAPY': { name: 'userEarnedAPY'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; }; };
     'MarketsRequest': { kind: 'INPUT_OBJECT'; name: 'MarketsRequest'; isOneOf: false; inputFields: [{ name: 'chainIds'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'LIST'; name: never; ofType: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'ChainId'; ofType: null; }; }; }; }; defaultValue: null }, { name: 'user'; type: { kind: 'SCALAR'; name: 'EvmAddress'; ofType: null; }; defaultValue: null }]; };
     'MeritBorrowAndSupplyIncentiveCondition': { kind: 'OBJECT'; name: 'MeritBorrowAndSupplyIncentiveCondition'; fields: { 'borrowToken': { name: 'borrowToken'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'Currency'; ofType: null; }; } }; 'claimLink': { name: 'claimLink'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'URL'; ofType: null; }; } }; 'extraApr': { name: 'extraApr'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'supplyToken': { name: 'supplyToken'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'Currency'; ofType: null; }; } }; }; };
     'MeritBorrowIncentive': { kind: 'OBJECT'; name: 'MeritBorrowIncentive'; fields: { 'borrowAprDiscount': { name: 'borrowAprDiscount'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'claimLink': { name: 'claimLink'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'URL'; ofType: null; }; } }; }; };
     'MeritSupplyIncentive': { kind: 'OBJECT'; name: 'MeritSupplyIncentive'; fields: { 'claimLink': { name: 'claimLink'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'URL'; ofType: null; }; } }; 'extraSupplyApr': { name: 'extraSupplyApr'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; }; };
     'MessageData': { kind: 'OBJECT'; name: 'MessageData'; fields: { 'deadline': { name: 'deadline'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Int'; ofType: null; }; } }; 'nonce': { name: 'nonce'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigInt'; ofType: null; }; } }; 'owner': { name: 'owner'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'EvmAddress'; ofType: null; }; } }; 'spender': { name: 'spender'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'EvmAddress'; ofType: null; }; } }; 'value': { name: 'value'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'BigInt'; ofType: null; }; } }; }; };
     'NativeCurrency': { kind: 'OBJECT'; name: 'NativeCurrency'; fields: { 'chainId': { name: 'chainId'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'ChainId'; ofType: null; }; } }; 'decimals': { name: 'decimals'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Int'; ofType: null; }; } }; 'imageUrl': { name: 'imageUrl'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'name': { name: 'name'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'symbol': { name: 'symbol'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'wrappedToken': { name: 'wrappedToken'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'EvmAddress'; ofType: null; }; } }; }; };
-    'OperationType': { name: 'OperationType'; enumValues: 'BORROW' | 'REPAY' | 'RESERVE_USED_AS_COLLATERAL_ENABLED' | 'RESERVE_USED_AS_COLLATERAL_DISABLED' | 'SUPPLY' | 'USER_EMODE_SET' | 'WITHDRAW' | 'VAULT_DEPLOYED' | 'VAULT_DEPOSIT' | 'VAULT_FEE_UPDATED' | 'VAULT_FEE_WITHDRAWN' | 'VAULT_WITHDRAW' | 'VAULT_TRANSFER' | 'REVENUE_SPLITTER_OWNER_DEPLOYED' | 'REVENUE_SPLITTER_OWNER_TRANSFER' | 'LIQUIDATION'; };
+    'OperationType': { name: 'OperationType'; enumValues: 'BORROW' | 'REPAY' | 'RESERVE_USED_AS_COLLATERAL_ENABLED' | 'RESERVE_USED_AS_COLLATERAL_DISABLED' | 'SUPPLY' | 'USER_EMODE_SET' | 'WITHDRAW' | 'VAULT_DEPLOYED' | 'VAULT_DEPOSIT' | 'VAULT_FEE_UPDATED' | 'VAULT_FEE_WITHDRAWN' | 'VAULT_WITHDRAW' | 'VAULT_OWNERSHIP_TRANSFERRED' | 'REVENUE_SPLITTER_OWNER_DEPLOYED' | 'REVENUE_SPLITTER_OWNER_TRANSFER' | 'LIQUIDATION'; };
     'OrderDirection': { name: 'OrderDirection'; enumValues: 'ASC' | 'DESC'; };
     'PageSize': { name: 'PageSize'; enumValues: 'TEN' | 'FIFTY'; };
     'PaginatedResultInfo': { kind: 'OBJECT'; name: 'PaginatedResultInfo'; fields: { 'next': { name: 'next'; type: { kind: 'SCALAR'; name: 'Cursor'; ofType: null; } }; 'prev': { name: 'prev'; type: { kind: 'SCALAR'; name: 'Cursor'; ofType: null; } }; }; };