Class: ContractFactory
@fuel-ts/contract.ContractFactory
ContractFactory provides utilities for deploying and configuring contracts.
Constructors
constructor
• new ContractFactory(bytecode, abi, accountOrProvider?): ContractFactory
Create a ContractFactory instance.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
bytecode | BytesLike | undefined | The bytecode of the contract. |
abi | JsonAbi | 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
Defined in
contract-factory.ts:60
Properties
account
• account: null | Account
Defined in
contract-factory.ts:51
bytecode
• bytecode: BytesLike
Defined in
contract-factory.ts:48
interface
• interface: Interface<JsonAbi>
Defined in
contract-factory.ts:49
provider
• provider: null | Provider
Defined in
contract-factory.ts:50
Methods
connect
▸ connect(provider): ContractFactory
Connect the factory to a provider.
Parameters
| Name | Type | Description |
|---|---|---|
provider | Provider | The provider to be associated with the factory. |
Returns
A new ContractFactory instance.
Defined in
contract-factory.ts:102
createTransactionRequest
▸ createTransactionRequest(deployOptions?): Object
Create a transaction request to deploy a contract with the specified options.
Parameters
| Name | Type | Description |
|---|---|---|
deployOptions? | DeployContractOptions | Options for deploying the contract. |
Returns
Object
The CreateTransactionRequest object for deploying the contract.
| Name | Type |
|---|---|
contractId | string |
transactionRequest | CreateTransactionRequest |
Defined in
contract-factory.ts:112
deploy
▸ deploy<TContract>(deployOptions?): Promise<DeployContractResult<TContract>>
Deploy a contract with the specified options.
Type parameters
| Name | Type |
|---|---|
TContract | extends Contract = Contract |
Parameters
| Name | Type | Description |
|---|---|---|
deployOptions | DeployContractOptions | Options for deploying the contract. |
Returns
Promise<DeployContractResult<TContract>>
A promise that resolves to the deployed contract instance.
Defined in
contract-factory.ts:154
getAccount
▸ getAccount(): Account
Returns
Defined in
contract-factory.ts:222
prepareDeploy
▸ prepareDeploy(deployOptions): Promise<{ contractId: string ; transactionRequest: CreateTransactionRequest }>
Parameters
| Name | Type |
|---|---|
deployOptions | DeployContractOptions |
Returns
Promise<{ contractId: string ; transactionRequest: CreateTransactionRequest }>
Defined in
contract-factory.ts:229
setConfigurableConstants
▸ setConfigurableConstants(configurableConstants): void
Set configurable constants of the contract with the specified values.
Parameters
| Name | Type | Description |
|---|---|---|
configurableConstants | Object | An object containing configurable names and their values. |
Returns
void
Defined in
contract-factory.ts:185