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 Incentive is designed to store and distribute assets that can be claimed by users. The Boost SDK provides several methods to retrieve information about claim state, as well as drawing raffles.

​
API

​
claims

Retrieves the total number of completed claims. 
await cgdaIncentive.claims();

​
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

​
Total claims
Promise<bigint>
Returns the total number of claims.

​
claimed

Checks if an address has previously claimed this incentive. 
await cgdaIncentive.claimed(address);

​
Parameters

​
address
Address
The address to check claimed status.
​
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

​
Has claimed
Promise<boolean>
Returns true if address has claimed the incentive.

​
isClaimable

Check if an incentive is claimable by an address. Will return false if the recipient has already claimed, or incentive does not have the balance to cover the current reward. 
await cgdaIncentive.isClaimable(address);

​
Parameters

​
address
Address
The address to check eligibility for.
​
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

​
Eligibility
Promise<boolean>
Returns true if address can claim incentive.