ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2026-06-04 17:26:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

revert HTML files to local links

Browse Source
This commit is contained in:
mDuo13
2016-03-07 18:49:11 -08:00
parent 30a5b6d04b
commit bafd714dac
21 changed files with 830 additions and 811 deletions
Download Patch File Download Diff File Expand all files Collapse all files

165
reference-data-api.html
View File

@@ -47,44 +47,44 @@
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">References <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://ripple.com/build/rippled-apis/">rippled</a></li>
<li><a href="https://ripple.com/build/transactions/">Transaction Format</a></li>
<li><a href="https://ripple.com/build/ledger-format/">Ledger Format</a></li>
<li><a href="https://ripple.com/build/rippleapi/">RippleAPI</a></li>
<li><a href="https://ripple.com/build/data-api-v2/">Ripple Data API v2</a></li>
<li><a href="reference-rippled.html">rippled</a></li>
<li><a href="reference-transaction-format.html">Transaction Format</a></li>
<li><a href="reference-ledger-format.html">Ledger Format</a></li>
<li><a href="reference-rippleapi.html">RippleAPI</a></li>
<li><a href="reference-data-api.html">Ripple Data API v2</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Tutorials <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://ripple.com/build/rippleapi-beginners-guide/">RippleAPI Beginners Guide</a></li>
<li><a href="https://ripple.com/build/rippled-setup/">rippled Setup</a></li>
<li><a href="https://ripple.com/build/reliable-transaction-submission/">Reliable Transaction Submission</a></li>
<li><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
<li><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
<li><a href="tutorial-reliable-transaction-submission.html">Reliable Transaction Submission</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Concepts <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://ripple.com/build/paths/">Paths</a></li>
<li><a href="https://ripple.com/knowledge_center/fees-disambiguation/">Fees (Disambiguation)</a></li>
<li><a href="https://ripple.com/knowledge_center/transfer-fees/">Transfer Fees</a></li>
<li><a href="https://ripple.com/build/transaction-cost/">Transaction Cost</a></li>
<li><a href="https://ripple.com/build/fee-voting/">Fee Voting</a></li>
<li><a href="https://ripple.com/build/reserves/">Reserves</a></li>
<li><a href="https://ripple.com/build/freeze/">Freeze</a></li>
<li><a href="concept-paths.html">Paths</a></li>
<li><a href="concept-fees.html">Fees (Disambiguation)</a></li>
<li><a href="concept-transfer-fees.html">Transfer Fees</a></li>
<li><a href="concept-transaction-cost.html">Transaction Cost</a></li>
<li><a href="concept-fee-voting.html">Fee Voting</a></li>
<li><a href="concept-reserves.html">Reserves</a></li>
<li><a href="concept-freeze.html">Freeze</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">Best Practices <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://ripple.com/build/gateway-guide/#hot-and-cold-wallets">Issuing and Operational Acounts</a></li>
<li><a href="https://ripple.com/build/gateway-guide/">Gateway Guide</a></li>
<li><a href="concept-issuing-and-operational-accounts.html">Issuing and Operational Acounts</a></li>
<li><a href="tutorial-gateway-guide.html">Gateway Guide</a></li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" data-toggle="dropdown" href="#">API Tools <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://ripple.com/build/websocket-tool/">WebSocket API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="data-api-v2-tool.html">Data API v2 Tool</a></li>
<li><a href="tool-jsonrpc.html">rippled JSON-RPC Tool</a></li>
</ul>
@@ -110,11 +110,11 @@
<div id="cont">
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="https://ripple.com/build/rippled-apis/">rippled</a></li>
<li class="level-2"><a href="https://ripple.com/build/transactions/">Transaction Format</a></li>
<li class="level-2"><a href="https://ripple.com/build/ledger-format/">Ledger Format</a></li>
<li class="level-2"><a href="https://ripple.com/build/rippleapi/">RippleAPI</a></li>
<li class="level-2"><a href="https://ripple.com/build/data-api-v2/">Ripple Data API v2</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
<li class="level-2"><a href="reference-ledger-format.html">Ledger Format</a></li>
<li class="level-2"><a href="reference-rippleapi.html">RippleAPI</a></li>
<li class="level-2"><a href="reference-data-api.html">Ripple Data API v2</a></li>
</ul>
<hr/>
<h5>In this page:</h5>
@@ -437,12 +437,12 @@
<tr>
<td>type</td>
<td>String</td>
<td>Filter transactions to a specific <a href="https://ripple.com/build/transactions/">transaction type</a>.</td>
<td>Filter transactions to a specific <a href="reference-transaction-format.html">transaction type</a>.</td>
</tr>
<tr>
<td>result</td>
<td>String</td>
<td>Filter transactions for a specific <a href="https://ripple.com/build/transactions/#transaction-results">transaction result</a>.</td>
<td>Filter transactions for a specific <a href="reference-transaction-format.html#transaction-results">transaction result</a>.</td>
</tr>
<tr>
<td>binary</td>
@@ -1499,12 +1499,12 @@
<tbody>
<tr>
<td>type</td>
<td>All Ripple <a href="https://ripple.com/build/transactions/">transaction types</a>, including <code>Payment</code>, <code>AccountSet</code>, <code>SetRegularKey</code>, <code>OfferCreate</code>, <code>OfferCancel</code>, <code>TrustSet</code>.</td>
<td>All Ripple <a href="reference-transaction-format.html">transaction types</a>, including <code>Payment</code>, <code>AccountSet</code>, <code>SetRegularKey</code>, <code>OfferCreate</code>, <code>OfferCancel</code>, <code>TrustSet</code>.</td>
<td>Number of transactions of the given type that occurred during the interval.</td>
</tr>
<tr>
<td>result</td>
<td>All <a href="https://ripple.com/build/transactions/#transaction-results">transaction result codes</a> (string codes, not the numeric codes), including <code>tesSUCCESS</code>, <code>tecPATH_DRY</code>, and many others.</td>
<td>All <a href="reference-transaction-format.html#transaction-results">transaction result codes</a> (string codes, not the numeric codes), including <code>tesSUCCESS</code>, <code>tecPATH_DRY</code>, and many others.</td>
<td>Number of transactions that resulted in the given code during the interval.</td>
</tr>
<tr>
@@ -2803,12 +2803,12 @@
<tr>
<td>accounts</td>
<td>Array</td>
<td>A list of <a href="https://ripple.com/build/gateway-guide/#hot-and-cold-wallets">issuing accounts</a> (cold wallets) used by this gateway. (Gateways may use different issuing accounts for different currencies.)</td>
<td>A list of <a href="concept-issuing-and-operational-accounts.html">issuing accounts</a> (cold wallets) used by this gateway. (Gateways may use different issuing accounts for different currencies.)</td>
</tr>
<tr>
<td>hotwallets</td>
<td>Array of <a href="#addresses">Address</a>es</td>
<td>The addresses of the Ripple accounts this gateway uses as <a href="https://ripple.com/build/gateway-guide/#hot-and-cold-wallets">operational accounts</a>.</td>
<td>The addresses of the Ripple accounts this gateway uses as <a href="concept-issuing-and-operational-accounts.html">operational accounts</a>.</td>
</tr>
<tr>
<td>domain</td>
@@ -2840,7 +2840,7 @@
<tr>
<td>address</td>
<td>String</td>
<td>The <a href="#addresses">Address</a> of an <a href="https://ripple.com/build/gateway-guide/#hot-and-cold-wallets">issuing account</a> (cold wallet) used by this gateway.</td>
<td>The <a href="#addresses">Address</a> of an <a href="concept-issuing-and-operational-accounts.html">issuing account</a> (cold wallet) used by this gateway.</td>
</tr>
<tr>
<td>currencies</td>
@@ -3576,7 +3576,7 @@ Content-Type: image/svg+xml
<tr>
<td>type</td>
<td>String</td>
<td>Restrict results to a specified <a href="https://ripple.com/build/transactions/">transaction type</a></td>
<td>Restrict results to a specified <a href="reference-transaction-format.html">transaction type</a></td>
</tr>
<tr>
<td>result</td>
@@ -3851,13 +3851,23 @@ Content-Type: image/svg+xml
</tr>
<tr>
<td>currency</td>
<td>String</td>
<td>Restrict results to specified currency</td>
<td>String - <a href="#currency-code">Currency Code</a></td>
<td>Filter results to specified currency</td>
</tr>
<tr>
<td>issuer</td>
<td>String</td>
<td>Restrict results to specified issuer</td>
<td>String - <a href="#addresses">Address</a></td>
<td>Filter results to specified issuer</td>
</tr>
<tr>
<td>source_tag</td>
<td>Integer</td>
<td>Filter results to specified source tag</td>
</tr>
<tr>
<td>destination_tag</td>
<td>Integer</td>
<td>Filter results to specified destination tag</td>
</tr>
<tr>
<td>descending</td>
@@ -3934,7 +3944,6 @@ Content-Type: image/svg+xml
"value": "1"
}
],
"transaction_cost": "1.0E-5",
"source_balance_changes": [
{
"counterparty": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
@@ -3942,14 +3951,16 @@ Content-Type: image/svg+xml
"value": "-1"
}
],
"tx_index": 1,
"currency": "USD",
"destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"executed_time": "2014-06-02T22:47:50",
"executed_time": "2014-06-02T22:47:50Z",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ledger_index": 6979192,
"source": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"source_currency": "USD",
"tx_hash": "7BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E"
"tx_hash": "7BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E",
"transaction_cost": "1.0E-5"
}
]
}
@@ -4241,40 +4252,38 @@ Content-Type: image/svg+xml
<pre><code>{
"result": "success",
"count": 3,
"marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20150616212230|000014091020|00003|$",
"marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20160122235211|000018425487|00010|00001",
"balance_changes": [
{
"change": "-0.012",
"final_balance": "148.446663",
"tx_index": 1,
"amount_change": "-0.012",
"final_balance": "75.169663",
"tx_index": 7,
"change_type": "transaction_cost",
"currency": "XRP",
"executed_time": "2015-06-16T21:32:40",
"ledger_index": 14091160,
"tx_hash": "0D5FB50FA65C9FE1538FD7E398FFFE9D1908DFA4576D8D7A020040686F93C77D",
"node_index": null
"executed_time": "2016-01-29T22:57:20Z",
"ledger_index": 18555460,
"tx_hash": "2B44EBE00728D04658E597A85EC4F71D20503B31ABBF556764AD8F7A80BA72F6"
},
{
"change": "-0.012",
"final_balance": "148.458663",
"tx_index": 20,
"change_type": "transaction_cost",
"currency": "XRP",
"executed_time": "2015-06-16T21:22:40",
"ledger_index": 14091022,
"tx_hash": "26C1C876D709380DF7136F307B84E7F16CD74381F82E9B2D352A92069C880D66",
"node_index": null
},
{
"change": "-30.0",
"final_balance": "148.470663",
"node_index": 0,
"tx_index": 3,
"amount_change": "-25.0",
"final_balance": "75.181663",
"node_index": 1,
"tx_index": 4,
"change_type": "payment_source",
"currency": "XRP",
"executed_time": "2015-06-16T21:22:30",
"ledger_index": 14091020,
"tx_hash": "73699F26E2A4A8703EB48684FF38CD6362B7ABF217576AB460CBAA64D383D9EC"
"executed_time": "2016-01-26T08:32:20Z",
"ledger_index": 18489336,
"tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9"
},
{
"amount_change": "-0.01",
"final_balance": "100.181663",
"tx_index": 4,
"change_type": "transaction_cost",
"currency": "XRP",
"executed_time": "2016-01-26T08:32:20Z",
"ledger_index": 18489336,
"tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9"
}
]
}
@@ -4704,7 +4713,7 @@ Content-Type: image/svg+xml
<tr>
<td>rrrrrrrrrrrrrrrrrrrrBZbvji</td>
<td>ACCOUNT_ONE</td>
<td>An address that is the base-58 encoding of the value <code>1</code>. In the ledger, <a href="https://ripple.com/build/ledger-format/#ripplestate">RippleState entries</a> use this address as a placeholder for the issuer of a trust line balance.</td>
<td>An address that is the base-58 encoding of the value <code>1</code>. In the ledger, <a href="reference-ledger-format.html#ripplestate">RippleState entries</a> use this address as a placeholder for the issuer of a trust line balance.</td>
<td>Yes</td>
</tr>
<tr>
@@ -4758,8 +4767,8 @@ Content-Type: image/svg+xml
</ul>
<h3 id="account-sequence">Account Sequence</h3>
<p>A Sequence number is a 32-bit unsigned integer used to identify a transaction or Offer relative to a specific account.</p>
<p>Every <a href="https://ripple.com/build/ledger-format/#accountroot">account object in the Ripple Consensus Ledger</a> has a Sequence number, which starts at 1. For a transaction to be relayed to the network and possibly included in a validated ledger, it must have a <code>Sequence</code> field that matches the sending account's current <code>Sequence</code> number. An account's Sequence field is incremented whenever a transaction from that account is included in a validated ledger (regardless of whether the transaction succeeded or failed). This preserves the order of transactions submitted by an account, and differentiates transactions that would otherwise be identical.</p>
<p>Every <a href="https://ripple.com/build/ledger-format/#offer">Offer node in the Ripple Consensus Ledger</a> is marked with the sending <code>Account</code> <a href="#addresses">Address</a> and the <code>Sequence</code> value of the <a href="https://ripple.com/build/transactions/#offercreate">OfferCreate transaction</a> that created it. These two fields, together, uniquely identify the Offer.</p>
<p>Every <a href="reference-ledger-format.html#accountroot">account object in the Ripple Consensus Ledger</a> has a Sequence number, which starts at 1. For a transaction to be relayed to the network and possibly included in a validated ledger, it must have a <code>Sequence</code> field that matches the sending account's current <code>Sequence</code> number. An account's Sequence field is incremented whenever a transaction from that account is included in a validated ledger (regardless of whether the transaction succeeded or failed). This preserves the order of transactions submitted by an account, and differentiates transactions that would otherwise be identical.</p>
<p>Every <a href="reference-ledger-format.html#offer">Offer node in the Ripple Consensus Ledger</a> is marked with the sending <code>Account</code> <a href="#addresses">Address</a> and the <code>Sequence</code> value of the <a href="reference-transaction-format.html#offercreate">OfferCreate transaction</a> that created it. These two fields, together, uniquely identify the Offer.</p>
<h3 id="currency-code">Currency Code</h3>
<p>There are two kinds of currency code in the Ripple Consensus Ledger:</p>
<ul>
@@ -4801,7 +4810,7 @@ Content-Type: image/svg+xml
<tr>
<td>tx</td>
<td>Object</td>
<td>The fields of this transaction object, as defined by the <a href="https://ripple.com/build/transactions/">Transaction Format</a></td>
<td>The fields of this transaction object, as defined by the <a href="reference-transaction-format.html">Transaction Format</a></td>
</tr>
<tr>
<td>meta</td>
@@ -5182,7 +5191,7 @@ Content-Type: image/svg+xml
</tbody>
</table>
<h2 id="payment-objects">Payment Objects</h2>
<p>In the Data API, a Payment Object represents an event where one account sent value to another account. This mostly lines up with Ripple transactions of the <code>Payment</code> <a href="https://ripple.com/build/transactions/">transaction type</a>, except that the Data API does not consider a transaction to be a payment if the sending <code>Account</code> and the <code>Destination</code> account are the same, or if the transaction failed.</p>
<p>In the Data API, a Payment Object represents an event where one account sent value to another account. This mostly lines up with Ripple transactions of the <code>Payment</code> <a href="reference-transaction-format.html">transaction type</a>, except that the Data API does not consider a transaction to be a payment if the sending <code>Account</code> and the <code>Destination</code> account are the same, or if the transaction failed.</p>
<p>Payment objects have the following fields:</p>
<table>
<thead>
@@ -5219,6 +5228,16 @@ Content-Type: image/svg+xml
<td>The amount of XRP spent by the <code>source</code> account on the transaction cost. (Prior to <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.4">v2.0.4</a>, this parameter was called <code>fee</code>.)</td>
</tr>
<tr>
<td>destination_tag</td>
<td>Integer</td>
<td>(May be omitted) A <a href="tutorial-gateway-guide.html#source-and-destination-tags">destination tag</a> specified in this payment.</td>
</tr>
<tr>
<td>source_tag</td>
<td>Integer</td>
<td>(May be omitted) A <a href="tutorial-gateway-guide.html#source-and-destination-tags">source tag</a> specified in this payment.</td>
</tr>
<tr>
<td>currency</td>
<td>String - <a href="#currency-code">Currency Code</a></td>
<td>The currency that the <code>destination</code> account received.</td>
@@ -5298,9 +5317,9 @@ Content-Type: image/svg+xml
</thead>
<tbody>
<tr>
<td>change</td>
<td>amount_change</td>
<td><a href="#numbers-and-precision">String - Number</a></td>
<td>The difference in the amount of currency held before and after this change.</td>
<td>The difference in the amount of currency held before and after this change. <em>(Prior to <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.6">v2.0.6</a>, this field was called <code>change</code>.)</em></td>
</tr>
<tr>
<td>final_balance</td>
@@ -5333,9 +5352,9 @@ Content-Type: image/svg+xml
<td>The time the change occurred. (This is based on the close time of the ledger that included the transaction that executed the change.</td>
</tr>
<tr>
<td>issuer</td>
<td>counterparty</td>
<td>String - <a href="#addresses">Address</a></td>
<td>(Omitted for XRP) The <code>currency</code> was issued by this account.</td>
<td>(Omitted for XRP) The <code>currency</code> is held in a trust line to or from this account. <em>(Prior to <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.6">v2.0.6</a>, this field was called <code>issuer</code>.)</em></td>
</tr>
<tr>
<td>ledger_index</td>