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 > Welcome to the R3 prototyping repository! — 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 = "#" / >
2015-11-25 13:29:51 +00:00
< link rel = "next" title = "What’ href = "inthebox.html" / >
< 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" >
2016-03-08 17:30:51 +00:00
2015-11-25 13:29:51 +00:00
2016-05-09 16:13:23 +00:00
< a href = "#" 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 >
2016-03-08 17:30:51 +00:00
< 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" >
2015-12-22 15:15:38 +00:00
< p class = "caption" > < span class = "caption-text" > Overview< / span > < / p >
< ul >
2015-11-25 13:29:51 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "inthebox.html" > What’ s included?< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "getting-set-up.html" > Getting set up< / a > < / li >
2015-12-22 15:15:38 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "data-model.html" > Data 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-04-28 16:15:56 +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-04-18 17:25:41 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "irs.html" > The Interest Rate Swap Contract< / a > < / li >
2015-12-22 15:15:38 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Tutorials< / span > < / p >
< ul >
2016-05-09 09:19:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial_contract.html" > Writing a contract< / 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 >
2015-12-22 15:15:38 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Appendix< / span > < / p >
< ul >
2015-12-03 11:54:17 +00:00
< 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-04-28 16:15:56 +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 = "#" > 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 = "#" > Docs< / a > » < / li >
2015-11-30 17:00:25 +00:00
< li > Welcome to the R3 prototyping repository!< / li >
2015-11-25 13:29:51 +00:00
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/index.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" >
2015-11-30 17:00:25 +00:00
< div class = "section" id = "welcome-to-the-r3-prototyping-repository" >
< h1 > Welcome to the R3 prototyping repository!< a class = "headerlink" href = "#welcome-to-the-r3-prototyping-repository" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > This documentation describes the first prototype of a possible future R3 shared ledger platform.< / p >
2015-11-25 13:29:51 +00:00
< p > The goal of this prototype is to explore fundamentally better designs for transactions, states and smart contract APIs
2015-12-02 09:50:31 +00:00
than what presently exists on the market, tailor made for the needs of the financial industry. We are attempting to
prove or disprove the following hypothesis:< / p >
< p > < em > The combination of< / em > < / p >
< ul class = "simple" >
< li > < em > An upgraded state transition model< / em > < / li >
< li > < em > Industry standard, production quality virtual machines and languages< / em > < / li >
< li > < em > Limited data propagation< / em > < / li >
< li > < em > Conflict resolution without proof of work or blocks< / em > < / li >
< / ul >
< p > < em > is sufficiently powerful to justify the creation of a new platform implementation.< / em > < / p >
2015-11-25 13:29:51 +00:00
< p > Read on to learn:< / p >
2015-12-22 15:15:38 +00:00
< div class = "toctree-wrapper compound" id = "overview" >
< p class = "caption" > < span class = "caption-text" > Overview< / span > < a class = "headerlink" href = "#overview" title = "Permalink to this toctree" > ¶< / a > < / p >
2015-11-25 13:29:51 +00:00
< ul >
2015-12-22 15:15:38 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "inthebox.html" > What’ s included?< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "inthebox.html#contracts" > Contracts< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "inthebox.html#kotlin" > Kotlin< / a > < / li >
2015-11-25 13:29:51 +00:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "getting-set-up.html" > Getting set up< / a > < ul >
2015-12-08 15:47:45 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "getting-set-up.html#if-intellij-complains-about-lack-of-an-sdk" > If IntelliJ complains about lack of an SDK< / a > < / li >
2015-11-25 13:29:51 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "getting-set-up.html#doing-it-without-intellij" > Doing it without IntelliJ< / a > < / li >
< / ul >
< / li >
2015-12-22 15:15:38 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "data-model.html" > Data model< / a > < ul >
2016-05-09 16:13:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "data-model.html#overview" > Overview< / a > < / li >
2015-12-22 15:15:38 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "data-model.html#comparison-with-bitcoin" > Comparison with Bitcoin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "data-model.html#comparison-with-ethereum" > Comparison with Ethereum< / a > < / li >
2016-05-09 16:13:23 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "data-model.html#rationale-for-and-tradeoffs-in-adopting-a-utxo-style-model" > Rationale for and tradeoffs in adopting a UTXO-style model< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "data-model.html#rationale" > Rationale< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "data-model.html#pros" > Pros< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "data-model.html#cons" > Cons< / a > < / li >
2015-12-22 15:15:38 +00:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "messaging.html" > Networking and messaging< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "messaging.html#messaging-vs-networking" > Messaging vs networking< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "messaging.html#interfaces" > Interfaces< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "messaging.html#in-memory-implementation" > In memory implementation< / a > < / li >
2016-04-28 16:15:56 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "messaging.html#network-map-service" > Network Map Service< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "running-the-demos.html" > Running the demos< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "running-the-demos.html#trader-demo" > Trader demo< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "running-the-demos.html#irs-demo" > IRS demo< / a > < / li >
2015-12-22 15:15:38 +00:00
< / ul >
< / li >
2016-03-04 15:15:51 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "node-administration.html" > Node administration< / a > < ul >
2016-03-14 15:57:36 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "node-administration.html#monitoring-your-node" > Monitoring your node< / a > < / li >
2016-03-04 15:15:51 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "node-administration.html#uploading-and-downloading-attachments" > Uploading and downloading attachments< / a > < / li >
2016-03-14 15:57:36 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "node-administration.html#uploading-interest-rate-fixes" > Uploading interest rate fixes< / a > < / li >
2016-03-04 15:15:51 +00:00
< / ul >
< / li >
2016-04-18 17:25:41 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "irs.html" > The Interest Rate Swap Contract< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "irs.html#creating-an-instance-and-lifecycle" > Creating an instance and lifecycle< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "irs.html#technical-details" > Technical Details< / a > < / li >
< / ul >
< / li >
2015-12-22 15:15:38 +00:00
< / ul >
< / div >
< div class = "toctree-wrapper compound" id = "tutorials" >
< p class = "caption" > < span class = "caption-text" > Tutorials< / span > < a class = "headerlink" href = "#tutorials" title = "Permalink to this toctree" > ¶< / a > < / p >
< ul >
2016-05-09 09:19:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial_contract.html" > Writing a contract< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#starting-the-commercial-paper-class" > Starting the commercial paper class< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#states" > States< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#commands" > Commands< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#the-verify-function" > The verify function< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#using-state-groups" > Using state groups< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#checking-the-requirements" > Checking the requirements< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#how-to-test-your-contract" > How to test your contract< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#adding-a-generation-api-to-your-contract" > Adding a generation API to your contract< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "tutorial_contract.html#non-asset-oriented-based-smart-contracts" > Non-asset-oriented based smart contracts< / a > < / li >
2015-11-25 17:49:58 +00:00
< / ul >
< / 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 > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#introduction" > Introduction< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#theory" > Theory< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#a-two-party-trading-protocol" > A two party trading protocol< / a > < / li >
2016-01-13 12:54:10 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#suspendable-methods" > Suspendable methods< / a > < / li >
2015-12-14 17:22:34 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#the-state-machine-manager" > The state machine manager< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#implementing-the-seller" > Implementing the seller< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#implementing-the-buyer" > Implementing the buyer< / a > < / li >
2016-02-25 12:29:28 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "protocol-state-machines.html#progress-tracking" > Progress tracking< / a > < / li >
2015-12-14 17:22:34 +00:00
< / ul >
< / li >
2016-03-14 15:57:36 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "oracles.html" > Writing oracle services< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "oracles.html#introduction" > Introduction< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "oracles.html#the-two-basic-approaches" > The two basic approaches< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "oracles.html#asserting-continuously-varying-data-that-is-publicly-known" > Asserting continuously varying data that is publicly known< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "oracles.html#asserting-occasionally-varying-data-that-is-not-publicly-known" > Asserting occasionally varying data that is not publicly known< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "oracles.html#implementing-oracles-in-the-framework" > Implementing oracles in the framework< / a > < / li >
< / ul >
< / li >
2015-12-22 15:15:38 +00:00
< / ul >
< / div >
< div class = "toctree-wrapper compound" id = "appendix" >
< p class = "caption" > < span class = "caption-text" > Appendix< / span > < a class = "headerlink" href = "#appendix" title = "Permalink to this toctree" > ¶< / a > < / p >
< ul >
2015-12-03 11:54:17 +00:00
< 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 > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "codestyle.html#general-style" > 1. General style< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "codestyle.html#comments" > 2. Comments< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "codestyle.html#threading" > 3. Threading< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "codestyle.html#assertions-and-errors" > 4. Assertions and errors< / a > < / li >
< / ul >
< / li >
2016-04-28 16:15:56 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "building-the-docs.html" > Building the documentation< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "building-the-docs.html#requirements" > Requirements< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "building-the-docs.html#build" > Build< / a > < / li >
< / ul >
< / li >
2015-11-25 13:29:51 +00:00
< / ul >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "inthebox.html" class = "btn btn-neutral float-right" title = "What’ accesskey = "n" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2016-05-09 16:13:23 +00:00
© 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 >
