API
claims
Retrieves the total number of completed claims.
Parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Promise<bigint>
Returns the total number of claims.
claimed
Checks if an address has previously claimed this incentive.
Parameters
Address
The address to check claimed status.
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Promise<boolean>
Returns true if address has claimed the incentive.
isClaimable
Check if an incentive is claimable by an address. Will return false if the recipient has already claimed, or total incentive claims has met the configured limit.
Parameters
Address
The address to check eligibility for.
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Promise<boolean>
Returns true if address can claim incentive.
limit
The total number of tokens (in wei) that can be claimed from this incentive.
Parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Promise<bigint>
Returns the maximum number of tokens that can be claimed from this incentive.
getRemainingClaimPotential
Retrieves the number of remaining possible claims for an incentive by comparing total claims against the limit.
Note that this does not check if a specific user is eligible to claim.
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Promise<bigint>
Returns the number of remaining possible claims (limit minus current claims)
canBeClaimed
Checks if any claims remain for an incentive by comparing total claims against the limit.
Returns a boolean indicating if claims are still possible.
Note that this does not check if a specific user is eligible to claim.
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Returns
true if there are remaining claims available, false otherwise