Class Clause

Optional Readonlyabi

Optional Readonlycomment

Readonlydata

Readonlyto

Readonlyvalue

Static ReadonlyNO_VALUE

amount

• amount(): FixedPointNumber

• Return the amount of VET or VTHO token in Units.wei to transfer to the destination.

  Returns FixedPointNumber

  The amount as a fixed-point number.

StaticcallFunction

• callFunction(contractAddress, functionAbi, args, amount?, clauseOptions?): Clause

• Return a new clause to call a function of a smart contract.

  Parameters

  • contractAddress: Address

    The address of the smart contract.
  • functionAbi: ABIFunction<Abi, string>

    The ABI definition of the function to be called.
  • args: unknown[]

    The arguments for the function.
  • Optionalamount: VET = ...

    The amount of VET to be sent with the transaction calling the function.
  • OptionalclauseOptions: ClauseOptions

    Optional clause settings.

  Returns Clause

  A clause object to call the function in a transaction.

  Throws

  Throws an error if the amount is not a finite positive value.

StaticdeployContract

• deployContract(contractBytecode, deployParams?, clauseOptions?): Clause

• Returns a new clause to deploy a smart contract.

  Parameters

  • contractBytecode: HexUInt

    The bytecode of the contract to be deployed.
  • OptionaldeployParams: DeployParams

    Optional parameters to pass to the smart contract constructor.
  • OptionalclauseOptions: ClauseOptions

    Optional clause settings.

  Returns Clause

  The clause to deploy the smart contract as part of a transaction.

StatictransferNFT

• transferNFT(contractAddress, senderAddress, recipientAddress, tokenId, clauseOptions?): Clause

• Transfers an NFT from the sender to the recipient.

  Parameters

  • contractAddress: Address

    The address of the NFT contract.
  • senderAddress: Address

    The address of the current owner (sender) of the NFT.
  • recipientAddress: Address

    The address of the new owner (recipient) of the NFT.
  • tokenId: HexUInt

    The unique identifier of the NFT to be transferred.
  • OptionalclauseOptions: ClauseOptions

    Optional clause settings.

  Returns Clause

  The clause object representing the transfer operation as part of a transaction.

StatictransferToken

• transferToken(recipientAddress, token): Clause

• Return a new clause to transfer a generic VIP180/ERC20 Token

  Parameters

  • recipientAddress: Address

    The address of the recipient.
  • token: Token

  Returns Clause

  The clause to transfer tokens as part of a transaction.

  Throws

  Throws an error if the amount is not a positive integer.

StatictransferVET

• transferVET(recipientAddress, amount, clauseOptions?): Clause

• Return a new clause to transfers VET to a specified recipient address.

  Parameters

  • recipientAddress: Address

    The address of the recipient.
  • amount: VET

    The amount of VET to transfer.
  • OptionalclauseOptions: ClauseOptions

    Optional clause settings.

  Returns Clause

  • The clause object to transfer VET as part of a transaction.

  Throws

  • If the amount is not a finite positive value.

  See

  VET.transferTo

StatictransferVTHOToken

• transferVTHOToken(recipientAddress, amount): Clause

• Return a new clause to transfers the specified amount of VTHO

  Parameters

  • recipientAddress: Address

    The address of the recipient.
  • amount: VTHO

    The amount of token to be transferred.

  Returns Clause

  The clause to transfer VIP180 tokens as part of a transaction.

  Throws

  Throws an error if the amount is not a positive integer.

  See

  VTHO.transferTokenTo