Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.boost.xyz/llms.txt

Use this file to discover all available pages before exploring further.

The One-Time Actions docs are under active development and will be subject to changes.

Smart Contract

Read the smart contracts

Typedoc

See technical documentation

SDK Implementation

See the source
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 }) })