mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-24 04:55:52 +00:00
114 lines
7.7 KiB
HTML
114 lines
7.7 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: rippled Source</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">rippled Source </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>Some of these directories come from entire outside repositories brought in using <a href="https://github.com/apenwarr/git-subtree">git-subtree</a>. This means that the source files are inserted directly into the <code>rippled</code> repository. They can be edited and committed just as if they were normal files.</p>
|
|
<p>If you create a commit that contains files both from a subtree, and from the <code>rippled</code> source tree, please use care when designing the commit message, since it will appear in the subtree's individual repository when the changes are pushed back to the upstream. Better yet, do not mix files from subtrees and <code>ripple</code> in the same commit at all.</p>
|
|
<p>Source folders:</p>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadLeft">Folder </th><th class="markdownTableHeadLeft">Upstream Repo </th><th class="markdownTableHeadLeft">Description </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><code>beast</code> </td><td class="markdownTableBodyLeft">N/A </td><td class="markdownTableBodyLeft">legacy utility code that was formerly associated with boost::beast </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><code>ed25519-donna</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/floodyberry/ed25519-donna">https://github.com/floodyberry/ed25519-donna</a> </td><td class="markdownTableBodyLeft"><a href="http://ed25519.cr.yp.to/">Ed25519</a> digital signatures </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><code>ripple</code> </td><td class="markdownTableBodyLeft">N/A </td><td class="markdownTableBodyLeft"><b>Core source code for <code>rippled</code></b> </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><code>secp256k1</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/bitcoin-core/secp256k1">https://github.com/bitcoin-core/secp256k1</a> </td><td class="markdownTableBodyLeft">ECDSA digital signatures using the <b>secp256k1</b> curve </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><code>test</code> </td><td class="markdownTableBodyLeft">N/A </td><td class="markdownTableBodyLeft"><b>Unit tests for <code>rippled</code></b> </td></tr>
|
|
</table>
|
|
<p>The following dependencies are downloaded and built using ExternalProject (or FetchContent, where possible). Refer to CMakeLists.txt file for details about how these sources are built :</p>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadLeft">Name </th><th class="markdownTableHeadLeft">Upstream Repo </th><th class="markdownTableHeadLeft">Description </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><code>lz4</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/lz4/lz4">https://github.com/lz4/lz4</a> </td><td class="markdownTableBodyLeft">LZ4 lossless compression algorithm </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><code>nudb</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/vinniefalco/NuDB">https://github.com/vinniefalco/NuDB</a> </td><td class="markdownTableBodyLeft">Constant-time insert-only key/value database for SSD drives (Less memory usage than RocksDB.) </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><code>snappy</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/google/snappy">https://github.com/google/snappy</a> </td><td class="markdownTableBodyLeft">"Snappy" lossless compression algorithm. </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><code>soci</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/SOCI/soci">https://github.com/SOCI/soci</a> </td><td class="markdownTableBodyLeft">Abstraction layer for database access. </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><code>sqlite</code> </td><td class="markdownTableBodyLeft"><a href="https://www.sqlite.org/src">https://www.sqlite.org/src</a> </td><td class="markdownTableBodyLeft">An embedded database engine that writes to simple files. </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><code>rocksdb</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/facebook/rocksdb">https://github.com/facebook/rocksdb</a> </td><td class="markdownTableBodyLeft">Fast key/value database. (Supports rotational disks better than NuDB.) </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><code>protobuf</code> </td><td class="markdownTableBodyLeft"><a href="https://github.com/google/protobuf">https://github.com/google/protobuf</a> </td><td class="markdownTableBodyLeft">Protocol buffer data interchange format. Only downloaded/built if a suitable version is not found by find_package, or if the local_protobuf option is explicitly set </td></tr>
|
|
</table>
|
|
</div></div><!-- PageDoc -->
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|