The Boost V2 Docs are under active development and will be subject to changes.

​
API

​
getBoost

Retrieves a single Boost by ID and instantiate the correct interfaces for all components.

const boost = await core.getBoost(1n)
// You can also supply a numerical string, or hexadecimal representation
const boost = await core.getBoost(
  "1" // or "0x1"
)

// Afterwards, all components will be constructed with their correct interfaces
assert(boost.budget instanceof ManagedBudget)

This method also executes several read calls to ascertain the correct Boost component interfaces. If you’d like to save on calls, use core.readBoost instead, which returns the raw on-chain representation with component addresses instead of instantiated classes.

​
Parameters

​
id
string | bigint
required

A bigint, or numerical string, or hexadecimal string.

​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>

Optional parameters to pass to the underlying readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.

​
Returns

​
boost
Promise<Boost>
required

Returns the Boost if found. Otherwise, throws BoostNotFoundError

​
readBoost

Retrieves the raw on-chain representation of a Boost.

const boost = await core.readBoost(1n)
// You can also supply a numerical string, or hexadecimal representation
const boost = await core.readBoost(
  "1" // or "0x1"
)
// All fields and components are primitives
assert(isAddress(boost.budget))
const budget = await budgetFromAddress(boost.budget)
assert(budget instanceof ManagedBudget)

​
Parameters

​
id
string | bigint
required

A bigint, or numerical string, or hexadecimal string.

​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>

Optional parameters to pass to the underlying readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.

​
Returns

​
boost
Promise<Boost>
required

Returns the Boost if found. Otherwise, throws BoostNotFoundError

OverviewClaiming Incentives