Class DeployableTarget<Payload, ContractAbi>

A base class representing a generic base Boost Protocol target contract, extended by Actions, AllowLists, Budgets, Incentives, and Validators.

Export

DeployableTarget

Type Parameters

Payload
ContractAbi extends Abi

Hierarchy (view full)

Deployable<Payload, ContractAbi>
- DeployableTarget

Index

Constructors

constructor

new DeployableTarget<Payload, ContractAbi>(options, payload?, isBase?): DeployableTarget<Payload, ContractAbi>
Creates an instance of DeployableTarget.
Type Parameters
- Payload
- ContractAbi extends Abi
Parameters
- options: DeployableOptions
- Optionalpayload: DeployablePayloadOrAddress<Payload>
  Either a given implementation's initialization payload, or an address to an existing on chain target.
- OptionalisBase: boolean
  A 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.
Returns DeployableTarget<Payload, ContractAbi>
Overrides Deployable.constructor
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:84

Properties

`Static` `Readonly`bases

bases: Record<number, `0x${string}`> = {}

A static property representing a map of stringified chain ID's to the address of the base implementation on chain, used when cloning base contracts.

Static

`Static` `Readonly`registryType

registryType: RegistryType = RegistryType.ACTION

The target's registry type.

Static

`Readonly`_isBase

_isBase: boolean = true

A 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.

`Readonly`abi

abi: ContractAbi

`Protected`_payload

_payload: undefined | Payload

The deployable payload used either for contract construction or initialization

`Protected`_config

_config: Config

See

Wagmi Configuration

`Protected`_address

_address: undefined | `0x${string}`

The internally managed address for this contract

`Protected` `Optional`_account

_account?: Account

If it exists, Viem Local Account, if in a Node environment

Accessors

isBase

get isBase(): boolean
Returns boolean
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:64

bases

get bases(): Record<number, `0x${string}`>
A getter that will return the base implementation's static addresses by numerical chain ID

Returns Record<number, `0x${string}`>
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:111

registryType

get registryType(): RegistryType
A getter that returns the registry type of the base implementation

Returns RegistryType
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:122

payload

get payload(): undefined | Payload
Returns the attached deployable payload, if it exists

Returns undefined | Payload
Inherited from Deployable.payload
- Defined in packages/sdk/src/Deployable/Deployable.ts:125

address

get address(): undefined | `0x${string}`
A getter returning this contract's deployed address, if it exists.

Returns undefined | `0x${string}`
Inherited from Deployable.address
- Defined in packages/sdk/src/Deployable/Contract.ts:66

Methods

deploy

deploy(payload?, options?, waitParams?): Promise<DeployableTarget<Payload, ContractAbi>>
High 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.
Parameters
- Optionalpayload: Payload
- Optionaloptions: DeployableOptions
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
Returns Promise<DeployableTarget<Payload, ContractAbi>>
Async
Overrides Deployable.deploy
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:136

deployRaw

deployRaw(_payload?, _options?): Promise<`0x${string}`>
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.
Parameters
- Optional_payload: Payload
- Optional_options: DeployableOptions
Returns Promise<`0x${string}`>
Async
Throws
DeployableAlreadyDeployedError

Throws
DeployableWagmiConfigurationRequiredError

Throws
DeployableMissingPayloadError
Overrides Deployable.deployRaw
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:155

supportsInterface

supportsInterface(interfaceId, params?): Promise<boolean>
Check if the contract supports the given interface
Parameters
- interfaceId: `0x${string}`
  The interface identifier
- Optionalparams: Partial<Omit<ReadContractParameters<readonly [{
      type: "error";
      inputs: readonly [];
      name: "CloneAlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InitializerNotImplemented";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitialization";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitializationData";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotInitializing";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "version";
          internalType: "uint64";
          type: "uint64";
          indexed: false;
      }];
      name: "Initialized";
  }, {
      type: "function";
      inputs: readonly [];
      name: "getComponentInterface";
      outputs: readonly [{
          name: "";
          internalType: "bytes4";
          type: "bytes4";
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "initialize";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "interfaceId";
          internalType: "bytes4";
          type: "bytes4";
      }];
      name: "supportsInterface";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }], "supportsInterface">,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
- True if the contract supports the interface
Async
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:180

getComponentInterface

getComponentInterface(params?): Promise<`0x${string}`>
Return a cloneable's unique identifier for downstream consumers to differentiate various targets All implementations must override this function
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters<readonly [{
      type: "error";
      inputs: readonly [];
      name: "CloneAlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InitializerNotImplemented";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitialization";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitializationData";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotInitializing";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "version";
          internalType: "uint64";
          type: "uint64";
          indexed: false;
      }];
      name: "Initialized";
  }, {
      type: "function";
      inputs: readonly [];
      name: "getComponentInterface";
      outputs: readonly [{
          name: "";
          internalType: "bytes4";
          type: "bytes4";
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "initialize";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "interfaceId";
          internalType: "bytes4";
          type: "bytes4";
      }];
      name: "supportsInterface";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }], "getComponentInterface">,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
Async
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:202

withPayload

withPayload(payload): DeployableTarget<Payload, ContractAbi>
Attaches a new payload for use with this deployable's initialization
Parameters
- payload: Payload
Returns DeployableTarget<Payload, ContractAbi>
Inherited from Deployable.withPayload
- Defined in packages/sdk/src/Deployable/Deployable.ts:136

buildParameters

buildParameters(_payload?, _options?): GenericDeployableParams
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.
Parameters
- Optional_payload: Payload
- Optional_options: DeployableOptions
Returns GenericDeployableParams
Inherited from Deployable.buildParameters
- Defined in packages/sdk/src/Deployable/Deployable.ts:220

