Skip to main content

Parameters

NameTypeDescription
params.configSdkConfigConfiguration parameters
params.chainIdnumberThe chain ID (must be a number, e.g., 1 for Ethereum, 137 for Polygon)
params.currencyAddressstringThe currency contract address
params.queryStandardQueryOptionsOptional React Query configuration (from TanStack Query)

Returns

Query result containing currency details

Example

Basic usage:
const { data, isLoading } = useCurrency({
  chainId: 137,
  currencyAddress: '0x...'
});
With custom query options:
const { data, isLoading } = useCurrency({
  chainId: 1,
  currencyAddress: '0x...',
  query: {
    enabled: true
  }
});