Creates an instance of DeployableTarget.
Either a given implementation's initialization payload, or an address to an existing on chain target.
OptionalisBase: booleanA property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.
StaticbaseA static property representing the address of the base implementation on chain, used when cloning base contracts.
StaticregistryThe target's registry type.
ReadonlyabiProtected Readonly_isA property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.
Protected_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 the base implementation's static address
A getter that returns the registry type of the base implementation
A getter returning this contract's deployed address, if it exists.
Gets a specific action event by index
The index of the action event to retrieve
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Gets all action events
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Gets the count of action events
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Retrieves the payload describing how claimants can be identified from logs or function calls.
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Executes a prepared event action
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Executes a prepared event action
Optionalparams: Partial<Omit<WriteContractParameters<readonly [{ Retrieves action steps, and uses them to validate against, and optionally fetch logs that match the step's signature.
If logs are provided in the optional params argument, then those logs will be used instead of fetched with the configured client.
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Validates a single action step with a given criteria against logs.
If logs are provided in the optional params argument, then those logs will be used instead of fetched with the configured client.
Optionalparams: Partial<Omit<GetLogsParameters<AbiEvent, [AbiEvent]>, "address">> & { Validates a Log against a given criteria.
The criteria to validate against.
The Viem event log.
Base 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: EventActionPayloadOptional_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.
Optionalpayload: EventActionPayloadOptionaloptions: 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: EventActionPayloadOptional_options: DeployableOptionsCheck if the contract supports the given interface
The interface identifier
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Return a cloneable's unique identifier for downstream consumers to differentiate various targets All implementations must override this function
Optionalparams: Partial<Omit<ReadContractParameters<readonly [{ Attaches a new payload for use with this deployable's initialization
Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.
Will 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 [{ ProtectedvalidateProtectedInternal method used to ensure that a Wagmi configuration and payload are always present when deploying.
Optional_payload: POptional_options: DeployableOptionsProtectedoptionallyProtectedawaitProtectedOptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
A generic event action
Export
EventAction