Class Transaction

An abstraction for creating and signing transactions.

Constructors

constructor

new Transaction(options): Transaction
Creates a new Transaction object.
Parameters
- options: {
      chainID: string | IChainID;
      data?: Uint8Array | ITransactionPayload;
      gasLimit: bigint | IGasLimit;
      gasPrice?: bigint | IGasPrice;
      guardian?: string | IAddress;
      guardianSignature?: Uint8Array;
      nonce?: bigint | INonce;
      options?: number | ITransactionOptions;
      receiver: string | IAddress;
      receiverUsername?: string;
      sender: string | IAddress;
      senderUsername?: string;
      signature?: Uint8Array;
      value?: bigint | ITransactionValue;
      version?: number | ITransactionVersion;
  }
  - chainID: string | IChainID
  - Optional data?: Uint8Array | ITransactionPayload
  - gasLimit: bigint | IGasLimit
  - Optional gasPrice?: bigint | IGasPrice
  - Optional guardian?: string | IAddress
  - Optional guardianSignature?: Uint8Array
  - Optional nonce?: bigint | INonce
  - Optional options?: number | ITransactionOptions
  - receiver: string | IAddress
  - Optional receiverUsername?: string
  - sender: string | IAddress
  - Optional senderUsername?: string
  - Optional signature?: Uint8Array
  - Optional value?: bigint | ITransactionValue
  - Optional version?: number | ITransactionVersion
Returns Transaction
- Defined in src/transaction.ts:107

Properties

chainID

chainID: string

The chain ID of the Network (e.g. "1" for Mainnet).

data

data: Uint8Array

The payload of the transaction.

gasLimit

gasLimit: bigint

The maximum amount of gas to be consumed when processing the transaction.

gasPrice

gasPrice: bigint

The gas price to be used.

guardian

guardian: string

The address of the guardian, in bech32 format.

guardianSignature

guardianSignature: Uint8Array

The signature of the guardian.

nonce

nonce: bigint

The nonce of the transaction (the account sequence number of the sender).

options

options: number

The options field, useful for describing different settings available for transactions.

receiver

receiver: string

The address of the receiver, in bech32 format.

receiverUsername

receiverUsername: string

The username of the receiver.

sender

sender: string

The address of the sender, in bech32 format.

senderUsername

senderUsername: string

The username of the sender.

signature

signature: Uint8Array

The signature.

value

value: bigint

The value to transfer.

version

version: number

The version, required by the Network in order to correctly interpret the contents of the transaction.

Methods

`Private` addressAsBech32

addressAsBech32(address): string
Parameters
- address: string | IAddress
Returns string
- Defined in src/transaction.ts:144

applyGuardianSignature

applyGuardianSignature(guardianSignature): void
Legacy method, use the "guardianSignature" property instead. Applies the guardian signature on the transaction.
Parameters
- guardianSignature: Uint8Array | ISignature
  The signature, as computed by a signer.
Returns void
- Defined in src/transaction.ts:400

applySignature

applySignature(signature): void
Legacy method, use the "signature" property instead. Applies the signature on the transaction.
Parameters
- signature: Uint8Array | ISignature
  The signature, as computed by a signer.
Returns void
- Defined in src/transaction.ts:390

computeFee

computeFee(networkConfig): 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
- Defined in src/transaction.ts:418

getChainID

getChainID(): IChainID
Legacy method, use the "chainID" property instead.

Returns IChainID
- Defined in src/transaction.ts:271

getData

getData(): ITransactionPayload
Legacy method, use the "data" property instead.

Returns ITransactionPayload
- Defined in src/transaction.ts:264

getGasLimit

getGasLimit(): IGasLimit
Legacy method, use the "gasLimit" property instead.

Returns IGasLimit
- Defined in src/transaction.ts:250

getGasPrice

getGasPrice(): IGasPrice
Legacy method, use the "gasPrice" property instead.

Returns IGasPrice
- Defined in src/transaction.ts:236

getGuardian

getGuardian(): IAddress
Legacy method, use the "guardian" property instead.

Returns IAddress
- Defined in src/transaction.ts:229

getGuardianSignature

getGuardianSignature(): Buffer
Legacy method, use the "guardianSignature" property instead.

Returns Buffer
- Defined in src/transaction.ts:322

getHash

getHash(): TransactionHash
Legacy method, use "TransactionComputer.computeTransactionHash()" instead.

Returns TransactionHash
- Defined in src/transaction.ts:336

getNonce

getNonce(): INonce
Legacy method, use the "nonce" property instead.

Returns INonce
- Defined in src/transaction.ts:151

getOptions

getOptions(): TransactionOptions
Legacy method, use the "options" property instead.

Returns TransactionOptions
- Defined in src/transaction.ts:299

getReceiver

getReceiver(): IAddress
Legacy method, use the "receiver" property instead.

Returns IAddress
- Defined in src/transaction.ts:194

getReceiverUsername

getReceiverUsername(): string
Legacy method, use the "receiverUsername" property instead.

Returns string
- Defined in src/transaction.ts:215

getSender

getSender(): IAddress
Legacy method, use the "sender" property instead.