at

at(address): DeployableTarget<Payload, ContractAbi>
Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.
Parameters
- address: `0x${string}`
Returns DeployableTarget<Payload, ContractAbi>
Inherited from Deployable.at
- Defined in packages/sdk/src/Deployable/Contract.ts:77

withConfig

withConfig(config): DeployableTarget<Payload, ContractAbi>
Will set this contract's internal Wagmi Configuration and return the instance for chaining.
Parameters
- config: Config
Returns DeployableTarget<Payload, ContractAbi>
Inherited from Deployable.withConfig
- Defined in packages/sdk/src/Deployable/Contract.ts:89

assertValidAddress

assertValidAddress(): `0x${string}`
Utility function to validate the existence of an address on this Contract.

Returns `0x${string}`
Throws
ContractAddressRequiredError if no address exists on this Contract instance
Inherited from Deployable.assertValidAddress
- Defined in packages/sdk/src/Deployable/Contract.ts:101

getLogs

getLogs<event, const abiEvent>(params?): Promise<GetLogsReturnType<abiEvent, abiEvent[]>>
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.
Type Parameters
- event extends string
- const abiEvent extends {
      name: event;
  } & AbiEvent = Extract<Extract<ContractAbi[number], {
      type: "event";
  }>, {
      name: event;
  }>
Parameters
- Optionalparams: Omit<GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>, "event" | "events"> & {
  eventName?: event;
  eventNames?: event[];
  }
Returns Promise<GetLogsReturnType<abiEvent, abiEvent[]>>
Example
```
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
```
Inherited from Deployable.getLogs
- Defined in packages/sdk/src/Deployable/Contract.ts:131

subscribe<event>(cb, params?): (() => void)
A typed wrapper for wagmi.watchContractEvent
Type Parameters
- event extends string
Parameters
- cb: ((log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number]) => unknown)
  - - (log): unknown
    - Parameters
      log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number]
      Returns unknown
- Optionalparams: Partial<Omit<UnionCompute<WatchContractEventParameters<ContractAbi, event, undefined, WebSocketTransport> & ChainIdParameter<Config, number> & SyncConnectedChainParameter>, "address" | "abi">> & {
  eventName?: event;
  }
Returns (() => void)
- - (): void
  - Returns void
Inherited from Deployable.subscribe
- Defined in packages/sdk/src/Deployable/Contract.ts:186

`Protected`validateDeploymentConfig

validateDeploymentConfig<P>(_payload?, _options?): [P, DeployableOptions]
Protected
Internal method used to ensure that a Wagmi configuration and payload are always present when deploying.
Type Parameters
- P = Payload
Parameters
- Optional_payload: P
- Optional_options: DeployableOptions
Returns [P, DeployableOptions]
Throws
DeployableWagmiConfigurationRequiredError

Throws
DeployableMissingPayloadError
Overrides Deployable.validateDeploymentConfig
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:223

`Protected`optionallyAttachAccount

optionallyAttachAccount(account?): {
account: Account;
} | {
account: undefined;
}
Protected
Internal function to attach the connected account to write methods to avoid manually passing in an account each call.
Parameters
- Optionalaccount: Account
Returns {
account: Account;
} | {
account: undefined;
}
Inherited from Deployable.optionallyAttachAccount
- Defined in packages/sdk/src/Deployable/Deployable.ts:206

`Protected`awaitResult

awaitResult<Result>(hashPromise, waitParams?): Promise<Result>
Protected
Type Parameters
- Result = unknown
Parameters
- hashPromise: Promise<HashAndSimulatedResult<Result>>
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
Returns Promise<Result>
See
awaitResult

Async
Inherited from Deployable.awaitResult
- Defined in packages/sdk/src/Deployable/Contract.ts:222

Class DeployableTarget<Payload, ContractAbi>

Export

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DeployableTarget<Payload, ContractAbi>

Properties

Static Readonlybases

Static

Static ReadonlyregistryType

Static

Readonly_isBase

Readonlyabi

Protected_payload

Protected_config

See

Protected_address

Protected Optional_account

Accessors

isBase

Returns boolean

bases

Returns Record<number, `0x${string}`>

registryType

Returns RegistryType

payload

Returns undefined | Payload

address

Returns undefined | `0x${string}`

Methods

deploy

Parameters

Returns Promise<DeployableTarget<Payload, ContractAbi>>

Async

deployRaw

Parameters

Returns Promise<`0x${string}`>

Async

Throws

Throws

Throws

supportsInterface

Parameters

Returns Promise<boolean>

Async

getComponentInterface

Parameters

Returns Promise<`0x${string}`>

Async

withPayload

Parameters

Returns DeployableTarget<Payload, ContractAbi>

buildParameters

Parameters

Returns GenericDeployableParams

at

Parameters

Returns DeployableTarget<Payload, ContractAbi>

withConfig

Parameters

Returns DeployableTarget<Payload, ContractAbi>

assertValidAddress

Returns `0x${string}`

Throws

getLogs

Type Parameters

Parameters

Returns Promise<GetLogsReturnType<abiEvent, abiEvent[]>>

Example

subscribe

Type Parameters

Parameters

`Static` `Readonly`bases

`Static` `Readonly`registryType

`Readonly`_isBase

`Readonly`abi

`Protected`_payload

`Protected`_config

`Protected`_address

`Protected` `Optional`_account

`Protected`validateDeploymentConfig

`Protected`optionallyAttachAccount

Returns {
account: Account;
} | {
account: undefined;
}

`Protected`awaitResult