TransactionStream

Many subscriptions result in messages about transactions.

Hierarchy

BaseStream
- TransactionStream

Index

Properties

engine_result

engine_result: string

String Transaction result code.

engine_result_code

engine_result_code: number

Numeric transaction response code, if applicable.

engine_result_message

engine_result_message: string

Human-readable explanation for the transaction response.

Optional ledger_current_index

ledger_current_index?: number

The ledger index of the current in-progress ledger version for which this transaction is currently proposed.

Optional ledger_hash

ledger_hash?: string

The identifying hash of the ledger version that includes this transaction.

Optional ledger_index

ledger_index?: number

The ledger index of the ledger version that includes this transaction.

Optional meta

meta?: TransactionMetadata

The transaction metadata, which shows the exact outcome of the transaction in detail.

status

status: string

transaction

transaction: (AccountDelete & { date?: number; hash?: string }) & (AccountSet & { date?: number; hash?: string }) & (CheckCancel & { date?: number; hash?: string }) & (CheckCash & { date?: number; hash?: string }) & (CheckCreate & { date?: number; hash?: string }) & (DepositPreauth & { date?: number; hash?: string }) & (EscrowCancel & { date?: number; hash?: string }) & (EscrowCreate & { date?: number; hash?: string }) & (EscrowFinish & { date?: number; hash?: string }) & (NFTokenAcceptOffer & { date?: number; hash?: string }) & (NFTokenBurn & { date?: number; hash?: string }) & (NFTokenCancelOffer & { date?: number; hash?: string }) & (NFTokenCreateOffer & { date?: number; hash?: string }) & (NFTokenMint & { date?: number; hash?: string }) & (OfferCancel & { date?: number; hash?: string }) & (OfferCreate & { date?: number; hash?: string }) & (Payment & { date?: number; hash?: string }) & (PaymentChannelClaim & { date?: number; hash?: string }) & (PaymentChannelCreate & { date?: number; hash?: string }) & (PaymentChannelFund & { date?: number; hash?: string }) & (SetRegularKey & { date?: number; hash?: string }) & (SignerListSet & { date?: number; hash?: string }) & (TicketCreate & { date?: number; hash?: string }) & (TrustSet & { date?: number; hash?: string })

The definition of the transaction in JSON format.

type

type: "transaction"

Optional validated

validated?: boolean

If true, this transaction is included in a validated ledger and its outcome is final. Responses from the transaction stream should always be validated.

Optional warnings

warnings?: { id: number; message: string }[]