Skip to content
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 6 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
9 changes: 7 additions & 2 deletions lavamoat/build-webpack/policy.json
Original file line number Diff line number Diff line change
Expand Up @@ -1184,8 +1184,13 @@
"define": true
},
"packages": {
"jest>@jest/core>jest-snapshot>@babel/traverse>@babel/generator>@jridgewell/trace-mapping>@jridgewell/sourcemap-codec": true,
"webpack>terser-webpack-plugin>@jridgewell/trace-mapping>@jridgewell/resolve-uri": true
"jest>@jest/core>jest-snapshot>@babel/traverse>@babel/generator>@jridgewell/trace-mapping>@jridgewell/resolve-uri": true,
"jest>@jest/core>jest-snapshot>@babel/traverse>@babel/generator>@jridgewell/trace-mapping>@jridgewell/sourcemap-codec": true
}
},
"jest>@jest/core>jest-snapshot>@babel/traverse>@babel/generator>@jridgewell/trace-mapping>@jridgewell/resolve-uri": {
"globals": {
"define": true
}
},
"jest>@jest/core>jest-snapshot>@babel/traverse>@babel/generator>@jridgewell/trace-mapping>@jridgewell/sourcemap-codec": {
Expand Down
82 changes: 82 additions & 0 deletions src/core/graphql/__generated__/metadata.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions src/core/graphql/queries/metadata.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -490,3 +490,17 @@ mutation claimUserRewards($address: String!) {
txHash
}
}

query externalToken($address: String!, $chainId: Int!, $currency: String) {
token(address: $address, chainID: $chainId, currency: $currency) {
decimals
iconUrl
name
networks
price {
relativeChange24h
value
}
symbol
}
}
152 changes: 152 additions & 0 deletions src/core/resources/assets/externalToken.ts
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,
});
}
Copy link
Member

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?

Copy link
Member Author

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


// 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,
});
}
2 changes: 1 addition & 1 deletion src/core/resources/assets/userTestnetNativeAsset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ export function useUserTestnetNativeAsset(
config: QueryConfig<
UserAssetsResult,
Error,
UserAssetsResult,
ParsedUserAsset,
UserTestnetNativeAssetQueryKey
> = {},
) {
Expand Down
Loading