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

rippled - ledger cli tx option

Browse Source
This commit is contained in:
mDuo13
2016-02-10 17:42:49 -08:00
parent c7907d1afb
commit 60d9850683
2 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
content/rippled.md
View File

@@ -2911,6 +2911,7 @@ An example of the request format:
<!-- <div class='multicode'> --> <!-- <div class='multicode'> -->
*WebSocket* *WebSocket*
``` ```
{ {
"command": "ledger", "command": "ledger",
@@ -2923,6 +2924,7 @@ An example of the request format:
``` ```
*JSON-RPC* *JSON-RPC*
``` ```
{ {
"method": "ledger", "method": "ledger",
@@ -2939,9 +2941,12 @@ An example of the request format:
``` ```
*Commandline* *Commandline*
``` ```
#Syntax: ledger ledger_index|ledger_hash [full] #Syntax: ledger ledger_index|ledger_hash [full|tx]
rippled ledger current false # "full" is equivalent to "full": true
# "tx" is equivalent to "transactions": true
rippled ledger current
``` ```
<!-- </div> --> <!-- </div> -->
@@ -2954,7 +2959,7 @@ The request can contain the following parameters:
|-------|------|-------------| |-------|------|-------------|
| accounts | Boolean | (Optional, defaults to false) If true, return information on accounts in the ledger. *Admin required.* If enabled, this method returns a large amount of data, which may cause the request to fail due to a timeout, depending on the server load and capabilities. | | accounts | Boolean | (Optional, defaults to false) If true, return information on accounts in the ledger. *Admin required.* If enabled, this method returns a large amount of data, which may cause the request to fail due to a timeout, depending on the server load and capabilities. |
| transactions | Boolean | (Optional, defaults to false) If true, return information on transactions in the specified ledger version. | | transactions | Boolean | (Optional, defaults to false) If true, return information on transactions in the specified ledger version. |
| full | Boolean | (Optional, defaults to false) If true, return full information on the entire ledger. (Equivalent to enabling `transactions`, `accounts`, and `expand` *Admin required* | | full | Boolean | (Optional, defaults to false) **Admin required** If true, return full information on the entire ledger. (Equivalent to enabling `transactions`, `accounts`, and `expand`.) **Caution:** This is a very large amount of data -- on the order of several hundred megabytes! |
| expand | Boolean | (Optional, defaults to false) Provide full JSON-formatted information for transaction/account information instead of just hashes | | expand | Boolean | (Optional, defaults to false) Provide full JSON-formatted information for transaction/account information instead of just hashes |
| ledger\_hash | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | | 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))| | 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))|

8
rippled-apis.html
View File

@@ -3568,8 +3568,10 @@ rippled wallet_propose test
} }
</code></pre> </code></pre>
<p><em>Commandline</em></p> <p><em>Commandline</em></p>
<pre><code>#Syntax: ledger ledger_index|ledger_hash [full] <pre><code>#Syntax: ledger ledger_index|ledger_hash [full|tx]
rippled ledger current false # "full" is equivalent to "full": true
# "tx" is equivalent to "transactions": true
rippled ledger current
</code></pre> </code></pre>
</div> </div>
<p><a class="button" href="ripple-api-tool.html#ledger">Try it! &gt;</a></p> <p><a class="button" href="ripple-api-tool.html#ledger">Try it! &gt;</a></p>
@@ -3596,7 +3598,7 @@ rippled ledger current false
<tr> <tr>
<td>full</td> <td>full</td>
<td>Boolean</td> <td>Boolean</td>
<td>(Optional, defaults to false) If true, return full information on the entire ledger. (Equivalent to enabling <code>transactions</code>, <code>accounts</code>, and <code>expand</code> <em>Admin required</em></td> <td>(Optional, defaults to false) <strong>Admin required</strong> If true, return full information on the entire ledger. (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>
<tr> <tr>
<td>expand</td> <td>expand</td>