2016-10-31 11:30:57 +00:00
|
|
|
|
.. highlight:: kotlin
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
|
|
|
<script type="text/javascript" src="_static/codesets.js"></script>
|
|
|
|
|
|
2017-02-08 10:34:54 +00:00
|
|
|
|
The example CorDapp
|
|
|
|
|
===================
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.. contents::
|
2017-02-08 10:34:54 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
The example CorDapp allows nodes to agree IOUs with each other, as long as they obey the following contract rules:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
* The IOU's value is strictly positive
|
|
|
|
|
* A node is not trying to issue an IOU to itself
|
2016-11-29 13:45:58 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
We will deploy and run the CorDapp on four test nodes:
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-03-01 21:24:10 +00:00
|
|
|
|
* **Notary**, which hosts a validating notary service
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* **PartyA**
|
|
|
|
|
* **PartyB**
|
|
|
|
|
* **PartyC**
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
Because data is only propagated on a need-to-know basis, any IOUs agreed between PartyA and PartyB become "shared
|
|
|
|
|
facts" between PartyA and PartyB only. PartyC won't be aware of these IOUs.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Downloading the example CorDapp
|
|
|
|
|
-------------------------------
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Start by downloading the example CorDapp from GitHub:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Set up your machine by following the :doc:`quickstart guide <getting-set-up>`
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Clone the example CorDapp from the `cordapp-example repository <https://github.com/corda/cordapp-example>`_ using
|
|
|
|
|
the following command: ``git clone https://github.com/corda/cordapp-example``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Change directories to the freshly cloned repo: ``cd cordapp-example``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Opening the example CorDapp in IntelliJ
|
|
|
|
|
---------------------------------------
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Let's open the example CorDapp in IntelliJ IDEA:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Open IntelliJ
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-06-05 09:57:29 +00:00
|
|
|
|
* A splash screen will appear. Click ``open``, navigate to the folder where you cloned the ``cordapp-example``, and
|
|
|
|
|
click ``OK``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-06-05 09:57:29 +00:00
|
|
|
|
* Once the project is open, click ``File``, then ``Project Structure``. Under ``Project SDK:``, set the project SDK by
|
|
|
|
|
clicking ``New...``, clicking ``JDK``, and navigating to ``C:\Program Files\Java\jdk1.8.0_XXX`` (where ``XXX`` is the
|
|
|
|
|
latest minor version number). Click ``OK``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-06-05 09:57:29 +00:00
|
|
|
|
* Again under ``File`` then ``Project Structure``, select ``Modules``. Click ``+``, then ``Import Module``, then select
|
|
|
|
|
the ``cordapp-example`` folder and click ``Open``. Choose to ``Import module from external model``, select
|
|
|
|
|
``Gradle``, click ``Next`` then ``Finish`` (leaving the defaults) and ``OK``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
* Gradle will now download all the project dependencies and perform some indexing. This usually takes a minute or so
|
2017-09-22 15:51:32 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Project structure
|
2018-02-02 17:26:54 +00:00
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
The example CorDapp has the following structure:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.. sourcecode:: none
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.
|
|
|
|
|
├── config
|
|
|
|
|
│ ├── dev
|
|
|
|
|
│ │ └── log4j2.xml
|
|
|
|
|
│ └── test
|
|
|
|
|
│ └── log4j2.xml
|
|
|
|
|
├── doc
|
|
|
|
|
│ └── example_flow.plantuml
|
|
|
|
|
├── gradle
|
|
|
|
|
│ └── wrapper
|
|
|
|
|
│ ├── gradle-wrapper.jar
|
|
|
|
|
│ └── gradle-wrapper.properties
|
2017-09-22 15:51:32 +00:00
|
|
|
|
├── lib
|
|
|
|
|
│ ├── README.txt
|
|
|
|
|
│ └── quasar.jar
|
2017-07-21 11:33:31 +00:00
|
|
|
|
├── java-source
|
|
|
|
|
│ └── ...
|
|
|
|
|
├── kotlin-source
|
|
|
|
|
│ ├── build.gradle
|
|
|
|
|
│ └── src
|
|
|
|
|
│ ├── main
|
|
|
|
|
│ │ ├── kotlin
|
|
|
|
|
│ │ │ └── com
|
|
|
|
|
│ │ │ └── example
|
|
|
|
|
│ │ │ ├── api
|
|
|
|
|
│ │ │ │ └── ExampleApi.kt
|
|
|
|
|
│ │ │ ├── client
|
|
|
|
|
│ │ │ │ └── ExampleClientRPC.kt
|
|
|
|
|
│ │ │ ├── contract
|
|
|
|
|
│ │ │ │ └── IOUContract.kt
|
|
|
|
|
│ │ │ ├── flow
|
|
|
|
|
│ │ │ │ └── ExampleFlow.kt
|
|
|
|
|
│ │ │ ├── model
|
|
|
|
|
│ │ │ │ └── IOU.kt
|
|
|
|
|
│ │ │ ├── plugin
|
|
|
|
|
│ │ │ │ └── ExamplePlugin.kt
|
|
|
|
|
│ │ │ ├── schema
|
|
|
|
|
│ │ │ │ └── IOUSchema.kt
|
|
|
|
|
│ │ │ └── state
|
|
|
|
|
│ │ │ └── IOUState.kt
|
|
|
|
|
│ │ └── resources
|
|
|
|
|
│ │ ├── META-INF
|
|
|
|
|
│ │ │ └── services
|
|
|
|
|
│ │ │ └── net.corda.webserver.services.WebServerPluginRegistry
|
|
|
|
|
│ │ ├── certificates
|
|
|
|
|
│ │ │ ├── readme.txt
|
|
|
|
|
│ │ │ ├── sslkeystore.jks
|
|
|
|
|
│ │ │ └── truststore.jks
|
|
|
|
|
│ │ └── exampleWeb
|
|
|
|
|
│ │ ├── index.html
|
|
|
|
|
│ │ └── js
|
|
|
|
|
│ │ └── angular-module.js
|
|
|
|
|
│ └── test
|
|
|
|
|
│ └── kotlin
|
|
|
|
|
│ └── com
|
|
|
|
|
│ └── example
|
|
|
|
|
│ ├── Main.kt
|
|
|
|
|
│ ├── contract
|
|
|
|
|
│ │ └── IOUContractTests.kt
|
|
|
|
|
│ └── flow
|
|
|
|
|
│ └── IOUFlowTests.kt
|
2017-09-22 15:51:32 +00:00
|
|
|
|
├── .gitignore
|
|
|
|
|
├── LICENCE
|
|
|
|
|
├── README.md
|
|
|
|
|
├── TRADEMARK
|
|
|
|
|
├── build.gradle
|
|
|
|
|
├── gradle.properties
|
|
|
|
|
├── gradlew
|
|
|
|
|
├── gradlew.bat
|
2017-07-21 11:33:31 +00:00
|
|
|
|
└── settings.gradle
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
The key files and directories are as follows:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
* The **root directory** contains some gradle files, a README and a LICENSE
|
|
|
|
|
* **config** contains log4j configs
|
|
|
|
|
* **gradle** contains the gradle wrapper, which allows the use of Gradle without installing it yourself and worrying
|
|
|
|
|
about which version is required
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* **lib** contains the Quasar jar which rewrites our CorDapp's flows to be checkpointable
|
2017-07-21 11:33:31 +00:00
|
|
|
|
* **kotlin-source** contains the source code for the example CorDapp written in Kotlin
|
2018-05-09 14:19:35 +00:00
|
|
|
|
|
|
|
|
|
* **kotlin-source/src/main/kotlin** contains the source code for the example CorDapp
|
|
|
|
|
* **kotlin-source/src/main/resources** contains the certificate store, some static web content to be served by the
|
|
|
|
|
nodes and the WebServerPluginRegistry file
|
|
|
|
|
* **kotlin-source/src/test/kotlin** contains unit tests for the contracts and flows, and the driver to run the nodes
|
|
|
|
|
via IntelliJ
|
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* **java-source** contains the same source code, but written in Java. CorDapps can be developed in any language
|
|
|
|
|
targeting the JVM
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Running the example CorDapp
|
|
|
|
|
---------------------------
|
|
|
|
|
There are two ways to run the example CorDapp:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
* Via the terminal
|
|
|
|
|
* Via IntelliJ
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Both approaches will create a set of test nodes, install the CorDapp on these nodes, and then run the nodes. You can
|
|
|
|
|
read more about how we generate nodes :doc:`here <generating-a-node>`.
|
2017-09-22 15:51:32 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Running the example CorDapp from the terminal
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2017-09-22 15:51:32 +00:00
|
|
|
|
|
|
|
|
|
Building the example CorDapp
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
* Open a terminal window in the ``cordapp-example`` directory
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Build the test nodes with our CorDapp using the following command:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Unix/Mac OSX: ``./gradlew deployNodes``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Windows: ``gradlew.bat deployNodes``
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
This will automatically build four nodes with our CorDapp already installed
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.. note:: CorDapps can be written in any language targeting the JVM. In our case, we've provided the example source in
|
2018-02-02 17:26:54 +00:00
|
|
|
|
both Kotlin (``/kotlin-source/src``) and Java (``/java-source/src``). Since both sets of source files are
|
|
|
|
|
functionally identical, we will refer to the Kotlin version throughout the documentation.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
* After the build finishes, you will see the generated nodes in the ``kotlin-source/build/nodes`` folder
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
* There will be a folder for each generated node, plus a ``runnodes`` shell script (or batch file on Windows) to run
|
|
|
|
|
all the nodes simultaneously
|
2017-09-22 15:51:32 +00:00
|
|
|
|
|
|
|
|
|
* Each node in the ``nodes`` folder has the following structure:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
.. sourcecode:: none
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
. nodeName
|
2018-02-02 17:26:54 +00:00
|
|
|
|
├── corda.jar // The Corda node runtime.
|
|
|
|
|
├── corda-webserver.jar // The node development webserver.
|
|
|
|
|
├── node.conf // The node configuration file.
|
|
|
|
|
└── cordapps // The node's CorDapps.
|
2017-09-22 15:51:32 +00:00
|
|
|
|
|
|
|
|
|
Running the example CorDapp
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
Start the nodes by running the following command from the root of the ``cordapp-example`` folder:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
* Unix/Mac OSX: ``kotlin-source/build/nodes/runnodes``
|
|
|
|
|
* Windows: ``call kotlin-source\build\nodes\runnodes.bat``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-08 16:50:28 +00:00
|
|
|
|
.. warning:: On Unix/Mac OSX, do not click/change focus until all seven additional terminal windows have opened, or some
|
2017-09-22 15:51:32 +00:00
|
|
|
|
nodes may fail to start.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
For each node, the ``runnodes`` script creates a node tab/window:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
|
|
|
|
.. sourcecode:: none
|
|
|
|
|
|
2018-03-02 17:48:45 +00:00
|
|
|
|
______ __
|
|
|
|
|
/ ____/ _________/ /___ _
|
|
|
|
|
/ / __ / ___/ __ / __ `/ Top tip: never say "oops", instead
|
|
|
|
|
/ /___ /_/ / / / /_/ / /_/ / always say "Ah, Interesting!"
|
|
|
|
|
\____/ /_/ \__,_/\__,_/
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-03-02 17:48:45 +00:00
|
|
|
|
--- Corda Open Source corda-3.0 (4157c25) -----------------------------------------------
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
|
|
|
|
|
2018-03-02 17:48:45 +00:00
|
|
|
|
Logs can be found in : /Users/joeldudley/Desktop/cordapp-example/kotlin-source/build/nodes/PartyA/logs
|
|
|
|
|
Database connection url is : jdbc:h2:tcp://localhost:59472/node
|
2018-05-08 10:44:33 +00:00
|
|
|
|
Incoming connection address : localhost:10007
|
|
|
|
|
Listening on port : 10007
|
2018-03-02 17:48:45 +00:00
|
|
|
|
Loaded CorDapps : corda-finance-corda-3.0, cordapp-example-0.1, corda-core-corda-3.0
|
|
|
|
|
Node for "PartyA" started up and registered in 38.59 sec
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
|
|
|
|
|
2018-03-02 17:48:45 +00:00
|
|
|
|
Welcome to the Corda interactive shell.
|
|
|
|
|
Useful commands include 'help' to see what is available, and 'bye' to shut down the node.
|
2017-07-21 11:33:31 +00:00
|
|
|
|
|
2018-03-02 17:48:45 +00:00
|
|
|
|
Fri Mar 02 17:34:02 GMT 2018>>>
|
2017-07-21 11:33:31 +00:00
|
|
|
|
|
2018-03-01 21:24:10 +00:00
|
|
|
|
For every node except the notary, the script also creates a webserver terminal tab/window:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
|
|
|
|
.. sourcecode:: none
|
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Logs can be found in /Users/username/Desktop/cordapp-example/kotlin-source/build/nodes/PartyA/logs/web
|
2018-05-08 10:44:33 +00:00
|
|
|
|
Starting as webserver: localhost:10009
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Webserver started up in 42.02 sec
|
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
It usually takes around 60 seconds for the nodes to finish starting up. To ensure that all the nodes are running, you
|
|
|
|
|
can query the 'status' end-point located at ``http://localhost:[port]/api/status`` (e.g.
|
2018-05-08 10:44:33 +00:00
|
|
|
|
``http://localhost:10009/api/status`` for ``PartyA``).
|
2017-07-21 11:33:31 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Running the example CorDapp from IntelliJ
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Select the ``Run Example CorDapp - Kotlin`` run configuration from the drop-down menu at the top right-hand side of
|
|
|
|
|
the IDE
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* Click the green arrow to start the nodes:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
.. image:: resources/run-config-drop-down.png
|
|
|
|
|
:width: 400
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
* To stop the nodes, press the red square button at the top right-hand side of the IDE, next to the run configurations
|
2017-07-21 11:33:31 +00:00
|
|
|
|
|
2017-02-08 10:34:54 +00:00
|
|
|
|
Interacting with the example CorDapp
|
|
|
|
|
------------------------------------
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2016-12-12 18:48:35 +00:00
|
|
|
|
Via HTTP
|
2017-01-06 11:05:37 +00:00
|
|
|
|
~~~~~~~~
|
2018-02-02 17:26:54 +00:00
|
|
|
|
The nodes' webservers run locally on the following ports:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-05-08 10:44:33 +00:00
|
|
|
|
* PartyA: ``localhost:10009``
|
|
|
|
|
* PartyB: ``localhost:10012``
|
|
|
|
|
* PartyC: ``localhost:10015``
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
These ports are defined in each node's node.conf file under ``kotlin-source/build/nodes/NodeX/node.conf``.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Each node webserver exposes the following endpoints:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2016-11-29 13:45:58 +00:00
|
|
|
|
* ``/api/example/me``
|
|
|
|
|
* ``/api/example/peers``
|
2017-02-08 10:34:54 +00:00
|
|
|
|
* ``/api/example/ious``
|
2017-09-25 16:01:14 +00:00
|
|
|
|
* ``/api/example/create-iou`` with parameters ``iouValue`` and ``partyName`` which is CN name of a node
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
There is also a web front-end served from ``/web/example``.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.. warning:: The content in ``web/example`` is only available for demonstration purposes and does not implement
|
2018-02-02 17:26:54 +00:00
|
|
|
|
anti-XSS, anti-XSRF or other security techniques. Do not use this code in production.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
Creating an IOU via the endpoint
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2018-02-02 17:26:54 +00:00
|
|
|
|
An IOU can be created by sending a PUT request to the ``api/example/create-iou`` endpoint directly, or by using the
|
|
|
|
|
the web form served from ``/web/example``.
|
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
To create an IOU between PartyA and PartyB, run the following command from the command line:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
|
|
|
|
.. sourcecode:: bash
|
|
|
|
|
|
2018-05-08 10:44:33 +00:00
|
|
|
|
curl -X PUT 'http://localhost:10009/api/example/create-iou?iouValue=1&partyName=O=PartyB,L=New%20York,C=US'
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-05-08 10:44:33 +00:00
|
|
|
|
Note that both PartyA's port number (``10009``) and PartyB are referenced in the PUT request path. This command
|
2017-09-22 15:51:32 +00:00
|
|
|
|
instructs PartyA to agree an IOU with PartyB. Once the process is complete, both nodes will have a signed, notarised
|
|
|
|
|
copy of the IOU. PartyC will not.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
Submitting an IOU via the web front-end
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
To create an IOU between PartyA and PartyB, navigate to ``/web/example``, click the "create IOU" button at the top-left
|
|
|
|
|
of the page, and enter the IOU details into the web-form. The IOU must have a positive value. For example:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
|
|
|
|
.. sourcecode:: none
|
|
|
|
|
|
2018-03-06 14:22:38 +00:00
|
|
|
|
Counterparty: Select from list
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Value (Int): 5
|
2017-02-08 10:34:54 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
And click submit. Upon clicking submit, the modal dialogue will close, and the nodes will agree the IOU.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Checking the output
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^
|
2018-03-02 11:20:29 +00:00
|
|
|
|
Assuming all went well, you can view the newly-created IOU by accessing the vault of PartyA or PartyB:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
*Via the HTTP API:*
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-05-08 10:44:33 +00:00
|
|
|
|
* PartyA's vault: Navigate to http://localhost:10009/api/example/ious
|
|
|
|
|
* PartyB's vault: Navigate to http://localhost:10012/api/example/ious
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
*Via web/example:*
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-05-08 10:44:33 +00:00
|
|
|
|
* PartyA: Navigate to http://localhost:10009/web/example and hit the "refresh" button
|
|
|
|
|
* PartyA: Navigate to http://localhost:10012/web/example and hit the "refresh" button
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-05-08 10:44:33 +00:00
|
|
|
|
The vault and web front-end of PartyC (at ``localhost:10015``) will not display any IOUs. This is because PartyC was
|
2017-09-22 15:51:32 +00:00
|
|
|
|
not involved in this transaction.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Via the interactive shell (terminal only)
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2017-09-22 15:51:32 +00:00
|
|
|
|
Nodes started via the terminal will display an interactive shell:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.. sourcecode:: none
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Welcome to the Corda interactive shell.
|
|
|
|
|
Useful commands include 'help' to see what is available, and 'bye' to shut down the node.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Fri Jul 07 16:36:29 BST 2017>>>
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
Type ``flow list`` in the shell to see a list of the flows that your node can run. In our case, this will return the
|
|
|
|
|
following list:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.. sourcecode:: none
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
com.example.flow.ExampleFlow$Initiator
|
|
|
|
|
net.corda.core.flows.ContractUpgradeFlow$Initiator
|
|
|
|
|
net.corda.core.flows.ContractUpgradeFlow$Initiator
|
|
|
|
|
net.corda.finance.flows.CashExitFlow
|
|
|
|
|
net.corda.finance.flows.CashIssueAndPaymentFlow
|
|
|
|
|
net.corda.finance.flows.CashIssueFlow
|
|
|
|
|
net.corda.finance.flows.CashPaymentFlow
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Creating an IOU via the interactive shell
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2017-09-22 15:51:32 +00:00
|
|
|
|
We can create a new IOU using the ``ExampleFlow$Initiator`` flow. For example, from the interactive shell of PartyA,
|
|
|
|
|
you can agree an IOU of 50 with PartyB by running
|
|
|
|
|
``flow start ExampleFlow$Initiator iouValue: 50, otherParty: "O=PartyB,L=New York,C=US"``.
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
This will print out the following progress steps:
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
.. sourcecode:: none
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
✅ Generating transaction based on new IOU.
|
|
|
|
|
✅ Verifying contract constraints.
|
|
|
|
|
✅ Signing transaction with our private key.
|
|
|
|
|
✅ Gathering the counterparty's signature.
|
2018-03-06 14:22:38 +00:00
|
|
|
|
✅ Collecting signatures from counterparties.
|
2017-07-21 11:33:31 +00:00
|
|
|
|
✅ Verifying collected signatures.
|
|
|
|
|
✅ Obtaining notary signature and recording transaction.
|
|
|
|
|
✅ Requesting signature by notary service
|
|
|
|
|
Requesting signature by Notary service
|
|
|
|
|
Validating response from Notary service
|
|
|
|
|
✅ Broadcasting transaction to participants
|
|
|
|
|
✅ Done
|
2016-11-17 18:31:17 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Checking the output
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^
|
2017-07-21 11:33:31 +00:00
|
|
|
|
We can also issue RPC operations to the node via the interactive shell. Type ``run`` to see the full list of available
|
|
|
|
|
operations.
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
You can see the newly-created IOU by running ``run vaultQuery contractStateType: com.example.state.IOUState``.
|
|
|
|
|
|
|
|
|
|
As before, the interactive shell of PartyC will not display any IOUs.
|
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Via the h2 web console
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
You can connect directly to your node's database to see its stored states, transactions and attachments. To do so,
|
|
|
|
|
please follow the instructions in :doc:`node-database`.
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
Using the example RPC client
|
2017-01-06 11:05:37 +00:00
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2018-02-02 17:26:54 +00:00
|
|
|
|
``/src/main/kotlin-source/com/example/client/ExampleClientRPC.kt`` defines a simple RPC client that connects to a node,
|
|
|
|
|
logs any existing IOUs and listens for any future IOUs. If you haven't created
|
2017-07-21 11:33:31 +00:00
|
|
|
|
any IOUs when you first connect to one of the nodes, the client will simply log any future IOUs that are agreed.
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Running the client via IntelliJ
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
Run the 'Run Example RPC Client' run configuration. By default, this run configuration is configured to connect to
|
|
|
|
|
PartyA. You can edit the run configuration to connect on a different port.
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Running the client via the command line
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2016-11-17 18:31:17 +00:00
|
|
|
|
Run the following gradle task:
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2017-09-22 15:51:32 +00:00
|
|
|
|
``./gradlew runExampleClientRPCKotlin``
|
|
|
|
|
|
|
|
|
|
This will connect the RPC client to PartyA and log their past and future IOU activity.
|
2017-07-21 11:33:31 +00:00
|
|
|
|
|
|
|
|
|
You can close the application using ``ctrl+C``.
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2017-07-21 11:33:31 +00:00
|
|
|
|
For more information on the client RPC interface and how to build an RPC client application, see:
|
2016-10-31 15:52:10 +00:00
|
|
|
|
|
2016-11-17 18:31:17 +00:00
|
|
|
|
* :doc:`Client RPC documentation <clientrpc>`
|
|
|
|
|
* :doc:`Client RPC tutorial <tutorial-clientrpc-api>`
|
2016-10-31 11:30:57 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Running nodes across machines
|
2017-07-21 11:33:31 +00:00
|
|
|
|
-----------------------------
|
2018-07-04 09:22:39 +00:00
|
|
|
|
The nodes can be configured to communicate as a network even when distributed across several machines:
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
* Deploy the nodes as usual:
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
* Unix/Mac OSX: ``./gradlew deployNodes``
|
|
|
|
|
* Windows: ``gradlew.bat deployNodes``
|
|
|
|
|
|
|
|
|
|
* Navigate to the build folder (``kotlin-source/build/nodes``)
|
|
|
|
|
* For each node, open its ``node.conf`` file and change ``localhost`` in its ``p2pAddress`` to the IP address of the machine
|
|
|
|
|
where the node will be run (e.g. ``p2pAddress="10.18.0.166:10007"``)
|
|
|
|
|
* These changes require new node-info files to be distributed amongst the nodes. Use the network bootstrapper tool
|
|
|
|
|
(see :doc:`network-bootstrapper`) to update the files and have them distributed locally:
|
|
|
|
|
|
|
|
|
|
``java -jar network-bootstrapper.jar kotlin-source/build/nodes``
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
* Move the node folders to their individual machines (e.g. using a USB key). It is important that none of the
|
|
|
|
|
nodes - including the notary - end up on more than one machine. Each computer should also have a copy of ``runnodes``
|
|
|
|
|
and ``runnodes.bat``.
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
For example, you may end up with the following layout:
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
* Machine 1: ``Notary``, ``PartyA``, ``runnodes``, ``runnodes.bat``
|
|
|
|
|
* Machine 2: ``PartyB``, ``PartyC``, ``runnodes``, ``runnodes.bat``
|
2018-03-01 21:24:10 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
* After starting each node, the nodes will be able to see one another and agree IOUs among themselves
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
.. warning:: The bootstrapper must be run **after** the ``node.conf`` files have been modified, but **before** the nodes
|
|
|
|
|
are distributed across machines. Otherwise, the nodes will not be able to communicate.
|
2016-12-12 18:48:35 +00:00
|
|
|
|
|
2018-07-04 09:22:39 +00:00
|
|
|
|
.. note:: If you are using H2 and wish to use the same ``h2port`` value for two or more nodes, you must only assign them that
|
|
|
|
|
value after the nodes have been moved to their individual machines. The initial bootstrapping process requires access to the
|
|
|
|
|
nodes' databases and if two nodes share the same H2 port, the process will fail.
|
2018-04-30 10:05:57 +00:00
|
|
|
|
|
2018-07-10 14:17:59 +00:00
|
|
|
|
Testing your CorDapp
|
|
|
|
|
--------------------
|
2016-10-31 15:52:10 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Corda provides several frameworks for writing unit and integration tests for CorDapps.
|
2016-10-31 15:52:10 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Contract tests
|
2018-07-10 14:17:59 +00:00
|
|
|
|
~~~~~~~~~~~~~~
|
2018-02-02 17:26:54 +00:00
|
|
|
|
You can run the CorDapp's contract tests by running the ``Run Contract Tests - Kotlin`` run configuration.
|
2016-10-31 15:52:10 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Flow tests
|
2018-07-10 14:17:59 +00:00
|
|
|
|
~~~~~~~~~~
|
2018-02-02 17:26:54 +00:00
|
|
|
|
You can run the CorDapp's flow tests by running the ``Run Flow Tests - Kotlin`` run configuration.
|
2017-07-21 11:33:31 +00:00
|
|
|
|
|
2018-02-02 17:26:54 +00:00
|
|
|
|
Integration tests
|
2018-07-10 14:17:59 +00:00
|
|
|
|
~~~~~~~~~~~~~~~~~
|
2018-02-02 17:26:54 +00:00
|
|
|
|
You can run the CorDapp's integration tests by running the ``Run Integration Tests - Kotlin`` run configuration.
|
2016-10-31 15:52:10 +00:00
|
|
|
|
|
2018-07-10 14:17:59 +00:00
|
|
|
|
Debugging your CorDapp
|
|
|
|
|
----------------------
|
2017-09-22 15:51:32 +00:00
|
|
|
|
|
2018-07-10 14:17:59 +00:00
|
|
|
|
See :doc:`debugging-a-cordapp`.
|