deploy: a28c48b

d1/dab/md__2github_2workspace_2platform_2consensus_2ordering_2geo__pbft_2README.html

@@ -100,7 +100,7 @@
   <div class="headertitle"><div class="title">GeoBFT Consensus Structure Diagram</div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a class="anchor" id="autotoc_md25"></a></p><div align="center"> <img src="https://github.com/msadoghi/nexres/blob/geobft/ordering/img/GeoBFT_1.png" alt="" class="inline"/> </div> </div></div><!-- contents -->
+<div class="textblock"><p><a class="anchor" id="autotoc_md26"></a></p><div align="center"> <img src="https://github.com/msadoghi/nexres/blob/geobft/ordering/img/GeoBFT_1.png" alt="" class="inline"/> </div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <!-- start footer part -->

d5/d74/md__2github_2workspace_2README.html

@@ -100,8 +100,8 @@
   <div class="headertitle"><div class="title">ResilientDB: Global-Scale Sustainable Blockchain Fabric</div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a class="anchor" id="autotoc_md58"></a> <b><a href="https://resilientdb.com/">ResilientDB</a></b> is a <b>High Throughput Yielding Permissioned Blockchain Fabric</b> founded by <b><a href="https://expolab.org/">ExpoLab</a></b> at <b><a href="https://www.ucdavis.edu/">UC Davis</a></b> in 2018. ResilientDB advocates a <b>system-centric</b> design by adopting a <b>multi-threaded architecture</b> that encompasses <b>deep pipelines</b>. Further, ResilientDB <b>separates</b> the ordering of client transactions from their execution, which allows it to <b>process messages out-of-order</b>.</p>
-<h2><a class="anchor" id="autotoc_md59"></a>
+<div class="textblock"><p><a class="anchor" id="autotoc_md59"></a> <b><a href="https://resilientdb.com/">ResilientDB</a></b> is a <b>High Throughput Yielding Permissioned Blockchain Fabric</b> founded by <b><a href="https://expolab.org/">ExpoLab</a></b> at <b><a href="https://www.ucdavis.edu/">UC Davis</a></b> in 2018. ResilientDB advocates a <b>system-centric</b> design by adopting a <b>multi-threaded architecture</b> that encompasses <b>deep pipelines</b>. Further, ResilientDB <b>separates</b> the ordering of client transactions from their execution, which allows it to <b>process messages out-of-order</b>.</p>
+<h2><a class="anchor" id="autotoc_md60"></a>
 Quick Facts on ResilientDB</h2>
 <ol type="1">
 <li>ResilientDB orders client transactions through a highly optimized implementation of the <b><a href="https://pmg.csail.mit.edu/papers/osdi99.pdf">PBFT</a></b> [Castro and Liskov, 1998] protocol, which helps to achieve consensus among its replicas. ResilientDB also supports deploying other state-of-the-art consensus protocols <em>[release are planned]</em> such as <b><a href="http://www.vldb.org/pvldb/vol13/p868-gupta.pdf">GeoBFT</a></b> [<b><a href="https://blog.resilientdb.com/2023/03/07/GeoBFT.html">blog</a>, <a href="https://github.com/resilientdb/resilientdb/releases/tag/nexres-v1.1.0">released</a></b>], <b><a href="https://openproceedings.org/2021/conf/edbt/p111.pdf">PoE</a></b>, <b><a href="https://arxiv.org/abs/1911.00837">RCC</a></b>, <b><a href="https://openproceedings.org/2022/conf/edbt/paper-73.pdf">RingBFT</a></b>, <b><a href="https://arxiv.org/abs/2302.02325">PoC</a></b>, <b><a href="https://arxiv.org/abs/2302.02118">SpotLess</a></b>, <b><a href="https://arxiv.org/abs/1803.05069">HotStuff</a></b>, and <b><a href="https://arxiv.org/pdf/2105.11827.pdf">DAG</a></b>.</li>
