Class ContractFactory<TContract>

constructor

• new ContractFactory<TContract>(bytecode, abi, accountOrProvider?, storageSlots?): ContractFactory<TContract>

• Create a ContractFactory instance.

  Type Parameters

  • TContract extends Contract = Contract

  Parameters

  • bytecode: BytesLike

    The bytecode of the contract.
  • abi: Interface | JsonAbi

    The contract's ABI (Application Binary Interface).
  • accountOrProvider: null | Provider | Account = null

    An account or provider to be associated with the factory.
  • storageSlots: StorageSlot[] = []

  Returns ContractFactory<TContract>

account

bytecode

interface

provider

storageSlots

connect

• connect(provider): ContractFactory<Contract>

• Connect the factory to a provider.

  Parameters

  • provider: Provider

    The provider to be associated with the factory.

  Returns ContractFactory<Contract>

  A new ContractFactory instance.

createTransactionRequest

• createTransactionRequest(deployOptions?): {
      contractId: string;
      transactionRequest: CreateTransactionRequest;
  }

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

  Parameters

  • OptionaldeployOptions: {
        chunkSizeMultiplier?: number;
        configurableConstants?: {
            [name: string]: unknown;
        };
        salt?: BytesLike;
        stateRoot?: BytesLike;
        storageSlots?: StorageSlot[];
    } & CreateTransactionRequestLike & {
        bytecode?: BytesLike;
    }

    Options for deploying the contract.

  Returns {
      contractId: string;
      transactionRequest: CreateTransactionRequest;
  }

  The CreateTransactionRequest object for deploying the contract.

  • contractId: string

  • transactionRequest: CreateTransactionRequest

deploy

• deploy<T>(deployOptions?): Promise<DeployContractResult<T>>

• Deploy a contract of any length with the specified options.

  Type Parameters

  • T extends Contract = TContract

  Parameters

  • deployOptions: DeployContractOptions = {}

    Options for deploying the contract.

  Returns Promise<DeployContractResult<T>>

  A promise that resolves to the deployed contract instance.

deployAsBlobTx

• deployAsBlobTx<T>(deployOptions?): Promise<DeployContractResult<T>>

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

  Type Parameters

  • T extends Contract = TContract

  Parameters

  • deployOptions: DeployContractOptions = ...

    Options for deploying the contract.

  Returns Promise<DeployContractResult<T>>

  A promise that resolves to the deployed contract instance.

deployAsCreateTx

• deployAsCreateTx<T>(deployOptions?): Promise<DeployContractResult<T>>

• Deploy a contract with the specified options.

  Type Parameters

  • T extends Contract = TContract

  Parameters

  • deployOptions: DeployContractOptions = {}

    Options for deploying the contract.

  Returns Promise<DeployContractResult<T>>

  A promise that resolves to the deployed contract instance.

setConfigurableConstants

• setConfigurableConstants(configurableConstants): void

• Set configurable constants of the contract with the specified values.

  Parameters

  • configurableConstants: {
        [name: string]: unknown;
    }

    An object containing configurable names and their values.

    • [name: string]: unknown

  Returns void