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

Dactyl - fix key inheritence from target, pre-gen sidebar; fee voting - fix header hierarchy

Browse Source
This commit is contained in:
mDuo13
2016-05-10 17:39:01 -07:00
parent 46a5b02a36
commit e5f7a60b17
27 changed files with 741 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
assets/js/jquery.gensidebar.js
View File

@@ -1,13 +0,0 @@
$(document).ready(function() {
tableOfContents = $("<ul class='dev_nav_sidebar'>").appendTo(".sidebar #cont")
$("h1, h2, h3").each(function() {
indent_level = this.tagName.toLowerCase().substr(1);
if (this.id) { //only show headers with IDs. which should be all of them.
href = "#"+this.id;
$("<li class='level-"+indent_level+"'><a href='"+href+"'>"+
$(this).text()+"</a></li>").appendTo(tableOfContents);
}
});
});

18
concept-amendments.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,23 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#amendments">Amendments</a></li>
<li class="level-2"><a href="#background">Background</a></li>
<li class="level-2"><a href="#about-amendments">About Amendments</a></li>
<li class="level-2"><a href="#amendment-process">Amendment Process</a></li>
<li class="level-2"><a href="#amendment-voting">Amendment Voting</a></li>
<li class="level-3"><a href="#configuring-amendment-voting">Configuring Amendment Voting</a></li>
<li class="level-2"><a href="#testing-amendments">Testing Amendments</a></li>
<li class="level-1"><a href="#known-amendments">Known Amendments</a></li>
<li class="level-2"><a href="#feeescalation">FeeEscalation</a></li>
<li class="level-2"><a href="#multisign">MultiSign</a></li>
<li class="level-2"><a href="#suspay">SusPay</a></li>
<li class="level-2"><a href="#trustsetauth">TrustSetAuth</a></li>
<li class="level-2"><a href="#tickets">Tickets</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

11
concept-fee-voting.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,12 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#fee-voting">Fee Voting</a></li>
<li class="level-2"><a href="#voting-process">Voting Process</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">
@@ -177,9 +182,9 @@
</tr>
</tbody>
</table>
<h3 id="voting-process">Voting Process</h3>
<h2 id="voting-process">Voting Process</h2>
<p>Every 256th ledger is called a "flag" ledger. (A flag ledger is defined such that the <code>ledger_index</code> <a href="https://en.wikipedia.org/wiki/Modulo_operation">modulo</a> <code>256</code> is equal to <code>0</code>.) In the ledger immediately before the flag ledger, each validator whose account reserve or transaction cost preferences are different than the current network setting distributes a "vote" message alongside its ledger validation, indicating the values that validator prefers.</p>
<p>In the flag ledger itself, nothing happens, but validators receive and take note of the votes from other validators they trust. </p>
<p>In the flag ledger itself, nothing happens, but validators receive and take note of the votes from other validators they trust.</p>
<p>After counting the votes of other validators, each validator attempts to compromise between its own preferences and the preferences of a majority of validators it trusts. (For example, if one validator wants to raise the minimum transaction cost from 10 to 100, but most validators only want to raise it from 10 to 20, the one validator settles on the change to raise the cost to 20. However, the one validator never settles on a value lower than 10 or higher than 100.) If a compromise is possible, the validator inserts a <a href="reference-transaction-format.html#setfee">SetFee pseudo-transaction</a> into its proposal for the ledger following the flag ledger. Other validators who want the same change insert an identical SetFee pseudo-transaction into their proposals for the same ledger. (Validators whose preferences match the existing network settings do nothing.) If a SetFee psuedo-transaction survives the consensus process to be included in a validated ledger, then the new transaction cost and reserve settings denoted by the SetFee pseudo-transaction take effect starting with the following ledger.</p>
<p>In short:</p>
<ul>

10
concept-fees.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,15 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#fees-disambiguation">Fees (Disambiguation)</a></li>
<li class="level-2"><a href="#in-the-ledger">In the Ledger</a></li>
<li class="level-3"><a href="#neutral-fees">Neutral Fees</a></li>
<li class="level-3"><a href="#optional-fees">Optional Fees</a></li>
<li class="level-2"><a href="#outside-the-ledger">Outside the Ledger</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

26
concept-freeze.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,31 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#freeze-features">Freeze Features</a></li>
<li class="level-2"><a href="#individual-freeze">Individual Freeze</a></li>
<li class="level-2"><a href="#global-freeze">Global Freeze</a></li>
<li class="level-2"><a href="#no-freeze">No Freeze</a></li>
<li class="level-1"><a href="#technical-details">Technical Details</a></li>
<li class="level-2"><a href="#enabling-or-disabling-individual-freeze">Enabling or Disabling Individual Freeze</a></li>
<li class="level-3"><a href="#using-rippled">Using rippled</a></li>
<li class="level-3"><a href="#using-rippleapi">Using RippleAPI</a></li>
<li class="level-2"><a href="#enabling-or-disabling-global-freeze">Enabling or Disabling Global Freeze</a></li>
<li class="level-3"><a href="#using-rippled-1">Using rippled</a></li>
<li class="level-3"><a href="#using-rippleapi-1">Using RippleAPI</a></li>
<li class="level-2"><a href="#enabling-no-freeze">Enabling No Freeze</a></li>
<li class="level-3"><a href="#using-rippled-2">Using rippled</a></li>
<li class="level-3"><a href="#using-rippleapi-2">Using RippleAPI</a></li>
<li class="level-2"><a href="#checking-for-individual-freeze">Checking for Individual Freeze</a></li>
<li class="level-3"><a href="#using-rippled-3">Using rippled</a></li>
<li class="level-3"><a href="#using-rippleapi-3">Using RippleAPI</a></li>
<li class="level-2"><a href="#checking-for-global-freeze-and-no-freeze">Checking for Global Freeze and No Freeze</a></li>
<li class="level-3"><a href="#using-rippled-4">Using rippled</a></li>
<li class="level-3"><a href="#using-rippleapi-4">Using RippleAPI</a></li>
<li class="level-1"><a href="#see-also">See Also</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

14
concept-issuing-and-operational-addresses.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Best Practices</a></li>
<li class="level-2"><a href="concept-issuing-and-operational-addresses.html">Issuing and Operational Addresses</a></li>
@@ -134,8 +135,19 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#issuing-and-operational-addresses">Issuing and Operational Addresses</a></li>
<li class="level-2"><a href="#funds-lifecycle">Funds Lifecycle</a></li>
<li class="level-2"><a href="#issuing-address">Issuing Address</a></li>
<li class="level-3"><a href="#issuing-address-compromise">Issuing Address Compromise</a></li>
<li class="level-3"><a href="#multiple-issuing-addresses">Multiple Issuing Addresses</a></li>
<li class="level-2"><a href="#operational-addresses">Operational Addresses</a></li>
<li class="level-3"><a href="#operational-address-compromise">Operational Address Compromise</a></li>
<li class="level-2"><a href="#standby-addresses">Standby Addresses</a></li>
<li class="level-3"><a href="#standby-address-compromise">Standby Address Compromise</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

12
concept-noripple.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,17 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#understanding-the-noripple-flag">Understanding the NoRipple Flag</a></li>
<li class="level-2"><a href="#background">Background</a></li>
<li class="level-2"><a href="#justification">Justification</a></li>
<li class="level-2"><a href="#specifics">Specifics</a></li>
<li class="level-2"><a href="#technical-details">Technical Details</a></li>
<li class="level-3"><a href="#enabling-disabling-noripple">Enabling / Disabling NoRipple</a></li>
<li class="level-3"><a href="#looking-up-noripple-status">Looking Up NoRipple Status</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