@@ -113,10 +113,10 @@ <h2><a class="anchor" id="autotoc_md59"></a>
 <li><b>[Historial Facts]</b> The ResilientDB project was founded by <b><a href="https://expolab.org/">Mohammad Sadoghi</a></b> along with his students (<a href="https://gupta-suyash.github.io/index.html">Suyash Gupta</a> as the lead Architect, <a href="https://sajjadrahnama.com/">Sajjad Rahnama</a>, <a href="https://www.jhellings.nl/">Jelle Hellings</a>) at <b><a href="https://www.ucdavis.edu/">UC Davis</a></b> in 2018 and was open-sourced in late 2019. On September 30, 2021, we released ResilientDB v-3.0. In 2022, ResilientDB was completely re-written and re-architected (<a href="https://github.com/cjcchen">Junchao Chen</a> as the lead Architect along with the entire <a href="https://resilientdb.com/">NexRes Team</a>), paving the way for a new sustainable foundation, referred to as NexRes (Next Generation ResilientDB). Thus, on September 30, 2022, NexRes-v1.0.0 was born, marking a new beginning for <b><a href="https://resilientdb.com/">ResilientDB</a></b>.</li>
 </ol>
 <hr  />
-<h1><a class="anchor" id="autotoc_md61"></a>
+<h1><a class="anchor" id="autotoc_md62"></a>
 Online Documentation:</h1>
 <p>The latest ResilientDB documentation, including a programming guide, is available on our <b><a href="https://blog.resilientdb.com/archive.html?tag=NexRes">blog repository</a></b>. This README file provides basic setup instructions.</p>
-<h3><a class="anchor" id="autotoc_md62"></a>
+<h3><a class="anchor" id="autotoc_md63"></a>
 Table of Contents</h3>
 <ol type="1">
 <li>Software Stack Architecture<ul>
@@ -142,11 +142,11 @@ <h3><a class="anchor" id="autotoc_md62"></a>
 </li>
 </ol>
 <p><img src="../.././img/nexres.png" alt="Nexres" class="inline"/></p>
-<h1><a class="anchor" id="autotoc_md63"></a>
+<h1><a class="anchor" id="autotoc_md64"></a>
 OS Requirements</h1>
 <p>Ubuntu 20.*</p>
 <hr  />
-<h1><a class="anchor" id="autotoc_md65"></a>
+<h1><a class="anchor" id="autotoc_md66"></a>
 Build and Deploy ResilientDB</h1>
 <p>Install dependencies: </p><pre class="fragment">./INSTALL.sh
 </pre><p>Run ResilientDB (Providing a Key-Value Service): </p><pre class="fragment">./service/tools/kv/server_tools/start_kv_service.sh

d7/d1c/md__2github_2workspace_2CODE__OF__CONDUCT.html

@@ -100,11 +100,11 @@
   <div class="headertitle"><div class="title">Contributor Covenant Code of Conduct</div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a class="anchor" id="autotoc_md18"></a> </p>
-<h1><a class="anchor" id="autotoc_md19"></a>
+<div class="textblock"><p><a class="anchor" id="autotoc_md19"></a> </p>
+<h1><a class="anchor" id="autotoc_md20"></a>
 Our Pledge</h1>
 <p>In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.</p>
-<h1><a class="anchor" id="autotoc_md20"></a>
+<h1><a class="anchor" id="autotoc_md21"></a>
 Our Standards</h1>
 <p>Examples of behavior that contributes to creating a positive environment include:</p>
 <ul>
@@ -122,18 +122,18 @@ <h1><a class="anchor" id="autotoc_md20"></a>
 <li>Publishing others' private information, such as a physical or electronic address, without explicit permission</li>
 <li>Other conduct which could reasonably be considered inappropriate in a professional setting</li>
 </ul>
-<h1><a class="anchor" id="autotoc_md21"></a>
+<h1><a class="anchor" id="autotoc_md22"></a>
 Our Responsibilities</h1>
 <p>Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.</p>
 <p>Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.</p>
-<h1><a class="anchor" id="autotoc_md22"></a>
+<h1><a class="anchor" id="autotoc_md23"></a>
 Scope</h1>
 <p>This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.</p>
-<h1><a class="anchor" id="autotoc_md23"></a>
+<h1><a class="anchor" id="autotoc_md24"></a>
 Enforcement</h1>
 <p>Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <a href="#" onclick="location.href='mai'+'lto:'+'sup'+'po'+'rt@'+'re'+'sil'+'ie'+'ntd'+'b.'+'com'; return false;">suppo<span class="obfuscator">.nosp@m.</span>rt@r<span class="obfuscator">.nosp@m.</span>esili<span class="obfuscator">.nosp@m.</span>entd<span class="obfuscator">.nosp@m.</span>b.com</a>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.</p>
 <p>Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.</p>
