Class ContractsModule

constructor

• new ContractsModule(transactionsModule): ContractsModule

• Parameters

  • transactionsModule: TransactionsModule

  Returns ContractsModule

ReadonlytransactionsModule

createContractFactory

• createContractFactory<TAbi>(abi, bytecode, signer): ContractFactory<TAbi>

• Creates a new instance of ContractFactory configured with the specified ABI, bytecode, and signer. This factory is used to deploy new smart contracts to the blockchain network managed by this instance.

  Type Parameters

  • TAbi extends Abi

  Parameters

  • abi: TAbi

    The Application Binary Interface (ABI) of the contract, which defines the contract's methods and events.
  • bytecode: string

    The compiled bytecode of the contract, representing the contract's executable code.
  • signer: VeChainSigner

    The signer used for signing transactions during contract deployment, ensuring the deployer's identity.

  Returns ContractFactory<TAbi>

  An instance of ContractFactory configured with the provided ABI, bytecode, and signer, ready for deploying contracts.

executeCall

• executeCall(contractAddress, functionAbi, functionData, contractCallOptions?): Promise<ContractCallResult>

• This method is going to be deprecated in next release. Use TransactionsModule.executeCall instead.

  Parameters

  • contractAddress: string
  • functionAbi: ABIFunction<Abi, string>
  • functionData: unknown[]
  • OptionalcontractCallOptions: ContractCallOptions

  Returns Promise<ContractCallResult>

executeMultipleClausesCall

• executeMultipleClausesCall(clauses, options?): Promise<ContractCallResult[]>

• This method is going to be deprecated in the next release. Use TransactionsModule.executeMultipleClausesCall next.

  Parameters

  • clauses: ContractClause[]
  • Optionaloptions: SimulateTransactionOptions

  Returns Promise<ContractCallResult[]>

executeMultipleClausesTransaction

• executeMultipleClausesTransaction(clauses, signer, options?): Promise<SendTransactionResult>

• This method is going to be deprected in the next release. Use TransactionsModule.executeMultipleClausesTransaction instead.

  Parameters

  • clauses: ContractClause[]
  • signer: VeChainSigner
  • Optionaloptions: ContractTransactionOptions

  Returns Promise<SendTransactionResult>

executeTransaction

• executeTransaction(signer, contractAddress, functionAbi, functionData, options?): Promise<SendTransactionResult>

• This method is going to be deprecated in the next release. Use TransactionsModule.executeTransaction instead.

  Parameters

  • signer: VeChainSigner
  • contractAddress: string
  • functionAbi: ABIFunction<Abi, string>
  • functionData: unknown[]
  • Optionaloptions: ContractTransactionOptions

  Returns Promise<SendTransactionResult>

getLegacyBaseGasPrice

• getLegacyBaseGasPrice(): Promise<ContractCallResult>

• This method is going to be deprecated in the next release. Use TransactionsModule.getLegacyBaseGasPrice instead.

  Returns Promise<ContractCallResult>

load

• load<Tabi>(address, abi, signer?): Contract<Tabi>

• Initializes and returns a new Contract instance with the provided parameters.

  Type Parameters

  • Tabi extends Abi

  Parameters

  • address: string

    The blockchain address of the contract to load.
  • abi: Tabi

    The Application Binary Interface (ABI) of the contract, which defines the contract's methods and structures.
  • Optionalsigner: VeChainSigner

    Optional. The signer caller, used for signing transactions when interacting with the contract.

  Returns Contract<Tabi>

  A new instance of the Contract, initialized with the provided address, ABI, and optionally, a signer.