Interface LedgerResponse

Response expected from a LedgerRequest.

Hierarchy

  • BaseResponse
    • LedgerResponse

Properties

api_version? forwarded? id result status? type warning? warnings?

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: {
    ledger: Ledger | BinaryLedger;
    ledger_hash: string;
    ledger_index: number;
    queue_data?: (string | LedgerQueueData)[];
    validated?: boolean;
}

Type declaration

  • ledger: Ledger | BinaryLedger

    The complete header data of this Ledger.

  • ledger_hash: string

    Unique identifying hash of the entire ledger.

  • ledger_index: number

    The Ledger Index of this ledger.

  • Optional queue_data?: (string | LedgerQueueData)[]

    If true, this is a validated ledger version. If omitted or set to false, this ledger's data is not final.

  • Optional validated?: boolean

    Array of objects describing queued transactions, in the same order as the queue. If the request specified expand as true, members contain full representations of the transactions, in either JSON or binary depending on whether the request specified binary as true.

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Settings

Member Visibility

Theme

Generated using TypeDoc