ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 03:35:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

rippled - account_info queue stats (v0.33.0)

Browse Source
This commit is contained in:
mDuo13
2016-09-19 16:07:59 -07:00
parent 5f3902d4f1
commit e4e2a714b6
6 changed files with 526 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
concept-amendments.html
View File

@@ -484,7 +484,7 @@ TrustSetAuth
</table>
<p>Introduces Tickets as a way to reserve a transaction sequence number for later execution. Creates the <code>Ticket</code> ledger node type and the transaction types <code>TicketCreate</code> and <code>TicketCancel</code>.</p>
<p>This amendment is still in development.
<!---- rippled release notes links ----></p>
<!-- rippled release notes links --></p>
</div>
</main>
</div>

136
content/reference-rippled.md
View File

@@ -224,8 +224,9 @@ The fields of a successful response include:
| Field | Type | Description |
|-------|------|-------------|
| `id` | (Varies) | (WebSocket only) ID provided in the request that prompted this response |
| `status` (WebSocket) <br\> `result.status` (JSON-RPC and Commandline) | String | `"success"` if the request was successful. In the WebSocket API responses, this is included at the top level; in JSON-RPC and Commandline responses, this is included as a sub-field of the `"result"` object. |
| `type` | String | (WebSocket only) Typically `"response"`, which indicates a successful response to a command. Asynchronous notifications use a different value such as `"ledgerClosed"` or `"transaction"`. |
| `status` | String | (WebSocket only) The value `success` indicates the request was successfully received and understood by the server. |
| `result.status` | String | (JSON-RPC and Commandline) The value `success` indicates the request was successfully received and understood by the server. |
| `type` | String | (WebSocket only) The value `response` indicates a successful response to a command. [Asynchronous notifications](#subscriptions) use a different value such as `ledgerClosed` or `transaction`. |
| `result` | Object | The result of the query; contents vary depending on the command. |
#### Commandline ####
@@ -755,7 +756,8 @@ An example of an account_info request:
"command": "account_info",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated"
"ledger_index": "current",
"queue": true
}
```
@@ -766,9 +768,10 @@ An example of an account_info request:
"method": "account_info",
"params": [
{
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"strict": true,
"ledger_index": "validated"
"ledger_index": "current",
"queue": true
}
]
}
@@ -793,6 +796,7 @@ The request contains the following parameters:
| strict | Boolean | (Optional, defaults to False) If set to True, then the `account` field only accepts a public key or Ripple address. |
| 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))|
| queue | Boolean | (Optional) If `true`, and the [FeeEscalation amendment](concept-amendments.html#feeescalation) 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](concept-amendments.html#multisign) is enabled, also returns any [SignerList objects](reference-ledger-format.html#signerlist) associated with this account. _(New in [`rippled` 0.31.0][])_ |
The following fields are deprecated and should not be provided: `ident`, `ledger`.
@@ -812,17 +816,97 @@ An example of a successful response:
"type": "response",
"result": {
"account_data": {
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Balance": "27389517749",
"Flags": 0,
"Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"Balance": "999999999960",
"Flags": 8388608,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 18,
"PreviousTxnID": "2F804E1A00DBCBDAFBDB7D001409F79FE196785EB68FBA463E5924002BE4DEE9",
"PreviousTxnLgrSeq": 6405716,
"Sequence": 1400,
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
"OwnerCount": 0,
"PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
"PreviousTxnLgrSeq": 3,
"Sequence": 6,
"index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
},
"ledger_current_index": 6507948
"ledger_current_index": 4,
"queue_data": {
"auth_change_queued": true,
"highest_sequence": 10,
"lowest_sequence": 6,
"max_spend_drops_total": "500",
"transactions": [
{
"auth_change": false,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 6
},
... (trimmed for length) ...
{
"LastLedgerSequence": 10,
"auth_change": true,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 10
}
],
"txn_count": 5
},
"validated": false
}
}
```
*JSON-RPC*
```
{
"result": {
"account_data": {
"Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"Balance": "999999999960",
"Flags": 8388608,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 0,
"PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
"PreviousTxnLgrSeq": 3,
"Sequence": 6,
"index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
},
"ledger_current_index": 4,
"queue_data": {
"auth_change_queued": true,
"highest_sequence": 10,
"lowest_sequence": 6,
"max_spend_drops_total": "500",
"transactions": [
{
"auth_change": false,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 6
},
... (trimmed for length) ...
{
"LastLedgerSequence": 10,
"auth_change": true,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 10
}
],
"txn_count": 5
},
"status": "success",
"validated": false
}
}
```
@@ -837,12 +921,34 @@ The response follows the [standard format](#response-formatting), with the resul
| signer\_lists | Array | (Omitted unless the request specified `signer_lists` and at least one SignerList is associated with the account.) Array of [SignerList ledger nodes](reference-ledger-format.html#signerlist) associated with this account for [Multi-Signing](reference-transaction-format.html#multi-signing). Since an account can own at most 1 SignerList, this array should always have exactly 1 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`) Information about [queued transactions](concept-transaction-cost.html#queued-transactions) sent by this account. Some information is calculated "lazily" and may not be available. This information describes the state of the local `rippled` server, which may be different from other servers in the consensus network. |
| 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:
| Field | Type | Description |
|-------|------|-------------|
| txn\_count | Integer | Number of queued transactions from this address. |
| auth\_change\_queued | Boolean | (May be omitted) Whether a transaction in the queue changes this address's [ways of authorizing transactions](reference-transaction-format.html#authorizing-transactions). If `true`, this address can queue no further transactions until that transaction has been executed or dropped from the queue. |
| lowest\_sequence | Integer | (May be omitted) The lowest [Sequence Number][] among transactions queued by this address. |
| highest\_sequence | Integer | (May be omitted) The highest [Sequence Number][] among transactions queued by this address. |
| max\_spend\_drops\_total | String | (May be omitted) Integer amount of [drops of XRP](#specifying-currency-amounts) that could be debited from this address if every transaction in the queue consumes the maximum amount of XRP possible. |
| transactions | Array | (May be omitted) Information about each queued transaction from this address. |
Each object in the `transactions` array, if present, may contain any or all of the following fields:
| Field | Type | Description |
|-------|------|-------------|
| auth\_change | Boolean | Whether this transaction changes this address's [ways of authorizing transactions](reference-transaction-format.html#authorizing-transactions). |
| fee | String | The [Transaction Cost](concept-transaction-cost.html) of this transaction, in [drops of XRP](#specifying-currency-amounts). |
| fee\_level | String | The transaction cost of this transaction, relative to the minimum cost for this type of transaction, in [fee levels][]. |
| max\_spend\_drops | The maximum amount of XRP, [in drops](#specifying-currency-amounts), this transaction could send or destroy. |
| seq | Integer | The [Sequence Number][] of this transaction. |
#### Possible Errors ####
* Any of the [universal error types](#universal-errors).
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. For example, the request specified `queue` as `true` but specified a `ledger_index` that is not the current open ledger.
* `actNotFound` - The address specified in the `account` field of the request does not correspond to an account in the ledger.
* `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it.

6
content/snippets/rippled_versions.md
View File

@@ -1,4 +1,5 @@
<!---- rippled release notes links ---->
<!-- rippled release notes links -->
[`rippled` 0.26.0]: https://github.com/ripple/rippled/releases/tag/0.26.0
[`rippled` 0.26.1]: https://github.com/ripple/rippled/releases/tag/0.26.1
[`rippled` 0.26.2]: https://github.com/ripple/rippled/releases/tag/0.26.2
@@ -20,3 +21,6 @@
[`rippled` 0.30.1]: https://github.com/ripple/rippled/releases/tag/0.30.1
[`rippled` 0.31.0]: https://github.com/ripple/rippled/releases/tag/0.31.0
[`rippled` 0.32.0]: https://github.com/ripple/rippled/releases/tag/0.32.0
[`rippled` 0.32.0]: https://github.com/ripple/rippled/releases/tag/0.32.0
[`rippled` 0.32.1]: https://github.com/ripple/rippled/releases/tag/0.32.1
[`rippled` 0.33.0]: https://github.com/ripple/rippled/releases/tag/0.33.0

209
reference-rippled.html
View File

@@ -450,14 +450,19 @@
<td>(WebSocket only) ID provided in the request that prompted this response</td>
</tr>
<tr>
<td><code>status</code> (WebSocket) &lt;br&gt; <code>result.status</code> (JSON-RPC and Commandline)</td>
<td><code>status</code></td>
<td>String</td>
<td><code>"success"</code> if the request was successful. In the WebSocket API responses, this is included at the top level; in JSON-RPC and Commandline responses, this is included as a sub-field of the <code>"result"</code> object.</td>
<td>(WebSocket only) The value <code>success</code> indicates the request was successfully received and understood by the server.</td>
</tr>
<tr>
<td><code>result.status</code></td>
<td>String</td>
<td>(JSON-RPC and Commandline) The value <code>success</code> indicates the request was successfully received and understood by the server.</td>
</tr>
<tr>
<td><code>type</code></td>
<td>String</td>
<td>(WebSocket only) Typically <code>"response"</code>, which indicates a successful response to a command. Asynchronous notifications use a different value such as <code>"ledgerClosed"</code> or <code>"transaction"</code>.</td>
<td>(WebSocket only) The value <code>response</code> indicates a successful response to a command. <a href="#subscriptions">Asynchronous notifications</a> use a different value such as <code>ledgerClosed</code> or <code>transaction</code>.</td>
</tr>
<tr>
<td><code>result</code></td>
@@ -1107,7 +1112,8 @@ Null method
"command": "account_info",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated"
"ledger_index": "current",
"queue": true
}
</code></pre></div>
@@ -1115,9 +1121,10 @@ Null method
"method": "account_info",
"params": [
{
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"strict": true,
"ledger_index": "validated"
"ledger_index": "current",
"queue": true
}
]
}
@@ -1159,6 +1166,11 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
<td>(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See <a href="#specifying-ledgers">Specifying a Ledger</a>)</td>
</tr>
<tr>
<td>queue</td>
<td>Boolean</td>
<td>(Optional) If <code>true</code>, and the <a href="concept-amendments.html#feeescalation">FeeEscalation amendment</a> 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. <em>(New in [<code>rippled</code> 0.33.0][])</em></td>
</tr>
<tr>
<td>signer_lists</td>
<td>Boolean</td>
<td>(Optional) If <code>true</code>, and the <a href="concept-amendments.html#multisign">MultiSign amendment</a> is enabled, also returns any <a href="reference-ledger-format.html#signerlist">SignerList objects</a> associated with this account. <em>(New in [<code>rippled</code> 0.31.0][])</em></td>
@@ -1168,7 +1180,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
<p>The following fields are deprecated and should not be provided: <code>ident</code>, <code>ledger</code>.</p>
<h4 id="response-format-1">Response Format</h4>
<p>An example of a successful response:</p>
<div class="multicode" id="code-6"><ul class="codetabs"><li><a href="#code-6-0">WebSocket</a></li></ul>
<div class="multicode" id="code-6"><ul class="codetabs"><li><a href="#code-6-0">WebSocket</a></li><li><a href="#code-6-1">JSON-RPC</a></li></ul>
<div class="code_sample" id="code-6-0" style="position: static;"><pre><code>{
"id": 5,
@@ -1176,17 +1188,94 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
"type": "response",
"result": {
"account_data": {
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Balance": "27389517749",
"Flags": 0,
"Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"Balance": "999999999960",
"Flags": 8388608,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 18,
"PreviousTxnID": "2F804E1A00DBCBDAFBDB7D001409F79FE196785EB68FBA463E5924002BE4DEE9",
"PreviousTxnLgrSeq": 6405716,
"Sequence": 1400,
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
"OwnerCount": 0,
"PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
"PreviousTxnLgrSeq": 3,
"Sequence": 6,
"index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
},
"ledger_current_index": 6507948
"ledger_current_index": 4,
"queue_data": {
"auth_change_queued": true,
"highest_sequence": 10,
"lowest_sequence": 6,
"max_spend_drops_total": "500",
"transactions": [
{
"auth_change": false,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 6
},
... (trimmed for length) ...
{
"LastLedgerSequence": 10,
"auth_change": true,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 10
}
],
"txn_count": 5
},
"validated": false
}
}
</code></pre></div>
<div class="code_sample" id="code-6-1" style="position: static;"><pre><code>{
"result": {
"account_data": {
"Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"Balance": "999999999960",
"Flags": 8388608,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 0,
"PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
"PreviousTxnLgrSeq": 3,
"Sequence": 6,
"index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
},
"ledger_current_index": 4,
"queue_data": {
"auth_change_queued": true,
"highest_sequence": 10,
"lowest_sequence": 6,
"max_spend_drops_total": "500",
"transactions": [
{
"auth_change": false,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 6
},
... (trimmed for length) ...
{
"LastLedgerSequence": 10,
"auth_change": true,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 10
}
],
"txn_count": 5
},
"status": "success",
"validated": false
}
}
</code></pre></div>
@@ -1222,16 +1311,100 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
<td>(Omitted if <code>ledger_current_index</code> 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.</td>
</tr>
<tr>
<td>queue_data</td>
<td>Object</td>
<td>(Omitted unless <code>queue</code> specified as <code>true</code>) Information about <a href="concept-transaction-cost.html#queued-transactions">queued transactions</a> sent by this account. Some information is calculated "lazily" and may not be available. This information describes the state of the local <code>rippled</code> server, which may be different from other servers in the consensus network.</td>
</tr>
<tr>
<td>validated</td>
<td>Boolean</td>
<td>True if this data is from a validated ledger version; if omitted or set to false, this data is not final. <em>(New in [<code>rippled</code> 0.26.0][])</em></td>
</tr>
</tbody>
</table>
<p>The <code>queue_data</code> parameter, if present, contains the following fields:</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>txn_count</td>
<td>Integer</td>
<td>Number of queued transactions from this address.</td>
</tr>
<tr>
<td>auth_change_queued</td>
<td>Boolean</td>
<td>(May be omitted) Whether a transaction in the queue changes this address's <a href="reference-transaction-format.html#authorizing-transactions">ways of authorizing transactions</a>. If <code>true</code>, this address can queue no further transactions until that transaction has been executed or dropped from the queue.</td>
</tr>
<tr>
<td>lowest_sequence</td>
<td>Integer</td>
<td>(May be omitted) The lowest <a href="#account-sequence">Sequence Number</a> among transactions queued by this address.</td>
</tr>
<tr>
<td>highest_sequence</td>
<td>Integer</td>
<td>(May be omitted) The highest <a href="#account-sequence">Sequence Number</a> among transactions queued by this address.</td>
</tr>
<tr>
<td>max_spend_drops_total</td>
<td>String</td>
<td>(May be omitted) Integer amount of <a href="#specifying-currency-amounts">drops of XRP</a> that could be debited from this address if every transaction in the queue consumes the maximum amount of XRP possible.</td>
</tr>
<tr>
<td>transactions</td>
<td>Array</td>
<td>(May be omitted) Information about each queued transaction from this address.</td>
</tr>
</tbody>
</table>
<p>Each object in the <code>transactions</code> array, if present, may contain any or all of the following fields:</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>auth_change</td>
<td>Boolean</td>
<td>Whether this transaction changes this address's <a href="reference-transaction-format.html#authorizing-transactions">ways of authorizing transactions</a>.</td>
</tr>
<tr>
<td>fee</td>
<td>String</td>
<td>The <a href="concept-transaction-cost.html">Transaction Cost</a> of this transaction, in <a href="#specifying-currency-amounts">drops of XRP</a>.</td>
</tr>
<tr>
<td>fee_level</td>
<td>String</td>
<td>The transaction cost of this transaction, relative to the minimum cost for this type of transaction, in <a href="concept-transaction-cost.html#fee-levels">fee levels</a>.</td>
</tr>
<tr>
<td>max_spend_drops</td>
<td>The maximum amount of XRP, <a href="#specifying-currency-amounts">in drops</a>, this transaction could send or destroy.</td>
<td></td>
</tr>
<tr>
<td>seq</td>
<td>Integer</td>
<td>The <a href="#account-sequence">Sequence Number</a> of this transaction.</td>
</tr>
</tbody>
</table>
<h4 id="possible-errors-1">Possible Errors</h4>
<ul>
<li>Any of the <a href="#universal-errors">universal error types</a>.</li>
<li><code>invalidParams</code> - One or more fields are specified incorrectly, or one or more required fields are missing.</li>
<li><code>invalidParams</code> - One or more fields are specified incorrectly, or one or more required fields are missing. For example, the request specified <code>queue</code> as <code>true</code> but specified a <code>ledger_index</code> that is not the current open ledger.</li>
<li><code>actNotFound</code> - The address specified in the <code>account</code> field of the request does not correspond to an account in the ledger.</li>
<li><code>lgrNotFound</code> - The ledger specified by the <code>ledger_hash</code> or <code>ledger_index</code> does not exist, or it does exist but the server does not have it.</li>
</ul>
@@ -13048,7 +13221,7 @@ protocol = peer
[peer_private]
1
</code></pre>
<!---- rippled release notes links ---->
<!-- rippled release notes links -->
</div>
</main>
</div>

2
reference-transaction-format.html
View File

@@ -2209,7 +2209,7 @@
</tr>
</tbody>
</table>
<!---- rippled release notes links ---->
<!-- rippled release notes links -->
</div>
</main>
</div>

3
tool/dactyl-config.yml
View File

@@ -344,6 +344,9 @@ known_broken_links:
# Strangely, Python doesn't like the cert here. Firefox is OK with it.
- https://validators.ripple.com
# rippled 0.33.0 is not released yet:
- https://github.com/ripple/rippled/releases/tag/0.33.0
# Style Checker Config ------------------------------------------------------ #
word_substitutions_file: word_substitutions.yaml