The Boost V2 Docs are under active development and will be subject to changes.
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.
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.
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
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