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 pegged asset configured at time of initialization. This represents the value of the reward denominated in the pegged token (e.g., 1 USDC). When claimed, the user receives an equivalent value in the actual reward asset token, calculated based on the current price ratio between the pegged token and the reward asset.
For example:
- If the reward is pegged to 1 USDC
- And the reward asset token is worth 0.25 USDC per token
- Then claiming the reward would transfer 4 reward asset tokens to the claimant (1 USDC ÷ 0.25 = 4 tokens)
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 (in wei) of the pegged asset that each claim is valued at.
asset
Retrieves the address of the ERC20-like token that will be transferred when rewards are 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
The address of the reward asset token that will be transferred when claims are processed.
peg
Retrieves the address of the token that the reward value is pegged to.
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 token that the reward is pegged to.
getIncentiveCriteria
Fetches the IncentiveCriteria struct from the contract. The criteria determines how a claim value will be extracted from a transaction.
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
maxReward
Retrieves the maximum amount that can be claimed at a time, if the amount extracted from the claim transaction given the criteria is more than this value, then the claim value will be this max reward value.
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 reward per claim
limit
Retrieves the spending limit for this incentive. The sum of all claims cannot exceed this amount. Denominated in the asset token.
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 budget for this incentive, denominated in the asset token.