Function useClaimableBoostsCount

  • useClaimableBoostsCount(
        config: ClaimableBoostsCountConfig,
    ): { isPending: boolean; count: number }

    A React hook that returns the count of claimable boosts for a given claimant address.

    Parameters

    • config: ClaimableBoostsCountConfig

      Configuration object containing: - claimantAddress: The address of the user attempting to claim (required) - At least one of the following (required): - budgetAccount: The address of the budget account - targetContract: The address of the target contract - creatorAddress: The address of the creator of the boosts - tokens: Optional token configuration (if provided, chainId is required) - chainId: Required when tokens are provided, optional otherwise

    Returns { isPending: boolean; count: number }

    An object containing: - isPending: Loading state boolean - count: Number of claimable boosts

    Example

    const { isPending, count } = useClaimableBoostsCount({
      creatorAddress: "0x123...",
      claimantAddress: "0x456...",
      // other RewardKit config
    });

    if (isPending) return <div>Loading...</div>;
    return <div>You have {count} claimable boosts</div>;

Settings

Member Visibility