Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.boost.xyz/llms.txt

Use this file to discover all available pages before exploring further.

The One-Time Actions 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

​
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. 
await erc20VariableIncentive.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 reward multiplier.

​
asset

Retrieves the address of the ERC20-like asset to be rewarded on claim. 
await erc20VariableIncentive.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

​
limit

Retrieves the spending limit for this incentive. The sum of all claims cannot exceed this amount. 
await erc20VariableIncentive.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 the total budget for this incentive