🪙Tokens

This article shows how to get onchainindividual rewards

Fuul simplifies blockchain data for you. We take complex onchain information, clean it up, and present it in a format that's more readable. Projects then can choose to get the data from Fuul's indexed data, or directly from the subgraph.

Fuul's Indexed Data

Payouts for a specific Address

Rewards data is not updated in real time due to performance considerations. Recent conversions and payouts will appear on the leaderboard within a maximum of one hour.

To get the rewards use the getPayoutsLeaderboard method filtered by user address.

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

await Fuul.getPayoutsLeaderboard({ 
    currency_address: '0x12345',
    user_identifier: '0x12345', // the address of the user
    user_identifier_type: 'evm_address', // evm_address | solana_address | xrpl_address 
    from: new Date('2021-01-01'), // Optional
    to: new Date('2022-01-01'), // Optional
    user_type: 'all', // all, affiliate or end_user
    conversions: '1,2,3' // Optional
});

currency_address is the address of the currency on the chain that the project is distributing payouts. Remember projects can payout different tokens for different conversions.

A simple response for retrieving this information would be the following:

{
  "total_results": 100,
  "page": 1,
  "page_size": 10,
  "results": [
    {
      "address": "0xBfBAdD58B65B54D1a5cEa6d9c730fbd57c182d32",
      "total_amount": 200, // Already formatted with the corresponding decimals
      "rank": 1,
      "total_attributions": 10
    },
  ]
}

You can retrieve the tier and the volume information of users by adding them on the fields parameter as follows:

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

await Fuul.getPayoutsLeaderboard({ 
    user_identifier: '0x12345', // the address of the user
    user_identifier_type: 'evm_address', // evm_address | solana_address | xrpl_address 
    fields: 'tier,referred_volume,referred_users'
});

The referred_volume parameter will be returned in USD values.

Payouts for a specific address per conversion

To get all payouts for an address use the getUserPayoutsByConversion method.

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

await Fuul.getUserPayoutsByConversion({ user_identifier: '0x12345',
 user_identifier_type: 'evm_address' });

You can also filter out dates as follows:

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

await Fuul.getUserPayoutsByConversion({
      user_identifier: '0x12345', // the address of the user
      user_identifier_type: 'evm_address', // evm_address | solana_address | xrpl_address 
      from: new Date('2021-01-01'),
      to: new Date('2022-01-01'),
});

Payouts history for a specific address

To get all points history for an address use the getUserPayoutMovements method.

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

await Fuul.getUserPayoutMovements({
      user_identifier: '0x12345', // the address of the user
      user_identifier_type: 'evm_address', // evm_address | solana_address | xrpl_address 
      from: new Date('2021-01-01'), // optional
      to: new Date('2022-01-01'), // optional
});

Fuul Subgraphs

Every payout reward has an onchain record on the project's FuulProject contract. This information can be retrieved from any indexer, but using our aggregated subgraphs makes it much easier.

To get the total, claimed and unclaimed rewards for a specific user and Fuul projects, use the following query.

userBalances(
  where: { 
    owner_contains_nocase: "0x12345", 
    project_: {
      deployedAddress:"0x12345"
    }}
) {
  availableToClaim
  claimed
  currency
  project {
    id
    deployedAddress
  }
}

You can also filter out by currency like this:

userBalances(
  where: { 
    owner_contains_nocase: "0x12345", 
    currency_contains: "0x0000000000000000000000000000000000000000",
    project_: {
      deployedAddress:"0x12345"
    }}
) {
  availableToClaim
  claimed
  currency
  project {
    id
    deployedAddress
  }
}

Please visit the Subgraph section of the documentation to get the endpoints and know more about the schema