Rewards
Retrieve information about ERC20 Incentive rewards
The Boost V2 Docs are under active development and will be subject to changes.
The ERC20 Variable Incentive is designed to store and distribute dynamic amounts of assets that can be claimed by users. The Boost SDK provides several methods to retrieve information about the current state of its rewards.
API
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
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
reward
Retrieves the ETH decimal format reward multiplier. If set to 0n or 1 ether, user will be transferred the whole amount asserted at claim time.
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 reward multiplier.
limit
Retrieves the spending limit for this incentive. The sum of all claims cannot exceed this amount.
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