Get Boosts
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
API
getBoost
Retrieves a single Boost by ID and instantiate the correct interfaces for all components.
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
A bigint
, or numerical string, or hexadecimal string.
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
Returns the Boost if found. Otherwise, throws BoostNotFoundError
readBoost
Retrieves the raw on-chain representation of a Boost.
Parameters
A bigint
, or numerical string, or hexadecimal string.
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
Returns the Boost if found. Otherwise, throws BoostNotFoundError