Class Transaction

constructor

• new Transaction(
      options: {
          chainID: string | IChainID;
          data?: Uint8Array<ArrayBufferLike> | ITransactionPayload;
          gasLimit: bigint | IGasLimit;
          gasPrice?: bigint | IGasPrice;
          guardian?: string | IAddress;
          guardianSignature?: Uint8Array<ArrayBufferLike>;
          nonce?: bigint | INonce;
          options?: number | ITransactionOptions;
          receiver: string | IAddress;
          receiverUsername?: string;
          sender: string | IAddress;
          senderUsername?: string;
          signature?: Uint8Array<ArrayBufferLike>;
          value?: bigint | ITransactionValue;
          version?: number | ITransactionVersion;
      },
  ): Transaction

• Creates a new Transaction object.

  Parameters

  • options: {
        chainID: string | IChainID;
        data?: Uint8Array<ArrayBufferLike> | ITransactionPayload;
        gasLimit: bigint | IGasLimit;
        gasPrice?: bigint | IGasPrice;
        guardian?: string | IAddress;
        guardianSignature?: Uint8Array<ArrayBufferLike>;
        nonce?: bigint | INonce;
        options?: number | ITransactionOptions;
        receiver: string | IAddress;
        receiverUsername?: string;
        sender: string | IAddress;
        senderUsername?: string;
        signature?: Uint8Array<ArrayBufferLike>;
        value?: bigint | ITransactionValue;
        version?: number | ITransactionVersion;
    }

  Returns Transaction

chainID

data

gasLimit

gasPrice

guardian

guardianSignature

nonce

options

receiver

receiverUsername

sender

senderUsername

signature

value

version

applyGuardianSignature

• applyGuardianSignature(
      guardianSignature: Uint8Array<ArrayBufferLike> | ISignature,
  ): void

• Legacy method, use the "guardianSignature" property instead. Applies the guardian signature on the transaction.

  Parameters

  • guardianSignature: Uint8Array<ArrayBufferLike> | ISignature

    The signature, as computed by a signer.

  Returns void

applySignature

• applySignature(signature: Uint8Array<ArrayBufferLike> | ISignature): void

• Legacy method, use the "signature" property instead. Applies the signature on the transaction.

  Parameters

  • signature: Uint8Array<ArrayBufferLike> | ISignature

    The signature, as computed by a signer.

  Returns void

computeFee

• computeFee(networkConfig: INetworkConfig): BigNumber

• Legacy method, use "TransactionComputer.computeTransactionFee()" instead.

  Computes the current transaction fee based on the NetworkConfig and transaction properties

  Parameters

  • networkConfig: INetworkConfig

    NetworkConfig

  Returns BigNumber

getChainID

• getChainID(): IChainID

• Legacy method, use the "chainID" property instead.

  Returns IChainID

getData

• getData(): ITransactionPayload

• Legacy method, use the "data" property instead.

  Returns ITransactionPayload

getGasLimit

• getGasLimit(): IGasLimit

• Legacy method, use the "gasLimit" property instead.

  Returns IGasLimit

getGasPrice

• getGasPrice(): IGasPrice

• Legacy method, use the "gasPrice" property instead.

  Returns IGasPrice

getGuardian

• getGuardian(): IAddress

• Legacy method, use the "guardian" property instead.

  Returns IAddress

getGuardianSignature

• getGuardianSignature(): Buffer

• Legacy method, use the "guardianSignature" property instead.

  Returns Buffer

getHash

• getHash(): TransactionHash

• Legacy method, use "TransactionComputer.computeTransactionHash()" instead.

  Returns TransactionHash

getNonce

• getNonce(): INonce

• Legacy method, use the "nonce" property instead.

  Returns INonce

getOptions

• getOptions(): TransactionOptions

• Legacy method, use the "options" property instead.

  Returns TransactionOptions

getReceiver

• getReceiver(): IAddress

• Legacy method, use the "receiver" property instead.

  Returns IAddress

getReceiverUsername

• getReceiverUsername(): string

