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. 
await erc20Incentive.reward()

​
Parameters

​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
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

​
Promise<bigint>
bigint
Returns the amount of the asset rewarded per-claim.

​
asset

Retrieves the address of the ERC20-like asset to be rewarded on claim. 
await erc20Incentive.asset();

​
Parameters

​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
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

​
ERC20-like address
Address
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 
await erc20Incentive.strategy();

​
Parameters The total amount of the asset distributed from the budget.

​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
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

​
Promise<StrategyType>
StrategyType
The total amount of the asset distributed from the budget.

​
limit

Retrieves the amount of times this incentive can be claimed. 
await erc20Incentive.limit()

​
Parameters

​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
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

​
Promise<bigint>
bigint
Returns total number of claims that can be made against this incentive.