Class Transaction

Readonlybody

Optional Readonlysignature

ReadonlytransactionType

Static ReadonlyGAS_CONSTANTS

encoded

• get encoded(): Uint8Array

• Get the encoded bytes as a Uint8Array. The encoding is determined by whether the data is signed.

  Returns Uint8Array

  The encoded byte array.

  See

  decode

gasPayer

• get gasPayer(): Address

• Get the gas payer's address if the transaction is delegated.

  If the transaction is delegated and a signature is available, this method recovers the gas payer parameter from the signature and subsequently recovers the gas payer's public key to derive the gas payer's address.

  Returns Address

  The address of the gas payer.

  Throws

  If the transaction is delegated but the signature is missing.

  Throws

  If the transaction is not delegated.

  Remarks

  Security auditable method, depends on

  • Address.ofPublicKey;
  • Secp256k1.recover;
  • Transaction.getTransactionHash.

id

• get id(): Blake2b256

• Get transaction ID.

  The ID is the Blake2b256 hash of the transaction's signature concatenated with the origin's address. If the transaction is not signed, it throws an UnavailableTransactionField error.

  Returns Blake2b256

  The concatenated hash of the signature and origin if the transaction is signed.

  Throws

  If the transaction is not signed.

  Remarks

  Security auditable method, depends on

  • Blake2b256.of

intrinsicGas

• get intrinsicGas(): VTHO

• Return the intrinsic gas required for this transaction.

  Returns VTHO

  The computed intrinsic gas for the transaction.

isDelegated

• get isDelegated(): boolean

• Returns true if the transaction is delegated, otherwise false.

  Returns boolean

  true if the transaction is delegated, otherwise false.

isSigned

• get isSigned(): boolean

• Return true if the signature is defined and complete, otherwise false.

  Returns boolean

  return true if the signature is defined and complete, otherwise false.

  Remarks

  Any delegated transaction signed with signAsSender but not yet signed with signAsGasPayer is not signed.

origin

• get origin(): Address

• Return the origin (also known as sender) address of the transaction.

  The origin is determined by recovering the public key from the transaction's sender.

  Returns Address

  The address derived from the public key of the transaction's sender.

  Throws

  If the transaction is not signed, an exception is thrown indicating the absence of the origin field.

  Remarks

  Security auditable method, depends on

  • Address.ofPublicKey;
  • Secp256k1.recover.

getTransactionHash

• getTransactionHash(sender?): Blake2b256

• Computes the transaction hash, optionally incorporating a gas payer's address.

  Parameters

  • Optionalsender: Address

    Optional transaction origin's address to include in the hash computation.

  Returns Blake2b256

  • The computed transaction hash.

  Remarks

  sender is used to sign a transaction on behalf of another account.

sign

• sign(senderPrivateKey): Transaction

• Signs the transaction using the provided private key of the transaction sender.

  Parameters

  • senderPrivateKey: Uint8Array

    The private key used to sign the transaction.

  Returns Transaction

  The signed transaction.

  Throws

  If attempting to sign a delegated transaction.

  Throws

  If the provided private key is not valid.

  Remarks

  Security auditable method, depends on

  • Secp256k1.isValidPrivateKey;
  • Secp256k1.sign.

signAsGasPayer

• signAsGasPayer(sender, gasPayerPrivateKey): Transaction

• Signs a transaction as a gas payer using the provided private key. This is applicable only if the transaction has been marked as delegated and already contains the signature of the transaction sender that needs to be extended with the gas payer's signature.

  Parameters

  • sender: Address

    The address of the sender for whom the transaction hash is generated.
  • gasPayerPrivateKey: Uint8Array

    The private key of the gas payer. Must be a valid secp256k1 key.

  Returns Transaction

  • A new transaction object with the gas payer's signature appended.

  Throws

  If the provided gas payer private key is not valid.

  Throws

  If the transaction is unsigned or lacks a valid signature.

  Throws

  If the transaction is not set as delegated.

  Remarks

  Security auditable method, depends on

  • Secp256k1.isValidPrivateKey;
  • Secp256k1.sign.

signAsSender

• signAsSender(senderPrivateKey): Transaction

• Signs a delegated transaction using the provided transaction sender's private key, call the signAsGasPayer to complete the signature, before such call isDelegated returns true but isSigned returns false.

  Parameters

  • senderPrivateKey: Uint8Array

    The private key of the transaction sender, represented as a Uint8Array. It must be a valid secp256k1 private key.

  Returns Transaction

  A new Transaction object with the signature applied, if the transaction is delegated and the private key is valid.

  Throws

  NotDelegatedTransaction if the current transaction is not marked as delegated, instructing to use the regular sign method instead.

  Throws

  InvalidSecp256k1PrivateKey if the provided senderPrivateKey is not a valid secp256k1 private key.

  Remarks

  Security auditable method, depends on

  • Secp256k1.isValidPrivateKey;
  • Secp256k1.sign.

signAsSenderAndGasPayer

• signAsSenderAndGasPayer(senderPrivateKey, gasPayerPrivateKey): Transaction

• Signs the transaction using both the transaction sender and the gas payer private keys.

  Parameters

  • senderPrivateKey: Uint8Array

    The private key of the transaction sender.
  • gasPayerPrivateKey: Uint8Array

    The private key of the gas payer.

  Returns Transaction

  A new transaction with the concatenated signatures of the transaction sender and the gas payer.

  Throws

  • If either the private key of the transaction sender or gas payer is invalid.

  Throws

  • If the transaction is not delegated.

  Remarks

  Security auditable method, depends on

  • Address.ofPublicKey
  • Secp256k1.isValidPrivateKey;
  • Secp256k1.sign.

Staticdecode

• decode(rawTransaction, isSigned): Transaction

• Decodes a raw transaction byte array into a new Transaction object.

  Parameters

  • rawTransaction: Uint8Array

    The raw transaction bytes to decode.
  • isSigned: boolean

    Flag indicating if the transaction is signed.

  Returns Transaction

  The decoded transaction object.

  See

  encoded

StaticintrinsicGas

• intrinsicGas(clauses): VTHO

• Calculates the intrinsic gas required for the given transaction clauses.

  Parameters

  • clauses: TransactionClause[]

    An array of transaction clauses to calculate the intrinsic gas for.

  Returns VTHO

  The total intrinsic gas required for the provided clauses.

  Throws

  If clauses have invalid data as invalid addresses.

StaticisValidBody

• isValidBody(body, type): boolean

• Validates the transaction body's fields according to the transaction type.

  Parameters

  • body: TransactionBody

    The transaction body to validate.
  • type: TransactionType

    The transaction type to validate the body against.

  Returns boolean

  True if the transaction body is valid for the given type.

Staticof

• of(body, signature?): Transaction

• Creates a new Transaction instance if the provided body is valid.

  Parameters

  • body: TransactionBody

    The transaction body to be validated.
  • Optionalsignature: Uint8Array

    Optional signature.

  Returns Transaction

  A new Transaction instance if validation is successful.

  Throws

  If the provided body is invalid.