API
claimIncentive
Claims one incentive from a boost. Must be called by claimant.
To learn how to encode the
claimDataPayload, see the full Claim Example.Parameters
bigint
required
A
bigint representing the boost ID.bigint
required
A
bigint representing the incentive ID. The incentive ID is the index of the incentive in the incentives array.string
required
An address representing the claimant of the incentive.
string
required
A hexadecimal string containing the encoded claim data payload.
Omit<wagmi.WriteContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
writeContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Promise<void>
claimIncentiveFor
Claim an incentive for a Boost on behalf of another user.
To learn how to encode the
claimDataPayload, see the full Claim Example.Parameters
bigint
required
A
bigint representing the boost ID.bigint
required
A
bigint representing the incentive ID. The incentive ID is the index of the incentive in the incentives array.string
required
The address of the referrer (if any). Use zero address if no referrer.
string
required
A hexadecimal string containing the encoded claim data payload.
string
required
The address of the user eligible for the incentive payout
Omit<wagmi.WriteContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying
writeContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.Returns
Promise<void>