Creates an instance of BoostCore.
Static ReadonlyaddressesA static property representing a map of stringified chain ID's to the address of the deployed implementation on chain
ReadonlyabiProtected_payloadThe deployable payload used either for contract construction or initialization
Protected_configProtected_addressThe internally managed address for this contract
Protected Optional_accountIf it exists, Viem Local Account, if in a Node environment
A getter that will return Boost core's static addresses by numerical chain ID
A getter returning this contract's deployed address, if it exists.
Create a new Boost.
Optional_params: Partial<Omit<WriteContractParameters<readonly [{ Returns a simulated Boost creation.
Optional_params: Partial<Omit<WriteContractParameters<readonly [{ Claims one incentive from a given Boost by boostId and incentiveId
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Claim an incentive for a Boost
The ID of the Boost
The ID of the Incentive
The address of the referrer (if any)
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Claims one incentive for a given Boost on behalf of another user by boostId and incentiveId
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Claim an incentive for a Boost on behalf of another user
The ID of the Boost
The ID of the Incentive
The address of the referrer (if any)
The data for the claim
The address of the user eligible for the incentive payout
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Get a Boost by index, will return the raw on chain representation of a Boost.
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Get a Boost by index, will return a new Boost with correct target implementations instantiated, ie (await core.getBoost(0n)).allowList instanceof SimpleAllowList vs SimpleDenyList
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Retrieve the total number of deployed Boosts
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Checks if an address is authorized
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Retrieve the address of the current creation auth provider.
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Replace the current auth scheme.
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Set the createBoostAuth address
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Get the protocol fee.
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Get the protocol fee receiver.
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Set the protocol fee receiver address. This function is only callable by the owner.
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Set the protocol fee receiver address. This function is only callable by the owner.
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Retrieves the claim information from a transaction receipt.
The parameters required to get the transaction receipt.
The hash of the transaction.
OptionalchainThe claim information if found, undefined otherwise.
This method retrieves the transaction receipt using the provided parameters, then parses the logs to find the 'BoostClaimed' event. If found, it returns the arguments of the event, which include the boost ID, incentive ID, claimer address, and claimed amount.
const claimInfo = await boostCore.getClaimFromTransaction({
hash: '0x...',
chainId: 1
});
if (claimInfo) {
console.log(`Boost ${claimInfo.boostId} claimed by ${claimInfo.claimer}`);
}
Bound PassthroughAuth constructor that reuses the same configuration as the Boost Core instance.
Optionaladdress: `0x${string}`Bound EventAction constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBound OpenAllowList constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBound SimpleAllowList constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBound SimpleDenyList constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBound ManagedBudget constructor that reuses the same configuration as the Boost Core instance.
Bound AllowListIncentive constructor that reuses the same configuration as the Boost Core instance.
Bound CGDAIncentive constructor that reuses the same configuration as the Boost Core instance.
Bound ERC20Incentive constructor that reuses the same configuration as the Boost Core instance.
Bound PointsIncentive constructor that reuses the same configuration as the Boost Core instance.
Bound SignerValidator constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBound LimitedSignerValidator constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBound ERC20VariableCriteriaIncentive constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBound ERC20VariableIncentive constructor that reuses the same configuration as the Boost Core instance.
OptionalisBase: booleanBase parameter constructor, should return a partial viem.deployContract parameters shape including abi, bytecode, and arguments, if any.
Expected to be overridden by protocol contracts.
Optional_payload: [`0x${string}`, `0x${string}`]Optional_options: DeployableOptionsHigh level deployment function to deploy and await the contract address.
This is mainly a convenience method to easily deploy a contract, but will not initialize a Cloneable,
which makes it useless for Boost components.
Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
Optional_payload: [`0x${string}`, `0x${string}`]Optional_options: DeployableOptionsOptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">The lower level contract deployment function that does not await for the transaction receipt.
This is mainly a convenience method to easily deploy a contract, but will not initialize a Cloneable,
which makes it useless for Boost components.
Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
Optional_payload: [`0x${string}`, `0x${string}`]Optional_options: DeployableOptionsWill set this contract's internal Wagmi Configuration and return the instance for chaining.
Utility function to validate the existence of an address on this Contract.
ContractAddressRequiredError if no address exists on this Contract instance
A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs].
Accepts eventName and eventNames as optional parameters to narrow the returned log types.
Optionalparams: Omit<GetLogsParams<readonly [{ const logs = contract.getLogs({ eventName: 'EventName' })
const logs = contract.getLogs({ eventNames: ['EventName'] })
@public
@async
@template {ContractEvent} event
@template {ExtractAbiEvent<
ContractAbi,
event
>} [abiEvent=ExtractAbiEvent<ContractAbi, event>]
@param {?Omit<
GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,
'event' | 'events'
> & {
eventName?: event;
eventNames?: event[];
}} [params]
@returns {Promise<GetLogsReturnType<abiEvent, abiEvent
A typed wrapper for wagmi.watchContractEvent
Optionalparams: Partial<Omit<UnionCompute<WatchContractEventParameters<readonly [{ ProtectedoptionallyProtectedvalidateProtectedInternal method used to ensure that a Wagmi configuration and payload are always present when deploying.
Optional_payload: POptional_options: DeployableOptionsProtectedawaitProtectedOptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
The core contract for the Boost protocol. Used to create and retrieve deployed Boosts.
Export
BoostCore