Under Construction The V2 Protocol, SDK, and these docs are under active development. You can find the latest testnet deployments here

In prerelease Currently the SDK and protocol only support Sepolia. Public API’s are stable, but could still change before our initial release. If you experience any bugs, please open a Github issue

The Boost Core contract is the protocol’s main touchpoint for Boosts, exposing functionality to create and retrieve Boosts, and claim incentives.

Unless you’re an advanced user, you will likely never need to deploy your own core contract. The SDK comes preconfigured with the correct contract addresses for all deployed core implementations.

Usage

import { BoostCore } from '@boostxyz/sdk/BoostCore'
// you can also access BoostCore from the root export
import { BoostCore } from '@boostxyz/sdk'

// Basic instantiation
const core = new BoostCore({ config: wagmiConfig })

// In Node, you'll need to supply a viem local account https://viem.sh/docs/accounts/local.html
const core = new BoostCore({ config: wagmiConfig, ...(!!account && { account: viemLocalAccount }) })