Rewards
Retrieve information about ERC20 Incentive rewards
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 the current state of its rewards.
API
reward
Retrieves the amount of the reward configured at time of initialization. When claimed, this is the amount that is transferred to the claimant.
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 amount of the asset rewarded per-claim.
asset
Retrieves the address of the ERC20-like asset to be rewarded on claim.
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
The address of the asset transferred on claim
strategy
Retrieve the strategy configured at time of intitialization, either. Either POOL, or RAFFLE. A typical Boost setup will be using StrategyType.POOL
Parameters The total amount of the asset distributed from the budget.
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
The total amount of the asset distributed from the budget.
limit
Retrieves the amount of times this incentive can be claimed.
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 total number of claims that can be made against this incentive.