corda/docs/build/html/inthebox.html

278 lines
10 KiB
HTML
Raw Normal View History

2015-11-25 13:29:51 +00:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
2016-05-09 16:13:23 +00:00
<title>Whats included? &mdash; R3 Corda latest documentation</title>
2015-11-25 13:29:51 +00:00
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
2016-05-09 16:13:23 +00:00
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
<link rel="next" title="Getting set up" href="getting-set-up.html"/>
2016-05-24 11:27:23 +00:00
<link rel="prev" title="Welcome to the Corda repository!" href="index.html"/>
2015-11-25 13:29:51 +00:00
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
2015-11-25 13:29:51 +00:00
2016-05-09 16:13:23 +00:00
<a href="index.html" class="icon icon-home"> R3 Corda
2015-11-25 13:29:51 +00:00
</a>
<div class="version">
2016-02-25 12:29:28 +00:00
latest
2015-11-25 13:29:51 +00:00
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<br>
<a href="api/index.html">API reference</a>
2015-11-25 13:29:51 +00:00
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Overview</span></p>
<ul class="current">
2016-04-13 09:29:54 +00:00
<li class="toctree-l1 current"><a class="current reference internal" href="#">What&#8217;s included?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#kotlin">Kotlin</a></li>
</ul>
</li>
2015-11-25 13:29:51 +00:00
<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="data-model.html">Data model</a></li>
2016-06-30 12:49:28 +00:00
<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="consensus.html">Consensus model</a></li>
2015-12-14 17:22:34 +00:00
<li class="toctree-l1"><a class="reference internal" href="messaging.html">Networking and messaging</a></li>
2016-08-30 11:05:32 +00:00
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">Creating a Cordapp</a></li>
2016-05-09 16:13:23 +00:00
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li>
2016-03-04 15:15:51 +00:00
<li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li>
2016-08-09 10:21:07 +00:00
</ul>
<p class="caption"><span class="caption-text">Contracts</span></p>
<ul>
2016-08-30 11:05:32 +00:00
<li class="toctree-l1"><a class="reference internal" href="contract-catalogue.html">Contract catalogue</a></li>
2016-08-09 10:21:07 +00:00
<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">Tutorials</span></p>
<ul>
2016-05-24 11:27:23 +00:00
<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>
2016-07-12 16:52:52 +00:00
<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>
2015-12-14 17:22:34 +00:00
<li class="toctree-l1"><a class="reference internal" href="protocol-state-machines.html">Protocol state machines</a></li>
2016-03-14 15:57:36 +00:00
<li class="toctree-l1"><a class="reference internal" href="oracles.html">Writing oracle services</a></li>
2016-06-30 12:49:28 +00:00
<li class="toctree-l1"><a class="reference internal" href="event-scheduling.html">Event scheduling</a></li>
</ul>
<p class="caption"><span class="caption-text">Appendix</span></p>
<ul>
2016-05-24 11:27:23 +00:00
<li class="toctree-l1"><a class="reference internal" href="release-process.html">Release process</a></li>
2016-06-13 17:27:53 +00:00
<li class="toctree-l1"><a class="reference internal" href="release-process.html#steps-to-cut-a-release">Steps to cut a release</a></li>
2016-05-24 11:27:23 +00:00
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="visualiser.html">Using the visualiser</a></li>
2016-01-27 15:01:52 +00:00
<li class="toctree-l1"><a class="reference internal" href="codestyle.html">Code style guide</a></li>
2016-05-09 16:13:23 +00:00
<li class="toctree-l1"><a class="reference internal" href="building-the-docs.html">Building the documentation</a></li>
2015-11-25 13:29:51 +00:00
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
2016-05-09 16:13:23 +00:00
<a href="index.html">R3 Corda</a>
2015-11-25 13:29:51 +00:00
</nav>
<div class="wy-nav-content">
<div class="rst-content">
2016-04-13 09:29:54 +00:00
2015-11-25 13:29:51 +00:00
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>What&#8217;s included?</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/inthebox.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="what-s-included">
<h1>What&#8217;s included?<a class="headerlink" href="#what-s-included" title="Permalink to this headline"></a></h1>
2016-06-30 12:49:28 +00:00
<p>The Corda prototype currently includes:</p>
2016-08-30 11:05:32 +00:00
<ul class="simple">
<li>A peer to peer network with message persistence and delivery retries.</li>
<li>Key data structures for defining contracts and states.</li>
<li>Smart contracts, which you can find in the <a class="reference internal" href="contract-catalogue.html"><span class="doc">Contract catalogue</span></a>.</li>
<li>Algorithms that work with them, such as serialising, hashing, signing, and verification of the signatures.</li>
<li>API documentation and tutorials (what you&#8217;re reading).</li>
<li>A business process orchestration framework.</li>
<li>Notary infrastructure for precise timestamping, and elimination of double spending without a blockchain.</li>
<li>A simple REST API, and a web app demo that uses it to present a frontend for IRS trading.</li>
2015-11-25 13:29:51 +00:00
</ul>
<p>Some things it does not currently include but should gain later are:</p>
<ul class="simple">
2015-11-25 17:49:58 +00:00
<li>Sandboxing, distribution or publication of smart contract code</li>
2015-11-25 13:29:51 +00:00
<li>A user interface for administration</li>
</ul>
<p>The prototype&#8217;s goal is rapid exploration of ideas. Therefore in places it takes shortcuts that a production system
would not in order to boost productivity:</p>
<ul class="simple">
2016-03-14 15:57:36 +00:00
<li>It uses an object graph serialization framework instead of a well specified, vendor neutral protocol.</li>
2016-08-30 11:05:32 +00:00
<li>There&#8217;s currently no permissioning framework.</li>
<li>Some privacy techniques aren&#8217;t implemented yet.</li>
<li>It uses an embedded SQL database and doesn&#8217;t yet have connectivity support for mainstream SQL vendors (Oracle,
Postgres, MySQL, SQL Server etc).</li>
2015-11-25 13:29:51 +00:00
</ul>
<div class="section" id="kotlin">
<h2>Kotlin<a class="headerlink" href="#kotlin" title="Permalink to this headline"></a></h2>
2016-06-30 12:49:28 +00:00
<p>Corda is written in a language called <a class="reference external" href="https://kotlinlang.org/">Kotlin</a>. Kotlin is a language that targets the JVM
and can be thought of as a simpler Scala, with much better Java interop. It is developed by and has commercial support
from JetBrains, the makers of the IntelliJ IDE and other popular developer tools.</p>
<p>As Kotlin is very new, without a doubt you have not encountered it before. Don&#8217;t worry: it is designed as a better
Java for industrial use and as such, the syntax was carefully designed to be readable even to people who don&#8217;t know
the language, after only a few minutes of introduction.</p>
<p>Due to the seamless Java interop the use of Kotlin to extend the platform is <em>not</em> required and the tutorial shows how
to write contracts in both Kotlin and Java. You can <a class="reference external" href="https://medium.com/&#64;octskyward/why-kotlin-is-my-next-programming-language-c25c001e26e3">read more about why Kotlin is a potentially strong successor to Java here</a>.</p>
</div>
2015-11-25 13:29:51 +00:00
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="getting-set-up.html" class="btn btn-neutral float-right" title="Getting set up" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
2015-11-25 13:29:51 +00:00
2016-05-24 11:27:23 +00:00
<a href="index.html" class="btn btn-neutral" title="Welcome to the Corda repository!" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
2015-11-25 13:29:51 +00:00
</div>
<hr/>
<div role="contentinfo">
<p>
2016-05-09 16:13:23 +00:00
&copy; Copyright 2016, Distributed Ledger Group, LLC.
2015-11-25 13:29:51 +00:00
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
2016-02-25 12:29:28 +00:00
VERSION:'latest',
2015-11-25 13:29:51 +00:00
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>