Claims
Retrieve ERC20 Incentive claim information and draw raffle
The Boost V2 Docs are under active development and will be subject to changes.
The ERC20 Incentive 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, as well as drawing raffles.
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.
totalClaimed
Returns the total amount distributed by 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 total amount claimed
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.
getRemainingClaimPotential
Retrieves the remaining amount of tokens (in wei) remaining in the incentive by comparing total claims against the limit.
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 remaining amount of tokens (in wei) remaining in the incentive
canBeClaimed
Checks if the balance of the incentive is greater than 0. 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 the incentive has a remaining balance, false otherwise