Building an Incentives Explorer

This documentation outlines the process of building an Incentives Explorer

Building an Incentives involves two steps:

1. Getting the incentives

2. Getting incentive information.

3. Getting user rewards

1. Getting the Incentives

The first step in building an Incentive Explorer is to retrieve a list of available incentives.

You can filter by the paying network (where the rewards will be paid) or by the triggers network (where the conversion action takes place).

To display all incentives available use the getExplorerIncentiveRewards method.

import { Fuul } from ('@fuul/sdk');

await Fuul.getExplorerIncentiveRewards({ trigger_chain_id: '1' });

You will receive information for each conversion, which you can choose to use to build a table of incentives.

2. Getting Incentive Information

Here's how you will get the information for a specific conversion.

Retrieving conversion setup

To get the conversion setup use the getRewardDetails method.

import { Fuul } from ('@fuul/sdk');

await Fuul.getRewardDetails(
    {
        type: 'incentive',
        projectId: 'PROJECT_ID',
        conversion_external_id: 'CONVERSION_EXTERNAL_ID'
    });

The PROJECT_ID and CONVERSION_EXTERNAL_ID variables are available programmatically from the response in step 1.

Getting Project budgets

Project budgets are available on Fuul's subgraphs.

Please check this guide on how to get a Project's program budget. The FuulProject deployed contract for the program is available from the response in step 1.

3. Getting user rewards

User rewards are available on Fuul's subgraphs.

Please check this guide on how to get users rewards.

You can either get all rewards for the user or filter it by project. The FuulProject deployed contract for the program is available from the response in step 1.