Function useRewardKitBoosts

  • useRewardKitBoosts(
        params: RewardKitBoostsParams,
    ): UseQueryResult<
        {
            boosts: {
                id: string;
                chainId: number;
                incentives: {
                    type: IncentiveTypeString;
                    assetAddress?: `0x${string}`;
                    rewardAmount?: string;
                    rewardAmountFormatted?: string;
                    rewardPercentage?: number;
                    maxReward?: string;
                    rewardUsdValue?: number;
                    tokenSymbol?: string;
                    tokenImageUri?: string;
                    metadata?: | null
                    | {
                        id: string;
                        chainId: number;
                        address: `0x${string}`;
                        decimals: number;
                        name: string;
                        symbol: string;
                        imageUri: string;
                    };
                }[];
                actionTemplate: | null
                | {
                    id: string;
                    actionType: string;
                    projectId: string;
                    projectImage?: string;
                };
                boostName?: null
                | string;
                tokenImageUri?: null | string;
                nftImageUri?: null | string;
                nftName?: null | string;
                status?: "active" | "claimable" | "claimed";
                txHash?: string;
                blockTimestamp?: string;
            }[];
        },
        Error,
    >

    Hook to fetch RewardKit Boosts based on creator and claimant addresses. Retrieves paginated data with optional status filtering.

    See useQuery from react-query

    Parameters

    • params: RewardKitBoostsParams

      Parameters for fetching boosts

      • creatorAddress

        Address of the boost creator

      • claimantAddress

        Address of the boost claimant

      • pageSize

        Number of results per page

      • page

        Page number to fetch

      • status

        Status to filter boosts

    Returns UseQueryResult<
        {
            boosts: {
                id: string;
                chainId: number;
                incentives: {
                    type: IncentiveTypeString;
                    assetAddress?: `0x${string}`;
                    rewardAmount?: string;
                    rewardAmountFormatted?: string;
                    rewardPercentage?: number;
                    maxReward?: string;
                    rewardUsdValue?: number;
                    tokenSymbol?: string;
                    tokenImageUri?: string;
                    metadata?: | null
                    | {
                        id: string;
                        chainId: number;
                        address: `0x${string}`;
                        decimals: number;
                        name: string;
                        symbol: string;
                        imageUri: string;
                    };
                }[];
                actionTemplate: | null
                | {
                    id: string;
                    actionType: string;
                    projectId: string;
                    projectImage?: string;
                };
                boostName?: null
                | string;
                tokenImageUri?: null | string;
                nftImageUri?: null | string;
                nftName?: null | string;
                status?: "active" | "claimable" | "claimed";
                txHash?: string;
                blockTimestamp?: string;
            }[];
        },
        Error,
    >

    Query result containing array of boosts

    Example

    const { data, isLoading } = useRewardKitBoosts({
      creatorAddress: "0x123...",
      claimantAddress: "0x456...",
      pageSize: 10,
      page: 1,
      status: RewardKitBoostStatus.CLAIMED
    });

Settings

Member Visibility