Reward Campaigns

Overview

When a protocol wishes to incentivize certain actions by giving tokens as rewards to users, they can create a reward campaign. Campaigns have specific characteristics and parameters that define their behavior and structure.

Campaign Characteristics

• Campaigns run for a defined period, from a start block to an end block.
• A set total amount of rewards is distributed linearly over time.
• Campaign creators must provide the full rewards at the beginning.
• Campaigns can be paused or cancelled, with remaining funds refunded.
• Creators select a distribution bundle and its configuration to determine incentivized actions and other necessary parameters.
• Black lists and white lists can be used to maximize the effectiveness of reward spending.

Campaign Data

Parameter	Type	Description
id	number	Unique identifier for the campaign
liquidityPool	string	Address of the associated liquidity pool
rewardToken	string	Address of the token used for rewards
creator	string	Address of the campaign creator
startBlock	string	Block number at which the campaign starts
endBlock	string	Block number at which the campaign ends
distributionAmount	string	Total amount of tokens to be distributed as rewards
abandonedDeadline	string	Deadline after which the campaign is considered abandoned
cumulativeAllocated	string	Total amount of rewards allocated so far
lastBlockUpdatedTo	number	Last block number the campaign was updated to
paused	boolean	Indicates if the campaign is currently paused
closed	boolean	Indicates if the campaign has been closed
ipfsHash	string	IPFS hash for additional campaign data
chainId	number	ID of the blockchain network the campaign is on
ponderDbIdentifier	string	Identifier for the campaign in the Ponder database
executionBundle	string	Identifier for the distribution bundle used
executionParams	string	Parameters for the execution of the distribution bundle
desc	string	Description of the campaign
created_at	string	Timestamp of when the campaign was created
updated_at	string	Timestamp of the last update to the campaign
campaignEventId	string	Identifier for events associated with the campaign
campaignId	string	Another identifier for the campaign (possibly for cross-referencing)

Creating a Campaign

Coming soon