Skip to main content
The One-Time Actions 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.
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

string | bigint
required
A bigint, or numerical string, or hexadecimal string.
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

Promise<Boost>
required
Returns the Boost if found. Otherwise, throws BoostNotFoundError

readBoost

Retrieves the raw on-chain representation of a Boost.

Parameters

string | bigint
required
A bigint, or numerical string, or hexadecimal string.
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

Promise<Boost>
required
Returns the Boost if found. Otherwise, throws BoostNotFoundError