package org.xrpl.rpc.v1

Get desktop application:
View/edit binary Protocol Buffers messages

These methods are binary only methods for retrieiving arbitrary ledger state via gRPC. These methods are used by clio, but can also be used by any client that wants to extract ledger state in an efficient manner. They do not directly mimic the JSON equivalent methods.

• rpc GetLedger (GetLedgerRequest, GetLedgerResponse)

  xrp_ledger.proto:21

  Get a specific ledger, optionally including transactions and any modified, added or deleted ledger objects

  message GetLedgerRequest

  get_ledger.proto:9

  • optional LedgerSpecifier ledger = 1

  • bool transactions = 2

    If true, include transactions contained in this ledger

  • bool expand = 3

    If true and transactions, include full transactions and metadata If false and transactions, include only transaction hashes

  • bool get_objects = 4

    If true, include state map difference between this ledger and the previous ledger. This includes all added, modified or deleted ledger objects

  • string client_ip = 5

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  • string user = 6

    Identifying string. If user is set, client_ip is not set, and request is coming from a secure_gateway host, then the client is not subject to resource controls

  • bool get_object_neighbors = 7

    For every object in the diff, get the object's predecessor and successor in the state map. Only used if get_objects is also true.

  message GetLedgerResponse

  get_ledger.proto:41

  • bytes ledger_header = 1

  • oneof transactions

    • TransactionHashList hashes_list = 2

      Just the hashes

    • TransactionAndMetadataList transactions_list = 3

      Full transactions and metadata

  • bool validated = 4

    True if the ledger has been validated

  • optional RawLedgerObjects ledger_objects = 5

    State map difference between this ledger and the previous ledger

  • bool skiplist_included = 6

    True if the skiplist object is included in ledger_objects

  • bool is_unlimited = 7

    True if request was exempt from resource controls

  • bool objects_included = 8

    True if the response contains the state map diff

  • bool object_neighbors_included = 9

    True if the response contains key of objects adjacent to objects in state map diff

  • repeated BookSuccessor book_successors = 10

    Successor information for book directories modified as part of this ledger

• rpc GetLedgerEntry (GetLedgerEntryRequest, GetLedgerEntryResponse)

  xrp_ledger.proto:24

  Get a specific ledger object from a specific ledger

  message GetLedgerEntryRequest

  get_ledger_entry.proto:10

  Get a single ledger object

  • bytes key = 1

    Key of the desired object

  • optional LedgerSpecifier ledger = 2

    Ledger containing the object

  • string client_ip = 3

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  message GetLedgerEntryResponse

  get_ledger_entry.proto:24

  • optional RawLedgerObject ledger_object = 1

  • optional LedgerSpecifier ledger = 2

    Ledger containing the object. Will match the value specified in the request.

• rpc GetLedgerData (GetLedgerDataRequest, GetLedgerDataResponse)

  xrp_ledger.proto:27

  Iterate through all ledger objects in a specific ledger

  message GetLedgerDataRequest

  get_ledger_data.proto:11

  Get ledger objects for a specific ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.

  • bytes marker = 1

    If set, only objects with a key greater than marker are returned. This can be used to pick up where a previous call left off. Set marker to the value of marker in the previous response.

  • optional LedgerSpecifier ledger = 2

  • bytes end_marker = 3

    If set, only objects with a key less than end_marker are returned

  • string client_ip = 4

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  • string user = 6

    Identifying string. If user is set, client_ip is not set, and request is coming from a secure_gateway host, then the client is not subject to resource controls

  message GetLedgerDataResponse

  get_ledger_data.proto:34

  • uint32 ledger_index = 1

    Sequence of the ledger containing the returned ledger objects

  • bytes ledger_hash = 2

    Hash of the ledger containing the returned ledger objects

  • optional RawLedgerObjects ledger_objects = 3

    Ledger objects

  • bytes marker = 4

    Key to be passed into a subsequent call to continue iteration. If not set, there are no more objects left in the ledger, or no more objects with key less than end_marker (if end_marker was set in the request)

  • bool is_unlimited = 7

    True if request was exempt from resource controls

• rpc GetLedgerDiff (GetLedgerDiffRequest, GetLedgerDiffResponse)

  xrp_ledger.proto:31

  Get all ledger objects that are different between the two specified ledgers. Note, this method has no JSON equivalent.

  message GetLedgerDiffRequest

  get_ledger_diff.proto:11

  Get the state map difference between the two specified ledgers

  • optional LedgerSpecifier base_ledger = 1

  • optional LedgerSpecifier desired_ledger = 2

  • bool include_blobs = 3

    If true, include the full ledger object. If false, only keys are included.

  • string client_ip = 4

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  message GetLedgerDiffResponse

  get_ledger_diff.proto:26

  • optional RawLedgerObjects ledger_objects = 1

    All ledger objects that were added, modified or deleted between base_ledger and desired_ledger

Successor information for book directories. The book base is (usually) not an actual object, yet we need to be able to ask for the successor to the book base.

Used in: GetLedgerResponse

• bytes book_base = 1

  Base of the book in question

• bytes first_book = 2

  First book directory in the book. An empty value here means the entire book is deleted

Next field: 4

Used in: GetLedgerDataRequest, GetLedgerDiffRequest, GetLedgerEntryRequest, GetLedgerEntryResponse, GetLedgerRequest

• oneof ledger

  • LedgerSpecifier.Shortcut shortcut = 1

  • uint32 sequence = 2

  • bytes hash = 3

    32 bytes

Next field: 4

Used in: LedgerSpecifier

• SHORTCUT_UNSPECIFIED = 0

• SHORTCUT_VALIDATED = 1

• SHORTCUT_CLOSED = 2

• SHORTCUT_CURRENT = 3

Next field: 3

Used in: GetLedgerEntryResponse, RawLedgerObjects

• bytes data = 1

  Raw data of the ledger object. In GetLedgerResponse and GetLedgerDiffResponse, data will be empty if the object was deleted.

• bytes key = 2

  Key of the ledger object

• RawLedgerObject.ModificationType mod_type = 3

  Whether the object was created, modified or deleted

• bytes predecessor = 4

  Key of the object preceding this object in the desired ledger

• bytes successor = 5

  Key of the object succeeding this object in the desired ledger

Used in: RawLedgerObject

• UNSPECIFIED = 0

• CREATED = 1

• MODIFIED = 2

• DELETED = 3

Used in: GetLedgerDataResponse, GetLedgerDiffResponse, GetLedgerResponse

• repeated RawLedgerObject objects = 1

Used in: TransactionAndMetadataList

• bytes transaction_blob = 1

• bytes metadata_blob = 2

Used in: GetLedgerResponse

• repeated TransactionAndMetadata transactions = 1

Used in: GetLedgerResponse

• repeated bytes hashes = 1