mirror of
https://github.com/corda/corda.git
synced 2025-02-20 17:33:15 +00:00
commit
f4b66536c2
BIN
docs/build/doctrees/CLI-vs-IDE.doctree
vendored
BIN
docs/build/doctrees/CLI-vs-IDE.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/azure-vm.doctree
vendored
BIN
docs/build/doctrees/azure-vm.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/building-the-docs.doctree
vendored
BIN
docs/build/doctrees/building-the-docs.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/clauses.doctree
vendored
BIN
docs/build/doctrees/clauses.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/clientrpc.doctree
vendored
BIN
docs/build/doctrees/clientrpc.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/codestyle.doctree
vendored
BIN
docs/build/doctrees/codestyle.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/contract-catalogue.doctree
vendored
BIN
docs/build/doctrees/contract-catalogue.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/contract-irs.doctree
vendored
BIN
docs/build/doctrees/contract-irs.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/corda-configuration-file.doctree
vendored
BIN
docs/build/doctrees/corda-configuration-file.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/corda-plugins.doctree
vendored
BIN
docs/build/doctrees/corda-plugins.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/creating-a-cordapp.doctree
vendored
BIN
docs/build/doctrees/creating-a-cordapp.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/event-scheduling.doctree
vendored
BIN
docs/build/doctrees/event-scheduling.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/flow-state-machines.doctree
vendored
BIN
docs/build/doctrees/flow-state-machines.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/flow-testing.doctree
vendored
BIN
docs/build/doctrees/flow-testing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/further-notes-on-kotlin.doctree
vendored
BIN
docs/build/doctrees/further-notes-on-kotlin.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/getting-set-up.doctree
vendored
BIN
docs/build/doctrees/getting-set-up.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/glossary.doctree
vendored
BIN
docs/build/doctrees/glossary.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/inthebox.doctree
vendored
BIN
docs/build/doctrees/inthebox.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/key-concepts-core-types.doctree
vendored
BIN
docs/build/doctrees/key-concepts-core-types.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/key-concepts-data-model.doctree
vendored
BIN
docs/build/doctrees/key-concepts-data-model.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/key-concepts-ecosystem.doctree
vendored
BIN
docs/build/doctrees/key-concepts-ecosystem.doctree
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/key-concepts-vault.doctree
vendored
BIN
docs/build/doctrees/key-concepts-vault.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/key-concepts.doctree
vendored
BIN
docs/build/doctrees/key-concepts.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/loadtesting.doctree
vendored
BIN
docs/build/doctrees/loadtesting.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/merkle-trees.doctree
vendored
BIN
docs/build/doctrees/merkle-trees.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/messaging.doctree
vendored
BIN
docs/build/doctrees/messaging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/network-simulator.doctree
vendored
BIN
docs/build/doctrees/network-simulator.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/node-administration.doctree
vendored
BIN
docs/build/doctrees/node-administration.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/node-explorer.doctree
vendored
BIN
docs/build/doctrees/node-explorer.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/node-services.doctree
vendored
BIN
docs/build/doctrees/node-services.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/oracles.doctree
vendored
BIN
docs/build/doctrees/oracles.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/permissioning.doctree
vendored
BIN
docs/build/doctrees/permissioning.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/persistence.doctree
vendored
BIN
docs/build/doctrees/persistence.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/publishing-corda.doctree
vendored
BIN
docs/build/doctrees/publishing-corda.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/release-notes.doctree
vendored
BIN
docs/build/doctrees/release-notes.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/release-process.doctree
vendored
BIN
docs/build/doctrees/release-process.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/running-a-notary.doctree
vendored
BIN
docs/build/doctrees/running-a-notary.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/running-the-demos.doctree
vendored
BIN
docs/build/doctrees/running-the-demos.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/secure-coding-guidelines.doctree
vendored
BIN
docs/build/doctrees/secure-coding-guidelines.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorial-attachments.doctree
vendored
BIN
docs/build/doctrees/tutorial-attachments.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorial-clientrpc-api.doctree
vendored
BIN
docs/build/doctrees/tutorial-clientrpc-api.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorial-contract.doctree
vendored
BIN
docs/build/doctrees/tutorial-contract.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorial-cordapp.doctree
vendored
BIN
docs/build/doctrees/tutorial-cordapp.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorial-test-dsl.doctree
vendored
BIN
docs/build/doctrees/tutorial-test-dsl.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/using-a-notary.doctree
vendored
BIN
docs/build/doctrees/using-a-notary.doctree
vendored
Binary file not shown.
2
docs/build/html/.buildinfo
vendored
2
docs/build/html/.buildinfo
vendored
@ -1,4 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 7d9b5637897ed8e07ca7b2f63f52238c
|
||||
config: 1768caf6e5e802b716b72241d5bd1c76
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
3
docs/build/html/CLI-vs-IDE.html
vendored
3
docs/build/html/CLI-vs-IDE.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Overview" href="key-concepts.html"/>
|
||||
<link rel="prev" title="Running the demos" href="running-the-demos.html"/>
|
||||
|
@ -1,83 +1,83 @@
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
IntelliJ issues
|
||||
---------------
|
||||
Milestone releases
|
||||
------------------
|
||||
|
||||
Run configurations are missing
|
||||
When you clone the corda or cordapp-template repos, they will default to the master branch. The master branch is being continuously developed upon, and its features may not align with the state of Corda as described in the docs. Additionally, the master branch of the CorDapp Template may break in response to changes in the main corda repo.
|
||||
|
||||
When developing on Corda, you should always check out the latest stable branch instead, by running ``git checkout release-M7``.
|
||||
|
||||
Java issues
|
||||
-----------
|
||||
|
||||
Outdated/non-Oracle JDKs
|
||||
************************
|
||||
|
||||
Many users have faced issues when running versions of Java that are either outdated, or are produced by organisations other than Oracle (e.g. OpenJDK). The errors generated by these issues will not always clearly point to the JDK as the cause. If in doubt, check your JDK version by following the instructions `here <https://java.com/en/download/help/version_manual.xml>`_. You can download the latest version of Oracle's JDK `here <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_.
|
||||
|
||||
"Unresolved reference: javafx"
|
||||
******************************
|
||||
|
||||
If you opened the Corda project using "Import" from the IntelliJ splash screen rather than using "Open" and then
|
||||
importing the Gradle build system from the popup bubble, then a bug in IntelliJ will cause it to wipe and recreate
|
||||
the ``.idea`` directory where the run configurations are stored. The fix is simple and doesn't require you to
|
||||
re-import the project: just undelete the files! You can do that by either:
|
||||
JavaFX is not bundled with OpenJDK. If you are using OpenJDK and get an 'Unresolved reference: javafx' error, this means that you need to install OpenJFX. Do this by running ``sudo apt install openjfx``, and possibly ``sudo apt install libopenjfx-jav``.
|
||||
|
||||
1. Running ``git checkout .idea/runConfigurations`` to restore that part of the tree to its normal state.
|
||||
2. Using the "Version Control" pane in IntelliJ to undelete the files via the GUI.
|
||||
IDEA issues
|
||||
---------------
|
||||
|
||||
If IntelliJ complains about lack of an SDK
|
||||
******************************************
|
||||
No source files are present
|
||||
***************************
|
||||
|
||||
If on attempting to open the project (including importing Gradle project), IntelliJ refuses because an SDK was not selected,
|
||||
you may need to fix the project structure. Do this by following `these instructions <https://www.jetbrains.com/help/idea/2016.2/configuring-global-project-and-module-sdks.html>`_. The correct JDK is often found at a path such as ``jdk1.8.0_xx…/Contents/Home``
|
||||
|
||||
Ensure that you have the Project language level set at as 8. If you are having trouble selecting the correct JDK, the
|
||||
JetBrains website offers the `following guidelines <https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under>`_.
|
||||
|
||||
Kotlin issues
|
||||
-------------
|
||||
|
||||
Installation
|
||||
************
|
||||
|
||||
There are two ways to configure Kotlin from IntelliJ. One way is via the initial project opening screen in which you will
|
||||
need to use the ``Configure > Plugins`` tab. The other way is when you are in an open project, then you will need to
|
||||
configure it via (on Mac) ``IntelliJ -> Preferences ...``, whereas on PC it is ``File -> Settings``. Select the plugins
|
||||
bar, confirm that Kotlin is installed and up to date.
|
||||
|
||||
If you are having trouble installing Kotlin, first try upgrading the Kotlin plugin. At the time of writing, you can
|
||||
confirm what is the latest version of the Kotlin plugin on `this page <https://plugins.jetbrains.com/plugin/6954>`_.
|
||||
|
||||
|
||||
Gradle issues
|
||||
-------------
|
||||
|
||||
Gradle within IntelliJ
|
||||
**********************
|
||||
|
||||
After you have updated your code to the latest version from git, ensure that the gradle project is imported. Although
|
||||
gradle is used via the command line, it is also integrated with IntelliJ in order for IntelliJ to determine dependencies
|
||||
and index the project correctly.
|
||||
|
||||
When opening a project for the first time, you should see the "Unlinked Gradle project?" pop-up window in the IntelliJ top
|
||||
right corner or in a popup alert window. If you miss this, it will also appear in the "Event Log" windows which can be
|
||||
opened by clicking on "Event Log" at the bottom right of the IntelliJ window. Either way, click on "Import Gradle Project".
|
||||
When opening a project in IDEA for the first time, you will need to build the project. You should see "Unlinked Gradle project?"
|
||||
in a pop-up window in the top-right corner or in a popup alert window. It will also appear in the "Event Log" window which can be
|
||||
opened by clicking on "Event Log" at the bottom right of the IDEA window. Find one of these links and click on "Import Gradle Project".
|
||||
|
||||
.. image:: resources/unlinked-gradle.png
|
||||
:height: 50 px
|
||||
:width: 410 px
|
||||
:alt: IntelliJ Gradle Prompt
|
||||
:alt: IDEA Gradle Prompt
|
||||
|
||||
Wait for it to think and download the dependencies. After that you might have another popup titled "Unindexed remote maven repositories found." This is a general IntelliJ question and doesn't affect Corda, therefore you can decided to index them or not. Next click on the "green arrow" next to "All tests" pop-up on the top toolbar.
|
||||
Wait for it to download the dependencies. You may then see another popup titled "Unindexed remote maven repositories found." This won't affect Corda,
|
||||
so you can choose to leave them unindexed.
|
||||
|
||||
The code should build, the unit tests should show as all green.
|
||||
If still have problems, the JetBrains website has more information on `here <https://www.jetbrains.com/help/idea/2016.2/working-with-gradle-projects.html>`_.
|
||||
|
||||
If still have problems, the JetBrains website has more information on `gradle here <https://www.jetbrains.com/help/idea/2016.2/working-with-gradle-projects.html>`_.
|
||||
Run configurations are missing
|
||||
******************************
|
||||
|
||||
Gradle via the CLI
|
||||
******************
|
||||
If you opened the Corda project by clicking "Import Project" on the IDEA splash screen rather than clicking "Open", a bug
|
||||
in IDEA will cause it to wipe and recreate the ``.idea`` directory where the run configurations are stored. The fix is
|
||||
simple and doesn't require you to re-import the project: just undelete the files! You can do that by either:
|
||||
|
||||
Gradle commands can also be run from the command line - further details of command line gradle can be found `here <https://docs.gradle.org/current/userguide/gradle_command_line.html>`_.
|
||||
1. Running ``git checkout .idea/runConfigurations`` to redownload the files.
|
||||
2. Using the "Version Control" pane in IDEA to undelete the files via the GUI.
|
||||
|
||||
Doing it without IntelliJ
|
||||
-------------------------
|
||||
IDEA complains about lack of an SDK
|
||||
***************************************
|
||||
|
||||
If you don't want to explore or modify the code in a local IDE, you can also just use the command line and a text editor:
|
||||
If IDEA refuses to open a project because an SDK has not been selected, you may need to fix the project structure. Do this by following `these instructions <https://www.jetbrains.com/help/idea/2016.2/configuring-global-project-and-module-sdks.html>`_. The correct JDK is often found on a path such as ``jdk1.8.0_xx…/Contents/Home``. Ensure that you have the Project language level set at 8.
|
||||
|
||||
* First run ``git clone https://github.com/corda/corda`` to download Corda core source code
|
||||
If you are having trouble selecting the correct JDK, the JetBrains website provides the `following guidelines <https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under>`_.
|
||||
|
||||
* Next ensure that you are in correct directory ``cd corda``
|
||||
Kotlin plugin
|
||||
*************
|
||||
|
||||
* Then you can run ``./gradlew test`` to run the unit tests.
|
||||
There are two ways to configure Kotlin in IDEA:
|
||||
|
||||
* Finally remember to run ``git pull`` occasionally to upgrade the source code to the latest revision
|
||||
1. Via the initial project opening screen, by using the ``Configure > Plugins`` tab.
|
||||
2. From an open IDEA project, by clicking ``IDEA -> Preferences ...`` (on OS X) or ``File -> Settings`` (on Windows). Select the Plugins bar to confirm that Kotlin is installed and up-to-date.
|
||||
|
||||
If you are still having trouble installing Kotlin, first try upgrading the Kotlin plugin. At the time of writing, you can
|
||||
identify the latest version of the Kotlin plugin on `this page <https://plugins.jetbrains.com/plugin/6954>`_.
|
||||
|
||||
"Unable to make the module: related gradle configuration was not found. Please, re-import the Gradle project and try again"
|
||||
***************************************************************************************************************************
|
||||
|
||||
This can usually be solved by updating IDEA. Check that you have the latest version `here <https://www.jetbrains.com/idea/download/>`_.
|
||||
|
||||
Other common issues
|
||||
-------------------
|
||||
|
||||
“xterm: command not found”
|
||||
**************************
|
||||
|
||||
On some machines, running the samples requires xterm. You can download it `here <http://invisible-island.net/xterm/#download>`_.
|
120
docs/build/html/_sources/getting-set-up.txt
vendored
120
docs/build/html/_sources/getting-set-up.txt
vendored
@ -1,83 +1,103 @@
|
||||
Getting set up
|
||||
==============
|
||||
|
||||
We have tried to make access to Corda as relatively simple as possible, using industry standard established tools.
|
||||
Although it is possible to replace any of the recommendations below, we will find it a lot easier to support your efforts
|
||||
if you follow our guidelines. Saying that, we are also interested in problems that arise due to different configurations.
|
||||
Software requirements
|
||||
---------------------
|
||||
|
||||
A JVM
|
||||
-----
|
||||
Corda uses industry-standard tools to make set-up as simple as possible. Following the software recommendations below will
|
||||
minimize the number of errors you encounter, and make it easier for others to provide support. However, if you do use other tools,
|
||||
we're interested to hear about any issues that arise.
|
||||
|
||||
Corda runs in a JVM and is written predominantly in Kotlin with some example use cases demonstrated in Java that we have
|
||||
incorporated to demonstrate that Kotlin and Java can work seamlessly together. We recommend the most recent production
|
||||
version of Java 8. The JDK can be obtained `from Oracle <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_.
|
||||
Other implementations of the JVM are not actively supported, but as mentioned, we are interested in finding out any issues you
|
||||
do have with them.
|
||||
JVM
|
||||
~~~
|
||||
|
||||
.. note:: If you are using a JVM implementation other than Oracle's you may get errors similar to ``Unresolved reference: javafx``.
|
||||
This means JavaFX is not bundled with the JVM and you will need to install it separately (e.g. OpenJFX is needed
|
||||
with OpenJDK).
|
||||
Corda is written in Kotlin and runs in a JVM. We develop against Oracle JDK 8, and other JVM implementations are not actively
|
||||
supported. Oracle JDK 8 can be obtained directly from
|
||||
`Oracle <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_. Installation instructions are
|
||||
available for `Windows <http://docs.oracle.com/javase/8/docs/technotes/guides/install/windows_jdk_install.html#CHDEBCCJ>`_,
|
||||
`Linux <http://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html#BJFGGEFG>`_ and
|
||||
`OS X <http://docs.oracle.com/javase/8/docs/technotes/guides/install/mac_jdk.html#CHDBADCG>`_.
|
||||
|
||||
IntelliJ
|
||||
--------
|
||||
We strongly recommend the use of IntelliJ's Development Environment known as IDEA. Download it for free from
|
||||
`JetBrains <https://www.jetbrains.com/idea/download/>`_. The primary reason we recommend this particular IDE is that it integrates
|
||||
very well with our choice of language for Corda, "Kotlin", as JetBrains also support the development of Kotlin.
|
||||
Please ensure that you keep your Oracle JDK installation updated to the latest version while working with Corda.
|
||||
Even earlier versions of JDK 8 versions can cause cryptic errors.
|
||||
|
||||
.. warning:: When opening the Corda project for the first time from the IntelliJ splash screen, please use "Open"
|
||||
and then agree to import the Gradle project from the popup bubble. Don't pick "Import" on the splash screen,
|
||||
because a bug in IntelliJ will cause the pre-packaged run configurations to be erased. If you see this warning
|
||||
too late, it's no problem, just use ``git checkout .idea/runConfiguration`` or the version control tab in IntelliJ
|
||||
to undelete the files.
|
||||
If you do choose to use OpenJDK instead of Oracle's JDK, you will also need to install OpenJFX.
|
||||
|
||||
Additional troubleshooting information can be found `here <https://docs.corda.net/getting-set-up-fault-finding.html#java-issues>`_.
|
||||
|
||||
Kotlin
|
||||
------
|
||||
Kotlin is available as a downloadable plugin to IntelliJ. Refer to IntelliJ's instructions on
|
||||
`getting Started with Kotlin and IntelliJ <https://kotlinlang.org/docs/tutorials/getting-started.html>`_. Additionally,
|
||||
if you would like to start getting to grips with the Kotlin language, then we strongly recommend you work through some
|
||||
of the tutorials (known as "koans") as well. Also see our :doc:`further-notes-on-kotlin`.
|
||||
~~~~~~
|
||||
|
||||
Applications on Corda (CorDapps) can be written in any JVM-targeting language. However, Corda itself and most of the samples
|
||||
are written in Kotlin. If you're unfamiliar with Kotlin, there is an official `getting started guide <https://kotlinlang.org/docs/tutorials/>`_.
|
||||
See also our :doc:`further-notes-on-kotlin`.
|
||||
|
||||
Version control via Git
|
||||
-----------------------
|
||||
IDE
|
||||
~~~
|
||||
|
||||
We use git to version control Corda. The authoritative place to obtain git is from the main `git website <https://git-scm.com/downloads>`_
|
||||
but it may be the case that your operating system provides git with a supported utility (e.g. for Apple, git is provided along
|
||||
with XCode - their free development environment). If this is the case, we would recommend you obtain git via that
|
||||
supported route.
|
||||
We strongly recommend the use of IntelliJ IDEA as an IDE, primarily due to the strength of its Kotlin integration. The free Community
|
||||
Edition can be downloaded from `JetBrains <https://www.jetbrains.com/idea/download/>`_.
|
||||
|
||||
You will need the command line package installed which you can then use natively (via the command line) or via IntelliJ
|
||||
(in which case you may need to configure IntelliJ to recognise where git has been installed on your system). IntelliJ and
|
||||
git configuration are quite seamless although the first time you use it, you will have to configure IntelliJ the location
|
||||
of your git command installation. More details regarding this can be found
|
||||
on the `JetBrains website <https://www.jetbrains.com/help/idea/2016.2/using-git-integration.html>`_
|
||||
Please make sure that you're running the latest version of IDEA, as older versions have been known to have problems integrating with Gradle,
|
||||
the build tool used by Corda.
|
||||
|
||||
You'll also want to install the Kotlin IDEA plugin by following the instructions
|
||||
`here <https://kotlinlang.org/docs/tutorials/getting-started.html>`_.
|
||||
|
||||
Additional troubleshooting information can be found `here <https://docs.corda.net/getting-set-up-fault-finding.html#idea-issues>`_.
|
||||
|
||||
Git
|
||||
~~~
|
||||
|
||||
We use git to version-control Corda. Instructions on installing git can be found
|
||||
`here <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_.
|
||||
|
||||
Following these instructions will give you access to git via the command line. It can also be useful to control git via IDEA. Instructions
|
||||
for doing so can be found on the `JetBrains website <https://www.jetbrains.com/help/idea/2016.2/using-git-integration.html>`_.
|
||||
|
||||
Gradle
|
||||
------
|
||||
~~~~~~
|
||||
|
||||
Gradle is our primary means of building Corda and managing dependencies. IntelliJ has its own view of this and occasionally
|
||||
may need to be resynced from time to time. This can be done within IntelliJ by pressing the "gradle refresh" icon located
|
||||
on the gradle tab (generally found on the right hand side), or by following the gradle commands specific for the task you
|
||||
are performing (details expounded later). Whenever prompted about gradle, accept the defaults suggested by IntelliJ.
|
||||
We use Gradle as the build tool for Corda. However, you do not need to install Gradle itself, as a wrapper is provided.
|
||||
|
||||
The wrapper can be run from the command line by using ``./gradlew [taskName]`` on OS X/Linux, or ``gradlew.bat [taskName]`` on Windows.
|
||||
|
||||
Corda source code
|
||||
-----------------
|
||||
|
||||
You can check out the Corda platform source code from this repository:
|
||||
The Corda platform source code is available here:
|
||||
|
||||
https://github.com/corda/corda.git
|
||||
|
||||
and a template app that you can use as a basis for experimenting with app development from:
|
||||
and a basic CorDapp that you can use as the basis for your own CorDapps is available here:
|
||||
|
||||
https://github.com/corda/cordapp-template.git
|
||||
|
||||
You can catch up with the latest code by selecting "VCS -> Update Project" in the IntelliJ menu.
|
||||
You can clone both of these repos to your local machine by running the command ``git clone [repo URL]``.
|
||||
|
||||
By default, both repos will be on the ``master`` branch. However, this is an unstable development branch. You should check
|
||||
out the latest milestone release (currently Milestone 7) instead by running ``git checkout release-M7``.
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
Opening Corda/CorDapps in IDEA
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
See :doc:`getting-set-up-fault-finding`, or get in touch with us either on the `forums <https://discourse.corda.net/>`_ or via `slack <http://slack.corda.net/>`_.
|
||||
When opening a Corda project for the first time from the IDEA splash screen, please click "Open" rather than "Import Project",
|
||||
and then import the Gradle project by clicking "Import Gradle project" in the popup bubble on the lower right-hand side of the screen.
|
||||
If you instead pick "Import Project" on the splash screen, a bug in IDEA will cause Corda's pre-packaged run configurations to be erased.
|
||||
|
||||
If you see this warning too late, that's not a problem - just use ``git checkout .idea/runConfiguration`` or the version control tab in
|
||||
IDEA to undelete the files.
|
||||
|
||||
IDEA's build of the project may need to be resynced from time to time. This can be done from within IDEA by going to "View" -> "Tool Windows" -> "Gradle"
|
||||
and clicking "Refresh all Gradle projects". Whenever prompted about Gradle, accept the defaults suggested by IDEA.
|
||||
|
||||
Next steps
|
||||
----------
|
||||
|
||||
The best way to check that everything is working fine is by :doc:`running-the-demos`.
|
||||
|
||||
Once you have these demos running, you may be interested in writing your own CorDapps, in which case you should refer to
|
||||
:doc:`tutorial-cordapp`.
|
||||
|
||||
If you encounter any issues, please see the :doc:`getting-set-up-fault-finding` page, or get in touch with us on the
|
||||
`forums <https://discourse.corda.net/>`_ or via `slack <http://slack.corda.net/>`_.
|
13
docs/build/html/_sources/index.txt
vendored
13
docs/build/html/_sources/index.txt
vendored
@ -14,17 +14,18 @@ they become more familiar with Corda, readers with a technical background will a
|
||||
which describes the platform's envisioned end-state.
|
||||
|
||||
Corda is designed so that developers can easily extend its functionality by writing CorDapps
|
||||
(**Cor**\ da **D**\ istributed **App**\ lication\ **s**\ ). An example CorDapp is available on
|
||||
(**Cor**\ da **D**\ istributed **App**\ lication\ **s**\ ). Some example CorDapps are available in the Corda repo's
|
||||
`samples <https://github.com/corda/corda/tree/master/samples>`_ directory. To run these yourself, make
|
||||
sure you follow the instructions in :doc:`getting-set-up`, then go to
|
||||
:doc:`running-the-demos`.
|
||||
|
||||
If, after running the demos, you're interested in writing your own CorDapps, a template CorDapp is available on
|
||||
`Github <https://github.com/corda/cordapp-template>`_. To get it running, follow the instructions in the
|
||||
`readme <https://github.com/corda/cordapp-template/blob/master/README.md>`_, or watch the
|
||||
`Corda Developers Tutorial <https://vimeo.com/192797322/aab499b152>`_.
|
||||
|
||||
Additional CorDapp samples are available in the Corda repo's `samples <https://github.com/corda/corda/tree/master/samples>`_
|
||||
directory. These are sophisticated CorDapps that implement more complex functionality. You can find directions for
|
||||
running these samples `here <https://docs.corda.net/running-the-demos.html>`_.
|
||||
|
||||
From there, you'll be in a position to start extending the example CorDapp yourself (e.g. by writing new states, contracts,
|
||||
and/or flows). For this, you'll want to refer to this docsite, and to the `tutorials <https://docs.corda.net/#tutorials>`_
|
||||
and/or flows). For this, you'll want to refer to this docsite, and to the `tutorials <https://docs.corda.net/tutorial-contract.html>`_
|
||||
in particular. If you get stuck, get in touch on `Slack <https://slack.corda.net/>`_ or the `forum <https://discourse.corda.net/>`_.
|
||||
|
||||
Once you're familiar with Corda and CorDapp development, we'd encourage you to get involved in the development of the
|
||||
|
8
docs/build/html/_sources/release-notes.txt
vendored
8
docs/build/html/_sources/release-notes.txt
vendored
@ -3,6 +3,14 @@ Release notes
|
||||
|
||||
Here are brief summaries of what's changed between each snapshot release.
|
||||
|
||||
Milestone 8
|
||||
-----------
|
||||
|
||||
* API:
|
||||
|
||||
* ``Party`` equality is now based on the owning key, rather than the owning key and name. This is important for
|
||||
party anonymisation to work, as each key must identify exactly one party.
|
||||
|
||||
Milestone 7
|
||||
-----------
|
||||
|
||||
|
7
docs/build/html/_static/basic.css
vendored
7
docs/build/html/_static/basic.css
vendored
@ -494,6 +494,13 @@ pre {
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
|
102
docs/build/html/_static/searchtools.js
vendored
102
docs/build/html/_static/searchtools.js
vendored
@ -226,6 +226,106 @@ var Scorer = {
|
||||
};
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
||||
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
||||
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
||||
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
||||
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
||||
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
||||
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
||||
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
||||
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
||||
var i, j, start, end;
|
||||
for (i = 0; i < singles.length; i++) {
|
||||
result[singles[i]] = true;
|
||||
}
|
||||
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
||||
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
||||
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
||||
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
||||
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
||||
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
||||
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
||||
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
||||
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
||||
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
||||
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
||||
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
||||
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
||||
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
||||
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
||||
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
||||
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
||||
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
||||
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
||||
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
||||
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
||||
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
||||
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
||||
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
||||
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
||||
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
||||
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
||||
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
||||
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
||||
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
||||
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
||||
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
||||
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
||||
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
||||
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
||||
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
||||
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
||||
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
||||
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
||||
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
||||
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
||||
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
||||
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
||||
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
||||
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
||||
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
||||
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
||||
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
||||
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
||||
for (i = 0; i < ranges.length; i++) {
|
||||
start = ranges[i][0];
|
||||
end = ranges[i][1];
|
||||
for (j = start; j <= end; j++) {
|
||||
result[j] = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
})();
|
||||
|
||||
function splitQuery(query) {
|
||||
var result = [];
|
||||
var start = -1;
|
||||
for (var i = 0; i < query.length; i++) {
|
||||
if (splitChars[query.charCodeAt(i)]) {
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start, i));
|
||||
start = -1;
|
||||
}
|
||||
} else if (start === -1) {
|
||||
start = i;
|
||||
}
|
||||
}
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
@ -324,7 +424,7 @@ var Search = {
|
||||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = query.split(/\s+/);
|
||||
var tmp = splitQuery(query);
|
||||
var objectterms = [];
|
||||
for (i = 0; i < tmp.length; i++) {
|
||||
if (tmp[i] !== "") {
|
||||
|
3
docs/build/html/azure-vm.html
vendored
3
docs/build/html/azure-vm.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Glossary" href="glossary.html"/>
|
||||
<link rel="prev" title="Publishing Corda" href="publishing-corda.html"/>
|
||||
|
3
docs/build/html/building-the-docs.html
vendored
3
docs/build/html/building-the-docs.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Further notes on Kotlin" href="further-notes-on-kotlin.html"/>
|
||||
<link rel="prev" title="Code style guide" href="codestyle.html"/>
|
||||
|
3
docs/build/html/clauses.html
vendored
3
docs/build/html/clauses.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Transaction tear-offs" href="merkle-trees.html"/>
|
||||
<link rel="prev" title="Network Simulator" href="network-simulator.html"/>
|
||||
|
3
docs/build/html/clientrpc.html
vendored
3
docs/build/html/clientrpc.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Networking and messaging" href="messaging.html"/>
|
||||
<link rel="prev" title="The CorDapp template" href="tutorial-cordapp.html"/>
|
||||
|
3
docs/build/html/codestyle.html
vendored
3
docs/build/html/codestyle.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Building the documentation" href="building-the-docs.html"/>
|
||||
<link rel="prev" title="Release notes" href="release-notes.html"/>
|
||||
|
3
docs/build/html/contract-catalogue.html
vendored
3
docs/build/html/contract-catalogue.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Interest rate swaps" href="contract-irs.html"/>
|
||||
<link rel="prev" title="Transaction tear-offs" href="merkle-trees.html"/>
|
||||
|
3
docs/build/html/contract-irs.html
vendored
3
docs/build/html/contract-irs.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Load testing" href="loadtesting.html"/>
|
||||
<link rel="prev" title="Contract catalogue" href="contract-catalogue.html"/>
|
||||
|
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="The Corda plugin framework" href="corda-plugins.html"/>
|
||||
<link rel="prev" title="Node administration" href="node-administration.html"/>
|
||||
|
3
docs/build/html/corda-plugins.html
vendored
3
docs/build/html/corda-plugins.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Brief introduction to the node services" href="node-services.html"/>
|
||||
<link rel="prev" title="Node configuration" href="corda-configuration-file.html"/>
|
||||
|
3
docs/build/html/creating-a-cordapp.html
vendored
3
docs/build/html/creating-a-cordapp.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="The CorDapp template" href="tutorial-cordapp.html"/>
|
||||
<link rel="prev" title="Security model" href="key-concepts-security-model.html"/>
|
||||
|
3
docs/build/html/event-scheduling.html
vendored
3
docs/build/html/event-scheduling.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Network Simulator" href="network-simulator.html"/>
|
||||
<link rel="prev" title="Using attachments" href="tutorial-attachments.html"/>
|
||||
|
3
docs/build/html/flow-state-machines.html
vendored
3
docs/build/html/flow-state-machines.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Writing flow tests" href="flow-testing.html"/>
|
||||
<link rel="prev" title="Building transactions" href="tutorial-building-transactions.html"/>
|
||||
|
3
docs/build/html/flow-testing.html
vendored
3
docs/build/html/flow-testing.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Running a notary service" href="running-a-notary.html"/>
|
||||
<link rel="prev" title="Writing flows" href="flow-state-machines.html"/>
|
||||
|
3
docs/build/html/further-notes-on-kotlin.html
vendored
3
docs/build/html/further-notes-on-kotlin.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Publishing Corda" href="publishing-corda.html"/>
|
||||
<link rel="prev" title="Building the documentation" href="building-the-docs.html"/>
|
||||
|
3
docs/build/html/genindex.html
vendored
3
docs/build/html/genindex.html
vendored
@ -35,6 +35,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="#"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
|
||||
|
||||
|
136
docs/build/html/getting-set-up-fault-finding.html
vendored
136
docs/build/html/getting-set-up-fault-finding.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Running the demos" href="running-the-demos.html"/>
|
||||
<link rel="prev" title="Getting set up" href="getting-set-up.html"/>
|
||||
@ -99,21 +102,24 @@ API reference: <a href="api/kotlin/corda/index.html">Kotlin</a>/ <a href="api/ja
|
||||
<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>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Troubleshooting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#intellij-issues">IntelliJ issues</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#milestone-releases">Milestone releases</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#java-issues">Java issues</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#outdated-non-oracle-jdks">Outdated/non-Oracle JDKs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#unresolved-reference-javafx">“Unresolved reference: javafx”</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#idea-issues">IDEA issues</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#no-source-files-are-present">No source files are present</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#run-configurations-are-missing">Run configurations are missing</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#if-intellij-complains-about-lack-of-an-sdk">If IntelliJ complains about lack of an SDK</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#idea-complains-about-lack-of-an-sdk">IDEA complains about lack of an SDK</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#kotlin-plugin">Kotlin plugin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#unable-to-make-the-module-related-gradle-configuration-was-not-found-please-re-import-the-gradle-project-and-try-again">“Unable to make the module: related gradle configuration was not found. Please, re-import the Gradle project and try again”</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#kotlin-issues">Kotlin issues</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#installation">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#other-common-issues">Other common issues</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#xterm-command-not-found">“xterm: command not found”</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#gradle-issues">Gradle issues</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#gradle-within-intellij">Gradle within IntelliJ</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#gradle-via-the-cli">Gradle via the CLI</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#doing-it-without-intellij">Doing it without IntelliJ</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li>
|
||||
@ -237,69 +243,71 @@ API reference: <a href="api/kotlin/corda/index.html">Kotlin</a>/ <a href="api/ja
|
||||
|
||||
<div class="section" id="troubleshooting">
|
||||
<h1>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="intellij-issues">
|
||||
<h2>IntelliJ issues<a class="headerlink" href="#intellij-issues" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="milestone-releases">
|
||||
<h2>Milestone releases<a class="headerlink" href="#milestone-releases" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When you clone the corda or cordapp-template repos, they will default to the master branch. The master branch is being continuously developed upon, and its features may not align with the state of Corda as described in the docs. Additionally, the master branch of the CorDapp Template may break in response to changes in the main corda repo.</p>
|
||||
<p>When developing on Corda, you should always check out the latest stable branch instead, by running <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">release-M7</span></code>.</p>
|
||||
</div>
|
||||
<div class="section" id="java-issues">
|
||||
<h2>Java issues<a class="headerlink" href="#java-issues" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="outdated-non-oracle-jdks">
|
||||
<h3>Outdated/non-Oracle JDKs<a class="headerlink" href="#outdated-non-oracle-jdks" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Many users have faced issues when running versions of Java that are either outdated, or are produced by organisations other than Oracle (e.g. OpenJDK). The errors generated by these issues will not always clearly point to the JDK as the cause. If in doubt, check your JDK version by following the instructions <a class="reference external" href="https://java.com/en/download/help/version_manual.xml">here</a>. You can download the latest version of Oracle’s JDK <a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">here</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="unresolved-reference-javafx">
|
||||
<h3>“Unresolved reference: javafx”<a class="headerlink" href="#unresolved-reference-javafx" title="Permalink to this headline">¶</a></h3>
|
||||
<p>JavaFX is not bundled with OpenJDK. If you are using OpenJDK and get an ‘Unresolved reference: javafx’ error, this means that you need to install OpenJFX. Do this by running <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">openjfx</span></code>, and possibly <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">apt</span> <span class="pre">install</span> <span class="pre">libopenjfx-jav</span></code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="idea-issues">
|
||||
<h2>IDEA issues<a class="headerlink" href="#idea-issues" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="no-source-files-are-present">
|
||||
<h3>No source files are present<a class="headerlink" href="#no-source-files-are-present" title="Permalink to this headline">¶</a></h3>
|
||||
<p>When opening a project in IDEA for the first time, you will need to build the project. You should see “Unlinked Gradle project?”
|
||||
in a pop-up window in the top-right corner or in a popup alert window. It will also appear in the “Event Log” window which can be
|
||||
opened by clicking on “Event Log” at the bottom right of the IDEA window. Find one of these links and click on “Import Gradle Project”.</p>
|
||||
<a class="reference internal image-reference" href="_images/unlinked-gradle.png"><img alt="IDEA Gradle Prompt" src="_images/unlinked-gradle.png" style="width: 410px; height: 50px;" /></a>
|
||||
<p>Wait for it to download the dependencies. You may then see another popup titled “Unindexed remote maven repositories found.” This won’t affect Corda,
|
||||
so you can choose to leave them unindexed.</p>
|
||||
<p>If still have problems, the JetBrains website has more information on <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/working-with-gradle-projects.html">here</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="run-configurations-are-missing">
|
||||
<h3>Run configurations are missing<a class="headerlink" href="#run-configurations-are-missing" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If you opened the Corda project using “Import” from the IntelliJ splash screen rather than using “Open” and then
|
||||
importing the Gradle build system from the popup bubble, then a bug in IntelliJ will cause it to wipe and recreate
|
||||
the <code class="docutils literal"><span class="pre">.idea</span></code> directory where the run configurations are stored. The fix is simple and doesn’t require you to
|
||||
re-import the project: just undelete the files! You can do that by either:</p>
|
||||
<p>If you opened the Corda project by clicking “Import Project” on the IDEA splash screen rather than clicking “Open”, a bug
|
||||
in IDEA will cause it to wipe and recreate the <code class="docutils literal"><span class="pre">.idea</span></code> directory where the run configurations are stored. The fix is
|
||||
simple and doesn’t require you to re-import the project: just undelete the files! You can do that by either:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Running <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">.idea/runConfigurations</span></code> to restore that part of the tree to its normal state.</li>
|
||||
<li>Using the “Version Control” pane in IntelliJ to undelete the files via the GUI.</li>
|
||||
<li>Running <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">.idea/runConfigurations</span></code> to redownload the files.</li>
|
||||
<li>Using the “Version Control” pane in IDEA to undelete the files via the GUI.</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="if-intellij-complains-about-lack-of-an-sdk">
|
||||
<h3>If IntelliJ complains about lack of an SDK<a class="headerlink" href="#if-intellij-complains-about-lack-of-an-sdk" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If on attempting to open the project (including importing Gradle project), IntelliJ refuses because an SDK was not selected,
|
||||
you may need to fix the project structure. Do this by following <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/configuring-global-project-and-module-sdks.html">these instructions</a>. The correct JDK is often found at a path such as <code class="docutils literal"><span class="pre">jdk1.8.0_xx…/Contents/Home</span></code></p>
|
||||
<p>Ensure that you have the Project language level set at as 8. If you are having trouble selecting the correct JDK, the
|
||||
JetBrains website offers the <a class="reference external" href="https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under">following guidelines</a>.</p>
|
||||
<div class="section" id="idea-complains-about-lack-of-an-sdk">
|
||||
<h3>IDEA complains about lack of an SDK<a class="headerlink" href="#idea-complains-about-lack-of-an-sdk" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If IDEA refuses to open a project because an SDK has not been selected, you may need to fix the project structure. Do this by following <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/configuring-global-project-and-module-sdks.html">these instructions</a>. The correct JDK is often found on a path such as <code class="docutils literal"><span class="pre">jdk1.8.0_xx…/Contents/Home</span></code>. Ensure that you have the Project language level set at 8.</p>
|
||||
<p>If you are having trouble selecting the correct JDK, the JetBrains website provides the <a class="reference external" href="https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under">following guidelines</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="kotlin-plugin">
|
||||
<h3>Kotlin plugin<a class="headerlink" href="#kotlin-plugin" title="Permalink to this headline">¶</a></h3>
|
||||
<p>There are two ways to configure Kotlin in IDEA:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Via the initial project opening screen, by using the <code class="docutils literal"><span class="pre">Configure</span> <span class="pre">></span> <span class="pre">Plugins</span></code> tab.</li>
|
||||
<li>From an open IDEA project, by clicking <code class="docutils literal"><span class="pre">IDEA</span> <span class="pre">-></span> <span class="pre">Preferences</span> <span class="pre">...</span></code> (on OS X) or <code class="docutils literal"><span class="pre">File</span> <span class="pre">-></span> <span class="pre">Settings</span></code> (on Windows). Select the Plugins bar to confirm that Kotlin is installed and up-to-date.</li>
|
||||
</ol>
|
||||
<p>If you are still having trouble installing Kotlin, first try upgrading the Kotlin plugin. At the time of writing, you can
|
||||
identify the latest version of the Kotlin plugin on <a class="reference external" href="https://plugins.jetbrains.com/plugin/6954">this page</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="unable-to-make-the-module-related-gradle-configuration-was-not-found-please-re-import-the-gradle-project-and-try-again">
|
||||
<h3>“Unable to make the module: related gradle configuration was not found. Please, re-import the Gradle project and try again”<a class="headerlink" href="#unable-to-make-the-module-related-gradle-configuration-was-not-found-please-re-import-the-gradle-project-and-try-again" title="Permalink to this headline">¶</a></h3>
|
||||
<p>This can usually be solved by updating IDEA. Check that you have the latest version <a class="reference external" href="https://www.jetbrains.com/idea/download/">here</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kotlin-issues">
|
||||
<h2>Kotlin issues<a class="headerlink" href="#kotlin-issues" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="installation">
|
||||
<h3>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h3>
|
||||
<p>There are two ways to configure Kotlin from IntelliJ. One way is via the initial project opening screen in which you will
|
||||
need to use the <code class="docutils literal"><span class="pre">Configure</span> <span class="pre">></span> <span class="pre">Plugins</span></code> tab. The other way is when you are in an open project, then you will need to
|
||||
configure it via (on Mac) <code class="docutils literal"><span class="pre">IntelliJ</span> <span class="pre">-></span> <span class="pre">Preferences</span> <span class="pre">...</span></code>, whereas on PC it is <code class="docutils literal"><span class="pre">File</span> <span class="pre">-></span> <span class="pre">Settings</span></code>. Select the plugins
|
||||
bar, confirm that Kotlin is installed and up to date.</p>
|
||||
<p>If you are having trouble installing Kotlin, first try upgrading the Kotlin plugin. At the time of writing, you can
|
||||
confirm what is the latest version of the Kotlin plugin on <a class="reference external" href="https://plugins.jetbrains.com/plugin/6954">this page</a>.</p>
|
||||
<div class="section" id="other-common-issues">
|
||||
<h2>Other common issues<a class="headerlink" href="#other-common-issues" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="xterm-command-not-found">
|
||||
<h3>“xterm: command not found”<a class="headerlink" href="#xterm-command-not-found" title="Permalink to this headline">¶</a></h3>
|
||||
<p>On some machines, running the samples requires xterm. You can download it <a class="reference external" href="http://invisible-island.net/xterm/#download">here</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="gradle-issues">
|
||||
<h2>Gradle issues<a class="headerlink" href="#gradle-issues" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="gradle-within-intellij">
|
||||
<h3>Gradle within IntelliJ<a class="headerlink" href="#gradle-within-intellij" title="Permalink to this headline">¶</a></h3>
|
||||
<p>After you have updated your code to the latest version from git, ensure that the gradle project is imported. Although
|
||||
gradle is used via the command line, it is also integrated with IntelliJ in order for IntelliJ to determine dependencies
|
||||
and index the project correctly.</p>
|
||||
<p>When opening a project for the first time, you should see the “Unlinked Gradle project?” pop-up window in the IntelliJ top
|
||||
right corner or in a popup alert window. If you miss this, it will also appear in the “Event Log” windows which can be
|
||||
opened by clicking on “Event Log” at the bottom right of the IntelliJ window. Either way, click on “Import Gradle Project”.</p>
|
||||
<a class="reference internal image-reference" href="_images/unlinked-gradle.png"><img alt="IntelliJ Gradle Prompt" src="_images/unlinked-gradle.png" style="width: 410px; height: 50px;" /></a>
|
||||
<p>Wait for it to think and download the dependencies. After that you might have another popup titled “Unindexed remote maven repositories found.” This is a general IntelliJ question and doesn’t affect Corda, therefore you can decided to index them or not. Next click on the “green arrow” next to “All tests” pop-up on the top toolbar.</p>
|
||||
<p>The code should build, the unit tests should show as all green.</p>
|
||||
<p>If still have problems, the JetBrains website has more information on <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/working-with-gradle-projects.html">gradle here</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="gradle-via-the-cli">
|
||||
<h3>Gradle via the CLI<a class="headerlink" href="#gradle-via-the-cli" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Gradle commands can also be run from the command line - further details of command line gradle can be found <a class="reference external" href="https://docs.gradle.org/current/userguide/gradle_command_line.html">here</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="doing-it-without-intellij">
|
||||
<h2>Doing it without IntelliJ<a class="headerlink" href="#doing-it-without-intellij" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you don’t want to explore or modify the code in a local IDE, you can also just use the command line and a text editor:</p>
|
||||
<ul class="simple">
|
||||
<li>First run <code class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/corda/corda</span></code> to download Corda core source code</li>
|
||||
<li>Next ensure that you are in correct directory <code class="docutils literal"><span class="pre">cd</span> <span class="pre">corda</span></code></li>
|
||||
<li>Then you can run <code class="docutils literal"><span class="pre">./gradlew</span> <span class="pre">test</span></code> to run the unit tests.</li>
|
||||
<li>Finally remember to run <code class="docutils literal"><span class="pre">git</span> <span class="pre">pull</span></code> occasionally to upgrade the source code to the latest revision</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
143
docs/build/html/getting-set-up.html
vendored
143
docs/build/html/getting-set-up.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Troubleshooting" href="getting-set-up-fault-finding.html"/>
|
||||
<link rel="prev" title="What’s included?" href="inthebox.html"/>
|
||||
@ -98,13 +101,19 @@ API reference: <a href="api/kotlin/corda/index.html">Kotlin</a>/ <a href="api/ja
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="inthebox.html">What’s included?</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting set up</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#a-jvm">A JVM</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#intellij">IntelliJ</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#kotlin">Kotlin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#version-control-via-git">Version control via Git</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#gradle">Gradle</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#corda-source-code">Corda source code</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#software-requirements">Software requirements</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#jvm">JVM</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#kotlin">Kotlin</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#ide">IDE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#git">Git</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#gradle">Gradle</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#corda-source-code">Corda source code</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#opening-corda-cordapps-in-idea">Opening Corda/CorDapps in IDEA</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#next-steps">Next steps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-set-up-fault-finding.html">Troubleshooting</a></li>
|
||||
@ -229,76 +238,82 @@ API reference: <a href="api/kotlin/corda/index.html">Kotlin</a>/ <a href="api/ja
|
||||
|
||||
<div class="section" id="getting-set-up">
|
||||
<h1>Getting set up<a class="headerlink" href="#getting-set-up" title="Permalink to this headline">¶</a></h1>
|
||||
<p>We have tried to make access to Corda as relatively simple as possible, using industry standard established tools.
|
||||
Although it is possible to replace any of the recommendations below, we will find it a lot easier to support your efforts
|
||||
if you follow our guidelines. Saying that, we are also interested in problems that arise due to different configurations.</p>
|
||||
<div class="section" id="a-jvm">
|
||||
<h2>A JVM<a class="headerlink" href="#a-jvm" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Corda runs in a JVM and is written predominantly in Kotlin with some example use cases demonstrated in Java that we have
|
||||
incorporated to demonstrate that Kotlin and Java can work seamlessly together. We recommend the most recent production
|
||||
version of Java 8. The JDK can be obtained <a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">from Oracle</a>.
|
||||
Other implementations of the JVM are not actively supported, but as mentioned, we are interested in finding out any issues you
|
||||
do have with them.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">If you are using a JVM implementation other than Oracle’s you may get errors similar to <code class="docutils literal"><span class="pre">Unresolved</span> <span class="pre">reference:</span> <span class="pre">javafx</span></code>.
|
||||
This means JavaFX is not bundled with the JVM and you will need to install it separately (e.g. OpenJFX is needed
|
||||
with OpenJDK).</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="intellij">
|
||||
<h2>IntelliJ<a class="headerlink" href="#intellij" title="Permalink to this headline">¶</a></h2>
|
||||
<p>We strongly recommend the use of IntelliJ’s Development Environment known as IDEA. Download it for free from
|
||||
<a class="reference external" href="https://www.jetbrains.com/idea/download/">JetBrains</a>. The primary reason we recommend this particular IDE is that it integrates
|
||||
very well with our choice of language for Corda, “Kotlin”, as JetBrains also support the development of Kotlin.</p>
|
||||
<div class="admonition warning">
|
||||
<p class="first admonition-title">Warning</p>
|
||||
<p class="last">When opening the Corda project for the first time from the IntelliJ splash screen, please use “Open”
|
||||
and then agree to import the Gradle project from the popup bubble. Don’t pick “Import” on the splash screen,
|
||||
because a bug in IntelliJ will cause the pre-packaged run configurations to be erased. If you see this warning
|
||||
too late, it’s no problem, just use <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">.idea/runConfiguration</span></code> or the version control tab in IntelliJ
|
||||
to undelete the files.</p>
|
||||
</div>
|
||||
<div class="section" id="software-requirements">
|
||||
<h2>Software requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Corda uses industry-standard tools to make set-up as simple as possible. Following the software recommendations below will
|
||||
minimize the number of errors you encounter, and make it easier for others to provide support. However, if you do use other tools,
|
||||
we’re interested to hear about any issues that arise.</p>
|
||||
<div class="section" id="jvm">
|
||||
<h3>JVM<a class="headerlink" href="#jvm" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Corda is written in Kotlin and runs in a JVM. We develop against Oracle JDK 8, and other JVM implementations are not actively
|
||||
supported. Oracle JDK 8 can be obtained directly from
|
||||
<a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Oracle</a>. Installation instructions are
|
||||
available for <a class="reference external" href="http://docs.oracle.com/javase/8/docs/technotes/guides/install/windows_jdk_install.html#CHDEBCCJ">Windows</a>,
|
||||
<a class="reference external" href="http://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html#BJFGGEFG">Linux</a> and
|
||||
<a class="reference external" href="http://docs.oracle.com/javase/8/docs/technotes/guides/install/mac_jdk.html#CHDBADCG">OS X</a>.</p>
|
||||
<p>Please ensure that you keep your Oracle JDK installation updated to the latest version while working with Corda.
|
||||
Even earlier versions of JDK 8 versions can cause cryptic errors.</p>
|
||||
<p>If you do choose to use OpenJDK instead of Oracle’s JDK, you will also need to install OpenJFX.</p>
|
||||
<p>Additional troubleshooting information can be found <a class="reference external" href="https://docs.corda.net/getting-set-up-fault-finding.html#java-issues">here</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="kotlin">
|
||||
<h2>Kotlin<a class="headerlink" href="#kotlin" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Kotlin is available as a downloadable plugin to IntelliJ. Refer to IntelliJ’s instructions on
|
||||
<a class="reference external" href="https://kotlinlang.org/docs/tutorials/getting-started.html">getting Started with Kotlin and IntelliJ</a>. Additionally,
|
||||
if you would like to start getting to grips with the Kotlin language, then we strongly recommend you work through some
|
||||
of the tutorials (known as “koans”) as well. Also see our <a class="reference internal" href="further-notes-on-kotlin.html"><span class="doc">Further notes on Kotlin</span></a>.</p>
|
||||
<h3>Kotlin<a class="headerlink" href="#kotlin" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Applications on Corda (CorDapps) can be written in any JVM-targeting language. However, Corda itself and most of the samples
|
||||
are written in Kotlin. If you’re unfamiliar with Kotlin, there is an official <a class="reference external" href="https://kotlinlang.org/docs/tutorials/">getting started guide</a>.
|
||||
See also our <a class="reference internal" href="further-notes-on-kotlin.html"><span class="doc">Further notes on Kotlin</span></a>.</p>
|
||||
</div>
|
||||
<div class="section" id="version-control-via-git">
|
||||
<h2>Version control via Git<a class="headerlink" href="#version-control-via-git" title="Permalink to this headline">¶</a></h2>
|
||||
<p>We use git to version control Corda. The authoritative place to obtain git is from the main <a class="reference external" href="https://git-scm.com/downloads">git website</a>
|
||||
but it may be the case that your operating system provides git with a supported utility (e.g. for Apple, git is provided along
|
||||
with XCode - their free development environment). If this is the case, we would recommend you obtain git via that
|
||||
supported route.</p>
|
||||
<p>You will need the command line package installed which you can then use natively (via the command line) or via IntelliJ
|
||||
(in which case you may need to configure IntelliJ to recognise where git has been installed on your system). IntelliJ and
|
||||
git configuration are quite seamless although the first time you use it, you will have to configure IntelliJ the location
|
||||
of your git command installation. More details regarding this can be found
|
||||
on the <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/using-git-integration.html">JetBrains website</a></p>
|
||||
<div class="section" id="ide">
|
||||
<h3>IDE<a class="headerlink" href="#ide" title="Permalink to this headline">¶</a></h3>
|
||||
<p>We strongly recommend the use of IntelliJ IDEA as an IDE, primarily due to the strength of its Kotlin integration. The free Community
|
||||
Edition can be downloaded from <a class="reference external" href="https://www.jetbrains.com/idea/download/">JetBrains</a>.</p>
|
||||
<p>Please make sure that you’re running the latest version of IDEA, as older versions have been known to have problems integrating with Gradle,
|
||||
the build tool used by Corda.</p>
|
||||
<p>You’ll also want to install the Kotlin IDEA plugin by following the instructions
|
||||
<a class="reference external" href="https://kotlinlang.org/docs/tutorials/getting-started.html">here</a>.</p>
|
||||
<p>Additional troubleshooting information can be found <a class="reference external" href="https://docs.corda.net/getting-set-up-fault-finding.html#idea-issues">here</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="git">
|
||||
<h3>Git<a class="headerlink" href="#git" title="Permalink to this headline">¶</a></h3>
|
||||
<p>We use git to version-control Corda. Instructions on installing git can be found
|
||||
<a class="reference external" href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">here</a>.</p>
|
||||
<p>Following these instructions will give you access to git via the command line. It can also be useful to control git via IDEA. Instructions
|
||||
for doing so can be found on the <a class="reference external" href="https://www.jetbrains.com/help/idea/2016.2/using-git-integration.html">JetBrains website</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="gradle">
|
||||
<h2>Gradle<a class="headerlink" href="#gradle" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Gradle is our primary means of building Corda and managing dependencies. IntelliJ has its own view of this and occasionally
|
||||
may need to be resynced from time to time. This can be done within IntelliJ by pressing the “gradle refresh” icon located
|
||||
on the gradle tab (generally found on the right hand side), or by following the gradle commands specific for the task you
|
||||
are performing (details expounded later). Whenever prompted about gradle, accept the defaults suggested by IntelliJ.</p>
|
||||
<h3>Gradle<a class="headerlink" href="#gradle" title="Permalink to this headline">¶</a></h3>
|
||||
<p>We use Gradle as the build tool for Corda. However, you do not need to install Gradle itself, as a wrapper is provided.</p>
|
||||
<p>The wrapper can be run from the command line by using <code class="docutils literal"><span class="pre">./gradlew</span> <span class="pre">[taskName]</span></code> on OS X/Linux, or <code class="docutils literal"><span class="pre">gradlew.bat</span> <span class="pre">[taskName]</span></code> on Windows.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="corda-source-code">
|
||||
<h2>Corda source code<a class="headerlink" href="#corda-source-code" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can check out the Corda platform source code from this repository:</p>
|
||||
<p>The Corda platform source code is available here:</p>
|
||||
<blockquote>
|
||||
<div><a class="reference external" href="https://github.com/corda/corda.git">https://github.com/corda/corda.git</a></div></blockquote>
|
||||
<p>and a template app that you can use as a basis for experimenting with app development from:</p>
|
||||
<p>and a basic CorDapp that you can use as the basis for your own CorDapps is available here:</p>
|
||||
<blockquote>
|
||||
<div><a class="reference external" href="https://github.com/corda/cordapp-template.git">https://github.com/corda/cordapp-template.git</a></div></blockquote>
|
||||
<p>You can catch up with the latest code by selecting “VCS -> Update Project” in the IntelliJ menu.</p>
|
||||
<p>You can clone both of these repos to your local machine by running the command <code class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">[repo</span> <span class="pre">URL]</span></code>.</p>
|
||||
<p>By default, both repos will be on the <code class="docutils literal"><span class="pre">master</span></code> branch. However, this is an unstable development branch. You should check
|
||||
out the latest milestone release (currently Milestone 7) instead by running <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">release-M7</span></code>.</p>
|
||||
<div class="section" id="opening-corda-cordapps-in-idea">
|
||||
<h3>Opening Corda/CorDapps in IDEA<a class="headerlink" href="#opening-corda-cordapps-in-idea" title="Permalink to this headline">¶</a></h3>
|
||||
<p>When opening a Corda project for the first time from the IDEA splash screen, please click “Open” rather than “Import Project”,
|
||||
and then import the Gradle project by clicking “Import Gradle project” in the popup bubble on the lower right-hand side of the screen.
|
||||
If you instead pick “Import Project” on the splash screen, a bug in IDEA will cause Corda’s pre-packaged run configurations to be erased.</p>
|
||||
<p>If you see this warning too late, that’s not a problem - just use <code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">.idea/runConfiguration</span></code> or the version control tab in
|
||||
IDEA to undelete the files.</p>
|
||||
<p>IDEA’s build of the project may need to be resynced from time to time. This can be done from within IDEA by going to “View” -> “Tool Windows” -> “Gradle”
|
||||
and clicking “Refresh all Gradle projects”. Whenever prompted about Gradle, accept the defaults suggested by IDEA.</p>
|
||||
</div>
|
||||
<div class="section" id="troubleshooting">
|
||||
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
|
||||
<p>See <a class="reference internal" href="getting-set-up-fault-finding.html"><span class="doc">Troubleshooting</span></a>, or get in touch with us either on the <a class="reference external" href="https://discourse.corda.net/">forums</a> or via <a class="reference external" href="http://slack.corda.net/">slack</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="next-steps">
|
||||
<h2>Next steps<a class="headerlink" href="#next-steps" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The best way to check that everything is working fine is by <a class="reference internal" href="running-the-demos.html"><span class="doc">Running the demos</span></a>.</p>
|
||||
<p>Once you have these demos running, you may be interested in writing your own CorDapps, in which case you should refer to
|
||||
<a class="reference internal" href="tutorial-cordapp.html"><span class="doc">The CorDapp template</span></a>.</p>
|
||||
<p>If you encounter any issues, please see the <a class="reference internal" href="getting-set-up-fault-finding.html"><span class="doc">Troubleshooting</span></a> page, or get in touch with us on the
|
||||
<a class="reference external" href="https://discourse.corda.net/">forums</a> or via <a class="reference external" href="http://slack.corda.net/">slack</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
3
docs/build/html/glossary.html
vendored
3
docs/build/html/glossary.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="prev" title="Working with the Corda Demo on Azure Marketplace" href="azure-vm.html"/>
|
||||
|
||||
|
67
docs/build/html/index.html
vendored
67
docs/build/html/index.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="#"/>
|
||||
<link rel="next" title="What’s included?" href="inthebox.html"/>
|
||||
|
||||
@ -232,40 +235,37 @@ is the <a class="reference external" href="https://vimeo.com/192757743/c2ec39c1e
|
||||
they become more familiar with Corda, readers with a technical background will also want to dive into the <a class="reference external" href="_static/corda-technical-whitepaper.pdf">Technical white paper</a>,
|
||||
which describes the platform’s envisioned end-state.</p>
|
||||
<p>Corda is designed so that developers can easily extend its functionality by writing CorDapps
|
||||
(<strong>Cor</strong>da <strong>D</strong>istributed <strong>App</strong>lication<strong>s</strong>). An example CorDapp is available on
|
||||
(<strong>Cor</strong>da <strong>D</strong>istributed <strong>App</strong>lication<strong>s</strong>). Some example CorDapps are available in the Corda repo’s
|
||||
<a class="reference external" href="https://github.com/corda/corda/tree/master/samples">samples</a> directory. To run these yourself, make
|
||||
sure you follow the instructions in <a class="reference internal" href="getting-set-up.html"><span class="doc">Getting set up</span></a>, then go to
|
||||
<a class="reference internal" href="running-the-demos.html"><span class="doc">Running the demos</span></a>.</p>
|
||||
<p>If, after running the demos, you’re interested in writing your own CorDapps, a template CorDapp is available on
|
||||
<a class="reference external" href="https://github.com/corda/cordapp-template">Github</a>. To get it running, follow the instructions in the
|
||||
<a class="reference external" href="https://github.com/corda/cordapp-template/blob/master/README.md">readme</a>, or watch the
|
||||
<a class="reference external" href="https://vimeo.com/192797322/aab499b152">Corda Developers Tutorial</a>.</p>
|
||||
<p>Additional CorDapp samples are available in the Corda repo’s <a class="reference external" href="https://github.com/corda/corda/tree/master/samples">samples</a>
|
||||
directory. These are sophisticated CorDapps that implement more complex functionality. You can find directions for
|
||||
running these samples <a class="reference external" href="https://docs.corda.net/running-the-demos.html">here</a>.</p>
|
||||
<p>From there, you’ll be in a position to start extending the example CorDapp yourself (e.g. by writing new states, contracts,
|
||||
and/or flows). For this, you’ll want to refer to this docsite, and to the <a class="reference external" href="https://docs.corda.net/#tutorials">tutorials</a>
|
||||
and/or flows). For this, you’ll want to refer to this docsite, and to the <a class="reference external" href="https://docs.corda.net/tutorial-contract.html">tutorials</a>
|
||||
in particular. If you get stuck, get in touch on <a class="reference external" href="https://slack.corda.net/">Slack</a> or the <a class="reference external" href="https://discourse.corda.net/">forum</a>.</p>
|
||||
<p>Once you’re familiar with Corda and CorDapp development, we’d encourage you to get involved in the development of the
|
||||
platform itself. Find out more about <a class="reference external" href="https://github.com/corda/corda/wiki/Corda's-Open-Source-Approach">contributing to Corda</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="documentation-contents">
|
||||
<h1>Documentation Contents:<a class="headerlink" href="#documentation-contents" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound" id="getting-started">
|
||||
<p class="caption"><span class="caption-text">Getting started</span><a class="headerlink" href="#getting-started" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">Getting started</span></p>
|
||||
<ul>
|
||||
<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><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#a-jvm">A JVM</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#intellij">IntelliJ</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#kotlin">Kotlin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#version-control-via-git">Version control via Git</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#gradle">Gradle</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#software-requirements">Software requirements</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#corda-source-code">Corda source code</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#troubleshooting">Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up.html#next-steps">Next steps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-set-up-fault-finding.html">Troubleshooting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#intellij-issues">IntelliJ issues</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#kotlin-issues">Kotlin issues</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#gradle-issues">Gradle issues</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#doing-it-without-intellij">Doing it without IntelliJ</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#milestone-releases">Milestone releases</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#java-issues">Java issues</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#idea-issues">IDEA issues</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-set-up-fault-finding.html#other-common-issues">Other common issues</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a><ul>
|
||||
@ -285,8 +285,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound" id="key-concepts">
|
||||
<p class="caption"><span class="caption-text">Key concepts</span><a class="headerlink" href="#key-concepts" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">Key concepts</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="key-concepts.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="key-concepts-ecosystem.html">Corda ecosystem</a><ul>
|
||||
@ -327,8 +327,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
<li class="toctree-l1"><a class="reference internal" href="key-concepts-security-model.html">Security model</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound" id="cordapps">
|
||||
<p class="caption"><span class="caption-text">CorDapps</span><a class="headerlink" href="#cordapps" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">CorDapps</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="creating-a-cordapp.html">CorDapp basics</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="creating-a-cordapp.html#app-plugins">App plugins</a></li>
|
||||
@ -353,8 +353,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound" id="the-corda-node">
|
||||
<p class="caption"><span class="caption-text">The Corda node</span><a class="headerlink" href="#the-corda-node" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">The Corda node</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="clientrpc.html">Client RPC</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="clientrpc.html#security">Security</a></li>
|
||||
@ -419,8 +419,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound" id="id4">
|
||||
<p class="caption"><span class="caption-text">Tutorials</span><a class="headerlink" href="#id4" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<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#where-to-put-your-code">Where to put your code</a></li>
|
||||
@ -511,8 +511,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound" id="other">
|
||||
<p class="caption"><span class="caption-text">Other</span><a class="headerlink" href="#other" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<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><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="network-simulator.html#what-it-is-and-is-not">What it is and is not</a></li>
|
||||
@ -533,8 +533,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound" id="component-library">
|
||||
<p class="caption"><span class="caption-text">Component library</span><a class="headerlink" href="#component-library" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<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><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contract-catalogue.html#cash">Cash</a></li>
|
||||
@ -551,8 +551,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</li>
|
||||
</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>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">Appendix</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="loadtesting.html">Load testing</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="loadtesting.html#configuration-of-the-load-testing-cluster">Configuration of the load testing cluster</a></li>
|
||||
@ -575,6 +575,7 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release notes</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#milestone-8">Milestone 8</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#milestone-7">Milestone 7</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#milestone-6">Milestone 6</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#milestone-5">Milestone 5</a></li>
|
||||
@ -618,8 +619,8 @@ platform itself. Find out more about <a class="reference external" href="https:/
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound" id="glossary">
|
||||
<p class="caption"><span class="caption-text">Glossary</span><a class="headerlink" href="#glossary" title="Permalink to this toctree">¶</a></p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">Glossary</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
3
docs/build/html/inthebox.html
vendored
3
docs/build/html/inthebox.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Getting set up" href="getting-set-up.html"/>
|
||||
<link rel="prev" title="Welcome to the Corda documentation!" href="index.html"/>
|
||||
|
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Vault" href="key-concepts-vault.html"/>
|
||||
<link rel="prev" title="Flow framework" href="key-concepts-flow-framework.html"/>
|
||||
|
3
docs/build/html/key-concepts-core-types.html
vendored
3
docs/build/html/key-concepts-core-types.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Financial model" href="key-concepts-financial-model.html"/>
|
||||
<link rel="prev" title="Data model" href="key-concepts-data-model.html"/>
|
||||
|
3
docs/build/html/key-concepts-data-model.html
vendored
3
docs/build/html/key-concepts-data-model.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Core types" href="key-concepts-core-types.html"/>
|
||||
<link rel="prev" title="Corda ecosystem" href="key-concepts-ecosystem.html"/>
|
||||
|
3
docs/build/html/key-concepts-ecosystem.html
vendored
3
docs/build/html/key-concepts-ecosystem.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Data model" href="key-concepts-data-model.html"/>
|
||||
<link rel="prev" title="Overview" href="key-concepts.html"/>
|
||||
|
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Flow framework" href="key-concepts-flow-framework.html"/>
|
||||
<link rel="prev" title="Core types" href="key-concepts-core-types.html"/>
|
||||
|
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Consensus and notaries" href="key-concepts-consensus-notaries.html"/>
|
||||
<link rel="prev" title="Financial model" href="key-concepts-financial-model.html"/>
|
||||
|
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="CorDapp basics" href="creating-a-cordapp.html"/>
|
||||
<link rel="prev" title="Vault" href="key-concepts-vault.html"/>
|
||||
|
3
docs/build/html/key-concepts-vault.html
vendored
3
docs/build/html/key-concepts-vault.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Security model" href="key-concepts-security-model.html"/>
|
||||
<link rel="prev" title="Consensus and notaries" href="key-concepts-consensus-notaries.html"/>
|
||||
|
3
docs/build/html/key-concepts.html
vendored
3
docs/build/html/key-concepts.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Corda ecosystem" href="key-concepts-ecosystem.html"/>
|
||||
<link rel="prev" title="CLI vs IDE" href="CLI-vs-IDE.html"/>
|
||||
|
3
docs/build/html/loadtesting.html
vendored
3
docs/build/html/loadtesting.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="What is a corda network?" href="setting-up-a-corda-network.html"/>
|
||||
<link rel="prev" title="Interest rate swaps" href="contract-irs.html"/>
|
||||
|
3
docs/build/html/merkle-trees.html
vendored
3
docs/build/html/merkle-trees.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Contract catalogue" href="contract-catalogue.html"/>
|
||||
<link rel="prev" title="Clauses" href="clauses.html"/>
|
||||
|
3
docs/build/html/messaging.html
vendored
3
docs/build/html/messaging.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Persistence" href="persistence.html"/>
|
||||
<link rel="prev" title="Client RPC" href="clientrpc.html"/>
|
||||
|
3
docs/build/html/network-simulator.html
vendored
3
docs/build/html/network-simulator.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Clauses" href="clauses.html"/>
|
||||
<link rel="prev" title="Event scheduling" href="event-scheduling.html"/>
|
||||
|
3
docs/build/html/node-administration.html
vendored
3
docs/build/html/node-administration.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Node configuration" href="corda-configuration-file.html"/>
|
||||
<link rel="prev" title="Persistence" href="persistence.html"/>
|
||||
|
3
docs/build/html/node-explorer.html
vendored
3
docs/build/html/node-explorer.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Network permissioning" href="permissioning.html"/>
|
||||
<link rel="prev" title="Brief introduction to the node services" href="node-services.html"/>
|
||||
|
3
docs/build/html/node-services.html
vendored
3
docs/build/html/node-services.html
vendored
@ -34,6 +34,9 @@
|
||||
|
||||
|
||||
|
||||
<link rel="index" title="Index"
|
||||
href="genindex.html"/>
|
||||
<link rel="search" title="Search" href="search.html"/>
|
||||
<link rel="top" title="R3 Corda latest documentation" href="index.html"/>
|
||||
<link rel="next" title="Node Explorer" href="node-explorer.html"/>
|
||||
<link rel="prev" title="The Corda plugin framework" href="corda-plugins.html"/>
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user