-
Notifications
You must be signed in to change notification settings - Fork 35
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.
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
extend user native asset #1717
Merged
Merged
extend user native asset #1717
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6c8633b
external token resource
estebanmino a79046c
use useUserNativeAsset
estebanmino f73756d
usenativeasset
estebanmino c9b6bcb
rmpasta
estebanmino 1592a35
remove prefetch
estebanmino e813b3c
Merge branch 'master' into @esteban/user-native-asset
DanielSinclair File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,152 @@ | ||
import { useQuery } from '@tanstack/react-query'; | ||
import { Address } from 'viem'; | ||
|
||
import { metadataClient } from '~/core/graphql'; | ||
import { Token } from '~/core/graphql/__generated__/metadata'; | ||
import { | ||
QueryConfig, | ||
QueryFunctionArgs, | ||
QueryFunctionResult, | ||
createQueryKey, | ||
queryClient, | ||
} from '~/core/react-query'; | ||
import { SupportedCurrencyKey } from '~/core/references'; | ||
import { AddressOrEth, ParsedAsset } from '~/core/types/assets'; | ||
import { ChainId, chainIdToNameMapping } from '~/core/types/chains'; | ||
import { isNativeAsset } from '~/core/utils/chains'; | ||
import { | ||
convertAmountAndPriceToNativeDisplay, | ||
convertAmountToPercentageDisplay, | ||
} from '~/core/utils/numbers'; | ||
|
||
export const EXTERNAL_TOKEN_CACHE_TIME = 1000 * 60 * 60 * 24; // 24 hours | ||
export const EXTERNAL_TOKEN_STALE_TIME = 1000 * 60; // 1 minute | ||
|
||
// Types | ||
type ExternalToken = Pick< | ||
Token, | ||
'decimals' | 'iconUrl' | 'name' | 'networks' | 'symbol' | 'price' | ||
>; | ||
|
||
// Query Types for External Token | ||
type ExternalTokenArgs = { | ||
address: string; | ||
chainId: ChainId; | ||
currency: SupportedCurrencyKey; | ||
}; | ||
|
||
// Query Key for Token Price | ||
export const externalTokenQueryKey = ({ | ||
address, | ||
chainId, | ||
currency, | ||
}: ExternalTokenArgs) => | ||
createQueryKey( | ||
'externalToken', | ||
{ address, chainId, currency }, | ||
{ persisterVersion: 1 }, | ||
); | ||
|
||
type externalTokenQueryKey = ReturnType<typeof externalTokenQueryKey>; | ||
|
||
// Helpers | ||
const formatExternalAsset = ( | ||
address: string, | ||
chainId: ChainId, | ||
asset: ExternalToken, | ||
nativeCurrency: SupportedCurrencyKey, | ||
): ParsedAsset => { | ||
return { | ||
...asset, | ||
chainId, | ||
chainName: chainIdToNameMapping[chainId], | ||
uniqueId: `${address}_${chainId}`, | ||
address: address as Address, | ||
isNativeAsset: isNativeAsset(address as AddressOrEth, chainId), | ||
native: { | ||
price: { | ||
change: asset?.price?.relativeChange24h | ||
? convertAmountToPercentageDisplay( | ||
`${asset?.price?.relativeChange24h}`, | ||
) | ||
: '', | ||
amount: asset?.price?.value ?? 0, | ||
display: convertAmountAndPriceToNativeDisplay( | ||
1, | ||
asset?.price?.value ?? 0, | ||
nativeCurrency, | ||
).display, | ||
}, | ||
}, | ||
price: { | ||
value: asset?.price?.value ?? 0, | ||
relative_change_24h: asset?.price?.relativeChange24h ?? 0, | ||
}, | ||
icon_url: asset?.iconUrl || undefined, | ||
}; | ||
}; | ||
|
||
// Query Function for Token Price | ||
export async function fetchExternalToken({ | ||
address, | ||
chainId, | ||
currency, | ||
}: ExternalTokenArgs) { | ||
const response = await metadataClient.externalToken({ | ||
address, | ||
chainId, | ||
currency, | ||
}); | ||
if (response?.token) { | ||
return formatExternalAsset(address, chainId, response.token, currency); | ||
} else { | ||
return null; | ||
} | ||
} | ||
|
||
export async function externalTokenQueryFunction({ | ||
queryKey: [{ address, chainId, currency }], | ||
}: QueryFunctionArgs< | ||
typeof externalTokenQueryKey | ||
>): Promise<ParsedAsset | null> { | ||
if (!address || !chainId) return null; | ||
return fetchExternalToken({ address, chainId, currency }); | ||
} | ||
|
||
export type ExternalTokenQueryFunctionResult = QueryFunctionResult< | ||
typeof externalTokenQueryFunction | ||
>; | ||
|
||
// Prefetch function for Token Price | ||
export async function prefetchExternalToken({ | ||
address, | ||
chainId, | ||
currency, | ||
}: ExternalTokenArgs) { | ||
await queryClient.prefetchQuery({ | ||
queryKey: externalTokenQueryKey({ address, chainId, currency }), | ||
queryFn: externalTokenQueryFunction, | ||
staleTime: EXTERNAL_TOKEN_STALE_TIME, | ||
gcTime: EXTERNAL_TOKEN_CACHE_TIME, | ||
}); | ||
} | ||
|
||
// Query Hook for Token Price | ||
export function useExternalToken( | ||
{ address, chainId, currency }: ExternalTokenArgs, | ||
config: QueryConfig< | ||
ExternalTokenQueryFunctionResult, | ||
Error, | ||
ParsedAsset, | ||
externalTokenQueryKey | ||
> = {}, | ||
) { | ||
return useQuery({ | ||
queryKey: externalTokenQueryKey({ address, chainId, currency }), | ||
queryFn: externalTokenQueryFunction, | ||
staleTime: EXTERNAL_TOKEN_STALE_TIME, | ||
gcTime: EXTERNAL_TOKEN_CACHE_TIME, | ||
enabled: !!address && !!chainId, | ||
...config, | ||
}); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you think we'll end up using this prefetch?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it was a copy paste from app, i can remove