Function useClaimIncentives

  • useClaimIncentives(
        params: ProcessClaimParams,
    ): UseMutationResult<
        `0x${string}`,
        Error,
        { signature: `0x${string}`; claimant: `0x${string}` },
        unknown,
    >

    A React Query hook for claiming incentives for a specific boost.

    This hook handles the mutation for claiming boost incentives by a claimant address, requiring a valid signature for authorization.

    See useMutation from react-query

    Parameters

    • params: ProcessClaimParams

      Parameters for claiming incentives

      • boostId

        ID of the boost in format "chainId:coreAddress:index"

      • address

        Optional address of the claimer

    Returns UseMutationResult<
        `0x${string}`,
        Error,
        { signature: `0x${string}`; claimant: `0x${string}` },
        unknown,
    >

    A React Query mutation object for handling the claim

    Example

    const { mutate } = useClaimIncentives({
      boostId: "11155111:0x378632819F39C74c4F56B1429E760739c5fb51b7:33",
      address: "0xabcd...ef12"
    });

    // Trigger the claim
    mutate({
      signature: "0x123...", // Valid signature
      claimant: "0xabcd...ef12" // Address of claimant
    });

Settings

Member Visibility