The Boost V2 Docs are under active development and will be subject to changes.
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 incentive does not have the balance to cover the current reward.
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.