Skip to content

Feat: support currency for preview query and get swappable tokens userBalances #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
juangm merged 3 commits into from
Oct 6, 2025
Merged

Feat: support currency for preview query and get swappable tokens userBalances #86

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52d1d3b
feat: update schema to support currency in preview query
juangm Oct 3, 2025
353fae9
feat: support userBalances for swappable tokens
juangm Oct 3, 2025
79a332e
fix: tsdocs
juangm Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/client/src/actions/transactions.ts
View file
Open in desktop
Copy link
Collaborator

@cesarenaldi cesarenaldi Oct 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs updating tsdoc

Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import {
} from '@aave/graphql-next';
import type { ResultAsync } from '@aave/types-next';
import type { AaveClient } from '../AaveClient';
import { type CurrencyQueryOptions, DEFAULT_QUERY_OPTIONS } from '../options';

/**
* Creates a transaction to borrow from a market.
Expand Down Expand Up @@ -428,8 +429,9 @@ export function setSpokeUserPositionManager(
export function preview(
client: AaveClient,
request: PreviewRequest,
options: Required<CurrencyQueryOptions> = DEFAULT_QUERY_OPTIONS,
): ResultAsync<PreviewUserPosition, UnexpectedError> {
return client.query(PreviewQuery, { request });
return client.query(PreviewQuery, { request, ...options });
}

/**
Expand Down
7 changes: 5 additions & 2 deletions packages/graphql/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,8 +642,8 @@ type PreviewUserPosition {
riskPremium: PercentValueVariation!
positionApy: PercentValueVariation!
netApy: PercentValueVariation!
netCollateral: FiatAmountValueVariation!
netBalance: FiatAmountValueVariation!
netCollateral(currency: Currency! = USD): FiatAmountValueVariation!
netBalance(currency: Currency! = USD): FiatAmountValueVariation!
}

type Query {
Expand Down Expand Up @@ -1410,6 +1410,9 @@ input UserBalancesRequestFilter @oneOf {

"""The balances for the underlying attached to a spoke"""
spoke: SpokeInput

"""The balances for the swappable tokens"""
swappable: SwappableTokensRequestQuery
}

input UserBalancesRequestOrderBy @oneOf {
Expand Down
2 changes: 1 addition & 1 deletion packages/graphql/src/graphql-env.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export type introspection_types = {
'UpdateUserRiskPremiumRequest': { kind: 'INPUT_OBJECT'; name: 'UpdateUserRiskPremiumRequest'; isOneOf: false; inputFields: [{ name: 'spoke'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'INPUT_OBJECT'; name: 'SpokeInput'; ofType: null; }; }; defaultValue: null }, { name: 'sender'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'EvmAddress'; ofType: null; }; }; defaultValue: null }, { name: 'onBehalfOf'; type: { kind: 'SCALAR'; name: 'EvmAddress'; ofType: null; }; defaultValue: null }]; };
'UserBalance': { kind: 'OBJECT'; name: 'UserBalance'; fields: { 'balances': { name: 'balances'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'LIST'; name: never; ofType: { kind: 'NON_NULL'; name: never; ofType: { kind: 'UNION'; name: 'TokenAmount'; ofType: null; }; }; }; } }; 'borrowApy': { name: 'borrowApy'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'fiatAmount': { name: 'fiatAmount'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'FiatAmount'; ofType: null; }; } }; 'info': { name: 'info'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'TokenInfo'; ofType: null; }; } }; 'supplyApy': { name: 'supplyApy'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'PercentValue'; ofType: null; }; } }; 'totalAmount': { name: 'totalAmount'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'DecimalValue'; ofType: null; }; } }; }; };
'UserBalancesRequest': { kind: 'INPUT_OBJECT'; name: 'UserBalancesRequest'; isOneOf: false; inputFields: [{ name: 'user'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'EvmAddress'; ofType: null; }; }; defaultValue: null }, { name: 'orderBy'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'INPUT_OBJECT'; name: 'UserBalancesRequestOrderBy'; ofType: null; }; }; defaultValue: "{balance: DESC}" }, { name: 'filter'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'INPUT_OBJECT'; name: 'UserBalancesRequestFilter'; ofType: null; }; }; defaultValue: null }, { name: 'includeZeroBalances'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; }; defaultValue: "false" }]; };
'UserBalancesRequestFilter': { kind: 'INPUT_OBJECT'; name: 'UserBalancesRequestFilter'; isOneOf: true; inputFields: [{ name: 'chainIds'; type: { kind: 'LIST'; name: never; ofType: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'ChainId'; ofType: null; }; }; }; defaultValue: null }, { name: 'hub'; type: { kind: 'INPUT_OBJECT'; name: 'HubInput'; ofType: null; }; defaultValue: null }, { name: 'spoke'; type: { kind: 'INPUT_OBJECT'; name: 'SpokeInput'; ofType: null; }; defaultValue: null }]; };
'UserBalancesRequestFilter': { kind: 'INPUT_OBJECT'; name: 'UserBalancesRequestFilter'; isOneOf: true; inputFields: [{ name: 'chainIds'; type: { kind: 'LIST'; name: never; ofType: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'ChainId'; ofType: null; }; }; }; defaultValue: null }, { name: 'hub'; type: { kind: 'INPUT_OBJECT'; name: 'HubInput'; ofType: null; }; defaultValue: null }, { name: 'spoke'; type: { kind: 'INPUT_OBJECT'; name: 'SpokeInput'; ofType: null; }; defaultValue: null }, { name: 'swappable'; type: { kind: 'INPUT_OBJECT'; name: 'SwappableTokensRequestQuery'; ofType: null; }; defaultValue: null }]; };
'UserBalancesRequestOrderBy': { kind: 'INPUT_OBJECT'; name: 'UserBalancesRequestOrderBy'; isOneOf: true; inputFields: [{ name: 'name'; type: { kind: 'ENUM'; name: 'OrderDirection'; ofType: null; }; defaultValue: null }, { name: 'balance'; type: { kind: 'ENUM'; name: 'OrderDirection'; ofType: null; }; defaultValue: null }]; };
'UserBorrowItem': { kind: 'OBJECT'; name: 'UserBorrowItem'; fields: { 'amount': { name: 'amount'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'Erc20Amount'; ofType: null; }; } }; 'paid': { name: 'paid'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'Erc20Amount'; ofType: null; }; } }; 'reserve': { name: 'reserve'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'Reserve'; ofType: null; }; } }; }; };
'UserBorrowsQueryRequest': { kind: 'INPUT_OBJECT'; name: 'UserBorrowsQueryRequest'; isOneOf: true; inputFields: [{ name: 'userSpoke'; type: { kind: 'INPUT_OBJECT'; name: 'UserSpokeInput'; ofType: null; }; defaultValue: null }, { name: 'userPositionId'; type: { kind: 'SCALAR'; name: 'UserPositionId'; ofType: null; }; defaultValue: null }]; };
Expand Down
26 changes: 24 additions & 2 deletions packages/graphql/src/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1957,7 +1957,18 @@
"ofType": null
}
},
"args": []
"args": [
{
"name": "currency",
"type": {
"kind": "NON_NULL",
"ofType": {
"kind": "SCALAR",
"name": "Any"
}
}
}
]
},
{
"name": "netBalance",
Expand All @@ -1969,7 +1980,18 @@
"ofType": null
}
},
"args": []
"args": [
{
"name": "currency",
"type": {
"kind": "NON_NULL",
"ofType": {
"kind": "SCALAR",
"name": "Any"
}
}
}
]
}
],
"interfaces": []
Expand Down
6 changes: 3 additions & 3 deletions packages/graphql/src/transactions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,10 @@ export const PreviewUserPositionFragment = graphql(
riskPremium {
...PercentValueVariation
}
netCollateral {
netCollateral(currency: $currency) {
...FiatAmountValueVariation
}
netBalance {
netBalance(currency: $currency) {
...FiatAmountValueVariation
}
}`,
Expand All @@ -169,7 +169,7 @@ export type PreviewUserPosition = FragmentOf<
* @internal
*/
export const PreviewQuery = graphql(
`query Preview($request: PreviewRequest!) {
`query Preview($request: PreviewRequest!, $currency: Currency! = USD) {
value: preview(request: $request) {
...PreviewUserPosition
}
Expand Down
7 changes: 4 additions & 3 deletions packages/react/src/transactions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1231,12 +1231,13 @@ export function useSetSpokeUserPositionManagerAction(): UseAsyncTask<
* ```
*/
export function usePreviewAction(
_options: Required<CurrencyQueryOptions> = DEFAULT_QUERY_OPTIONS,
options: Required<CurrencyQueryOptions> = DEFAULT_QUERY_OPTIONS,
): UseAsyncTask<PreviewRequest, PreviewUserPosition, UnexpectedError> {
// TODO: wire up _options once AAVE-1916 is implemented
const client = useAaveClient();

return useAsyncTask((request: PreviewRequest) => preview(client, request));
return useAsyncTask((request: PreviewRequest) =>
preview(client, request, options),
);
}

export type UsePreviewArgs = Prettify<PreviewRequest & CurrencyQueryOptions>;
Expand Down