useCollateralTokensForCreditedToken()

function useCollateralTokensForCreditedToken(params?): UseCollateralTokensForCreditedTokenResult;

Fetches the CollateralTokens eligible as collateral for a given credited token. Maps to getCollateralTokensForCreditedToken.

Omitting params entirely leaves the hook idle — no query is created and no cache entry is written — which is how a form mounts this before its credited token is chosen. Each page is held fresh for five minutes.

Parameters

Parameter	Type	Description
params?	GetCollateralTokensForCreditedTokenParams	The credited token to find eligible collateral for, plus optional pagination. Omit to leave the hook idle.

Returns

UseCollateralTokensForCreditedTokenResult

Progressive pages and flattened eligible collateral-token items, with fetchNextPage, separate first-page and later-page errors, and retry.

Throws

Error when rendered outside <AnvilProvider>, by way of useAnvilSDK.

Example

export function EligibleCollateral({ credited }: { credited?: Address }) {
  // Omitting `params` leaves the hook idle -- no query, no cache entry.
  const { items } = useCollateralTokensForCreditedToken(
    credited === undefined ? undefined : { creditedToken: credited }
  );

  return (
    <ul>
      {items.map(token => (
        <li key={token.token.address}>{token.token.symbol}</li>
      ))}
    </ul>
  );
}