Class Deployable<Payload, ContractAbi>

A generic deployable contract that encapsulates common operations related to contract deployment

Export

Deployable

Template: ContractEvent

Type Parameters

Payload
ContractAbi extends Abi

Hierarchy (view full)

Contract<ContractAbi>
- Deployable

Index

Constructors

constructor

new Deployable<Payload, ContractAbi>(param0, payload?): Deployable<Payload, ContractAbi>
Creates an instance of Deployable.
Type Parameters
- Payload
- ContractAbi extends Abi
Parameters
- param0: DeployableOptions
- Optionalpayload: DeployablePayloadOrAddress<Payload>
Returns Deployable<Payload, ContractAbi>
Overrides Contract.constructor
- Defined in packages/sdk/src/Deployable/Deployable.ts:106

Properties

`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

payload

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

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

account

get account(): undefined | Account
Returns the attached account, if it exists

Returns undefined | Account
- Defined in packages/sdk/src/Deployable/Deployable.ts:135

address

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

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

config

get config(): Config
A getter returning this contract's Wagmi configuration.

Returns Config
Inherited from Contract.config
- Defined in packages/sdk/src/Deployable/Contract.ts:77

Methods

withPayload

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

deploy

deploy(_payload?, _options?, waitParams?): Promise<Deployable<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
- Optional_payload: Payload
- Optional_options: DeployableOptions
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
  See viem.WaitForTransactionReceipt
Returns Promise<Deployable<Payload, ContractAbi>>
Async
- Defined in packages/sdk/src/Deployable/Deployable.ts:164

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
- Defined in packages/sdk/src/Deployable/Deployable.ts:194

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
- Defined in packages/sdk/src/Deployable/Deployable.ts:230

at

at(address): Deployable<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 Deployable<Payload, ContractAbi>
Inherited from Contract.at
- Defined in packages/sdk/src/Deployable/Contract.ts:88

withConfig

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

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 Contract.assertValidAddress
- Defined in packages/sdk/src/Deployable/Contract.ts:112

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 Contract.getLogs
- Defined in packages/sdk/src/Deployable/Contract.ts:142

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 Contract.subscribe
- Defined in packages/sdk/src/Deployable/Contract.ts:197

`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;
}
- Defined in packages/sdk/src/Deployable/Deployable.ts:216

`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
- Defined in packages/sdk/src/Deployable/Deployable.ts:248

`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 Contract.awaitResult
- Defined in packages/sdk/src/Deployable/Contract.ts:233

Class Deployable<Payload, ContractAbi>

Export

Template: ContractEvent

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Deployable<Payload, ContractAbi>

Properties

Readonlyabi

Protected_payload

Protected_config

See

Protected_address

Protected Optional_account

Accessors

payload

Returns undefined | Payload

account

Returns undefined | Account

address

Returns undefined | `0x${string}`

config

Returns Config

Methods

withPayload

Parameters

Returns Deployable<Payload, ContractAbi>

deploy

Parameters

Returns Promise<Deployable<Payload, ContractAbi>>

Async

deployRaw

Parameters

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

Async

Throws

Throws

Throws

buildParameters

Parameters

Returns GenericDeployableParams

at

Parameters

Returns Deployable<Payload, ContractAbi>

withConfig

Parameters

Returns Deployable<Payload, ContractAbi>

assertValidAddress

Returns `0x${string}`

Throws

getLogs

Type Parameters

Parameters

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

Example

subscribe

Type Parameters

Parameters

Parameters

Returns unknown

Returns (() => void)

Returns void

ProtectedoptionallyAttachAccount

Parameters

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

ProtectedvalidateDeploymentConfig

Type Parameters

Parameters

Returns [P, DeployableOptions]

Throws

Throws

ProtectedawaitResult

`Readonly`abi

`Protected`_payload

`Protected`_config

`Protected`_address

`Protected` `Optional`_account

`Protected`optionallyAttachAccount

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

`Protected`validateDeploymentConfig

`Protected`awaitResult