Claims
Retrieve ERC20PeggedIncentive claim information
The Boost V2 Docs are under active development and will be subject to changes.
The ERC20PeggedIncentive is designed to store and distribute assets that can be claimed by users. The Boost SDK provides several methods to retrieve information about claim state.
API
claims
Retrieves the total number of completed claims.
Parameters
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 the total number of claims.
claimed
Checks if an address has previously claimed this incentive.
Parameters
The address to check claimed status.
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 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
The address to check eligibility for.
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 address can claim incentive.
limit
The total number of tokens (in wei) that can be claimed from this incentive.
Parameters
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 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.
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 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.
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