@fuel-ts/contract v0.94.1 • Docs

---

Class: ContractFactory

ContractFactory provides utilities for deploying and configuring contracts.

Constructors

new ContractFactory()

new ContractFactory(bytecode, abi, accountOrProvider): ContractFactory

Create a ContractFactory instance.

Parameters

Parameter	Type	Default value	Description
bytecode	BytesLike	undefined	The bytecode of the contract.
abi	Interface | JsonAbi	undefined	The contract's ABI (Application Binary Interface).
accountOrProvider	null | Provider | Account	null	An account or provider to be associated with the factory.

Returns

ContractFactory

Defined in

packages/contract/src/contract-factory.ts:68

Properties

Property	Type	Defined in
account	null | Account	packages/contract/src/contract-factory.ts:59
bytecode	BytesLike	packages/contract/src/contract-factory.ts:56
interface	Interface	packages/contract/src/contract-factory.ts:57
provider	null | Provider	packages/contract/src/contract-factory.ts:58

Methods

connect()

connect(provider): ContractFactory

Connect the factory to a provider.

Parameters

Parameter	Type	Description
provider	Provider	The provider to be associated with the factory.

Returns

ContractFactory

A new ContractFactory instance.

Defined in

packages/contract/src/contract-factory.ts:110

---

createTransactionRequest()

createTransactionRequest(deployOptions?): object

Create a transaction request to deploy a contract with the specified options.

Parameters

Parameter	Type	Description
deployOptions?	object & CreateTransactionRequestLike & object	Options for deploying the contract.

Returns

object

The CreateTransactionRequest object for deploying the contract.

Name	Type	Defined in
contractId	string	packages/contract/src/contract-factory.ts:152
transactionRequest	CreateTransactionRequest	packages/contract/src/contract-factory.ts:153

Defined in

packages/contract/src/contract-factory.ts:120

---

deploy()

deploy<TContract>(deployOptions): Promise<DeployContractResult<TContract>>

Deploy a contract of any length with the specified options.

Type Parameters

Type Parameter	Default type
TContract extends Contract	Contract

Parameters

Parameter	Type	Description
deployOptions	DeployContractOptions	Options for deploying the contract.

Returns

Promise<DeployContractResult<TContract>>

A promise that resolves to the deployed contract instance.

Defined in

packages/contract/src/contract-factory.ts:195

---

deployAsBlobTx()

deployAsBlobTx<TContract>(deployOptions): Promise<DeployContractResult<TContract>>

Chunks and deploys a contract via a loader contract. Suitable for deploying contracts larger than the max contract size.

Type Parameters

Type Parameter	Default type
TContract extends Contract	Contract

Parameters

Parameter	Type	Description
deployOptions	DeployContractOptions	Options for deploying the contract.

Returns

Promise<DeployContractResult<TContract>>

A promise that resolves to the deployed contract instance.

Defined in

packages/contract/src/contract-factory.ts:251

---

deployAsCreateTx()

deployAsCreateTx<TContract>(deployOptions): Promise<DeployContractResult<TContract>>

Deploy a contract with the specified options.

Type Parameters

Type Parameter	Default type
TContract extends Contract	Contract

Parameters

Parameter	Type	Description
deployOptions	DeployContractOptions	Options for deploying the contract.

Returns

Promise<DeployContractResult<TContract>>

A promise that resolves to the deployed contract instance.

Defined in

packages/contract/src/contract-factory.ts:213

---

setConfigurableConstants()

setConfigurableConstants(configurableConstants): void

Set configurable constants of the contract with the specified values.

Parameters

Parameter	Type	Description
configurableConstants	object	An object containing configurable names and their values.

Returns

void

Defined in

packages/contract/src/contract-factory.ts:377