Class Contract<TAbi>

constructor

• new Contract<TAbi>(address, abi, contractsModule, signer?, transactionReceipt?): Contract<TAbi>

• Initializes a new instance of the Contract class.

  Type Parameters

  • TAbi extends Abi

  Parameters

  • address: string

    The address of the contract.
  • abi: Abi

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

    The signer caller used for signing transactions.
  • OptionaltransactionReceipt: TransactionReceipt

    (Optional) The transaction receipt of the contract deployment.

  Returns Contract<TAbi>

Readonlyabi

Readonlyaddress

clause

ReadonlycontractsModule

criteria

ReadonlydeployTransactionReceipt

filters

read

transact

clearContractReadOptions

• clearContractReadOptions(): void

• Clears the current contract call options, resetting them to an empty object.

  Returns void

clearContractTransactOptions

• clearContractTransactOptions(): void

• Clears the current contract transaction options, resetting them to an empty object.

  Returns void

getContractReadOptions

• getContractReadOptions(): ContractCallOptions

• Clears the current contract call options, resetting them to an empty object.

  Returns ContractCallOptions

  The updated contract call options.

getContractTransactOptions

• getContractTransactOptions(): ContractTransactionOptions

• Retrieves the options for contract transactions.

  Returns ContractTransactionOptions

  The contract transaction options.

getEventAbi

• getEventAbi(eventName): ABIEvent<Abi, string>

• Retrieves the event ABI for the specified event name.

  Parameters

  • eventName: string | symbol

    The name of the event.

  Returns ABIEvent<Abi, string>

  The event ABI for the specified event name.

  Throws

getFunctionAbi

• getFunctionAbi(prop): ABIFunction<Abi, string>

• Retrieves the function ABI for the specified function name.

  Parameters

  • prop: string | symbol

    The name of the function.

  Returns ABIFunction<Abi, string>

  The function ABI for the specified event name.

  Throws

getSigner

• getSigner(): VeChainSigner

• Get the caller signer used for signing transactions.

  Returns VeChainSigner

  The signer used for signing transactions.

setContractReadOptions

• setContractReadOptions(options): ContractCallOptions

• Sets the options for contract calls.

  Parameters

  • options: ContractCallOptions

    The contract call options to set.

  Returns ContractCallOptions

  The updated contract call options.

setContractTransactOptions

• setContractTransactOptions(options): ContractTransactionOptions

• Sets the options for contract transactions.

  Parameters

  • options: ContractTransactionOptions

    The contract transaction options to set.

  Returns ContractTransactionOptions

  The updated contract transaction options.

setSigner

• setSigner(signer): VeChainSigner

• Sets the private key of the caller for signing transactions.

  Parameters

  • signer: VeChainSigner

    The caller signer

  Returns VeChainSigner