mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
rippled: corrections to ledger/queue dump
This incorporates @ximinez's feedback from after PR#259 was merged
This commit is contained in:
mDuo13
@@ -3376,9 +3376,9 @@ The request can contain the following parameters:
|
||||
|:---------------|:---------------------------|:-------------------------------|
|
||||
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#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 a Ledger](#specifying-ledgers)) |
|
||||
| `full` | Boolean | _(Optional)_ **Admin required** If `true`, return full information on the entire ledger. Ignored if you did not specify a ledger. 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. 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. |
|
||||
| `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. |
|
||||
| `expand` | Boolean | _(Optional)_ Provide full JSON-formatted information for transaction/account information instead of only hashes. Defaults to `false`. Ignored unless you request transactions, accounts, or both. |
|
||||
| `owner_funds` | Boolean | _(Optional)_ If `true`, include `owner_funds` field in the metadata of OfferCreate transactions in the response. Defaults to `false`. Ignored unless transactions are included and `expand` is true. |
|
||||
| `binary` | Boolean | _(Optional)_ If `true`, and `transactions` and `expand` are both also `true`, return transaction information in binary format (hexadecimal string) instead of JSON format. [New in: rippled 0.28.0][] |
|
||||
@@ -3490,12 +3490,11 @@ Each member of the `queue_data` array represents one transaction in the queue. S
|
||||
| `tx` | String or Object | By default, this is a String containing the [identifying hash](#hashes) of the transaction. If transactions are expanded in binary format, this is an object whose only field is `tx_blob`, containing the binary form of the transaction as a decimal string. If transactions are expanded in JSON format, this is an object containing the [transaction object](reference-transaction-format.html) including the transaction's identifying hash in the `hash` field. |
|
||||
| `retries_remaining` | Number | How many times this transaction can be retried before being dropped. |
|
||||
| `preflight_result` | String | The tentative result from preliminary transaction checking. This is always `tesSUCCESS`. |
|
||||
| `last_result` | String | _(May be omitted)_ If this transaction was put in the queue after getting a [retriable (`ter`) result](reference-transaction-format.html#result-categories), this is the exact `ter` result code it got. |
|
||||
| `last_result` | String | _(May be omitted)_ If this transaction was left in the queue after getting a [retriable (`ter`) result](reference-transaction-format.html#result-categories), this is the exact `ter` result code it got. |
|
||||
| `auth_change` | Boolean | _(May be omitted)_ Whether this transaction changes this address's [ways of authorizing transactions](reference-transaction-format.html#authorizing-transactions). |
|
||||
| `fee` | String | _(May be omitted)_ The [Transaction Cost](concept-transaction-cost.html) of this transaction, in [drops of XRP](#specifying-currency-amounts). |
|
||||
| `fee_level` | String | _(May be omitted)_ The transaction cost of this transaction, relative to the minimum cost for this type of transaction, in [fee levels][]. |
|
||||
| `max_spend_drops` | String | _(May be omitted)_ The maximum amount of XRP, [in drops](#specifying-currency-amounts), this transaction could send or destroy. |
|
||||
| `seq` | Integer | _(May be omitted)_ The [Sequence Number][] of this transaction. |
|
||||
| `max_spend_drops` | String | _(May be omitted)_ The maximum amount of XRP, [in drops](#specifying-currency-amounts), this transaction could potentially send or destroy. |
|
||||
|
||||
If the request specified `"owner_funds": true` and expanded transactions, the response has a field `owner_funds` in the `metaData` object of each [OfferCreate-type transaction](reference-transaction-format.html#offercreate). The purpose of this field is to make it easier to track the [funding status of offers](reference-transaction-format.html#lifecycle-of-an-offer) with each new validated ledger. This field is defined slightly differently than the version of this field in [Order Book subscription streams](#order-book-streams):
|
||||
|
||||
|
||||
@@ -4210,17 +4210,17 @@ rippled ledger current
|
||||
<tr>
|
||||
<td align="left"><code>full</code></td>
|
||||
<td align="left">Boolean</td>
|
||||
<td align="left"><em>(Optional)</em> <strong>Admin required</strong> If <code>true</code>, return full information on the entire ledger. Ignored if you did not specify a ledger. Defaults to <code>false</code>. (Equivalent to enabling <code>transactions</code>, <code>accounts</code>, and <code>expand</code>.) <strong>Caution:</strong> This is a very large amount of data -- on the order of several hundred megabytes!</td>
|
||||
<td align="left"><em>(Optional)</em> <strong>Admin required</strong> If <code>true</code>, return full information on the entire ledger. Ignored if you did not specify a ledger version. Defaults to <code>false</code>. (Equivalent to enabling <code>transactions</code>, <code>accounts</code>, and <code>expand</code>.) <strong>Caution:</strong> This is a very large amount of data -- on the order of several hundred megabytes!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>accounts</code></td>
|
||||
<td align="left">Boolean</td>
|
||||
<td align="left"><em>(Optional)</em> <strong>Admin required.</strong> If <code>true</code>, return information on accounts in the ledger. Ignored if you did not specify a ledger. Defaults to <code>false</code>. <strong>Caution:</strong> This returns a very large amount of data!</td>
|
||||
<td align="left"><em>(Optional)</em> <strong>Admin required.</strong> If <code>true</code>, return information on accounts in the ledger. Ignored if you did not specify a ledger version. Defaults to <code>false</code>. <strong>Caution:</strong> This returns a very large amount of data!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>transactions</code></td>
|
||||
<td align="left">Boolean</td>
|
||||
<td align="left"><em>(Optional)</em> If <code>true</code>, return information on transactions in the specified ledger version. Defaults to <code>false</code>. Ignored if you did not specify a ledger.</td>
|
||||
<td align="left"><em>(Optional)</em> If <code>true</code>, return information on transactions in the specified ledger version. Defaults to <code>false</code>. Ignored if you did not specify a ledger version.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>expand</code></td>
|
||||
@@ -4434,7 +4434,7 @@ rippled ledger current
|
||||
<tr>
|
||||
<td align="left"><code>last_result</code></td>
|
||||
<td align="left">String</td>
|
||||
<td align="left"><em>(May be omitted)</em> If this transaction was put in the queue after getting a <a href="reference-transaction-format.html#result-categories">retriable (<code>ter</code>) result</a>, this is the exact <code>ter</code> result code it got.</td>
|
||||
<td align="left"><em>(May be omitted)</em> If this transaction was left in the queue after getting a <a href="reference-transaction-format.html#result-categories">retriable (<code>ter</code>) result</a>, this is the exact <code>ter</code> result code it got.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>auth_change</code></td>
|
||||
@@ -4454,12 +4454,7 @@ rippled ledger current
|
||||
<tr>
|
||||
<td align="left"><code>max_spend_drops</code></td>
|
||||
<td align="left">String</td>
|
||||
<td align="left"><em>(May be omitted)</em> The maximum amount of XRP, <a href="#specifying-currency-amounts">in drops</a>, this transaction could send or destroy.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>seq</code></td>
|
||||
<td align="left">Integer</td>
|
||||
<td align="left"><em>(May be omitted)</em> The <a href="#account-sequence">Sequence Number</a> of this transaction.</td>
|
||||
<td align="left"><em>(May be omitted)</em> The maximum amount of XRP, <a href="#specifying-currency-amounts">in drops</a>, this transaction could potentially send or destroy.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Reference in New Issue
Block a user