Hooks reference - Alphscan

Summary

Hook	Purpose	Requires provider
useClient	Get SDK client from context	Yes (AlphscanProvider)
useTokens	Paginated token list	Yes
useTxNormalizedEvents	Normalized events for a transaction	No
useAlphscan	Placeholder (getToken, getDocs stubs)	No

useClient

function useClient(): AlphscanClientApi

Returns the client from AlphscanProvider. Throws if used outside the provider.

useTokens

function useTokens(options?: UseTokensOptions): UseTokensResult

UseTokensOptions: page?, pageSize?, enabled?
UseTokensResult: tokens, total, page, pageSize, totalPages, loading, error, setPage, refetch Requires AlphscanProvider.

useTxNormalizedEvents

function useTxNormalizedEvents(
  transactionId: string | undefined,
  options?: UseTxNormalizedEventsOptions
): { data, loading, error, refetch }

UseTxNormalizedEventsOptions: baseUrl?, settings?, enabled?
Return: data: TxNormalizedEventsResponse | null, loading, error, refetch Does not require provider; uses its own client from options.

useAlphscan

function useAlphscan(): {
  getToken: () => Promise<null>;
  getDocs: () => Promise<{}>;
  loading: boolean;
  error: Error | null;
}

Placeholder hook. Use useClient + client.token.list() or useTokens for tokens; other SDK methods for other data.

Folder structure (sdk-react)

AlphscanProvider — root
hooks/ — useClient, useAlphscan
token/ — useTokens
transaction/ — useTxNormalizedEvents
system/ — reserved for future hooks (e.g. usePlans, useKeys)

​Summary

​useClient

​useTokens

​useTxNormalizedEvents

​useAlphscan

​Folder structure (sdk-react)