-<h1><a class="anchor" id="autotoc_md24"></a>
+<h1><a class="anchor" id="autotoc_md25"></a>
 Attribution</h1>
 <p>This Code of Conduct is adapted from the <a href="https://www.contributor-covenant.org">Contributor Covenant</a>, version 1.4, available at <a href="https://www.contributor-covenant.org/version/1/4/code-of-conduct.html">https://www.contributor-covenant.org/version/1/4/code-of-conduct.html</a></p>
 <p>For answers to common questions about this code of conduct, see <a href="https://www.contributor-covenant.org/faq">https://www.contributor-covenant.org/faq</a> </p>

d7/d8c/md__2github_2workspace_2platform_2consensus_2ordering_2pbft_2README.html

@@ -100,18 +100,18 @@
   <div class="headertitle"><div class="title">PBFT Consensus Flow Charts</div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><a class="anchor" id="autotoc_md26"></a> </p>
-<h1><a class="anchor" id="autotoc_md27"></a>
+<div class="textblock"><p><a class="anchor" id="autotoc_md27"></a> </p>
+<h1><a class="anchor" id="autotoc_md28"></a>
 New Client Request</h1>
-<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_1.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md28"></a>
+<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_1.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md29"></a>
 Process New Request</h1>
-<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_2.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md29"></a>
+<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_2.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md30"></a>
 Pre-prepare Phase</h1>
-<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_3.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md30"></a>
+<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_3.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md31"></a>
 Preparing Phase</h1>
-<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_4.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md31"></a>
+<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_4.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md32"></a>
 Commiting Phase</h1>
-<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_5.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md32"></a>
+<div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_5.png" alt="" class="inline"/> </div><h1><a class="anchor" id="autotoc_md33"></a>
 Ordering Thread</h1>
 <div align="center"> <img src="https://github.com/resilientdb/resilientdb/blob/master/platform/consensus/ordering/img/PBFT_6.png" alt="" class="inline"/> </div> </div></div><!-- contents -->
 </div><!-- PageDoc -->

d7/dbd/md__2github_2workspace_2scripts_2deploy_2README.html

@@ -101,9 +101,9 @@
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><p>This directory includes deployment scripts that help to deploy ResilientDB on multiple machines. At present, these scripts only support deploying KV service and KV Performance server.</p>
-<h1><a class="anchor" id="autotoc_md66"></a>
+<h1><a class="anchor" id="autotoc_md67"></a>
 Usage</h1>
-<h2><a class="anchor" id="autotoc_md67"></a>
+<h2><a class="anchor" id="autotoc_md68"></a>
 Deploy KV Service</h2>
 <p>Add the IP addresses and the SSH key of the machines where you wish to deploy ResilientDB replicas and client proxy in the file <a href="https://github.com/msadoghi/nexres/blob/master/deploy/config/kv_server.conf">config/kv_server.conf</a>. We recomment using private IP addresses of each machine.</p>
 <ul>
@@ -115,13 +115,13 @@ <h2><a class="anchor" id="autotoc_md67"></a>
 </pre><p> If the script outputs <code>Servers are running</code>, it implies that you have successfully deployed ReslientDB KV Service on desired machines. <br  />
 </p>
 <p>Note: this script creates a directory <code>config_out</code>, which includes keys and certificates for all the replicas and the proxy. Further, it includes the configuration for replicas <code>server.config</code> and proxy <code>client.config</code>.</p>
-<h3><a class="anchor" id="autotoc_md68"></a>
+<h3><a class="anchor" id="autotoc_md69"></a>
 Testing deployed KV Service</h3>
 <p>To do so, we need to build and run the KV client tools: </p><pre class="fragment">cd ../..
 bazel build service/tools/kv/api_tools/kv_service_tools
 bazel-bin/service/tools/kv/api_tools/kv_service_tools scripts/deploy/config_out/client.config get test 1234
 </pre><p> Or: </p><pre class="fragment">bazel run //service/tools/kv/api_tools:kv_service_tools -- $PWD/config_out/client.config get test
-</pre> <h2><a class="anchor" id="autotoc_md69"></a>
+</pre> <h2><a class="anchor" id="autotoc_md70"></a>
 Test Performance</h2>
 <p>Our benchmark is based on the Key-Value service.</p>
 <p>Before running, place the private IP addresses of your machines in the file <code>config/kv_performance_server.conf</code>.</p>