Interface: PlainTransactionDetails
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.
Hierarchy
↳
PlainTransactionDetails
Table of contents
Properties
- blockHeight
- confirmations
- data
- executionResult
- fee
- feePerByte
- flags
- format
- network
- proof
- recipient
- recipientType
- sender
- senderData
- senderType
- size
- state
- timestamp
- transactionHash
- valid
- validityStartHeight
- value
Properties
blockHeight
• Optional
blockHeight: number
Defined in
web.d.ts:533
confirmations
• Optional
confirmations: number
Defined in
web.d.ts:534
data
• data: 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
Defined in
web.d.ts:501
executionResult
• Optional
executionResult: boolean
Defined in
web.d.ts:532
fee
• fee: number
The transaction's fee in luna (NIM's smallest unit).
Inherited from
Defined in
web.d.ts:471
feePerByte
• feePerByte: number
The transaction's fee-per-byte in luna (NIM's smallest unit).
Inherited from
Defined in
web.d.ts:475
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
Defined in
web.d.ts:488
format
• format: 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
Defined in
web.d.ts:448
network
• network: string
The network name on which this transaction is valid.
Inherited from
Defined in
web.d.ts:483
proof
• proof: 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
Defined in
web.d.ts:507
recipient
• recipient: string
The transaction's recipient address in human-readable IBAN format.
Inherited from
Defined in
web.d.ts:461
recipientType
• recipientType: PlainAccountType
The type of the transaction's sender. "basic" are regular private-key controlled addresses, "vesting" and "htlc" are those contract types respectively, and "staking" is the staking contract.
Inherited from
PlainTransaction.recipientType
Defined in
web.d.ts:466
sender
• sender: string
The transaction's sender address in human-readable IBAN format.
Inherited from
Defined in
web.d.ts:452
senderData
• senderData: 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
Defined in
web.d.ts:493
senderType
• senderType: PlainAccountType
The type of the transaction's sender. "basic" are regular private-key controlled addresses, "vesting" and "htlc" are those contract types respectively, and "staking" is the staking contract.
Inherited from
Defined in
web.d.ts:457
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
Defined in
web.d.ts:512
state
• state: TransactionState
Defined in
web.d.ts:531
timestamp
• Optional
timestamp: number
Defined in
web.d.ts:535
transactionHash
• transactionHash: string
The transaction's unique hash, used as its identifier. Sometimes also called txId
.
Inherited from
PlainTransaction.transactionHash
Defined in
web.d.ts:440
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
Defined in
web.d.ts:517
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
Defined in
web.d.ts:479
value
• value: number
Inherited from
Defined in
web.d.ts:467