12
concept-paths.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,17 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#paths">Paths</a></li>
<li class="level-2"><a href="#path-steps">Path Steps</a></li>
<li class="level-1"><a href="#technical-details">Technical Details</a></li>
<li class="level-2"><a href="#pathfinding">Pathfinding</a></li>
<li class="level-2"><a href="#implied-steps">Implied Steps</a></li>
<li class="level-2"><a href="#default-paths">Default Paths</a></li>
<li class="level-2"><a href="#path-specifications">Path Specifications</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

10
concept-reserves.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,15 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#reserves">Reserves</a></li>
<li class="level-2"><a href="#base-reserve-and-owner-reserve">Base Reserve and Owner Reserve</a></li>
<li class="level-3"><a href="#owner-reserves">Owner Reserves</a></li>
<li class="level-2"><a href="#going-below-the-reserve-requirement">Going Below the Reserve Requirement</a></li>
<li class="level-2"><a href="#changing-the-reserve-requirements">Changing the Reserve Requirements</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

15
concept-stand-alone-mode.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,20 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#stand-alone-mode">Stand-Alone Mode</a></li>
<li class="level-2"><a href="#new-genesis-ledger">New Genesis Ledger</a></li>
<li class="level-2"><a href="#load-saved-ledger">Load Saved Ledger</a></li>
<li class="level-3"><a href="#1-start-rippled-normally">1. Start rippled normally.</a></li>
<li class="level-3"><a href="#2-wait-until-rippled-is-synced">2. Wait until rippled is synced.</a></li>
<li class="level-3"><a href="#3-optional-retrieve-specific-ledger-versions">3. (Optional) Retrieve specific ledger versions.</a></li>
<li class="level-3"><a href="#4-shut-down-rippled">4. Shut down rippled .</a></li>
<li class="level-3"><a href="#5-start-rippled-in-stand-alone-mode">5. Start rippled in stand-alone mode.</a></li>
<li class="level-3"><a href="#6-manually-advance-the-ledger">6. Manually advance the ledger.</a></li>
<li class="level-2"><a href="#advancing-ledgers-in-stand-alone-mode">Advancing Ledgers in Stand-Alone Mode</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

24
concept-transaction-cost.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,29 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#transaction-cost">Transaction Cost</a></li>
<li class="level-2"><a href="#current-transaction-cost">Current Transaction Cost</a></li>
<li class="level-3"><a href="#special-transaction-costs">Special Transaction Costs</a></li>
<li class="level-2"><a href="#beneficiaries-of-the-transaction-cost">Beneficiaries of the Transaction Cost</a></li>
<li class="level-2"><a href="#load-cost-and-open-ledger-cost">Load Cost and Open Ledger Cost</a></li>
<li class="level-2"><a href="#local-load-cost">Local Load Cost</a></li>
<li class="level-2"><a href="#open-ledger-cost">Open Ledger Cost</a></li>
<li class="level-3"><a href="#queued-transactions">Queued Transactions</a></li>
<li class="level-2"><a href="#reference-transaction-cost">Reference Transaction Cost</a></li>
<li class="level-3"><a href="#fee-levels">Fee Levels</a></li>
<li class="level-2"><a href="#querying-the-transaction-cost">Querying the Transaction Cost</a></li>
<li class="level-3"><a href="#server-info">server_info</a></li>
<li class="level-3"><a href="#server-state">server_state</a></li>
<li class="level-2"><a href="#specifying-the-transaction-cost">Specifying the Transaction Cost</a></li>
<li class="level-3"><a href="#automatically-specifying-the-transaction-cost">Automatically Specifying the Transaction Cost</a></li>
<li class="level-2"><a href="#transaction-costs-and-failed-transactions">Transaction Costs and Failed Transactions</a></li>
<li class="level-3"><a href="#insufficient-xrp">Insufficient XRP</a></li>
<li class="level-2"><a href="#key-reset-transaction">Key Reset Transaction</a></li>
<li class="level-2"><a href="#changing-the-transaction-cost">Changing the Transaction Cost</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

10
concept-transfer-fees.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
@@ -142,8 +143,15 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#transfer-fees">Transfer Fees</a></li>
<li class="level-2"><a href="#transfer-fees-in-payment-paths">Transfer Fees in Payment Paths</a></li>
<li class="level-1"><a href="#technical-details">Technical Details</a></li>
<li class="level-2"><a href="#rippleapi">RippleAPI</a></li>
<li class="level-2"><a href="#rippled">rippled</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

3
content/concept-fee-voting.md
View File

