Regen docsite

This commit is contained in:
Mike Hearn
2016-11-29 18:44:59 +00:00
parent c9b4755f55
commit b4c0229ccc
109 changed files with 7289 additions and 900 deletions

View File

@ -89,14 +89,26 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="inthebox.html">What&#8217;s included?</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-set-up.html">Getting set up</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-set-up-fault-finding.html">Getting Set Up : Faultfinding</a></li>
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li>
<li class="toctree-l1"><a class="reference internal" href="CLI-vs-IDE.html">CLI vs IDE</a></li>
</ul>
<p class="caption"><span class="caption-text">Key concepts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="data-model.html">Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="transaction-data-types.html">Data types</a></li>
<li class="toctree-l1"><a class="reference internal" href="merkle-trees.html">Transaction Tear-offs</a></li>
<li class="toctree-l1"><a class="reference internal" href="merkle-trees.html">Transaction tear-offs</a></li>
<li class="toctree-l1"><a class="reference internal" href="consensus.html">Consensus model</a></li>
<li class="toctree-l1"><a class="reference internal" href="clauses.html">Clauses key concepts</a></li>
</ul>
<p class="caption"><span class="caption-text">CorDapps</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">CorDapps Background</a></li>
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html#gradle-plugins-for-cordapps">Gradle plugins for CorDapps</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html">The CorDapp Template</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html#building-the-cordapp-template">Building the CorDapp template</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html#running-the-sample-cordapp">Running the Sample CorDapp</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-cordapp.html#using-the-sample-cordapp">Using the sample CorDapp</a></li>
</ul>
<p class="caption"><span class="caption-text">The Corda node</span></p>
<ul>
@ -104,44 +116,50 @@
<li class="toctree-l1"><a class="reference internal" href="messaging.html">Networking and messaging</a></li>
<li class="toctree-l1"><a class="reference internal" href="persistence.html">Persistence</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
<li class="toctree-l1"><a class="reference internal" href="corda-configuration-files.html">The Corda Configuration File</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-services.html">A Brief Introduction To The Node Services</a></li>
</ul>
<p class="caption"><span class="caption-text">CorDapps</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">Creating a Cordapp</a></li>
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html#gradle-plugins-for-cordapps">Gradle Plugins for Cordapps</a></li>
<li class="toctree-l1"><a class="reference internal" href="corda-configuration-file.html">Node configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="corda-plugins.html">The Corda plugin framework</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-services.html">Brief introduction to the node services</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-explorer.html">Node Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="permissioning.html">Network permissioning</a></li>
</ul>
<p class="caption"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="where-to-start.html">Where to start</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract.html">Writing a contract</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-contract-clauses.html">Writing a contract using clauses</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-test-dsl.html">Writing a contract test</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-clientrpc-api.html">Client RPC API Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="flow-state-machines.html">Flow state machines</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-integration-testing.html">Integration Test Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-clientrpc-api.html">Client RPC API tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-building-transactions.html">Building Transactions</a></li>
<li class="toctree-l1"><a class="reference internal" href="flow-state-machines.html">Writing flows</a></li>
<li class="toctree-l1"><a class="reference internal" href="flow-testing.html">Writing flow tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="running-a-notary.html">Running a notary service</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-a-notary.html">Using a notary service</a></li>
<li class="toctree-l1"><a class="reference internal" href="oracles.html">Writing oracle services</a></li>
<li class="toctree-l1"><a class="reference internal" href="oracles.html#implementing-an-oracle-with-continuously-varying-data">Implementing an oracle with continuously varying data</a></li>
<li class="toctree-l1"><a class="reference internal" href="oracles.html#using-an-oracle">Using an oracle</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial-attachments.html">Using attachments</a></li>
<li class="toctree-l1"><a class="reference internal" href="event-scheduling.html">Event scheduling</a></li>
</ul>
<p class="caption"><span class="caption-text">Other</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="network-simulator.html">Network Simulator</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-explorer.html">Node Explorer</a></li>
<li class="toctree-l1"><a class="reference internal" href="initial-margin-agreement.html">Initial Margin Agreements</a></li>
<li class="toctree-l1"><a class="reference internal" href="initial-margin-agreement.html">Initial margin agreements</a></li>
</ul>
<p class="caption"><span class="caption-text">Component library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contract-catalogue.html">Contract catalogue</a></li>
<li class="toctree-l1"><a class="reference internal" href="contract-irs.html">Interest Rate Swaps</a></li>
<li class="toctree-l1"><a class="reference internal" href="contract-irs.html">Interest rate swaps</a></li>
</ul>
<p class="caption"><span class="caption-text">Appendix</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="loadtesting.html">Load testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="setting-up-a-corda-network.html">Introduction - What is a corda network?</a></li>
<li class="toctree-l1"><a class="reference internal" href="setting-up-a-corda-network.html#setting-up-your-own-network">Setting up your own network</a></li>
<li class="toctree-l1"><a class="reference internal" href="secure-coding-guidelines.html">Secure coding guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release process</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-process.html#steps-to-cut-a-release">Steps to cut a release</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Release notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#milestone-6">Milestone 6</a></li>
<li class="toctree-l2"><a class="reference internal" href="#milestone-5">Milestone 5</a></li>
<li class="toctree-l2"><a class="reference internal" href="#milestone-4">Milestone 4</a></li>
<li class="toctree-l2"><a class="reference internal" href="#milestone-3">Milestone 3</a></li>
@ -203,6 +221,87 @@
<div class="section" id="release-notes">
<h1>Release notes<a class="headerlink" href="#release-notes" title="Permalink to this headline"></a></h1>
<p>Here are brief summaries of what&#8217;s changed between each snapshot release.</p>
<div class="section" id="milestone-6">
<h2>Milestone 6<a class="headerlink" href="#milestone-6" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">Added the <a class="reference external" href="_static/corda-technical-whitepaper.pdf">Corda technical white paper</a>. Note that its current version
is 0.5 to reflect the fact that the Corda design is still evolving. Although we expect only relatively small tweaks
at this point, when Corda reaches 1.0 so will the white paper.</p>
</li>
<li><p class="first">Major documentation restructuring and new content:</p>
<blockquote>
<div><ul class="simple">
<li>More details on Corda node internals.</li>
<li>New CorDapp tutorial.</li>
<li>New tutorial on building transactions.</li>
<li>New tutorials on how to run and use a notary service.</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">An experimental version of the deterministic JVM sandbox has been added. It is not integrated with the node and will
undergo some significant changes in the coming releases before it is integrated, as the code is finished, as bugs are
found and fixed, and as the platform subset we choose to expose is finalised. Treat this as an outline of the basic
approach rather than something usable for production.</p>
</li>
<li><p class="first">Developer experience:</p>
<blockquote>
<div><ul class="simple">
<li>Samples have been merged back into the main repository. All samples can now be run via command line or IntelliJ.</li>
<li>Added a Client RPC python example.</li>
<li>Node console output now displays concise startup information, such as startup time or web address. All logging to
the console is suppressed apart from errors and flow progress tracker steps. It can be re-enabled by passing
<code class="docutils literal"><span class="pre">--log-to-console</span></code> command line parameter. Note that the log file remains unchanged an will still contain all
log entries.</li>
<li>The <code class="docutils literal"><span class="pre">runnodes</span></code> scripts generated by the Gradle plugins now open each node in separate terminal windows or (on macOS) tabs.</li>
<li>A much more complete template app.</li>
<li>JARs now available on Maven Central.</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Data model: A party is now identified by a composite key (formerly known as a &#8220;public key tree&#8221;) instead of a single public key.
Read more in <a class="reference internal" href="transaction-data-types.html#composite-keys"><span class="std std-ref">Multi-signature support</span></a>. This allows expressing distributed service identities, e.g. a distributed notary.
In the future this will also allow parties to use multiple signing keys for their legal identity.</p>
</li>
<li><p class="first">Decentralised consensus: A prototype RAFT based notary composed of multiple nodes has been added. This implementation
is optimised for high performance over robustness against malicious cluster members, which may be appropriate for
some financial situations. See <a class="reference internal" href="running-the-demos.html#notary-demo"><span class="std std-ref">Distributed Notary demo</span></a> to try it out. A BFT notary will be added later.</p>
</li>
<li><p class="first">Node explorer app:</p>
<blockquote>
<div><ul class="simple">
<li>New theme aligned with the Corda branding.</li>
<li>The New Transaction screen moved to the Cash View (as it is used solely for cash transactions)</li>
<li>Removed state machine/flow information from Transaction table. A new view for this will be created in a future release.</li>
<li>Added a new Network View that displays details of all nodes on the network.</li>
<li>Users can now configure the reporting currency in settings.</li>
<li>Various layout and performance enhancements.</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Client RPC:</p>
<blockquote>
<div><ul class="simple">
<li>Added a generic <code class="docutils literal"><span class="pre">startFlow</span></code> method that enables starting of any flow, given sufficient permissions.</li>
<li>Added the ability for plugins to register additional classes or custom serialisers with Kryo for use in RPC.</li>
<li><code class="docutils literal"><span class="pre">rpc-users.properties</span></code> file has been removed with RPC user settings moved to the config file.</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Configuration changes: It is now possible to specify a custom legal name for any of the node&#8217;s advertised services.</p>
</li>
<li><p class="first">Added a load testing framework which allows stress testing of a node cluster, as well as specifying different ways of
disrupting the normal operation of nodes. See <a class="reference internal" href="loadtesting.html"><span class="doc">Load testing</span></a>.</p>
</li>
<li><p class="first">Improvements to the experimental contract DSL, by Sofus Mortensen of Nordea Bank (please give Nordea a shoutout too).</p>
</li>
</ul>
<p>API changes:</p>
<ul class="simple">
<li>The top level package has been renamed from <code class="docutils literal"><span class="pre">com.r3corda</span></code> to <code class="docutils literal"><span class="pre">net.corda</span></code>.</li>
<li>Protocols have been renamed to &#8220;flows&#8221;.</li>
<li><code class="docutils literal"><span class="pre">OpaqueBytes</span></code> now uses <code class="docutils literal"><span class="pre">bytes</span></code> as the field name rather than <code class="docutils literal"><span class="pre">bits</span></code>.</li>
</ul>
</div>
<div class="section" id="milestone-5">
<h2>Milestone 5<a class="headerlink" href="#milestone-5" title="Permalink to this headline"></a></h2>
<ul>
@ -325,7 +424,7 @@ not currently running a permissioning service.</li>
<blockquote>
<div><ul class="simple">
<li>The Corda libraries that app developers need to link against can now be installed into your local Maven
repository, where they can then be used like any other JAR. See <a class="reference internal" href="creating-a-cordapp.html"><span class="doc">Creating a Cordapp</span></a>.</li>
repository, where they can then be used like any other JAR. See <a class="reference internal" href="creating-a-cordapp.html"><span class="doc">CorDapps Background</span></a>.</li>
</ul>
</div></blockquote>
</li>
@ -494,7 +593,7 @@ in the upcoming releases.</li>
<p>New documentation:</p>
<ul class="simple">
<li><a class="reference internal" href="contract-catalogue.html"><span class="doc">Contract catalogue</span></a></li>
<li><a class="reference internal" href="contract-irs.html"><span class="doc">Interest Rate Swaps</span></a></li>
<li><a class="reference internal" href="contract-irs.html"><span class="doc">Interest rate swaps</span></a></li>
<li><a class="reference internal" href="tutorial-test-dsl.html"><span class="doc">Writing a contract test</span></a></li>
</ul>
</div>
@ -621,7 +720,7 @@ the custom function forces the use of non-blocking random drivers on Linux.</p>
<div role="contentinfo">
<p>
&copy; Copyright 2016, Distributed Ledger Group, LLC.
&copy; Copyright 2016, R3 Limited.
</p>
</div>