Skip to main content

Function: useAddresses()

useAddresses(params?: {chain: ChainId | Chain;profile: string;query: {}; }): UseQueryResult<AddressesResponse, Error>

Parameters

ParameterTypeDescription
params?objectNo required parameters.
params.chain?ChainId | ChainFilter based on chain - CURRENTLY RETURNS AN ERROR.
params.profile?stringFilter based on profile id.
params.query?QueryOptions<AddressesResponse>See Tanstack Query - useQuery options.

Returns

UseQueryResult<AddressesResponse, Error>

Example

const {
data,
isLoading,
isError,
error,
refetch,
...moreUseQueryResults
} = useAddresses();

See

API Documentation

Defined in

sdk-react-provider/src/lib/hooks.tsx:350