@@ -10,7 +10,7 @@ Operators of [`rippled` validators](tutorial-rippled-setup.html#running-a-valida
| account\_reserve | Minimum amount of XRP, in _drops_, that an account must have on reserve. This is the smallest amount that can be sent to fund a new account in the ledger. | `20000000` (20 XRP) |
| owner\_reserve | Additional amount of XRP, in _drops_, that an account must have on reserve for _each_ object it owns in the ledger. | `5000000` (5 XRP) |
### Voting Process ###
## Voting Process ##
Every 256th ledger is called a "flag" ledger. (A flag ledger is defined such that the `ledger_index` [modulo](https://en.wikipedia.org/wiki/Modulo_operation) `256` is equal to `0`.) In the ledger immediately before the flag ledger, each validator whose account reserve or transaction cost preferences are different than the current network setting distributes a "vote" message alongside its ledger validation, indicating the values that validator prefers.
@@ -24,4 +24,3 @@ In short:
* **Flag ledger**: Validators tally votes and decide what SetFee to include, if any.
* **Flag ledger +1**: Validators insert SetFee pseudo-transaction into their proposed ledgers.
* **Flag ledger +2**: New settings take effect, if a SetFee psuedotransaction achieved consensus.

74
reference-data-api.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
@@ -137,8 +138,79 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#ripple-data-api-v2">Ripple Data API v2</a></li>
<li class="level-2"><a href="#more-information">More Information</a></li>
<li class="level-1"><a href="#api-method-reference">API Method Reference</a></li>
<li class="level-2"><a href="#get-ledger">Get Ledger</a></li>
<li class="level-2"><a href="#get-transaction">Get Transaction</a></li>
<li class="level-2"><a href="#get-transactions">Get Transactions</a></li>
<li class="level-2"><a href="#get-payments">Get Payments</a></li>
<li class="level-2"><a href="#get-exchanges">Get Exchanges</a></li>
<li class="level-2"><a href="#get-exchange-rates">Get Exchange Rates</a></li>
<li class="level-2"><a href="#normalize">Normalize</a></li>
<li class="level-2"><a href="#get-daily-reports">Get Daily Reports</a></li>
<li class="level-2"><a href="#get-stats">Get Stats</a></li>
<li class="level-2"><a href="#get-capitalization">Get Capitalization</a></li>
<li class="level-2"><a href="#get-active-accounts">Get Active Accounts</a></li>
<li class="level-2"><a href="#get-exchange-volume">Get Exchange Volume</a></li>
<li class="level-2"><a href="#get-payment-volume">Get Payment Volume</a></li>
<li class="level-2"><a href="#get-issued-value">Get Issued Value</a></li>
<li class="level-2"><a href="#get-top-currencies">Get Top Currencies</a></li>
<li class="level-2"><a href="#get-top-markets">Get Top Markets</a></li>
<li class="level-2"><a href="#get-all-gateways">Get All Gateways</a></li>
<li class="level-2"><a href="#get-gateway">Get Gateway</a></li>
<li class="level-2"><a href="#get-currency-image">Get Currency Image</a></li>
<li class="level-2"><a href="#get-accounts">Get Accounts</a></li>
<li class="level-2"><a href="#get-account">Get Account</a></li>
<li class="level-2"><a href="#get-account-balances">Get Account Balances</a></li>
<li class="level-2"><a href="#get-account-orders">Get Account Orders</a></li>
<li class="level-2"><a href="#get-account-transaction-history">Get Account Transaction History</a></li>
<li class="level-2"><a href="#get-transaction-by-account-and-sequence">Get Transaction By Account And Sequence</a></li>
<li class="level-2"><a href="#get-account-payments">Get Account Payments</a></li>
<li class="level-2"><a href="#get-account-exchanges">Get Account Exchanges</a></li>
<li class="level-2"><a href="#get-account-balance-changes">Get Account Balance Changes</a></li>
<li class="level-2"><a href="#get-account-reports">Get Account Reports</a></li>
<li class="level-2"><a href="#get-account-transaction-stats">Get Account Transaction Stats</a></li>
<li class="level-2"><a href="#get-account-value-stats">Get Account Value Stats</a></li>
<li class="level-2"><a href="#health-check-api">Health Check - API</a></li>
<li class="level-2"><a href="#health-check-ledger-importer">Health Check - Ledger Importer</a></li>
<li class="level-1"><a href="#api-conventions">API Conventions</a></li>
<li class="level-2"><a href="#basic-types">Basic Types</a></li>
<li class="level-3"><a href="#numbers-and-precision">Numbers and Precision</a></li>
<li class="level-3"><a href="#addresses">Addresses</a></li>
<li class="level-3"><a href="#hashes">Hashes</a></li>
<li class="level-3"><a href="#timestamps">Timestamps</a></li>
<li class="level-3"><a href="#ledger-index">Ledger Index</a></li>
<li class="level-3"><a href="#account-sequence">Account Sequence</a></li>
<li class="level-3"><a href="#currency-code">Currency Code</a></li>
<li class="level-2"><a href="#pagination">Pagination</a></li>
<li class="level-2"><a href="#transaction-objects">Transaction Objects</a></li>
<li class="level-3"><a href="#full-json-format">Full JSON Format</a></li>
<li class="level-3"><a href="#binary-format">Binary Format</a></li>
<li class="level-2"><a href="#ledger-objects">Ledger Objects</a></li>
<li class="level-3"><a href="#genesis-ledger">Genesis Ledger</a></li>
<li class="level-2"><a href="#account-creation-objects">Account Creation Objects</a></li>
<li class="level-2"><a href="#exchange-objects">Exchange Objects</a></li>
<li class="level-2"><a href="#reports-objects">Reports Objects</a></li>
<li class="level-2"><a href="#payment-summary-objects">Payment Summary Objects</a></li>
<li class="level-2"><a href="#payment-objects">Payment Objects</a></li>
<li class="level-2"><a href="#balance-objects-and-balance-change-objects">Balance Objects and Balance Change Objects</a></li>
<li class="level-2"><a href="#balance-change-descriptors">Balance Change Descriptors</a></li>
<li class="level-3"><a href="#change-types">Change Types</a></li>
<li class="level-2"><a href="#volume-objects">Volume Objects</a></li>
<li class="level-1"><a href="#running-the-historical-database">Running the Historical Database</a></li>
<li class="level-2"><a href="#installation">Installation</a></li>
<li class="level-3"><a href="#dependencies">Dependencies</a></li>
<li class="level-3"><a href="#installation-process">Installation Process</a></li>
<li class="level-3"><a href="#tests">Tests</a></li>
<li class="level-3"><a href="#services">Services</a></li>
<li class="level-2"><a href="#importing-data">Importing Data</a></li>
<li class="level-3"><a href="#live-ledger-importer">Live Ledger Importer</a></li>
<li class="level-3"><a href="#backfiller">Backfiller</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

26
reference-ledger-format.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
@@ -137,8 +138,31 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#the-ledger">The Ledger</a></li>
<li class="level-2"><a href="#tree-format">Tree Format</a></li>
<li class="level-2"><a href="#header-format">Header Format</a></li>
<li class="level-3"><a href="#ledger-index">Ledger Index</a></li>
<li class="level-3"><a href="#close-flags">Close Flags</a></li>
<li class="level-1"><a href="#ledger-node-types">Ledger Node Types</a></li>
<li class="level-2"><a href="#accountroot">AccountRoot</a></li>
<li class="level-3"><a href="#accountroot-flags">AccountRoot Flags</a></li>
<li class="level-3"><a href="#accountroot-index-format">AccountRoot Index Format</a></li>
<li class="level-2"><a href="#directorynode">DirectoryNode</a></li>
<li class="level-3"><a href="#directory-index-formats">Directory Index Formats</a></li>
<li class="level-2"><a href="#offer">Offer</a></li>
<li class="level-3"><a href="#offer-flags">Offer Flags</a></li>
<li class="level-3"><a href="#offer-index-format">Offer Index Format</a></li>
<li class="level-2"><a href="#ripplestate">RippleState</a></li>
<li class="level-3"><a href="#ripplestate-flags">RippleState Flags</a></li>
<li class="level-3"><a href="#contributing-to-the-owner-reserve">Contributing to the Owner Reserve</a></li>
<li class="level-3"><a href="#ripplestate-index-format">RippleState Index Format</a></li>
<li class="level-2"><a href="#signerlist">SignerList</a></li>
<li class="level-3"><a href="#signerentry-object">SignerEntry Object</a></li>
<li class="level-3"><a href="#signerlists-and-reserves">SignerLists and Reserves</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

173
reference-rippleapi.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
@@ -137,8 +138,178 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#introduction">Introduction</a></li>
<li class="level-2"><a href="#boilerplate">Boilerplate</a></li>
<li class="level-3"><a href="#parameters">Parameters</a></li>
<li class="level-3"><a href="#installation">Installation</a></li>
<li class="level-2"><a href="#offline-functionality">Offline functionality</a></li>
<li class="level-1"><a href="#basic-types">Basic Types</a></li>
<li class="level-2"><a href="#ripple-address">Ripple Address</a></li>
<li class="level-2"><a href="#account-sequence-number">Account Sequence Number</a></li>
<li class="level-2"><a href="#currency">Currency</a></li>
<li class="level-2"><a href="#value">Value</a></li>
<li class="level-2"><a href="#amount">Amount</a></li>
<li class="level-1"><a href="#transaction-overview">Transaction Overview</a></li>
<li class="level-2"><a href="#transaction-types">Transaction Types</a></li>
<li class="level-2"><a href="#transaction-flow">Transaction Flow</a></li>
<li class="level-2"><a href="#transaction-fees">Transaction Fees</a></li>
<li class="level-2"><a href="#transaction-instructions">Transaction Instructions</a></li>
<li class="level-2"><a href="#transaction-id">Transaction ID</a></li>
<li class="level-2"><a href="#transaction-memos">Transaction Memos</a></li>
<li class="level-1"><a href="#transaction-specifications">Transaction Specifications</a></li>
<li class="level-2"><a href="#payment">Payment</a></li>
<li class="level-3"><a href="#example">Example</a></li>
<li class="level-2"><a href="#trustline">Trustline</a></li>
<li class="level-3"><a href="#example-1">Example</a></li>
<li class="level-2"><a href="#order">Order</a></li>
<li class="level-3"><a href="#example-2">Example</a></li>
<li class="level-2"><a href="#order-cancellation">Order Cancellation</a></li>
<li class="level-3"><a href="#example-3">Example</a></li>
<li class="level-2"><a href="#settings">Settings</a></li>
<li class="level-3"><a href="#example-4">Example</a></li>
<li class="level-2"><a href="#suspended-payment-creation">Suspended Payment Creation</a></li>
<li class="level-3"><a href="#example-5">Example</a></li>
<li class="level-2"><a href="#suspended-payment-cancellation">Suspended Payment Cancellation</a></li>
<li class="level-3"><a href="#example-6">Example</a></li>
<li class="level-2"><a href="#suspended-payment-execution">Suspended Payment Execution</a></li>
<li class="level-3"><a href="#example-7">Example</a></li>
<li class="level-1"><a href="#api-methods">API Methods</a></li>
<li class="level-2"><a href="#connect">connect</a></li>
<li class="level-3"><a href="#parameters-1">Parameters</a></li>
<li class="level-3"><a href="#return-value">Return Value</a></li>
<li class="level-3"><a href="#example-8">Example</a></li>
<li class="level-2"><a href="#disconnect">disconnect</a></li>
<li class="level-3"><a href="#parameters-2">Parameters</a></li>
<li class="level-3"><a href="#return-value-1">Return Value</a></li>
<li class="level-3"><a href="#example-9">Example</a></li>
<li class="level-2"><a href="#isconnected">isConnected</a></li>
<li class="level-3"><a href="#parameters-3">Parameters</a></li>
<li class="level-3"><a href="#return-value-2">Return Value</a></li>
<li class="level-3"><a href="#example-10">Example</a></li>
<li class="level-2"><a href="#getserverinfo">getServerInfo</a></li>
<li class="level-3"><a href="#parameters-4">Parameters</a></li>
<li class="level-3"><a href="#return-value-3">Return Value</a></li>
<li class="level-3"><a href="#example-11">Example</a></li>
<li class="level-2"><a href="#getfee">getFee</a></li>
<li class="level-3"><a href="#parameters-5">Parameters</a></li>
<li class="level-3"><a href="#return-value-4">Return Value</a></li>
<li class="level-3"><a href="#example-12">Example</a></li>
<li class="level-2"><a href="#getledgerversion">getLedgerVersion</a></li>
<li class="level-3"><a href="#parameters-6">Parameters</a></li>
<li class="level-3"><a href="#return-value-5">Return Value</a></li>
<li class="level-3"><a href="#example-13">Example</a></li>
<li class="level-2"><a href="#gettransaction">getTransaction</a></li>
<li class="level-3"><a href="#parameters-7">Parameters</a></li>
<li class="level-3"><a href="#return-value-6">Return Value</a></li>
<li class="level-3"><a href="#example-14">Example</a></li>
<li class="level-2"><a href="#gettransactions">getTransactions</a></li>
<li class="level-3"><a href="#parameters-8">Parameters</a></li>
<li class="level-3"><a href="#return-value-7">Return Value</a></li>
<li class="level-3"><a href="#example-15">Example</a></li>
<li class="level-2"><a href="#gettrustlines">getTrustlines</a></li>
<li class="level-3"><a href="#parameters-9">Parameters</a></li>
<li class="level-3"><a href="#return-value-8">Return Value</a></li>
<li class="level-3"><a href="#example-16">Example</a></li>
<li class="level-2"><a href="#getbalances">getBalances</a></li>
<li class="level-3"><a href="#parameters-10">Parameters</a></li>
<li class="level-3"><a href="#return-value-9">Return Value</a></li>
<li class="level-3"><a href="#example-17">Example</a></li>
<li class="level-2"><a href="#getbalancesheet">getBalanceSheet</a></li>
<li class="level-3"><a href="#parameters-11">Parameters</a></li>
<li class="level-3"><a href="#return-value-10">Return Value</a></li>
<li class="level-3"><a href="#example-18">Example</a></li>
<li class="level-2"><a href="#getpaths">getPaths</a></li>
<li class="level-3"><a href="#parameters-12">Parameters</a></li>
<li class="level-3"><a href="#return-value-11">Return Value</a></li>
<li class="level-3"><a href="#example-19">Example</a></li>
<li class="level-2"><a href="#getorders">getOrders</a></li>
<li class="level-3"><a href="#parameters-13">Parameters</a></li>
<li class="level-3"><a href="#return-value-12">Return Value</a></li>
<li class="level-3"><a href="#example-20">Example</a></li>
<li class="level-2"><a href="#getorderbook">getOrderbook</a></li>
<li class="level-3"><a href="#parameters-14">Parameters</a></li>
<li class="level-3"><a href="#return-value-13">Return Value</a></li>
<li class="level-3"><a href="#example-21">Example</a></li>
<li class="level-2"><a href="#getsettings">getSettings</a></li>
<li class="level-3"><a href="#parameters-15">Parameters</a></li>
<li class="level-3"><a href="#return-value-14">Return Value</a></li>
<li class="level-3"><a href="#example-22">Example</a></li>
<li class="level-2"><a href="#getaccountinfo">getAccountInfo</a></li>
<li class="level-3"><a href="#parameters-16">Parameters</a></li>
<li class="level-3"><a href="#return-value-15">Return Value</a></li>
<li class="level-3"><a href="#example-23">Example</a></li>
<li class="level-2"><a href="#getledger">getLedger</a></li>
<li class="level-3"><a href="#parameters-17">Parameters</a></li>
<li class="level-3"><a href="#return-value-16">Return Value</a></li>
<li class="level-3"><a href="#example-24">Example</a></li>
<li class="level-2"><a href="#preparepayment">preparePayment</a></li>
<li class="level-3"><a href="#parameters-18">Parameters</a></li>
<li class="level-3"><a href="#return-value-17">Return Value</a></li>
<li class="level-3"><a href="#example-25">Example</a></li>
<li class="level-2"><a href="#preparetrustline">prepareTrustline</a></li>
<li class="level-3"><a href="#parameters-19">Parameters</a></li>
<li class="level-3"><a href="#return-value-18">Return Value</a></li>
<li class="level-3"><a href="#example-26">Example</a></li>
<li class="level-2"><a href="#prepareorder">prepareOrder</a></li>
<li class="level-3"><a href="#parameters-20">Parameters</a></li>
<li class="level-3"><a href="#return-value-19">Return Value</a></li>
<li class="level-3"><a href="#example-27">Example</a></li>
<li class="level-2"><a href="#prepareordercancellation">prepareOrderCancellation</a></li>
<li class="level-3"><a href="#parameters-21">Parameters</a></li>
<li class="level-3"><a href="#return-value-20">Return Value</a></li>
<li class="level-3"><a href="#example-28">Example</a></li>
<li class="level-2"><a href="#preparesettings">prepareSettings</a></li>
<li class="level-3"><a href="#parameters-22">Parameters</a></li>
<li class="level-3"><a href="#return-value-21">Return Value</a></li>
<li class="level-3"><a href="#example-29">Example</a></li>
<li class="level-2"><a href="#preparesuspendedpaymentcreation">prepareSuspendedPaymentCreation</a></li>
<li class="level-3"><a href="#parameters-23">Parameters</a></li>
<li class="level-3"><a href="#return-value-22">Return Value</a></li>
<li class="level-3"><a href="#example-30">Example</a></li>
<li class="level-2"><a href="#preparesuspendedpaymentcancellation">prepareSuspendedPaymentCancellation</a></li>
<li class="level-3"><a href="#parameters-24">Parameters</a></li>
<li class="level-3"><a href="#return-value-23">Return Value</a></li>
<li class="level-3"><a href="#example-31">Example</a></li>
<li class="level-2"><a href="#preparesuspendedpaymentexecution">prepareSuspendedPaymentExecution</a></li>
<li class="level-3"><a href="#parameters-25">Parameters</a></li>
<li class="level-3"><a href="#return-value-24">Return Value</a></li>
<li class="level-3"><a href="#example-32">Example</a></li>
<li class="level-2"><a href="#sign">sign</a></li>
<li class="level-3"><a href="#parameters-26">Parameters</a></li>
<li class="level-3"><a href="#return-value-25">Return Value</a></li>
<li class="level-3"><a href="#example-33">Example</a></li>
<li class="level-2"><a href="#combine">combine</a></li>
<li class="level-3"><a href="#parameters-27">Parameters</a></li>
<li class="level-3"><a href="#return-value-26">Return Value</a></li>
<li class="level-3"><a href="#example-34">Example</a></li>
<li class="level-2"><a href="#submit">submit</a></li>
<li class="level-3"><a href="#parameters-28">Parameters</a></li>
<li class="level-3"><a href="#return-value-27">Return Value</a></li>
<li class="level-3"><a href="#example-35">Example</a></li>
<li class="level-2"><a href="#generateaddress">generateAddress</a></li>
<li class="level-3"><a href="#parameters-29">Parameters</a></li>
<li class="level-3"><a href="#return-value-28">Return Value</a></li>
<li class="level-3"><a href="#example-36">Example</a></li>
<li class="level-2"><a href="#computeledgerhash">computeLedgerHash</a></li>
<li class="level-3"><a href="#parameters-30">Parameters</a></li>
<li class="level-3"><a href="#return-value-29">Return Value</a></li>
<li class="level-3"><a href="#example-37">Example</a></li>
<li class="level-1"><a href="#api-events">API Events</a></li>
<li class="level-2"><a href="#ledger">ledger</a></li>
<li class="level-3"><a href="#return-value-30">Return Value</a></li>
<li class="level-3"><a href="#example-38">Example</a></li>
<li class="level-2"><a href="#error">error</a></li>
<li class="level-3"><a href="#return-value-31">Return Value</a></li>
<li class="level-3"><a href="#example-39">Example</a></li>
<li class="level-2"><a href="#connected">connected</a></li>
<li class="level-3"><a href="#example-40">Example</a></li>
<li class="level-2"><a href="#disconnected">disconnected</a></li>
<li class="level-3"><a href="#return-value-32">Return Value</a></li>
<li class="level-3"><a href="#example-41">Example</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

99
reference-rippled.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
@@ -137,8 +138,104 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#rippled">rippled</a></li>
<li class="level-1"><a href="#websocket-and-json-rpc-apis">WebSocket and JSON-RPC APIs</a></li>
<li class="level-2"><a href="#changes-to-the-apis">Changes to the APIs</a></li>
<li class="level-2"><a href="#connecting-to-rippled">Connecting to rippled</a></li>
<li class="level-3"><a href="#websocket-api">WebSocket API</a></li>
<li class="level-3"><a href="#json-rpc">JSON-RPC</a></li>
<li class="level-3"><a href="#commandline">Commandline</a></li>
<li class="level-2"><a href="#example-request">Example Request</a></li>
<li class="level-2"><a href="#response-formatting">Response Formatting</a></li>
<li class="level-2"><a href="#error-responses">Error Responses</a></li>
<li class="level-3"><a href="#caution-on-errors">Caution on Errors</a></li>
<li class="level-3"><a href="#universal-errors">Universal Errors</a></li>
<li class="level-2"><a href="#formatting-conventions">Formatting Conventions</a></li>
<li class="level-2"><a href="#basic-data-types">Basic Data Types</a></li>
<li class="level-3"><a href="#addresses">Addresses</a></li>
<li class="level-3"><a href="#hashes">Hashes</a></li>
<li class="level-3"><a href="#account-sequence">Account Sequence</a></li>
<li class="level-3"><a href="#ledger-index">Ledger Index</a></li>
<li class="level-3"><a href="#specifying-ledgers">Specifying Ledgers</a></li>
<li class="level-2"><a href="#currencies">Currencies</a></li>
<li class="level-3"><a href="#specifying-currency-amounts">Specifying Currency Amounts</a></li>
<li class="level-3"><a href="#currency-codes">Currency Codes</a></li>
<li class="level-2"><a href="#specifying-time">Specifying Time</a></li>
<li class="level-2"><a href="#possible-server-states">Possible Server States</a></li>
<li class="level-2"><a href="#markers-and-pagination">Markers and Pagination</a></li>
<li class="level-2"><a href="#modifying-the-ledger">Modifying the Ledger</a></li>
<li class="level-1"><a href="#api-methods">API Methods</a></li>
<li class="level-2"><a href="#list-of-public-commands">List of Public Commands</a></li>
<li class="level-2"><a href="#list-of-admin-commands">List of Admin Commands</a></li>
<li class="level-2"><a href="#commandline-access">Commandline Access</a></li>
<li class="level-1"><a href="#account-information">Account Information</a></li>
<li class="level-2"><a href="#account-currencies">account_currencies</a></li>
<li class="level-2"><a href="#account-info">account_info</a></li>
<li class="level-2"><a href="#account-lines">account_lines</a></li>
<li class="level-2"><a href="#account-offers">account_offers</a></li>
<li class="level-2"><a href="#account-objects">account_objects</a></li>
<li class="level-2"><a href="#account-tx">account_tx</a></li>
<li class="level-2"><a href="#noripple-check">noripple_check</a></li>
<li class="level-2"><a href="#gateway-balances">gateway_balances</a></li>
<li class="level-2"><a href="#wallet-propose">wallet_propose</a></li>
<li class="level-1"><a href="#ledger-information">Ledger Information</a></li>
<li class="level-2"><a href="#ledger">ledger</a></li>
<li class="level-2"><a href="#ledger-closed">ledger_closed</a></li>
<li class="level-2"><a href="#ledger-current">ledger_current</a></li>
<li class="level-2"><a href="#ledger-data">ledger_data</a></li>
<li class="level-2"><a href="#ledger-entry">ledger_entry</a></li>
<li class="level-2"><a href="#ledger-request">ledger_request</a></li>
<li class="level-2"><a href="#ledger-accept">ledger_accept</a></li>
<li class="level-1"><a href="#transactions">Transactions</a></li>
<li class="level-2"><a href="#tx">tx</a></li>
<li class="level-2"><a href="#transaction-entry">transaction_entry</a></li>
<li class="level-2"><a href="#tx-history">tx_history</a></li>
<li class="level-2"><a href="#path-find">path_find</a></li>
<li class="level-3"><a href="#path-find-create">path_find create</a></li>
<li class="level-3"><a href="#path-find-close">path_find close</a></li>
<li class="level-3"><a href="#path-find-status">path_find status</a></li>
<li class="level-2"><a href="#ripple-path-find">ripple_path_find</a></li>
<li class="level-2"><a href="#sign">sign</a></li>
<li class="level-2"><a href="#sign-for">sign_for</a></li>
<li class="level-2"><a href="#submit">submit</a></li>
<li class="level-3"><a href="#submit-only-mode">Submit-Only Mode</a></li>
<li class="level-3"><a href="#sign-and-submit-mode">Sign-and-Submit Mode</a></li>
<li class="level-2"><a href="#submit-multisigned">submit_multisigned</a></li>
<li class="level-2"><a href="#book-offers">book_offers</a></li>
<li class="level-1"><a href="#subscriptions">Subscriptions</a></li>
<li class="level-2"><a href="#subscribe">subscribe</a></li>
<li class="level-3"><a href="#ledger-stream">Ledger Stream</a></li>
<li class="level-3"><a href="#validations-stream">Validations Stream</a></li>
<li class="level-3"><a href="#transaction-streams">Transaction Streams</a></li>
<li class="level-3"><a href="#peer-status-stream">Peer Status Stream</a></li>
<li class="level-3"><a href="#order-book-streams">Order Book Streams</a></li>
<li class="level-2"><a href="#unsubscribe">unsubscribe</a></li>
<li class="level-1"><a href="#server-information">Server Information</a></li>
<li class="level-2"><a href="#server-info">server_info</a></li>
<li class="level-2"><a href="#server-state">server_state</a></li>
<li class="level-2"><a href="#can-delete">can_delete</a></li>
<li class="level-2"><a href="#consensus-info">consensus_info</a></li>
<li class="level-2"><a href="#fetch-info">fetch_info</a></li>
<li class="level-2"><a href="#feature">feature</a></li>
<li class="level-2"><a href="#fee">fee</a></li>
<li class="level-2"><a href="#get-counts">get_counts</a></li>
<li class="level-2"><a href="#ledger-cleaner">ledger_cleaner</a></li>
<li class="level-2"><a href="#log-level">log_level</a></li>
<li class="level-2"><a href="#logrotate">logrotate</a></li>
<li class="level-2"><a href="#validation-create">validation_create</a></li>
<li class="level-2"><a href="#validation-seed">validation_seed</a></li>
<li class="level-2"><a href="#peers">peers</a></li>
<li class="level-2"><a href="#print">print</a></li>
<li class="level-1"><a href="#convenience-functions">Convenience Functions</a></li>
<li class="level-2"><a href="#ping">ping</a></li>
<li class="level-2"><a href="#random">random</a></li>
<li class="level-2"><a href="#json">json</a></li>
<li class="level-2"><a href="#connect">connect</a></li>
<li class="level-2"><a href="#stop">stop</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

5
reference-transaction-format.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: References</a></li>
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
@@ -137,8 +138,10 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
None
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

48
tool/dactyl-config.yml
View File

@@ -35,7 +35,7 @@ targets:
- multicode_tabs
- standardize_header_ids
- buttonize
template: template-contentonly.html
template: template-contentwithtoc.html
image_subs:
"img/funds_flow_diagram.png": https://ripple.com/wp-content/uploads/2016/03/funds_flow_diagram.png
"img/e2g-01.png": https://ripple.com/wp-content/themes/ripple-beta/assets/img/e2g-01.png
@@ -75,7 +75,7 @@ pages:
html: reference-rippled.html
md: reference-rippled.md
ripple.com: https://ripple.com/build/rippled-apis/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -95,7 +95,7 @@ pages:
html: reference-ledger-format.html
md: reference-ledger-format.md
ripple.com: https://ripple.com/build/ledger-format/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -109,7 +109,7 @@ pages:
filters:
- remove_doctoc
- add_version
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -119,7 +119,7 @@ pages:
html: reference-data-api.html
md: reference-data-api.md
ripple.com: https://ripple.com/build/data-api-v2/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -130,7 +130,7 @@ pages:
html: tutorial-rippleapi-beginners-guide.html
md: tutorial-rippleapi-beginners-guide.md
ripple.com: https://ripple.com/build/rippleapi-beginners-guide/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -140,7 +140,7 @@ pages:
html: tutorial-rippled-setup.html
md: tutorial-rippled-setup.md
ripple.com: https://ripple.com/build/rippled-setup/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -151,7 +151,7 @@ pages:
html: tutorial-reliable-transaction-submission.html
md: tutorial-reliable-transaction-submission.md
ripple.com: https://ripple.com/build/reliable-transaction-submission/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -161,7 +161,7 @@ pages:
html: tutorial-multisign.html
md: tutorial-multisign.md
ripple.com: https://ripple.com/build/how-to-multi-sign/
sidebar: true
sidebar: toc
# Concepts are introductions that explain a topic.
# In the Dev Portal, these are mostly summaries of RCL features.
@@ -170,7 +170,7 @@ pages:
html: concept-paths.html
md: concept-paths.md
ripple.com: https://ripple.com/build/paths/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -180,7 +180,7 @@ pages:
html: concept-fees.html
md: concept-fees.md
ripple.com: https://ripple.com/knowledge_center/fees-disambiguation/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -190,7 +190,7 @@ pages:
html: concept-transfer-fees.html
md: concept-transfer-fees.md
ripple.com: https://ripple.com/knowledge_center/transfer-fees/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -200,7 +200,7 @@ pages:
html: concept-transaction-cost.html
md: concept-transaction-cost.md
ripple.com: https://ripple.com/build/transaction-cost/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -210,7 +210,7 @@ pages:
html: concept-fee-voting.html
md: concept-fee-voting.md
ripple.com: https://ripple.com/build/fee-voting/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -220,7 +220,7 @@ pages:
html: concept-reserves.html
md: concept-reserves.md
ripple.com: https://ripple.com/build/reserves/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -230,7 +230,7 @@ pages:
html: concept-freeze.html
md: concept-freeze.md
ripple.com: https://ripple.com/build/freeze/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -240,7 +240,7 @@ pages:
html: concept-amendments.html
md: concept-amendments.md
ripple.com: https://ripple.com/build/amendments/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -250,7 +250,7 @@ pages:
html: concept-stand-alone-mode.html
md: concept-stand-alone-mode.md
ripple.com: https://ripple.com/build/stand-alone-mode/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -260,7 +260,7 @@ pages:
html: concept-noripple.html
md: concept-noripple.md
ripple.com: https://ripple.com/knowledge_center/understanding-the-noripple-flag/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -271,7 +271,7 @@ pages:
html: concept-issuing-and-operational-addresses.html
md: concept-issuing-and-operational-addresses.md
ripple.com: https://ripple.com/knowledge_center/issuing-operational-addresses/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -282,7 +282,7 @@ pages:
html: tutorial-gateway-guide.html
md: tutorial-gateway-guide.md
ripple.com: https://ripple.com/build/gateway-guide/
sidebar: true
sidebar: toc
targets:
- local
- ripple.com
@@ -292,7 +292,7 @@ pages:
category: API Tools
html: ripple-api-tool.html
ripple.com: https://ripple.com/build/websocket-tool/
sidebar: true
sidebar: custom
targets:
- local
- ripple.com
@@ -305,7 +305,7 @@ pages:
methods_js: js/apitool-methods-data_v2.js
rest_host: https://data.ripple.com
doc_page: reference-data-api.html
sidebar: true
sidebar: custom
targets:
- local
- ripple.com
@@ -318,7 +318,7 @@ pages:
methods_js: js/apitool-methods-jsonrpc.js
rest_host: http://localhost/rippled
doc_page: reference-rippled.html
sidebar: true
sidebar: custom
targets:
- local
- ripple.com

61
tool/dactyl_build.py
View File

@@ -44,7 +44,8 @@ logger = logging.getLogger()
RESERVED_KEYS_TARGET = [
"name",
"display_name",
"filters"
"filters",
"image_subs",
]
filters = {}
def load_config(config_file=DEFAULT_CONFIG_FILE):
@@ -76,8 +77,9 @@ def load_config(config_file=DEFAULT_CONFIG_FILE):
for filter_name in filternames:
filters[filter_name] = import_module("filter_"+filter_name)
# Make pages inherit arbitrary keys from targets
for target in config["targets"]:
def page_keys_from_target(target):
"""Make pages inherit arbitrary keys from a target"""
target = get_target(target)
pages = get_pages(target)
for p in pages:
for key,val in target.items():
@@ -360,28 +362,55 @@ def setup_html_env():
env.trim_blocks = True
return env
def toc_from_headers(html_string):
"""make a table of contents from headers"""
soup = BeautifulSoup(html_string, "html.parser")
headers = soup.find_all(name=re.compile("h[1-3]"), id=True)
toc_s = ""
for h in headers:
if h.name == "h1":
toc_level = "level-1"
elif h.name == "h2":
toc_level = "level-2"
else:
toc_level = "level-3"
new_a = soup.new_tag("a", href="#"+h["id"])
if h.string:
new_a.string = h.string
else:
new_a.string = " ".join(h.strings)
new_li = soup.new_tag("li")
new_li["class"] = toc_level
new_li.append(new_a)
toc_s += str(new_li)+"\n"
return str(toc_s)
def render_pages(target=None, for_pdf=False, bypass_errors=False):
"""Parse and render all pages in target, writing files to out_path."""
target = get_target(target)
pages = get_pages(target)
categories = get_categories(pages)
page_keys_from_target(target)
# Insert generated HTML into templates using this Jinja environment
env = setup_html_env()
if for_pdf:
if "pdf_template" in target:
logging.info("reading pdf template from target...")
logging.debug("reading pdf template %s from target..." % target["pdf_template"])
default_template = env.get_template(target["pdf_template"])
else:
logging.info("reading default pdf template...")
logging.debug("reading default pdf template %s..." % config["pdf_template"])
default_template = env.get_template(config["pdf_template"])
else:
if "template" in target:
logging.info("reading HTML template from target...")
logging.debug("reading HTML template %s from target..." % target["template"])
default_template = env.get_template(target["template"])
else:
logging.info("reading default HTML template...")
logging.debug("reading default HTML template %s..." % config["default_template"])
default_template = env.get_template(config["default_template"])
for currentpage in pages:
@@ -404,14 +433,21 @@ def render_pages(target=None, for_pdf=False, bypass_errors=False):
else:
html_content = ""
if "sidebar" in currentpage and currentpage["sidebar"] == "toc":
sidebar_content = toc_from_headers(html_content)
else:
sidebar_content = None
# Prepare some parameters for rendering
substitute_parameter_links("doc_page", currentpage, target)
current_time = time.strftime("%B %d, %Y")
# Figure out which template to use
if "template" in currentpage and not for_pdf:
logging.info("using template %s from page" % currentpage["template"])
use_template = env.get_template(currentpage["template"])
elif "pdf_template" in currentpage and for_pdf:
logging.info("using pdf_template %s from page" % currentpage["pdf_template"])
use_template = env.get_template(currentpage["pdf_template"])
else:
use_template = default_template
@@ -422,13 +458,9 @@ def render_pages(target=None, for_pdf=False, bypass_errors=False):
pages=pages,
content=html_content,
target=target,
current_time=current_time)
current_time=current_time,
sidebar_content=sidebar_content)
# # Experimental: replace links in full HTML, not just content
# soup = BeautifulSoup(out_html, "html.parser")
# if target["name"] != config["targets"][0]["name"]:
# substitute_links_for_target(soup, target)
# out_html = str(soup)
if for_pdf:
out_path = config["temporary_files_path"]
@@ -447,6 +479,7 @@ def watch(pdf_file, target):
"""Look for changed files and re-generate HTML (and optionally
PDF whenever there's an update. Runs until interrupted."""
target = get_target(target)
page_keys_from_target(target)
class UpdaterHandler(PatternMatchingEventHandler):
"""Updates to pattern-matched files means rendering."""
@@ -483,6 +516,7 @@ def make_pdf(outfile, target=None, bypass_errors=False):
"""Use prince to convert several HTML files into a PDF"""
logging.info("rendering PDF-able versions of pages...")
target = get_target(target)
page_keys_from_target(target)
render_pages(target=target, for_pdf=True, bypass_errors=bypass_errors)
temp_files_path = config["temporary_files_path"]
@@ -515,6 +549,7 @@ def githubify(md_file_name, target=None):
# with open(filein, "r") as f:
# md = f.read()
pages = get_pages()
page_keys_from_target(target)
logging.info("getting markdown for page %s" % md_file_name)
md = get_markdown_for_page(md_file_name,
pp_env=setup_pp_env(),

12
tool/template-contentwithtoc.html Normal file
View File

@@ -0,0 +1,12 @@
<div class='devportal_wrapper'>
<aside class='sidebar' role='complementary'>
<ul class='dev_nav_sidebar' id='dactyl_toc_sidebar'>
{{ sidebar_content }}
</ul>
</aside>
<main class='main' role='main'>
<div class='content'>
{{ content }}
</div>
</main>
</div>

6
tool/template-doc.html
View File

@@ -23,6 +23,7 @@
{% if currentpage.sidebar %}
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: {{ currentpage.category }}</a></li>
{% for page in pages %}
@@ -33,8 +34,10 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
{{ sidebar_content }}
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
{% endif %}
{% endblock %}
@@ -44,4 +47,3 @@
{{ content }}
</div>
{% endblock %}

44
tutorial-gateway-guide.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Best Practices</a></li>
<li class="level-2"><a href="concept-issuing-and-operational-addresses.html">Issuing and Operational Addresses</a></li>
@@ -134,8 +135,49 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#becoming-a-ripple-gateway">Becoming a Ripple Gateway</a></li>
<li class="level-2"><a href="#contact-information">Contact Information</a></li>
<li class="level-2"><a href="#ripple-gateways-explained">Ripple Gateways Explained</a></li>
<li class="level-3"><a href="#ripple-trust-lines-and-issuances">Ripple Trust Lines and Issuances</a></li>
<li class="level-3"><a href="#xrp">XRP</a></li>
<li class="level-3"><a href="#liquidity-and-currency-exchange">Liquidity and Currency Exchange</a></li>
<li class="level-2"><a href="#suggested-business-practices">Suggested Business Practices</a></li>
<li class="level-3"><a href="#hot-and-cold-wallets">Hot and Cold Wallets</a></li>
<li class="level-2"><a href="#fees-and-revenue-sources">Fees and Revenue Sources</a></li>
<li class="level-3"><a href="#choosing-fee-rates">Choosing Fee Rates</a></li>
<li class="level-1"><a href="#ripple-integration">Ripple Integration</a></li>
<li class="level-2"><a href="#before-ripple-integration">Before Ripple Integration</a></li>
<li class="level-2"><a href="#sending-from-gateway-to-ripple">Sending from Gateway to Ripple</a></li>
<li class="level-3"><a href="#requirements-for-sending-to-rcl">Requirements for Sending to RCL</a></li>
<li class="level-2"><a href="#sending-from-rcl-to-gateway">Sending from RCL to Gateway</a></li>
<li class="level-3"><a href="#requirements-for-receiving-from-rcl">Requirements for Receiving from RCL</a></li>
<li class="level-2"><a href="#precautions">Precautions</a></li>
<li class="level-2"><a href="#trading-on-ripple">Trading on Ripple</a></li>
<li class="level-2"><a href="#freeze">Freeze</a></li>
<li class="level-2"><a href="#authorized-accounts">Authorized Accounts</a></li>
<li class="level-2"><a href="#source-and-destination-tags">Source and Destination Tags</a></li>
<li class="level-1"><a href="#technical-details">Technical Details</a></li>
<li class="level-2"><a href="#infrastructure">Infrastructure</a></li>
<li class="level-3"><a href="#apis-and-middleware">APIs and Middleware</a></li>
<li class="level-2"><a href="#tool-security">Tool Security</a></li>
<li class="level-2"><a href="#defaultripple">DefaultRipple</a></li>
<li class="level-2"><a href="#generating-source-and-destination-tags">Generating Source and Destination Tags</a></li>
<li class="level-2"><a href="#disallowxrp">DisallowXRP</a></li>
<li class="level-2"><a href="#requiredest">RequireDest</a></li>
<li class="level-2"><a href="#requireauth">RequireAuth</a></li>
<li class="level-3"><a href="#enabling-requireauth">Enabling RequireAuth</a></li>
<li class="level-3"><a href="#authorizing-trust-lines">Authorizing Trust Lines</a></li>
<li class="level-2"><a href="#robustly-monitoring-for-payments">Robustly Monitoring for Payments</a></li>
<li class="level-2"><a href="#transferrate">TransferRate</a></li>
<li class="level-3"><a href="#transferrate-with-operational-and-standby-addresses">TransferRate with Operational and Standby Addresses</a></li>
<li class="level-2"><a href="#sending-payments-to-customers">Sending Payments to Customers</a></li>
<li class="level-2"><a href="#bouncing-payments">Bouncing Payments</a></li>
<li class="level-2"><a href="#reliable-transaction-submission">Reliable Transaction Submission</a></li>
<li class="level-2"><a href="#rippletxt">ripple.txt</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

21
tutorial-multisign.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
@@ -136,8 +137,26 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#how-to-multi-sign">How to Multi-Sign</a></li>
<li class="level-2"><a href="#availability-of-multi-signing">Availability of Multi-Signing</a></li>
<li class="level-2"><a href="#setting-up-multi-signing">Setting up Multi-Signing</a></li>
<li class="level-3"><a href="#1-prepare-a-funded-address">1. Prepare a funded address</a></li>
<li class="level-3"><a href="#2-prepare-member-keys">2. Prepare member keys</a></li>
<li class="level-3"><a href="#3-send-signerlistset-transaction">3. Send SignerListSet transaction</a></li>
<li class="level-3"><a href="#4-close-the-ledger">4. Close the ledger</a></li>
<li class="level-3"><a href="#5-confirm-the-new-signer-list">5. Confirm the new signer list</a></li>
<li class="level-3"><a href="#6-further-steps">6. Further steps</a></li>
<li class="level-2"><a href="#sending-a-multi-signed-transaction">Sending a Multi-Signed Transaction</a></li>
<li class="level-3"><a href="#1-create-the-transaction">1. Create the transaction</a></li>
<li class="level-3"><a href="#2-get-one-signature">2. Get one signature</a></li>
<li class="level-3"><a href="#3-get-additional-signatures">3. Get additional signatures</a></li>
<li class="level-3"><a href="#4-combine-signatures-and-submit">4. Combine signatures and submit</a></li>
<li class="level-3"><a href="#5-close-the-ledger">5. Close the ledger</a></li>
<li class="level-3"><a href="#6-confirm-transaction-results">6. Confirm transaction results</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

16
tutorial-reliable-transaction-submission.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
@@ -136,8 +137,21 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#reliable-transaction-submission">Reliable Transaction Submission</a></li>
<li class="level-2"><a href="#background">Background</a></li>
<li class="level-3"><a href="#transaction-timeline">Transaction Timeline</a></li>
<li class="level-3"><a href="#lastledgersequence">LastLedgerSequence</a></li>
<li class="level-2"><a href="#best-practices">Best Practices</a></li>
<li class="level-3"><a href="#reliable-transactions-submission">Reliable Transactions Submission</a></li>
<li class="level-3"><a href="#submission">Submission</a></li>
<li class="level-3"><a href="#verification">Verification</a></li>
<li class="level-2"><a href="#technical-application">Technical Application</a></li>
<li class="level-3"><a href="#rippled-submitting-and-verifying-transactions">rippled - Submitting and Verifying Transactions</a></li>
<li class="level-2"><a href="#additional-resources">Additional Resources</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

21
tutorial-rippleapi-beginners-guide.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
@@ -136,8 +137,26 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#rippleapi-beginners-guide">RippleAPI Beginners Guide</a></li>
<li class="level-1"><a href="#environment-setup">Environment Setup</a></li>
<li class="level-2"><a href="#install-nodejs-and-npm">Install Node.js and npm</a></li>
<li class="level-2"><a href="#use-npm-to-install-rippleapi-and-dependencies">Use NPM to install RippleAPI and dependencies</a></li>
<li class="level-1"><a href="#first-rippleapi-script">First RippleAPI Script</a></li>
<li class="level-2"><a href="#running-the-script">Running the script</a></li>
<li class="level-2"><a href="#understanding-the-script">Understanding the script</a></li>
<li class="level-3"><a href="#script-opening">Script opening</a></li>
<li class="level-3"><a href="#instantiating-the-api">Instantiating the API</a></li>
<li class="level-3"><a href="#connecting-and-promises">Connecting and Promises</a></li>
<li class="level-3"><a href="#custom-code">Custom code</a></li>
<li class="level-3"><a href="#cleanup">Cleanup</a></li>
<li class="level-1"><a href="#waiting-for-validation">Waiting for Validation</a></li>
<li class="level-1"><a href="#rippleapi-in-web-browsers">RippleAPI in Web Browsers</a></li>
<li class="level-2"><a href="#build-instructions">Build Instructions</a></li>
<li class="level-2"><a href="#example-browser-usage">Example Browser Usage</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">

26
tutorial-rippled-setup.html
View File

@@ -127,6 +127,7 @@
<aside class="sidebar" role="complementary">
<div class="dev_nav_wrapper">
<div id="cont">
<h5>In this category:</h5>
<ul class="dev_nav_sidebar">
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
@@ -136,8 +137,31 @@
</ul>
<hr />
<h5>In this page:</h5>
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
<li class="level-1"><a href="#operating-rippled-servers">Operating rippled Servers</a></li>
<li class="level-2"><a href="#types-of-rippled-servers">Types of rippled Servers</a></li>
<li class="level-2"><a href="#reasons-to-run-a-stock-server">Reasons to Run a Stock Server</a></li>
<li class="level-2"><a href="#reasons-to-run-a-validator">Reasons to Run a Validator</a></li>
<li class="level-3"><a href="#properties-of-a-good-validator">Properties of a Good Validator</a></li>
<li class="level-1"><a href="#installing-rippled">Installing rippled</a></li>
<li class="level-2"><a href="#system-requirements">System Requirements</a></li>
<li class="level-2"><a href="#installation-on-centosred-hat-with-yum">Installation on CentOS/Red Hat with yum</a></li>
<li class="level-2"><a href="#updating-rippled">Updating rippled</a></li>
<li class="level-3"><a href="#automatic">Automatic</a></li>
<li class="level-3"><a href="#manual">Manual</a></li>
<li class="level-1"><a href="#running-a-validator">Running a Validator</a></li>
<li class="level-2"><a href="#validator-setup">Validator Setup</a></li>
<li class="level-2"><a href="#public-facing-server">Public-Facing Server</a></li>
<li class="level-2"><a href="#domain-verification">Domain Verification</a></li>
<li class="level-3"><a href="#rippletxt">ripple.txt </a></li>
<li class="level-3"><a href="#account-domain">Account domain</a></li>
<li class="level-1"><a href="#additional-configuration">Additional Configuration</a></li>
<li class="level-2"><a href="#parallel-networks">Parallel Networks</a></li>
<li class="level-3"><a href="#parallel-networks-and-consensus">Parallel Networks and Consensus</a></li>
<li class="level-2"><a href="#clustering">Clustering</a></li>
</ul>
</div>
<script type="text/javascript" src="assets/js/jquery.gensidebar.js"></script>
</div>
</aside>
<main class="main" role="main">