Skip to content

Commit

Permalink
Add comments to protobuf files about specifying ledgers
Browse files Browse the repository at this point in the history
  • Loading branch information
cjcobb23 committed May 12, 2020
1 parent 9771210 commit e145d86
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
5 changes: 5 additions & 0 deletions src/ripple/proto/org/xrpl/rpc/v1/get_account_info.proto
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ message GetAccountInfoRequest

bool strict = 2;

// Which ledger to use to retrieve data.
// If this field is not set, the server will use the open ledger.
// The open ledger includes data that is not validated or final.
// To retrieve the most up to date and validated data, use
// SHORTCUT_VALIDATED
LedgerSpecifier ledger = 3;

bool queue = 4;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ message GetAccountTransactionHistoryRequest
// What ledger to include results from. Specifying a not yet validated
// ledger results in an error. Not specifying a ledger uses the entire
// range of validated ledgers available to the server.
// Note, this parameter acts as a filter, and can only reduce the number of
// results. Specifying a single ledger will return only transactions from
// that ledger. This includes specifying a ledger with a Shortcut. For
// example, specifying SHORTCUT_VALIDATED will result in only transactions
// that were part of the most recently validated ledger being returned.
// Specifying a range of ledgers results in only transactions that were
// included in a ledger within the specified range being returned.
oneof ledger
{
LedgerSpecifier ledger_specifier = 2;
Expand Down
6 changes: 5 additions & 1 deletion src/ripple/proto/org/xrpl/rpc/v1/get_transaction.proto
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@ message GetTransactionRequest {
// if true, return data in binary format. defaults to false
bool binary = 2;

// search only specified range. optional
// If the transaction is not found, server will report whether the entire
// specified range is searched. The value is contained in the error message.
// The error message is of the form:
// "txn not found. searched_all = [true,false]"
// If the transaction is found, this parameter is ignored.
LedgerRange ledger_range = 3;
}

Expand Down

0 comments on commit e145d86

Please sign in to comment.