Interface RewardKitBoost

Represents a reward boost in the RewardKit system.

Example

const boost: RewardKitBoost = {
 "id": "11155111:0x378632819f39c74c4f56b1429e760739c5fb51b7:55",
	"chainId": 11155111,
	"incentives": [
   {
     "type": "ERC20Incentive",
     "assetAddress": "0xf3b2d0e4f2d8f453dbcc278b10e88b20d7f19f8d",
     "rewardAmount": "250000000000000000",
     "rewardAmountFormatted": "0.25",
     "rewardUsdValue": 0.2665,
     "tokenSymbol": "STAGING",
     "tokenImageUri": "https://rabbithole-assets.s3.amazonaws.com/unknown_token.png"
	   }
  ],
  status: "active",
  txHash: "0xabcdef1234567890"
};
interface RewardKitBoost {
    id: string;
    chainId: number;
    incentives: {
        type: IncentiveTypeString;
        assetAddress?: `0x${string}`;
        rewardAmount?: string;
        rewardAmountFormatted?: string;
        rewardPercentage?: number;
        maxReward?: string;
        rewardUsdValue?: number;
        tokenSymbol?: string;
        tokenImageUri?: string;
        metadata?:
            | null
            | {
                id: string;
                chainId: number;
                address: `0x${string}`;
                decimals: number;
                name: string;
                symbol: string;
                imageUri: string;
            };
    }[];
    actionTemplate: | null
    | {
        id: string;
        actionType: string;
        projectId: string;
        projectImage?: string;
    };
    boostName?: null
    | string;
    tokenImageUri?: null | string;
    nftImageUri?: null | string;
    nftName?: null | string;
    status?: "active" | "claimable" | "claimed";
    txHash?: string;
    blockTimestamp?: string;
}

Properties

id chainId incentives actionTemplate boostName? tokenImageUri? nftImageUri? nftName? status? txHash? blockTimestamp?

Properties

id

id: string = ...

Unique identifier for the boost

chainId

chainId: number = ...

The blockchain chain ID where the boost exists

incentives

incentives: {
    type: IncentiveTypeString;
    assetAddress?: `0x${string}`;
    rewardAmount?: string;
    rewardAmountFormatted?: string;
    rewardPercentage?: number;
    maxReward?: string;
    rewardUsdValue?: number;
    tokenSymbol?: string;
    tokenImageUri?: string;
    metadata?:
        | null
        | {
            id: string;
            chainId: number;
            address: `0x${string}`;
            decimals: number;
            name: string;
            symbol: string;
            imageUri: string;
        };
}[] = ...

Array of incentives associated with this boost

actionTemplate

actionTemplate:
    | null
    | {
        id: string;
        actionType: string;
        projectId: string;
        projectImage?: string;
    } = ...

OptionalboostName

boostName?: null | string = ...

OptionaltokenImageUri

tokenImageUri?: null | string = ...

OptionalnftImageUri

nftImageUri?: null | string = ...

OptionalnftName

nftName?: null | string = ...

Optionalstatus

status?: "active" | "claimable" | "claimed" = ...

Current status of the boost

OptionaltxHash

txHash?: string = ...

Transaction hash where the boost was created

OptionalblockTimestamp

blockTimestamp?: string = ...

Settings

Member Visibility

On This Page

Properties