Returns IAddress
- Defined in src/transaction.ts:180

getSenderUsername

getSenderUsername(): string
Legacy method, use the "senderUsername" property instead.

Returns string
- Defined in src/transaction.ts:201

getSignature

getSignature(): Buffer
Legacy method, use the "signature" property instead.

Returns Buffer
- Defined in src/transaction.ts:315

getValue

getValue(): ITransactionValue
Legacy method, use the "value" property instead.

Returns ITransactionValue
- Defined in src/transaction.ts:166

getVersion

getVersion(): TransactionVersion
Legacy method, use the "version" property instead.

Returns TransactionVersion
- Defined in src/transaction.ts:285

isGuardedTransaction

isGuardedTransaction(): boolean
Checks the integrity of the guarded transaction

Returns boolean
- Defined in src/transaction.ts:354

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
- Defined in src/transaction.ts:345

setChainID

setChainID(chainID): void
Legacy method, use the "chainID" property instead.
Parameters
- chainID: string | IChainID
Returns void
- Defined in src/transaction.ts:278

setGasLimit

setGasLimit(gasLimit): void
Legacy method, use the "gasLimit" property instead.
Parameters
- gasLimit: bigint | IGasLimit
Returns void
- Defined in src/transaction.ts:257

setGasPrice

setGasPrice(gasPrice): void
Legacy method, use the "gasPrice" property instead.
Parameters
- gasPrice: bigint | IGasPrice
Returns void
- Defined in src/transaction.ts:243

setGuardian

setGuardian(guardian): void
Legacy method, use the "guardian" property instead.
Parameters
- guardian: string | IAddress
Returns void
- Defined in src/transaction.ts:329

setNonce

setNonce(nonce): 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
- Defined in src/transaction.ts:159

setOptions

setOptions(options): 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
- Defined in src/transaction.ts:308

setReceiverUsername

setReceiverUsername(receiverUsername): void
Legacy method, use the "receiverUsername" property instead.
Parameters
- receiverUsername: string
Returns void
- Defined in src/transaction.ts:222

setSender

setSender(sender): void
Legacy method, use the "sender" property instead.
Parameters
- sender: string | IAddress
Returns void
- Defined in src/transaction.ts:187

setSenderUsername

setSenderUsername(senderUsername): void
Legacy method, use the "senderUsername" property instead.
Parameters
- senderUsername: string
Returns void
- Defined in src/transaction.ts:208

setValue

setValue(value): void
Legacy method, use the "value" property instead.
Parameters
- value: bigint | ITransactionValue
Returns void
- Defined in src/transaction.ts:173

setVersion

setVersion(version): void
Legacy method, use the "version" property instead.
Parameters
- version: number | ITransactionVersion
Returns void
- Defined in src/transaction.ts:292

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
- Defined in src/transaction.ts:366

toSendable

toSendable(): any
Converts a transaction to a ready-to-broadcast object. Called internally by the network provider.

Returns any
- Defined in src/transaction.ts:408

`Static` fromPlainObject

fromPlainObject(plainObjectTransaction): 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
- Defined in src/transaction.ts:378

Class Transaction

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

chainID: string | IChainID

Optional data?: Uint8Array | ITransactionPayload

gasLimit: bigint | IGasLimit

Optional gasPrice?: bigint | IGasPrice

Optional guardian?: string | IAddress

Optional guardianSignature?: Uint8Array

Optional nonce?: bigint | INonce

Optional options?: number | ITransactionOptions

receiver: string | IAddress

Optional receiverUsername?: string

sender: string | IAddress

Optional senderUsername?: string

Optional signature?: Uint8Array

Optional value?: bigint | ITransactionValue

Optional version?: number | ITransactionVersion

Returns Transaction

Properties

chainID

data

gasLimit

gasPrice

guardian

guardianSignature

nonce

options

receiver

receiverUsername

sender

senderUsername

signature

value

version

Methods

Private addressAsBech32

Parameters

Returns string

applyGuardianSignature

Parameters

Returns void

applySignature

Parameters

Returns void

computeFee

Parameters

Returns BigNumber

getChainID

Returns IChainID

getData

Returns ITransactionPayload

getGasLimit

Returns IGasLimit

getGasPrice

Returns IGasPrice

getGuardian

Returns IAddress

getGuardianSignature

Returns Buffer

getHash

Returns TransactionHash

getNonce

Returns INonce

getOptions

Returns TransactionOptions

getReceiver

Returns IAddress

getReceiverUsername

Returns string

getSender

Returns IAddress

getSenderUsername

Returns string

getSignature

`Optional` data?: Uint8Array | ITransactionPayload

`Optional` gasPrice?: bigint | IGasPrice

`Optional` guardian?: string | IAddress

`Optional` guardianSignature?: Uint8Array

`Optional` nonce?: bigint | INonce

`Optional` options?: number | ITransactionOptions

`Optional` receiverUsername?: string

`Optional` senderUsername?: string

`Optional` signature?: Uint8Array

`Optional` value?: bigint | ITransactionValue

`Optional` version?: number | ITransactionVersion

`Private` addressAsBech32

`Static` fromPlainObject