Boost Docs

Documentation

API Reference

SDK Docs

Boost API

Reward Kit

boost.xyz

Support

Introduction to Boost V2

Understanding the vision and rationale behind Boost

Why We Built Boost

Redefining Network Participation and Ownership

The Vision of Boost

Explore the new features and improvements in Boost V2

What's New in V2

Guide on how budget accounts work in Boost V2

Budget Accounts

Step-by-step guide on how to deploy new Boost incentive programs

Deploying Boosts

Understanding the basics of selecting actions for your Boost

Introduction to Action Selection

Learn how to interpret transaction data on Etherscan for Boost actions

Understanding Etherscan Data

How to use Etherscan data to configure your Boost actions

Setting Up Boost Actions

Advanced strategies for creating more complex and targeted Boost actions

Advanced Action Selection Techniques

Overview of the tokens supported for rewards in Boost V2

Tokens Supported

Effective approaches to distribute rewards in Boost V2

Strategies for Reward Distribution

Managing and optimizing your reward budget in Boost V2

An overview of the Boost V2 core protocol architecture and its components

Boost V2 Core Protocol Architecture

A comprehensive comparison of Boost V2 and Boost V1 features and architecture

Boost V2 vs. Boost V1

A comprehensive guide to help developers migrate their applications from Boost V1 to V2

Boost V2 Integration Overview

Learn how to set up and manage your budget account - a prerequisite for deploying Boosts in V2

Setting Up a Budget Account

Learn how to deploy boosts in V2 using either the Deploy Flow UI or Boost SDK

Learn how to fetch and query boost information in V2

Fetching Boosts

Learn how to extract and link data from action steps to external sources

Extracting Data from Action Steps

Learn how to implement boost claiming functionality in V2

Claiming Boosts

Learn how to check if a user has claimed a boost's incentives

Checking Claim Status

Learn how to check if a boost is still active and can be claimed

Checking Boost Status

Learn how to withdraw remaining rewards from a boost using the UI or SDK

Withdrawing from Boosts

Overview of deployed contract addresses across all supported networks

Deployed Contracts

Boost SDK

Easily integrate Boost functionality into your application

Boost API Reference

Joining the Boost Community

Answers to frequently asked questions about Boost

Frequently Asked Questions

Introduction

What is a Boost?

How It Works

An overview of the Boost Protocol and ecosystem

Boost Protocol

Boost Manager

Boost Clients

Attribution System

Protocol Fees & Rewards

Affiliate Referrals

Boost Guild Treasury

How to Add Your Project to the Boost Registry

How to Deploy a Boost

How to Add a Token to the Whitelist

Learn how to integrate Boost Protocol into your Rollup

Integration Guide for Rollups

How to sign in to Boost using Sign-In with Ethereum

Sign in to Boost

How to create a boost using the Boost API

Create a Boost

How to query all Boosts with various filters

Fetch Boosts

Claim a Boost

Download the OpenAPI JSON specification for the Boost API

OpenAPI JSON File

Interacting directly with Boosts in Node and the Browser

Overview

Installation

Quick Start

Usage With React

Learn how to get logs and listen for new events emitted by the protocol

Working with Events

How to add your contracts' function and event signatures into Boost's well-known registry

Integrating your Protocol or DApp

Learn how to retrieve assets from a budget or incentive

Asset Retrieval

Protocol Fees

Learn how to reward users with ERC20 rewards when they mint an NFT on Zora.

Boost an NFT Mint on Zora

Learn how to reward users with ERC20 rewards when they vote for/against a specific proposal

Boost a Vote on Agora

Claim Rewards from a Boost

Learn how to deploy a Boost using the Boost SDK

Deploy a Boost

Learn about the role the Registry plays in the SDK

Initializing Components

Cloned Components

Learn about how to use the Boost Core contract with the SDK

Get Boosts

Claiming Incentives

Learn about how to interact with the Managed Budget using the SDK

Authorization

Funding

Retrieval

How to query for Boosts using various filters

Boost Details

How to retrieve the claim history for a specific boost

Boost Activity

How to retrieve a signature required for claiming boost incentives

Get Claim Signature

Learn about how to interact with an ERC20Incentive using the SDK

Retrieve information about ERC20 Incentive rewards

Rewards

Retrieve ERC20 Incentive claim information and draw raffle

Claims

Learn about how to interact with an ERC20PeggedIncentive using the SDK

Retrieve ERC20PeggedIncentive claim information

Learn about how to interact with an ERC20Variable Incentive using the SDK

Learn about how to interact with an ERC20 Variable Criteria Incentive using the SDK

Learn about how to interact with an ERC20PeggedVariableCriteriaIncentive using the SDK

Learn about how to interact with a Continuous Gradual Dutch Auction Incentive using the SDK

Download the OpenAPI JSON specification for the Boost V2 API

Empower your React application with simple reward distribution powered by Boost

RewardKitProvider

Customizable component to trigger RewardKit UI

RewardKitButton

Headless component system for displaying Reward information

Reward

Configure, style, and manipulate the RewardKit UI

useRewardKit

Retrieve count of claimable Boosts for an address.

useClaimableBoostsCount

useClaimIncentives

Get signatures that can be used to claim rewards

useClaimSignatures

useRewardKitBalances

Get details about a single RewardKit Boost

useRewardKitBoost

Fetch Boosts for given RewardKit configuration

useRewardKitBoosts

Fetch active, claimable, and claimed Boosts

useRewardKitProfile

useTokenBalances

Retrieve event or function signatures, human readable signature and their ABI which can be used when configuring Boost Actions.

Find event and function signatures used in Boost configurations

Given a tx hash, id, and valid claim data hash, generate a valid signature that can be used to claim a reward on chain.

Generate a claim signature that can be used to submit a claim

Discover Boosts with the most claim activity, along with their action and incentive configurations, and total USD distributed.

Explore contracts with Boosts

Accepts pagination, and filter options to return a list of boosts

Get a list of Boosts

Get events for a specific Boost

Return detailed information about a Boost, including budget, allowlist, incentives, actions, and token metadata

Get details for a Boost

Retrieve detailed information about a Budget Account, including contract address, chain ID, owner address, label, and members if applicable.

Retrieve a single Budget by its system ID

Accepts pagination, and filter options like owner address, chain ID, and permissioned member address.

Get Budgets

Query Dune for user transaction that can generate a valid claim signature

Try to get claim signature without known transaction

Accepts pagination, and filter options to return a list of rewards

Get a list of reward kit rewards

Accepts pagination, and filter options to return a list of active, claimable, and unclaimed rewards for a given user.

Get a user's RewardKit profile

Retrieve details on a reward, optionally providing a claimant address to decorate with additional claim context.

Get a single RewardKit reward

Returns all known Action Templates that can aid in initializing new Boost Actions and Incentives, with information about project smart contract deployments, event and function signatures, claimant configuration information, and placeholder reward configuration.

Get all Action Templates

Returns an Action Template by actionTemplateId

Get an Action Template by actionTemplateId

Find information on contracts used to interact with Boosts, as well as total claims, total USD claimed, address, and chain ID

auth

manager

metrics

accesslists

boosts

users

inboxes

Boost details