JSON-compatible and human-readable format of transactions, including details about its state in the blockchain. Contains all fields from PlainTransaction, plus additional fields such as blockHeight and timestamp if the transaction is included in the blockchain.

Extends

• PlainTransaction

Properties

blockHeight?

`optional` blockHeight: `number`

confirmations?

`optional` confirmations: `number`

data

data: [PlainTransactionRecipientData](../type-aliases/PlainTransactionRecipientData)

The data field of a transaction serves different purposes based on the transaction's recipient type. For transactions to "basic" address types, this field can contain up to 64 bytes of unstructured data. For transactions that create contracts or interact with the staking contract, the format of this field must follow a fixed structure and defines the new contracts' properties or how the staking contract is changed.

Inherited from

PlainTransaction.data

executionResult?

`optional` executionResult: `boolean`

fee

fee: `number`

The transaction's fee in luna (NIM's smallest unit).

Inherited from

PlainTransaction.fee

feePerByte

feePerByte: `number`

The transaction's fee-per-byte in luna (NIM's smallest unit).

Inherited from

PlainTransaction.feePerByte

flags

flags: `number`

Any flags that this transaction carries. 0b1 = 1 means it's a contract-creation transaction, 0b10 = 2 means it's a signalling transaction with 0 value.

Inherited from

PlainTransaction.flags

format

format: [PlainTransactionFormat](../type-aliases/PlainTransactionFormat)

The transaction's format. Nimiq transactions can have one of two formats: "basic" and "extended". Basic transactions are simple value transfers between two regular address types and cannot contain any extra data. Basic transactions can be serialized to less bytes, so take up less place on the blockchain. Extended transactions on the other hand are all other transactions: contract creations and interactions, staking transactions, transactions with exta data, etc.

Inherited from

PlainTransaction.format

network

network: `string`

The network name on which this transaction is valid.

Inherited from

PlainTransaction.network

proof

proof: [PlainTransactionProof](../type-aliases/PlainTransactionProof)

The proof field contains the signature of the eligible signer. The proof field's structure depends on the transaction's sender type. For transactions from contracts it can also contain additional structured data before the signature.

Inherited from

PlainTransaction.proof

recipient

recipient: `string`

The transaction's recipient address in human-readable IBAN format.

Inherited from

PlainTransaction.recipient

recipientType

recipientType: [PlainAccountType](../type-aliases/PlainAccountType)

The account type of the transaction's recipient. "basic" are regular private-key controlled accounts, "vesting" and "htlc" are contracts, and "staking" is the staking contract.

Inherited from

PlainTransaction.recipientType

sender

sender: `string`

The transaction's sender address in human-readable IBAN format.

Inherited from

PlainTransaction.sender

senderData?

`optional` senderData: [PlainTransactionSenderData](../type-aliases/PlainTransactionSenderData)

The sender_data field serves a purpose based on the transaction's sender type. It is currently only used for extra information in transactions from the staking contract.

Inherited from

PlainTransaction.senderData

senderType

senderType: [PlainAccountType](../type-aliases/PlainAccountType)

The account type of the transaction's sender. "basic" are regular private-key controlled accounts, "vesting" and "htlc" are contracts, and "staking" is the staking contract.

Inherited from

PlainTransaction.senderType

size

size: `number`

The transaction's serialized size in bytes. It is used to determine the fee-per-byte that this transaction pays.

Inherited from

PlainTransaction.size

state

state: [TransactionState](../type-aliases/TransactionState)

timestamp?

`optional` timestamp: `number`

transactionHash

transactionHash: `string`

The transaction's unique hash, used as its identifier. Sometimes also called txId.

Inherited from

PlainTransaction.transactionHash

valid

valid: `boolean`

Encodes if the transaction is valid, meaning the signature is valid and the data and proof fields follow the correct format for the transaction's recipient and sender type, respectively.

Inherited from

PlainTransaction.valid

validityStartHeight

validityStartHeight: `number`

The block height at which this transaction becomes valid. It is then valid for 7200 blocks (~2 hours).

Inherited from

PlainTransaction.validityStartHeight

value

value: `number`

Inherited from

PlainTransaction.value