Interface RewardKitConfig

Configuration interface for RewardKit, controlling reward display filters and display settings

Example

const config: RewardKitConfig = {
  testnetsEnabled: true,
  creatorAddress: "0x123...",
  boostId: "11155111:0x378632819F39C74c4F56B1429E760739c5fb51b7:33",
  budgetAccount: "0xd8f8d805f85518b2aedfe3148135bb6dce352aaf",
  chainId: 11155111,
  targetContract: "0xdcffce9d8185706780a46cf04d9c6b86b3451497",
  tokens: ["7777777:0x777777722d078c97c6ad07d9f36801e653e356ae", "7777777:0x777777722d078c97c6ad07d9f36801e653e356ae:1"],
  onConnectWalletClick: () => void
};
interface RewardKitConfig {
    testnetsEnabled?: boolean;
    creatorAddress?: `0x${string}`;
    boostId?: string;
    budgetAccount?: `0x${string}`;
    chainId?: number;
    targetContract?: `0x${string}`;
    tokens?: (`${number}:0x${string}` | `${number}:0x${string}:${number}`)[];
    onConnectWalletClick?: () => void;
}

Properties

testnetsEnabled? creatorAddress? boostId? budgetAccount? chainId? targetContract? tokens? onConnectWalletClick?

Properties

OptionaltestnetsEnabled

testnetsEnabled?: boolean

Enable testnet networks and staging API access

OptionalcreatorAddress

creatorAddress?: `0x${string}`

The creator address to filter displayed rewards by

OptionalboostId

boostId?: string

The Boost ID to filter rewards by, in format "chainId:address:id"

OptionalbudgetAccount

budgetAccount?: `0x${string}`

Filter to only show offers funded by this budget account

OptionalchainId

chainId?: number

Only show offers with actions that target a contract on this chain ID. You must specify this if also specifying targetContract

OptionaltargetContract

targetContract?: `0x${string}`

Only show offers with actions that target this contract address. If specifying, you must also specify chainId

Optionaltokens

tokens?: (`${number}:0x${string}` | `${number}:0x${string}:${number}`)[]

Only show offers with actions targeting tokens, in the format chainId:address, or chainId:address:tokenId

OptionalonConnectWalletClick

onConnectWalletClick?: () => void

Callback function triggered when user clicks "Connect Wallet" button

Settings

Member Visibility

On This Page

Properties