• Legacy method, use the "receiverUsername" property instead.

  Returns string

getSender

• getSender(): IAddress

• Legacy method, use the "sender" property instead.

  Returns IAddress

getSenderUsername

• getSenderUsername(): string

• Legacy method, use the "senderUsername" property instead.

  Returns string

getSignature

• getSignature(): Buffer

• Legacy method, use the "signature" property instead.

  Returns Buffer

getValue

• getValue(): ITransactionValue

• Legacy method, use the "value" property instead.

  Returns ITransactionValue

getVersion

• getVersion(): TransactionVersion

• Legacy method, use the "version" property instead.

  Returns TransactionVersion

isGuardedTransaction

• isGuardedTransaction(): boolean

• Checks the integrity of the guarded transaction

  Returns boolean

serializeForSigning

• serializeForSigning(): Buffer

• Legacy method, use "TransactionComputer.computeBytesForSigning()" instead. Serializes a transaction to a sequence of bytes, ready to be signed. This function is called internally by signers.

  Returns Buffer

setChainID

• setChainID(chainID: string | IChainID): void

• Legacy method, use the "chainID" property instead.

  Parameters

  • chainID: string | IChainID

  Returns void

setGasLimit

• setGasLimit(gasLimit: bigint | IGasLimit): void

• Legacy method, use the "gasLimit" property instead.

  Parameters

  • gasLimit: bigint | IGasLimit

  Returns void

setGasPrice

• setGasPrice(gasPrice: bigint | IGasPrice): void

• Legacy method, use the "gasPrice" property instead.

  Parameters

  • gasPrice: bigint | IGasPrice

  Returns void

setGuardian

• setGuardian(guardian: string | IAddress): void

• Legacy method, use the "guardian" property instead.

  Parameters

  • guardian: string | IAddress

  Returns void

setNonce

• setNonce(nonce: bigint | INonce): void

• Legacy method, use the "nonce" property instead. Sets the account sequence number of the sender. Must be done prior signing.

  Parameters

  • nonce: bigint | INonce

  Returns void

setOptions

• setOptions(options: number | ITransactionOptions): void

• Legacy method, use the "options" property instead.

  Question for review: check how the options are set by sdk-dapp, wallet, ledger, extension.

  Parameters

  • options: number | ITransactionOptions

  Returns void

setReceiverUsername

• setReceiverUsername(receiverUsername: string): void

• Legacy method, use the "receiverUsername" property instead.

  Parameters

  • receiverUsername: string

  Returns void

setSender

• setSender(sender: string | IAddress): void

• Legacy method, use the "sender" property instead.

  Parameters

  • sender: string | IAddress

  Returns void

setSenderUsername

• setSenderUsername(senderUsername: string): void

• Legacy method, use the "senderUsername" property instead.

  Parameters

  • senderUsername: string

  Returns void

setValue

• setValue(value: bigint | ITransactionValue): void

• Legacy method, use the "value" property instead.

  Parameters

  • value: bigint | ITransactionValue

  Returns void

setVersion

• setVersion(version: number | ITransactionVersion): void

• Legacy method, use the "version" property instead.

  Parameters

  • version: number | ITransactionVersion

  Returns void

toPlainObject

• toPlainObject(): IPlainTransactionObject

• Legacy method, use "TransactionsConverter.transactionToPlainObject()" instead.

  Converts the transaction object into a ready-to-serialize, plain JavaScript object. This function is called internally within the signing procedure.

  Returns IPlainTransactionObject

toSendable

• toSendable(): any

• Converts a transaction to a ready-to-broadcast object. Called internally by the network provider.

  Returns any

StaticfromPlainObject

• fromPlainObject(plainObjectTransaction: IPlainTransactionObject): Transaction

• Legacy method, use "TransactionsConverter.plainObjectToTransaction()" instead. Converts a plain object transaction into a Transaction Object.

  Parameters

  • plainObjectTransaction: IPlainTransactionObject

    Raw data of a transaction, usually obtained by calling toPlainObject()

  Returns Transaction