diff --git a/content/_snippets/data_types/ledger_index.md b/content/_snippets/data_types/ledger_index.md index f50258bcd9..1964201072 100644 --- a/content/_snippets/data_types/ledger_index.md +++ b/content/_snippets/data_types/ledger_index.md @@ -1,7 +1,7 @@ -A ledger index is a 32-bit unsigned integer used to identify a ledger. The ledger index is also known as the ledger's sequence number. The very first ledger was ledger index 1, and each new ledger has a ledger index 1 higher than that of the ledger immediately before it. +A ledger index is a 32-bit unsigned integer used to identify a ledger. The ledger index is sometimes known as the ledger's _sequence number_. (This is different from an [account sequence](basic-data-types.html#account-sequence).) The very first ledger was ledger index 1, and each new ledger has a ledger index that is 1 higher than the ledger index of the ledger immediately before it. -The ledger index indicates the order of the ledgers; the [Hash][] value identifies the exact contents of the ledger. Two ledgers with the same hash are always the same. For validated ledgers, hash values and sequence numbers are equally valid and correlate 1:1. However, this is not true for in-progress ledgers: +The ledger index indicates the order of the ledgers; the [Hash][] value identifies the exact contents of the ledger. Two ledgers with the same hash are always the same. For validated ledgers, hash values and ledger indexes are equally valid and correlate 1:1. However, this is not true for in-progress ledgers: * Two different `rippled` servers may have different contents for a current ledger with the same ledger index, due to latency in propagating transactions throughout the network. -* There may be multiple closed ledger versions competing to be validated by consensus. These ledger versions have the same sequence number but different contents (and different hashes). Only one of these closed ledgers can become validated. -* A current ledger's contents change over time, which would cause its hash to change, even though its ledger index number stays the same. The hash of a ledger is not calculated until the ledger is closed. +* There may be multiple closed ledger versions competing to be validated by consensus. These ledger versions have the same ledger index but different contents (and different hashes). Only one of these closed ledgers can become validated. +* The current open ledger's hash is not calculated. This is because a current ledger's contents change over time, which would cause its hash to change, even though its ledger index stays the same. The hash of a ledger is only calculated when the ledger is closed. diff --git a/content/_snippets/rippled-api-links.md b/content/_snippets/rippled-api-links.md index 2e50f28e34..859638fc03 100644 --- a/content/_snippets/rippled-api-links.md +++ b/content/_snippets/rippled-api-links.md @@ -18,6 +18,7 @@ [Internal Type]: serialization.html [内部の型]: serialization.html [Ledger Index]: basic-data-types.html#ledger-index +[ledger index]: basic-data-types.html#ledger-index [レジャーインデックス]: basic-data-types.html#レジャーインデックス [ledger format]: ledger-data-formats.html [Marker]: markers-and-pagination.html diff --git a/content/concepts/consensus-network/consensus.md b/content/concepts/consensus-network/consensus.md index 459a76a7e9..355cba093a 100644 --- a/content/concepts/consensus-network/consensus.md +++ b/content/concepts/consensus-network/consensus.md @@ -123,13 +123,13 @@ Validators each relay their results in the form of a signed message containing t _Figure 8: Ledger is Validated When Supermajority of Peers Calculate the Same Result — Each server compares its calculated ledger with the hashes received from its chosen validators. If not in agreement, the server must recalculate or retrieve the correct ledger._ -Servers in the network recognize a ledger instance as validated when a supermajority of the peers have signed and broadcast the same validation hash 7. Going forward, transactions are applied to this updated and now validated ledger with sequence number N+1. +Servers in the network recognize a ledger instance as validated when a supermajority of the peers have signed and broadcast the same validation hash 7. Going forward, transactions are applied to this updated and now validated ledger with ledger index N+1. In cases where a server is in the minority, having computed a ledger that differs from its peers, the server disregards the ledger it computed 8. It recomputes the correct ledger, or retrieves the correct ledger as needed. If the network fails to achieve supermajority agreement on validations, this implies that transaction volume was too high or network latency too great for the consensus process to produce consistent proposals. In this case, the servers repeat the consensus process. As time passes since consensus began, it becomes increasingly likely that a majority of the servers have received the same set of candidate transactions, as each consensus round reduces disagreement. The XRP Ledger dynamically adjusts [transaction costs](transaction-cost.html) and the time to wait for consensus in response to these conditions. -Once they reach supermajority agreement on validations, the servers work with the new validated ledger, sequence number N+1. The consensus and validation process repeats 9, considering candidate transactions that were not included in the last round along with new transactions submitted in the meantime. +Once they reach supermajority agreement on validations, the servers work with the new validated ledger, ledger index N+1. The consensus and validation process repeats 9, considering candidate transactions that were not included in the last round along with new transactions submitted in the meantime. ## Key Takeaways @@ -148,7 +148,7 @@ The lifecycle of a single transaction is as follows: - If a consensus round fails, the consensus process repeats until it succeeds. - The validated ledger includes the transaction and its effects on the ledger state. -Applications should only rely on information in validated ledgers, not on the provisional results of candidate transactions. Some [`rippled` APIs](rippled-api.html) initially return provisional results for transactions. The results of a transaction become immutable only when that transaction is included in a validated ledger, or the transaction includes `LastLedgerSequence` and does not appear in any validated ledger with that sequence number or lower. +Applications should only rely on information in validated ledgers, not on the provisional results of candidate transactions. Some [`rippled` APIs](rippled-api.html) initially return provisional results for transactions. The results of a transaction become immutable only when that transaction is included in a validated ledger, or the transaction includes `LastLedgerSequence` and does not appear in any validated ledger with that ledger index or lower. Best practices for applications submitting transactions include: @@ -183,7 +183,7 @@ Best practices for applications submitting transactions include: ## Footnotes -1 – Transactions with **tec** result codes do not perform the requested action, but do have effects on the ledger. To prevent abuse of the network and to pay for the cost of distributing the transaction, they destroy the XRP transaction cost. To not block other transactions submitted by the same sender around the same time, they increment the sender's account sequence number. They sometimes also perform maintenance such as deleting expired objects or unfunded trade offers. +1 – Transactions with [**tec** result codes](tec-codes.html) do not perform the requested action, but do have effects on the ledger. To prevent abuse of the network and to pay for the cost of distributing the transaction, they destroy the XRP [transaction cost](transaction-cost.html). To not block other transactions submitted by the same sender around the same time, they increment the sending account's [sequence number](basic-data-types.html#account-sequence). Transactions with `tec`-class results sometimes also perform maintenance such as deleting expired objects or unfunded trade offers. 2 – For example, consider a scenario where Alice has $100, and sends all of it to Bob. If an application first submits that payment transaction, then immediately after checks Alice’s balance, the API returns $0. This value is based on the provisional result of a candidate transaction. There are circumstances in which the payment fails and Alice’s balance remains $100 (or, due to other transactions, become some other amount). The only way to know with certainty that Alice’s payment to Bob succeeded is to check the status of the transaction until it is both in a validated ledger and has result code **tesSUCCESS**. If the transaction is in a validated ledger with any other result code, the payment has failed. diff --git a/content/concepts/payment-system-basics/accounts/accounts.md b/content/concepts/payment-system-basics/accounts/accounts.md index 8257a7d0ce..22db319cac 100644 --- a/content/concepts/payment-system-basics/accounts/accounts.md +++ b/content/concepts/payment-system-basics/accounts/accounts.md @@ -7,7 +7,7 @@ An "Account" in the XRP Ledger represents a holder of XRP and a sender of [trans **Note:** The XRP community has [proposed](https://github.com/xrp-community/standards-drafts/issues/6) (and developed a [codec](https://github.com/xrp-community/xrpl-tagged-address-codec) to support) a new **X**-address format that exchanges and wallets could use instead of [destination tags](https://xrpl.org/source-and-destination-tags.html). These "packed" addresses start with an `X` instead of an `r`. For more information, see the [XRPL 𝗫-address format](https://xrpaddress.info/) site. - An **XRP balance**. Some of this XRP is set aside for the [Reserve](reserves.html). -- A **sequence number**, starting at 1 and increasing with each transaction sent from this account. No transaction can be included in a ledger unless the transaction's sequence number matches its sender's next sequence number. +- A **sequence number**, which increases by 1 with each transaction sent from this account. No transaction can be included in a ledger unless the transaction's sequence number matches its sender's next sequence number. (See also: [Basic Data Types: Account Sequence](basic-data-types.html#account-sequence).) - A **history of transactions** that affected this account and its balances. - One or more ways to [authorize transactions](transaction-basics.html#authorizing-transactions), possibly including: - A master key pair intrinsic to the account. (This can be [disabled](accountset.html) but not changed.) diff --git a/content/concepts/payment-system-basics/transaction-basics/finality-of-results.md b/content/concepts/payment-system-basics/transaction-basics/finality-of-results.md index b46957c959..965866efd5 100644 --- a/content/concepts/payment-system-basics/transaction-basics/finality-of-results.md +++ b/content/concepts/payment-system-basics/transaction-basics/finality-of-results.md @@ -12,7 +12,7 @@ For any other result code, it can be difficult to determine if the result is fin | Any `tec` code | Final when included in a validated ledger | | Any `tem` code | Final unless the protocol changes to make the transaction valid | | `tefPAST_SEQ` | Final when another transaction with the same sequence number is included in a validated ledger | -| `tefMAX_LEDGER` | Final when a validated ledger has a sequence number higher than the transaction's `LastLedgerSequence` field, and no validated ledger includes the transaction | +| `tefMAX_LEDGER` | Final when a validated ledger has a [ledger index][Ledger Index] higher than the transaction's `LastLedgerSequence` field, and no validated ledger includes the transaction | Any other transaction result is potentially not final. In that case, the transaction could still succeed or fail later, especially if conditions change such that the transaction is no longer prevented from applying. For example, trying to send a non-XRP currency to an account that does not exist yet would fail, but it could succeed if another transaction sends enough XRP to create the destination account. A server might even store a temporarily-failed, signed transaction and then successfully apply it later without asking first. diff --git a/content/references/data-api.md b/content/references/data-api.md index e4d9ff862d..45fce534fd 100644 --- a/content/references/data-api.md +++ b/content/references/data-api.md @@ -123,7 +123,7 @@ This method requires the following URL parameters: | Field | Value | Description | |:--------------------|:----------------------------------------------------|:--| -| `ledger_identifier` | Ledger [Hash][], [Ledger Index][], or [Timestamp][] | _(Optional)_ An identifier for the ledger to retrieve: either the full hash in hex, an integer sequence number, or a date-time. If a date-time is provided, retrieve the ledger that was most recently closed at that time. If omitted, retrieve the latest validated ledger. | +| `ledger_identifier` | Ledger [Hash][], [Ledger Index][], or [Timestamp][] | _(Optional)_ An identifier for the ledger to retrieve: either the full hash in hex, an integer ledger index, or a date-time. If a date-time is provided, retrieve the ledger that was most recently closed at that time. If omitted, retrieve the latest validated ledger. | Optionally, you can provide the following query parameters: @@ -5024,7 +5024,7 @@ Transactions have two formats - a compact "binary" format where the defining fie |:---------------|:--------------------------|:--------------------------------| | `hash` | String - [Hash][] | An identifying hash value unique to this transaction, as a hex string. | | `date` | String - [Timestamp][] | The time when this transaction was included in a validated ledger. | -| `ledger_index` | Number - [Ledger Index][] | The sequence number of the ledger that included this ledger. | +| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this transaction. | | `tx` | Object | The fields of this transaction object, as defined by the [Transaction Format](transaction-formats.html). | | `meta` | Object | Metadata about the results of this transaction. | @@ -5034,7 +5034,7 @@ Transactions have two formats - a compact "binary" format where the defining fie |:---------------|:--------------------------|:--------------------------------| | `hash` | String - [Hash][] | An identifying hash value unique to this transaction, as a hex string. | | `date` | String - [Timestamp][] | The time when this transaction was included in a validated ledger. | -| `ledger_index` | Number - [Ledger Index][] | The sequence number of the ledger that included this ledger. | +| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this transaction. | | `tx` | String | The binary data that represents this transaction, as a hexadecimal string. | | `meta` | String | The binary data that represents this transaction's metadata, as a hex string. | @@ -5045,7 +5045,7 @@ A "ledger" is one version of the shared global ledger. Each ledger object has th | Field | Value | Description | |:--------------------|:--------------------------|:---------------------------| | `ledger_hash` | String - [Hash][] | An identifying hash unique to this ledger, as a hex string. | -| `ledger_index` | Number - [Ledger Index][] | The sequence number of the ledger. Each new ledger has a ledger index 1 higher than the ledger that came before it. | +| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger. Each new ledger has a ledger index 1 higher than the ledger that came before it. | | `parent_hash` | String - [Hash][] | The identifying hash of the previous ledger. | | `total_coins` | [String - Number][] | The total number of "drops" of XRP still in existence at the time of the ledger. (Each XRP is 1,000,000 drops.) | | `close_time_res` | Number | The ledger close time is rounded to this many seconds. | @@ -5054,7 +5054,7 @@ A "ledger" is one version of the shared global ledger. Each ledger object has th | `close_time` | Number | When this ledger was closed, in UNIX time. | | `close_time_human` | String - [Timestamp][] | When this ledger was closed. | -**Note:** Ledger close times are approximate, typically rounded to about 10 seconds. Two ledgers could have the same `close_time` values, when their actual close times were several seconds apart. The sequence number (`ledger_index`) of the ledger makes it unambiguous which ledger closed first. +**Note:** Ledger close times are approximate, typically rounded to about 10 seconds. Two ledgers could have the same `close_time` values, when their actual close times were several seconds apart. The ledger index makes it unambiguous which ledger closed first. ### Genesis Ledger @@ -5068,7 +5068,7 @@ An account creation object represents the action of creating an account in the X |:------------------|:-----------------------------|:--------------------------| | `address` | String - [Address][] | The identifying address of this account, in base-58. | | `inception` | String - [Timestamp][] | The UTC timestamp when the address was funded. For genesis accounts, this is the timestamp of ledger 32570. | -| `ledger_index` | Number - [Ledger Index][] | The sequence number of the ledger when the account was created, or 32570 for genesis accounts. | +| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger when the account was created, or 32570 for genesis accounts. | | `parent` | String - [Address][] | (Omitted for genesis accounts) The address that provided the XRP to fund this address. | | `tx_hash` | String - [Hash][] | (Omitted for genesis accounts) The identifying hash of the transaction that funded this account. | | `initial_balance` | [String - Number][] | (Omitted for genesis accounts) The amount of XRP that funded this account. | @@ -5097,7 +5097,7 @@ A single transaction can cause several exchanges to occur. In this case, the sen | `counter_currency` | String - [Currency Code][] | The counter currency. | | `counter_issuer` | String - [Address][] | (Omitted for XRP) The account that issued the counter currency. | | `executed_time` | String - [Timestamp][] | The time the exchange occurred. | -| `ledger_index` | Number - [Ledger Index][] | The sequence number of the ledger that included this transaction. | +| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this transaction. | | `offer_sequence` | Number - [Sequence Number][] | The sequence number of the `provider`'s existing offer in the ledger. | | `provider` | String - [Address][] | The account that had an existing Offer in the ledger. | | `seller` | String - [Address][] | The account that acquired the counter currency. | @@ -5159,7 +5159,7 @@ Payment objects have the following fields: | `currency` | String - [Currency Code][] | The currency that the `destination` account received. | | `destination` | String - [Address][] | The account that received the payment. | | `executed_time` | String - [Timestamp][] | The time the ledger that included this payment closed. | -| `ledger_index` | Number - [Ledger Index][] | The sequence number of the ledger that included this payment. | +| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this payment. | | `source` | String - [Address][] | The account that sent the payment. | | `source_currency` | String - [Currency Code][] | The currency that the `source` account spent. | | `tx_hash` | String - [Hash][] | The identifying hash of the transaction that caused the payment. | @@ -5199,7 +5199,7 @@ Balance Change Descriptors have the following fields: | `currency` | String - [Currency Code][] | The change affected this currency. | | `executed_time` | String - [Timestamp][] | The time the change occurred. (This is based on the close time of the ledger that included the transaction that executed the change. | | `counterparty` | String - [Address][] | (Omitted for XRP) The `currency` is held in a trust line to or from this account. _(Prior to [v2.0.6][], this field was called `issuer`.)_ | -| `ledger_index` | Number - [Ledger Index][] | The sequence number of the ledger that included the transaction that executed this balance change. | +| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included the transaction that executed this balance change. | | `tx_hash` | String - [Hash][] | The identifying hash of the transaction that executed this balance change. | ### Change Types diff --git a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md index e9dde5ed55..dd2b56be02 100644 --- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md +++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/ledger_cleaner.md @@ -25,15 +25,15 @@ An example of the request format: The request includes the following parameters: -| `Field` | Type | Description | -|:--------------|:--------------------------------|:---------------------------| -| `ledger` | Number (Ledger Sequence Number) | _(Optional)_ If provided, check and correct this specific ledger only. | -| `max_ledger` | Number (Ledger Sequence Number) | _(Optional)_ Configure the ledger cleaner to check ledgers with sequence numbers equal or lower than this. | -| `min_ledger` | Number (Ledger Sequence Number) | _(Optional)_ Configure the ledger cleaner to check ledgers with sequence numbers equal or higher than this. | -| `full` | Boolean | _(Optional)_ If true, fix ledger state objects and transations in the specified ledger(s). Defaults to false. Automatically set to `true` if `ledger` is provided. | -| `fix_txns` | Boolean | _(Optional)_ If true, correct transaction in the specified ledger(s). Overrides `full` if provided. | -| `check_nodes` | Boolean | _(Optional)_ If true, correct ledger state objects in the specified ledger(s). Overrides `full` if provided. | -| `stop` | Boolean | _(Optional)_ If true, disable the ledger cleaner. | +| `Field` | Type | Description | +|:--------------|:--------------------------|:---------------------------------| +| `ledger` | Number - [Ledger Index][] | _(Optional)_ If provided, check and correct the specified ledger only. | +| `max_ledger` | Number - [Ledger Index][] | _(Optional)_ Configure the ledger cleaner to check ledgers with ledger indexes equal or lower than this. | +| `min_ledger` | Number - [Ledger Index][] | _(Optional)_ Configure the ledger cleaner to check ledgers with ledger indexes equal or higher than this. | +| `full` | Boolean | _(Optional)_ If true, fix ledger state objects and transations in the specified ledger(s). Defaults to false. Automatically set to `true` if `ledger` is provided. | +| `fix_txns` | Boolean | _(Optional)_ If true, correct transaction in the specified ledger(s). Overrides `full` if provided. | +| `check_nodes` | Boolean | _(Optional)_ If true, correct ledger state objects in the specified ledger(s). Overrides `full` if provided. | +| `stop` | Boolean | _(Optional)_ If true, disable the ledger cleaner. | ### Response Format diff --git a/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md b/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md index 40f1dd09ba..9987315b21 100644 --- a/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md +++ b/content/references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md @@ -49,7 +49,7 @@ The response follows the [standard format][], with a successful result containin | `Field` | Type | Description | |:-----------------------|:-----------------|:---------------------------------| -| `ledger_current_index` | Unsigned Integer | Sequence number of the newly created 'current' ledger | +| `ledger_current_index` | Unsigned Integer - [Ledger Index][] | Ledger index of the newly created 'current' ledger | **Note:** When you close a ledger, `rippled` determines the canonical order of transactions in that ledger and replays them. This can change the outcome of transactions that were provisionally applied to the current ledger. diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md index eb562a8821..c36d327441 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/consensus_info.md @@ -1,7 +1,7 @@ # consensus_info [[Source]
](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source") -The `consensus_info` command provides information about the consensus process for debugging purposes. +The `consensus_info` command provides information about the [consensus process](consensus.html) for debugging purposes. _The `consensus_info` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._ @@ -211,7 +211,7 @@ The following is an incomplete summary of fields that may be contained in the `i | `Field` | Type | Description | |:-----------------|:--------|:------------------------------------------------| -| `ledger_seq` | Number | The sequence number of the ledger currently in the consensus process | +| `ledger_seq` | Number | The [ledger index][Ledger Index] of the [ledger](ledgers.html) currently in the consensus process | | `our_position` | Object | This server's expectation for the ledger in the consensus process. | | `peer_positions` | Object | Map of peers and their proposed versions of the ledger in the consensus process. | | `proposers` | Number | The number of trusted validators participating in this consensus process. Which validators are trusted depends on this server's configuration. | diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md index 341019a63d..9f9799db4c 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/fetch_info.md @@ -138,7 +138,7 @@ The response follows the [standard format][], with a successful result containin | `Field` | Type | Description | |:--------|:-------|:----------------------------------------------------------| -| `info` | Object | Map of objects being fetched and the status of that object being fetched. A ledger being fetched may be identified by its sequence number; ledgers and other objects being fetched may also be identified by their hashes. | +| `info` | Object | Map of objects being fetched and the status of that object being fetched. A ledger being fetched may be identified by its [ledger index][]; ledgers and other objects being fetched may also be identified by their hashes. | The fields describing a fetch in progress are subject to change without notice. The following fields may be included: diff --git a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md index 575b0ac5b5..e607cbfbbf 100644 --- a/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md +++ b/content/references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md @@ -392,7 +392,7 @@ Each member of the `peers` array is a peer object with the following fields: | `address` | String | The IP address and port where this peer is connected | | `cluster` | Boolean | (May be omitted) If `true`, the current server and the peer server are part of the same `rippled` cluster. | | `name` | String | (May be omitted) If the peer is part of the same cluster, this is the display name for that server as defined in the config file. | -| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the peer `rippled` has available | +| `complete_ledgers` | String | Range expression indicating the [ledger indexes][ledger index] of the ledger versions the peer `rippled` server has available | | `inbound` | Boolean | (May be omitted) If `true`, the peer is connecting to the local server. | | `latency` | Number | The network latency to the peer (in milliseconds) | | `ledger` | String | The hash of the peer's most recently closed ledger | diff --git a/content/references/rippled-api/api-conventions/basic-data-types.md b/content/references/rippled-api/api-conventions/basic-data-types.md index 6faaf69731..304dee6bb1 100644 --- a/content/references/rippled-api/api-conventions/basic-data-types.md +++ b/content/references/rippled-api/api-conventions/basic-data-types.md @@ -67,7 +67,7 @@ Some types of hash appear in API requests and responses. Others are only calcula Many API methods require you to specify an instance of the ledger, with the data retrieved being considered up-to-date as of that particular version of the shared ledger. The commands that accept a ledger version all work the same way. There are three ways you can specify which ledger you want to use: -1. Specify a ledger by its [Ledger Index][] in the `ledger_index` parameter. Each closed ledger has an identifying sequence number that is 1 higher than the previously-validated ledger. (The Genesis Ledger has sequence number 0) +1. Specify a ledger by its [Ledger Index][] in the `ledger_index` parameter. Each closed ledger has a ledger index that is 1 higher than the previous ledger. (The very first ledger had ledger index 1.) 2. Specify a ledger by its [Hash][] value in the `ledger_hash` parameter. 3. Specify a ledger by one of the following shortcuts, in the `ledger_index` parameter: * `validated` for the most recent ledger that has been validated by the whole network diff --git a/content/references/rippled-api/ledger-data-formats/ledger-header.md b/content/references/rippled-api/ledger-data-formats/ledger-header.md index 64b6d3ef7c..ffb97b643d 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-header.md +++ b/content/references/rippled-api/ledger-data-formats/ledger-header.md @@ -3,18 +3,18 @@ Every ledger version has a unique header that describes the contents. You can look up a ledger's header information with the [ledger method][]. The contents of the ledger header are as follows: -| Field | JSON Type | [Internal Type][] | Description | -|:-------------------------------|:----------|:------------------|:------------| -| [`ledger_index`][Ledger Index] | String | UInt32 | The sequence number of the ledger. Some API methods display this as a quoted integer; some display it as a native JSON number. | -| `ledger_hash` | String | Hash256 | The [SHA-512Half][] of this ledger version. This serves as a unique identifier for this ledger and all its contents. | -| `account_hash` | String | Hash256 | The [SHA-512Half][] of this ledger's state tree information. | -| `close_time` | Number | UInt32 | The approximate time this ledger closed, as the number of seconds since the Ripple Epoch of 2000-01-01 00:00:00. This value is rounded based on the `close_time_resolution`, so later ledgers can have the same value. | -| `closed` | Boolean | bool | If true, this ledger version is no longer accepting new transactions. (However, unless this ledger version is validated, it might be replaced by a different ledger version with a different set of transactions.) | -| `parent_hash` | String | Hash256 | The `ledger_hash` value of the previous ledger that was used to build this one. If there are different versions of the previous ledger index, this indicates from which one the ledger was derived. | -| `total_coins` | String | UInt64 | The total number of [drops of XRP][XRP, in drops] owned by accounts in the ledger. This omits XRP that has been destroyed by transaction fees. The actual amount of XRP in circulation is lower because some accounts are "black holes" whose keys are not known by anyone. | -| `transaction_hash` | String | Hash256 | The [SHA-512Half][] of the transactions included in this ledger. | -| `close_time_resolution` | Number | Uint8 | An integer in the range \[2,120\] indicating the maximum number of seconds by which the `close_time` could be rounded. | -| [`closeFlags`](#close-flags) | (Omitted) | UInt8 | A bit-map of flags relating to the closing of this ledger. | +| Field | JSON Type | [Internal Type][] | Description | +|:-----------------------------|:----------|:------------------|:--------------| +| `ledger_index` | String | UInt32 | The [ledger index][Ledger Index] of the ledger. Some API methods display this as a quoted integer; some display it as a native JSON number. | +| `ledger_hash` | String | Hash256 | The [SHA-512Half][] of this ledger version. This serves as a unique identifier for this ledger and all its contents. | +| `account_hash` | String | Hash256 | The [SHA-512Half][] of this ledger's state tree information. | +| `close_time` | Number | UInt32 | The approximate time this ledger closed, as the number of seconds since the Ripple Epoch of 2000-01-01 00:00:00. This value is rounded based on the `close_time_resolution`, so later ledgers can have the same value. | +| `closed` | Boolean | bool | If true, this ledger version is no longer accepting new transactions. (However, unless this ledger version is validated, it might be replaced by a different ledger version with a different set of transactions.) | +| `parent_hash` | String | Hash256 | The `ledger_hash` value of the previous ledger that was used to build this one. If there are different versions of the previous ledger index, this indicates from which one the ledger was derived. | +| `total_coins` | String | UInt64 | The total number of [drops of XRP][XRP, in drops] owned by accounts in the ledger. This omits XRP that has been destroyed by transaction fees. The actual amount of XRP in circulation is lower because some accounts are "black holes" whose keys are not known by anyone. | +| `transaction_hash` | String | Hash256 | The [SHA-512Half][] of the transactions included in this ledger. | +| `close_time_resolution` | Number | Uint8 | An integer in the range \[2,120\] indicating the maximum number of seconds by which the `close_time` could be rounded. | +| [`closeFlags`](#close-flags) | (Omitted) | UInt8 | A bit-map of flags relating to the closing of this ledger. | ## Ledger Index diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md index aaffedc2db..52cdbcd5a3 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_channels.md @@ -51,7 +51,7 @@ The request includes the following parameters: | `account` | String | The unique identifier of an account, typically the account's [Address][]. The request returns channels where this account is the channel's owner/source. | | `destination_account` | String | _(Optional)_ The unique identifier of an account, typically the account's [Address][]. If provided, filter results to payment channels whose destination is this account. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `limit` | Integer | _(Optional)_ Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. Defaults to 200. | | `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. | diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_currencies.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_currencies.md index 0c489a4972..1909826f9d 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_currencies.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_currencies.md @@ -46,7 +46,7 @@ The request includes the following parameters: | `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | | `strict` | Boolean | _(Optional)_ If true, only accept an address or public key for the account parameter. Defaults to false. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | The following field is deprecated and should not be provided: `account_index`. @@ -133,7 +133,7 @@ The response follows the [standard format][], with a successful result containin | `Field` | Type | Description | |:---------------------|:---------------------------|:-------------------------| | `ledger_hash` | String - [Hash][] | (May be omitted) The identifying hash of the ledger version used to retrieve this data, as hex. | -| `ledger_index` | Integer - [Ledger Index][] | The sequence number of the ledger version used to retrieve this data. | +| `ledger_index` | Integer - [Ledger Index][] | The ledger index of the ledger version used to retrieve this data. | | `receive_currencies` | Array of Strings | Array of [Currency Code][]s for currencies that this account can receive. | | `send_currencies` | Array of Strings | Array of [Currency Code][]s for currencies that this account can send. | | `validated` | Boolean | If `true`, this data comes from a validated ledger. | diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md index a23ba6aecc..6deee6bbaa 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_info.md @@ -56,7 +56,7 @@ The request contains the following parameters: | `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | | `strict` | Boolean | (Optional, defaults to False) If set to True, then the `account` field only accepts a public key or XRP Ledger address. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `queue` | Boolean | _(Optional)_ If `true`, and the [FeeEscalation amendment][] is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. [New in: rippled 0.33.0][] | | `signer_lists` | Boolean | _(Optional)_ If `true`, and the [MultiSign amendment][] is enabled, also returns any [SignerList objects](signerlist.html) associated with this account. [New in: rippled 0.31.0][] | @@ -173,10 +173,10 @@ The response follows the [standard format][], with the result containing the req | `Field` | Type | Description | |:-----------------------|:--------|:------------------------------------------| | `account_data` | Object | The [AccountRoot ledger object](accountroot.html) with this account's information, as stored in the ledger. | -| `signer_lists` | Array | (Omitted unless the request specified `signer_lists` and at least one SignerList is associated with the account.) Array of [SignerList ledger objects](signerlist.html) associated with this account for [Multi-Signing](multi-signing.html). Since an account can own at most one SignerList, this array must have exactly one member if it is present. [New in: rippled 0.31.0][] | -| `ledger_current_index` | Integer | (Omitted if `ledger_index` is provided instead) The sequence number of the most-current ledger, which was used when retrieving this information. The information does not contain any changes from ledgers newer than this one. | -| `ledger_index` | Integer | (Omitted if `ledger_current_index` is provided instead) The sequence number of the ledger used when retrieving this information. The information does not contain any changes from ledgers newer than this one. | -| `queue_data` | Object | (Omitted unless `queue` specified as `true` and querying the current open ledger.) Information about [queued transactions](transaction-cost.html#queued-transactions) sent by this account. This information describes the state of the local `rippled` server, which may be different from other servers in the consensus network. Some fields may be omitted because the values are calculated "lazily" by the queuing mechanism. | +| `signer_lists` | Array | _(Omitted unless the request specified `signer_lists` and at least one SignerList is associated with the account.)_ Array of [SignerList ledger objects](signerlist.html) associated with this account for [Multi-Signing](multi-signing.html). Since an account can own at most one SignerList, this array must have exactly one member if it is present. [New in: rippled 0.31.0][] | +| `ledger_current_index` | Integer | _(Omitted if `ledger_index` is provided instead)_ The [ledger index][] of the current in-progress ledger, which was used when retrieving this information. | +| `ledger_index` | Integer | _(Omitted if `ledger_current_index` is provided instead)_ The [ledger index][] of the ledger version used when retrieving this information. The information does not contain any changes from ledger versions newer than this one. | +| `queue_data` | Object | _(Omitted unless `queue` specified as `true` and querying the current open ledger.)_ Information about [queued transactions](transaction-cost.html#queued-transactions) sent by this account. This information describes the state of the local `rippled` server, which may be different from other servers in the [peer-to-peer XRP Ledger network](consensus-network.html). Some fields may be omitted because the values are calculated "lazily" by the queuing mechanism. | | `validated` | Boolean | True if this data is from a validated ledger version; if omitted or set to false, this data is not final. [New in: rippled 0.26.0][] | The `queue_data` parameter, if present, contains the following fields: diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_lines.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_lines.md index fb645e8e83..b861457ee2 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_lines.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_lines.md @@ -42,7 +42,7 @@ The request accepts the following paramters: |:---------------|:-------------------------------------------|:---------------| | `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `peer` | String | _(Optional)_ The [Address][] of a second account. If provided, show only lines of trust connecting the two accounts. | | `limit` | Integer | (Optional, default varies) Limit the number of trust lines to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. [New in: rippled 0.26.4][] | | `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] | @@ -148,14 +148,14 @@ An example of a successful response: The response follows the [standard format][], with a successful result containing the address of the account and an array of trust line objects. Specifically, the result object contains the following fields: -| `Field` | Type | Description | -|:-----------------------|:-------------------------------------------|:-------| -| `account` | String | Unique [Address][] of the account this request corresponds to. This is the "perspective account" for purpose of the trust lines. | -| `lines` | Array | Array of trust line objects, as described below. If the number of trust lines is large, only returns up to the `limit` at a time. | -| `ledger_current_index` | Integer | (Omitted if `ledger_hash` or `ledger_index` provided) Sequence number of the ledger version used when retrieving this data. [New in: rippled 0.26.4-sp1][] | -| `ledger_index` | Integer | (Omitted if `ledger_current_index` provided instead) Sequence number, provided in the request, of the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | -| `ledger_hash` | String | (May be omitted) Hex hash, provided in the request, of the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | -| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. [New in: rippled 0.26.4][] | +| `Field` | Type | Description | +|:-----------------------|:---------------------------|:-----------------------| +| `account` | String | Unique [Address][] of the account this request corresponds to. This is the "perspective account" for purpose of the trust lines. | +| `lines` | Array | Array of trust line objects, as described below. If the number of trust lines is large, only returns up to the `limit` at a time. | +| `ledger_current_index` | Integer - [Ledger Index][] | _(Omitted if `ledger_hash` or `ledger_index` provided)_ The ledger index of the current open ledger, which was used when retrieving this information. [New in: rippled 0.26.4-sp1][] | +| `ledger_index` | Integer - [Ledger Index][] | _(Omitted if `ledger_current_index` provided instead)_ The ledger index of the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | +| `ledger_hash` | String - [Hash][] | _(May be omitted)_ The identifying hash the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | +| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. [New in: rippled 0.26.4][] | Each trust line object has some combination of the following fields: diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_objects.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_objects.md index 001ced99b6..5cb2b96d03 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_objects.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_objects.md @@ -65,7 +65,7 @@ The request includes the following parameters: | `account` | String | A unique identifier for the account, most commonly the account's address. | | `type` | String | _(Optional)_ If included, filter results to include only this type of ledger object. The valid types are: `check`, `deposit_preauth`, `escrow`, `offer`, `payment_channel`, `signer_list`, and `state` (trust line). | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `limit` | Unsigned Integer | _(Optional)_ The maximum number of objects to include in the results. Must be within the inclusive range 10 to 400 on non-admin connections. Defaults to 200. | | `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. | @@ -598,16 +598,16 @@ An example of a successful response: The response follows the [standard format][], with a successful result containing the following fields: -| `Field` | Type | Description | -|:-----------------------|:-------------------------------------------|:-------| -| `account` | String | Unique [Address][] of the account this request corresponds to | -| `account_objects` | Array | Array of objects owned by this account. Each object is in its raw [ledger format][]. | -| `ledger_hash` | String | (May be omitted) The identifying hash of the ledger that was used to generate this response. | -| `ledger_index` | Number | (May be omitted) The sequence number of the ledger version that was used to generate this response. | -| `ledger_current_index` | Number | (May be omitted) The sequence number of the current in-progress ledger version that was used to generate this response. | -| `limit` | Number | (May be omitted) The limit that was used in this request, if any. | -| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. | -| `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | +| `Field` | Type | Description | +|:-----------------------|:--------------------------|:------------------------| +| `account` | String | Unique [Address][] of the account this request corresponds to | +| `account_objects` | Array | Array of objects owned by this account. Each object is in its raw [ledger format][]. | +| `ledger_hash` | String | (May be omitted) The identifying hash of the ledger that was used to generate this response. | +| `ledger_index` | Number - [Ledger Index][] | _(May be omitted)_ The ledger index of the ledger version that was used to generate this response. | +| `ledger_current_index` | Number - [Ledger Index][] | _(May be omitted)_ The ledger index of the current in-progress ledger version, which was used to generate this response. | +| `limit` | Number | _(May be omitted)_ The limit that was used in this request, if any. | +| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. | +| `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | ## Possible Errors diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_offers.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_offers.md index 6f9ea5d17a..6396c704b9 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_offers.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_offers.md @@ -45,14 +45,14 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current A request can include the following parameters: -| `Field` | Type | Description | -|:---------------|:-------------------------------------------|:---------------| -| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | -| `ledger` | Unsigned integer, or String | (Deprecated, Optional) A unique identifier for the ledger version to use, such as a ledger sequence number, a hash, or a shortcut such as "validated". | -| `ledger_hash` | String | _(Optional)_ A 20-byte hex string identifying the ledger version to use. | -| `ledger_index` | [Ledger Index][] | (Optional, defaults to `current`) The sequence number of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically. (See [Specifying Ledgers][]) | -| `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. [New in: rippled 0.26.4][] | -| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] | +| `Field` | Type | Description | +|:---------------|:----------------------------|:------------------------------| +| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | +| `ledger` | Unsigned Integer, or String | _(**Deprecated**, Optional)_ A unique identifier for the ledger version to use, such as a ledger index, a hash, or a shortcut such as "validated". | +| `ledger_hash` | String - [Hash][] | _(Optional)_ A 20-byte hex string identifying the ledger version to use. | +| `ledger_index` | Number - [Ledger Index][] | (Optional, defaults to `current`) The [ledger index][] of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically. (See [Specifying Ledgers][]) | +| `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. [New in: rippled 0.26.4][] | +| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] | The following parameter is deprecated and may be removed without further notice: `ledger`. diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/account_tx.md b/content/references/rippled-api/public-rippled-methods/account-methods/account_tx.md index a714edfbcc..157b31a69c 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/account_tx.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/account_tx.md @@ -560,15 +560,15 @@ An example of a successful response: The response follows the [standard format][], with a successful result containing the following fields: -| `Field` | Type | Description | -|:-------------------|:-------------------------------------------|:-----------| -| `account` | String | Unique [Address][] identifying the related account | -| `ledger_index_min` | Integer | The sequence number of the earliest ledger actually searched for transactions. | -| `ledger_index_max` | Integer | The sequence number of the most recent ledger actually searched for transactions. | -| `limit` | Integer | The `limit` value used in the request. (This may differ from the actual limit value enforced by the server.) | -| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. | -| `transactions` | Array | Array of transactions matching the request's criteria, as explained below. | -| `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | +| `Field` | Type | Description | +|:-------------------|:---------------------------|:---------------------------| +| `account` | String | Unique [Address][] identifying the related account | +| `ledger_index_min` | Integer - [Ledger Index][] | The ledger index of the earliest ledger actually searched for transactions. | +| `ledger_index_max` | Integer - [Ledger Index][] | The ledger index of the most recent ledger actually searched for transactions. | +| `limit` | Integer | The `limit` value used in the request. (This may differ from the actual limit value enforced by the server.) | +| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. | +| `transactions` | Array | Array of transactions matching the request's criteria, as explained below. | +| `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | **Note:** The server may respond with different values of `ledger_index_min` and `ledger_index_max` than you provided in the request, for example if it did not have the versions you specified on hand. @@ -576,7 +576,7 @@ Each transaction object includes the following fields, depending on whether it w | `Field` | Type | Description | |:---------------|:---------------------------------|:-------------------------| -| `ledger_index` | Integer | The sequence number of the ledger version that included this transaction. | +| `ledger_index` | Integer | The [ledger index][] of the ledger version that included this transaction. | | `meta` | Object (JSON) or String (Binary) | If `binary` is True, then this is a hex string of the transaction metadata. Otherwise, the transaction metadata is included in JSON format. | | `tx` | Object | (JSON mode only) JSON object defining the transaction | | `tx_blob` | String | (Binary mode only) Unique hashed String representing the transaction. | diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md b/content/references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md index e1f05337f2..c79d091655 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/gateway_balances.md @@ -50,7 +50,7 @@ The request includes the following parameters: | `strict` | Boolean | _(Optional)_ If true, only accept an address or public key for the account parameter. Defaults to false. | | `hotwallet` | String or Array | _(Optional)_ An [operational address](issuing-and-operational-addresses.html) to exclude from the balances issued, or an array of such addresses. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger version to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger version to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | ## Response Format @@ -206,7 +206,7 @@ The response follows the [standard format][], with a successful result containin | `balances` | Object | (Omitted if empty) Amounts issued to the `hotwallet` addresses from the request. The keys are addresses and the values are arrays of currency amounts they hold. | | `assets` | Object | (Omitted if empty) Total amounts held that are issued by others. In the recommended configuration, the [issuing address](issuing-and-operational-addresses.html) should have none. | | `ledger_hash` | String | (May be omitted) The identifying hash of the ledger that was used to generate this response. | -| `ledger_index` | Number | (May be omitted) The sequence number of the ledger version that was used to generate this response. | +| `ledger_index` | Number | _(May be omitted)_ The ledger index of the ledger version that was used to generate this response. | | `ledger_current_index` | Number | (May be omitted) The sequence number of the current in-progress ledger version that was used to generate this response. | ## Possible Errors diff --git a/content/references/rippled-api/public-rippled-methods/account-methods/noripple_check.md b/content/references/rippled-api/public-rippled-methods/account-methods/noripple_check.md index 73e260122e..821682cdca 100644 --- a/content/references/rippled-api/public-rippled-methods/account-methods/noripple_check.md +++ b/content/references/rippled-api/public-rippled-methods/account-methods/noripple_check.md @@ -52,7 +52,7 @@ The request includes the following parameters: | `transactions` | Boolean | _(Optional)_ If `true`, include an array of suggested [transactions](transaction-formats.html), as JSON objects, that you can sign and submit to fix the problems. Defaults to false. | | `limit` | Unsigned Integer | _(Optional)_ The maximum number of trust line problems to include in the results. Defaults to 300. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | ## Response Format @@ -169,7 +169,7 @@ The response follows the [standard format][], with a successful result containin | `Field` | Type | Description | |:-----------------------|:-------|:-------------------------------------------| -| `ledger_current_index` | Number | The sequence number of the ledger used to calculate these results. | +| `ledger_current_index` | Number | The [ledger index][] of the ledger used to calculate these results. | | `problems` | Array | Array of strings with human-readable descriptions of the problems. This includes up to one entry if the account's DefaultRipple setting is not as recommended, plus up to `limit` entries for trust lines whose NoRipple setting is not as recommended. | | `transactions` | Array | (May be omitted) If the request specified `transactions` as `true`, this is an array of JSON objects, each of which is the JSON form of a [transaction](transaction-formats.html) that should fix one of the described problems. The length of this array is the same as the `problems` array, and each entry is intended to fix the problem described at the same index into that array. | diff --git a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md index 4b6d2f8194..3864a1048e 100644 --- a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md +++ b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.md @@ -59,7 +59,7 @@ The request can contain the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `full` | Boolean | _(Optional)_ **Admin required** If `true`, return full information on the entire ledger. Ignored if you did not specify a ledger version. Defaults to `false`. (Equivalent to enabling `transactions`, `accounts`, and `expand`.) **Caution:** This is a very large amount of data -- on the order of several hundred megabytes! | | `accounts` | Boolean | _(Optional)_ **Admin required.** If `true`, return information on accounts in the ledger. Ignored if you did not specify a ledger version. Defaults to `false`. **Caution:** This returns a very large amount of data! | | `transactions` | Boolean | _(Optional)_ If `true`, return information on transactions in the specified ledger version. Defaults to `false`. Ignored if you did not specify a ledger version. | diff --git a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md index 3dcfd13d90..6d606f668e 100644 --- a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md +++ b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.md @@ -79,8 +79,8 @@ The response follows the [standard format][], with a successful result containin | `Field` | Type | Description | |:---------------|:-----------------|:-----------------------------------------| -| `ledger_hash` | String | 20-byte hex string with a unique hash of the ledger | -| `ledger_index` | Unsigned Integer | Sequence number of this ledger | +| `ledger_hash` | String | The unique [Hash][] of this ledger version, in hexadecimal. | +| `ledger_index` | Unsigned Integer | The [ledger index][] of this ledger version. | ## Possible Errors diff --git a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md index 0a10a6de92..147e5369f1 100644 --- a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md +++ b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.md @@ -1,7 +1,7 @@ # ledger_current [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerCurrent.cpp "Source") -The `ledger_current` method returns the unique identifiers of the current in-progress ledger. This command is mostly useful for testing, because the ledger returned is still in flux. +The `ledger_current` method returns the unique identifiers of the current in-progress [ledger](ledgers.html). This command is mostly useful for testing, because the ledger returned is still in flux. ## Request Format @@ -77,9 +77,9 @@ An example of a successful response: The response follows the [standard format][], with a successful result containing the following field: -| `Field` | Type | Description | -|:-----------------------|:-----------------|:-------------------------------| -| `ledger_current_index` | Unsigned Integer | Sequence number of this ledger | +| `Field` | Type | Description | +|:-----------------------|:------------------------------------|:--------------| +| `ledger_current_index` | Unsigned Integer - [Ledger Index][] | The ledger index of this ledger version. | A `ledger_hash` field is not provided, because the hash of the current ledger is constantly changing along with its contents. diff --git a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md index b9648064d5..3710fc3ba3 100644 --- a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md +++ b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.md @@ -45,7 +45,7 @@ A request can include the following fields: |:---------------|:-------------------------------------------|:---------------| | `id` | (Arbitrary) | (WebSocket only) Any identifier to separate this request from others in case the responses are delayed or out of order. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `binary` | Boolean | (Optional, defaults to False) If set to true, return ledger objects as hashed hex strings instead of JSON. | | `limit` | Integer | (Optional, default varies) Limit the number of ledger objects to retrieve. The server is not required to honor this value. | | `marker` | [Marker][] | Value from a previous paginated response. Resume retrieving data where that response left off. | @@ -234,12 +234,12 @@ An example of a successful response: The response follows the [standard format][], with a successful result containing the following fields: -| `Field` | Type | Description | -|:---------------|:-------------------------------------------|:---------------| -| `ledger_index` | Unsigned Integer | Sequence number of this ledger | -| `ledger_hash` | String | Unique identifying hash of the entire ledger. | -| `state` | Array | Array of JSON objects containing data from the tree, as defined below | -| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. | +| `Field` | Type | Description | +|:---------------|:------------------------------------|:----------------------| +| `ledger_index` | Unsigned Integer - [Ledger Index][] | The ledger index of this ledger version. | +| `ledger_hash` | String - [Hash][] | Unique identifying hash of this ledger version. | +| `state` | Array | Array of JSON objects containing data from the ledger's state tree, as defined below. | +| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. | The format of each object in the `state` array depends on whether `binary` was set to true or not in the request. Each `state` object may include the following fields: diff --git a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md index f886f7ca69..c95e9628ea 100644 --- a/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md +++ b/content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.md @@ -82,7 +82,7 @@ The full list of parameters recognized by this method is as follows: | `ripple_state.currency` | String | _(Required if `ripple_state` is specified)_ [Currency Code][] of the [RippleState object](ripplestate.html) to retrieve. | | `binary` | Boolean | _(Optional)_ If true, return the requested ledger object's contents as a hex string. Otherwise, return data in JSON format. The default is `false`. [Updated in: rippled 1.2.0][] | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | The `generator` and `ledger` parameters are deprecated and may be removed without further notice. @@ -147,10 +147,10 @@ The response follows the [standard format][], with a successful result containin | `Field` | Type | Description | |:---------------|:-----------------|:-----------------------------------------| -| `index` | String | Unique identifying key for this ledger_entry | -| `ledger_index` | Unsigned Integer | Unique sequence number of the ledger from which this data was retrieved | -| `node` | Object | (Omitted if `"binary": true` specified.) Object containing the data of this ledger object, according to the [ledger format][]. | -| `node_binary` | String | (Omitted unless `"binary":true` specified) Binary data of the ledger object, as hex. | +| `index` | String | The unique ID of this [ledger object](ledger-object-types.html). | +| `ledger_index` | Unsigned Integer | The [ledger index][] of the ledger that was used when retrieving this data. | +| `node` | Object | _(Omitted if `"binary": true` specified.)_ Object containing the data of this ledger object, according to the [ledger format][]. | +| `node_binary` | String | _(Omitted unless `"binary":true` specified)_ The [binary representation](serialization.html) of the ledger object, as hexadecimal. | ## Possible Errors diff --git a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md index 15c768b9b1..c8d3f1d246 100644 --- a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md +++ b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md @@ -63,7 +63,7 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:-------------------------------------------|:-------------------------------| | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `limit` | Unsigned Integer | _(Optional)_ If provided, the server does not provide more than this many offers in the results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers. | | `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. | | `taker` | String | _(Optional)_ The [Address][] of an account to use as a perspective. [Unfunded offers](offers.html#lifecycle-of-an-offer) placed by this account are always included in the response. (You can use this to look up your own orders to cancel them.) | diff --git a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/deposit_authorized.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/deposit_authorized.md index c4256b928c..744ee74b3c 100644 --- a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/deposit_authorized.md +++ b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/deposit_authorized.md @@ -51,7 +51,7 @@ The request includes the following parameters: | `source_account` | String - [Address][] | The sender of a possible payment. | | `destination_account` | String - [Address][] | The recipient of a possible payment. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | ## Response Format @@ -122,7 +122,7 @@ The response follows the [standard format][], with a successful result containin | `deposit_authorized` | Boolean | Whether the specified source account is authorized to send payments directly to the destination account. If `true`, either the destination account does not require [Deposit Authorization](depositauth.html) or the source account is preauthorized. | | `destination_account` | String - [Address][] | The destination account specified in the request. | | `ledger_hash` | String | _(May be omitted)_ The identifying hash of the ledger that was used to generate this response. | -| `ledger_index` | Number | _(May be omitted)_ The sequence number of the ledger version that was used to generate this response. | +| `ledger_index` | Number | _(May be omitted)_ The [ledger index][] of the ledger version that was used to generate this response. | | `ledger_current_index` | Number | _(May be omitted)_ The sequence number of the current in-progress ledger version that was used to generate this response. | | `source_account` | String - [Address][] | The source account specified in the request. | | `validated` | Boolean | _(May be omitted)_ If `true`, the information comes from a validated ledger version. | diff --git a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md index 826d418fbb..dd00184c12 100644 --- a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md +++ b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/ripple_path_find.md @@ -84,7 +84,7 @@ The request includes the following parameters: | `send_max` | String or Object | _(Optional)_ [Currency Amount][] that would be spent in the transaction. Cannot be used with `source_currencies`. [New in: rippled 0.30.0][] | | `source_currencies` | Array | _(Optional)_ Array of currencies that the source account might want to spend. Each entry in the array should be a JSON object with a mandatory `currency` field and optional `issuer` field, like how [currency amounts][Currency Amount] are specified. Cannot contain more than **18** source currencies. By default, uses all source currencies available up to a maximum of **88** different currency/issuer pairs. | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | ## Response Format diff --git a/content/references/rippled-api/public-rippled-methods/server-info-methods/server_state.md b/content/references/rippled-api/public-rippled-methods/server-info-methods/server_state.md index a8303ee2ce..34320f89b4 100644 --- a/content/references/rippled-api/public-rippled-methods/server-info-methods/server_state.md +++ b/content/references/rippled-api/public-rippled-methods/server-info-methods/server_state.md @@ -275,13 +275,13 @@ The `state` object may have some arrangement of the following fields: | `state_accounting.*.duration_us` | String | The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) [New in: rippled 0.30.1][] | | `state_accounting.*.transitions` | Number | The number of times the server has transitioned into this state. [New in: rippled 0.30.1][] | | `uptime` | Number | Number of consecutive seconds that the server has been operational. [New in: rippled 0.30.1][] | -| `validated_ledger` | Object | (May be omitted) Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. | +| `validated_ledger` | Object | _(May be omitted)_ Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. | | `validated_ledger.base_fee` | Unsigned Integer | Base fee, in drops of XRP, for propagating a transaction to the network. | | `validated_ledger.close_time` | Number | Time this ledger was closed, in [seconds since the Ripple Epoch][] | | `validated_ledger.hash` | String | Unique hash of this ledger version, as hex | -| `validated_ledger.reserve_base` | Unsigned Integer | Minimum amount, in drops of XRP, necessary for every account to keep in reserve | -| `validated_ledger.reserve_inc` | Unsigned Integer | Amount, in drops of XRP, that is added to the account reserve for each item the account owns in the ledger. | -| `validated_ledger.seq` | Unsigned Integer | Unique sequence number of this ledger | +| `validated_ledger.reserve_base` | Unsigned Integer | The minimum [account reserve](reserves.html), as of the most recent validated ledger version. | +| `validated_ledger.reserve_inc` | Unsigned Integer | The [owner reserve](reserves.html) for each item an account owns, as of the most recent validated ledger version. | +| `validated_ledger.seq` | Unsigned Integer | The [ledger index][] of the most recently validated ledger version. | | `validation_quorum` | Number | Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. | | `validator_list_expires` | Number | _(Admin only)_ When the current validator list will expire, in [seconds since the Ripple Epoch][], or 0 if the server has yet to load a published validator list. [New in: rippled 0.80.1][] | diff --git a/content/references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md index 9558d62d62..40e026fa46 100644 --- a/content/references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md +++ b/content/references/rippled-api/public-rippled-methods/transaction-methods/transaction_entry.md @@ -50,7 +50,7 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `tx_hash` | String | Unique hash of the transaction you are looking up | **Note:** This method does not support retrieving information from the current in-progress ledger. You must specify a ledger version in either `ledger_index` or `ledger_hash`. diff --git a/content/references/rippled-api/public-rippled-methods/transaction-methods/tx.md b/content/references/rippled-api/public-rippled-methods/transaction-methods/tx.md index 438005cd1d..e2f8876ccc 100644 --- a/content/references/rippled-api/public-rippled-methods/transaction-methods/tx.md +++ b/content/references/rippled-api/public-rippled-methods/transaction-methods/tx.md @@ -192,7 +192,7 @@ The response follows the [standard format][], with a successful result containin |:---------------|:-----------------|:-----------------------------------------| | `hash` | String | The SHA-512 hash of the transaction | | `inLedger` | Unsigned Integer | (Deprecated) Alias for `ledger_index`. | -| `ledger_index` | Unsigned Integer | The sequence number of the ledger that includes this transaction. | +| `ledger_index` | Unsigned Integer | The [ledger index][] of the ledger that includes this transaction. | | `meta` | Object | Various metadata about the transaction. | | `validated` | Boolean | True if this data is from a validated ledger version; if omitted or set to false, this data is not final. | | (Various) | (Various) | Other fields from the [Transaction object](transaction-formats.html) | diff --git a/content/references/rippled-api/transaction-formats/transaction-common-fields.md b/content/references/rippled-api/transaction-formats/transaction-common-fields.md index a6a0b218e9..ffa4669c76 100644 --- a/content/references/rippled-api/transaction-formats/transaction-common-fields.md +++ b/content/references/rippled-api/transaction-formats/transaction-common-fields.md @@ -7,7 +7,7 @@ Every transaction has the same set of common fields, plus additional fields base | Account | String | Account | _(Required)_ The unique address of the [account](accounts.html) that initiated the transaction. | | TransactionType | String | UInt16 | _(Required)_ The type of transaction. Valid types include: `Payment`, `OfferCreate`, `OfferCancel`, `TrustSet`, `AccountSet`, `SetRegularKey`, `SignerListSet`, `EscrowCreate`, `EscrowFinish`, `EscrowCancel`, `PaymentChannelCreate`, `PaymentChannelFund`, `PaymentChannelClaim`, and `DepositPreauth`. | | Fee | String | Amount | _(Required; [auto-fillable][])_ Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements. See [Transaction Cost][] for details. | -| Sequence | Unsigned Integer | UInt32 | _(Required; [auto-fillable][])_ The sequence number, relative to the initiating account, of this transaction. A transaction is only valid if the `Sequence` number is exactly 1 greater than the previous transaction from the same account. For how to use the `Sequence` number to invalidate a pending transaction, see [Cancel or Skip a Transaction](cancel-or-skip-a-transaction.html). | +| Sequence | Unsigned Integer | UInt32 | _(Required; [auto-fillable][])_ The [sequence number](basic-data-types.html#account-sequence) of the account sending the transaction. A transaction is only valid if the `Sequence` number is exactly 1 greater than the previous transaction from the same account. | | [AccountTxnID][] | String | Hash256 | _(Optional)_ Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash. | | [Flags][] | Unsigned Integer | UInt32 | _(Optional)_ Set of bit-flags for this transaction. | | LastLedgerSequence | Number | UInt32 | _(Optional; strongly recommended)_ Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected. See [Reliable Transaction Submission](reliable-transaction-submission.html) for more details. | diff --git a/content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.md b/content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.md index efa89f6684..11d7a80ed2 100644 --- a/content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.md +++ b/content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.md @@ -178,9 +178,9 @@ Alternatively, you can look up the status of the transaction using a different ` To implement the transaction submission and verification best practices, applications need to do the following: 1. Determine the signing account's next sequence number - * Each transaction has an account-specific sequence number. This guarantees the order in which transactions signed by an account are executed and makes it safe to resubmit a transaction without danger of the transaction being applied to the ledger more than once. + * Each transaction has an account-specific [sequence number](basic-data-types.html#account-sequence). This guarantees the order in which transactions signed by an account are executed and makes it safe to resubmit a transaction without danger of the transaction being applied to the ledger more than once. 3. Decide on a `LastLedgerSequence` - * A transaction's `LastLedgerSequence` is calculated from the last validated ledger sequence number. + * A transaction's `LastLedgerSequence` is calculated from the last validated ledger index. 3. Construct and sign the transaction * Persist the details of a signed transaction before submission. 4. Submit the transaction @@ -291,7 +291,7 @@ Response: } ``` -In this example the last validated ledger sequence number is 10268596 (found under `result.state.validated_ledger` in the response). Note also this example indicates a gap in ledger history. The server used here would not be able to provide information about the transactions applied during that gap (ledgers 10256383 through 10256411). If configured to do so, the server eventually retrieves that part of the ledger history. +In this example the last validated ledger index is 10268596 (found under `result.state.validated_ledger` in the response). Note also this example indicates a gap in ledger history. The server used here would not be able to provide information about the transactions applied during that gap (ledgers 10256383 through 10256411). If configured to do so, the server eventually retrieves that part of the ledger history. #### Construct the Transaction @@ -526,7 +526,7 @@ The [server_state method][] (used earlier to determine the last validated ledger Our example transaction specified `LastLedgerSequence` 10268600, based on the last validated ledger at the time, plus four. To determine whether our missing transaction has permanently failed, our `rippled` server must have ledgers 10268597 through 10268600. If the server has those validated ledgers in its history, **and** `tx` returns `txnNotFound`, then the transaction has failed and cannot be included in any future ledger. In this case, application logic may dictate building and submitting a replacement transaction with the same account sequence and updated `LastLedgerSequence`. -The server may report a last validated ledger sequence number less than the specified `LastLedgerSequence`. If so, the `txnNotFound` indicates either (a) the submitted transaction has not been distributed to the network, or (b) the transaction has been distributed to the network but has not yet been processed. To handle the former case, applications may submit again the same signed transaction. Because the transaction has a unique account sequence number, it can be processed at most once. +The server may report a last validated ledger index less than the specified `LastLedgerSequence`. If so, the `txnNotFound` indicates either (a) the submitted transaction has not been distributed to the network, or (b) the transaction has been distributed to the network but has not yet been processed. To handle the former case, applications may submit again the same signed transaction. Because the transaction has a unique account sequence number, it can be processed at most once. Finally the server may show one or more gaps in the transaction history. The `completed_ledgers` field shown in the response above indicates that ledgers 10256383 through 10256411 are missing from this rippled instance. Our example transaction can only appear in ledgers 10268597 - 10268600 (based on when it was submitted and `LastLedgerSequence`), so the gap shown here is not relevant. However, if the gap indicated a ledger in that range was missing, then an application would need to query another rippled server (or wait for this one to retrieve the missing ledgers) to determine that a `txnNotFound` result is immutable. diff --git a/content/tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md b/content/tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md index 893f9bff7e..7193180a84 100644 --- a/content/tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md +++ b/content/tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md @@ -757,7 +757,7 @@ To submit transactions reliably, follow these guidelines: * Persist details of the transaction before submitting it. * Use the `LastLedgerSequence` parameter. (RippleAPI does this by default.) -* Resubmit a transaction if it has not appeared in a validated ledger whose sequence number is less than or equal to the transaction's `LastLedgerSequence` parameter. +* Resubmit a transaction if it has not appeared in a validated ledger whose [ledger index][] is less than or equal to the transaction's `LastLedgerSequence` parameter. For more information, see [Reliable Transaction Submission](reliable-transaction-submission.html).