ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-01-30 16:14:39 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Updates docs to match new cordapp-example structure. (#4748)

Browse Source
This commit is contained in:
Joel Dudley 2019-02-13 07:37:27 +00:00 committed by GitHub
parent db41f660e0
commit 873e9a5442
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 94 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
docs/source/tutorial-cordapp.rst
View File

@ -59,32 +59,72 @@ The example CorDapp has the following structure:
.. sourcecode:: none .. sourcecode:: none
. .
├── LICENCE
├── README.md
├── TRADEMARK
├── build.gradle
├── clients ├── clients
│   ├── build.gradle
│   └── src │   └── src
│   └── main │   └── main
│   └── kotlin │   ├── kotlin
│   └── com.example.server │   │   └── com
│   ├── MainController.kt │   │   └── example
│   ├── NodeRPCConnection.kt │   │   └── server
│   └── Server.kt │   │   ├── MainController.kt
│   ├── resources │   │   ├── NodeRPCConnection.kt
│   ├── public │   │   └── Server.kt
│   ├── js │   └── resources
│   ├── application.properties
│   └── public
│   ├── index.html
│   └── js
│   └── angular-module.js │   └── angular-module.js
│   └── index.html
│   └── application.properties
│ └── build.gradle
│  
├── config ├── config
│   ├── dev │   ├── dev
│   │   └── log4j2.xml │   │   └── log4j2.xml
│   └── test │   └── test
│   └── log4j2.xml │   └── log4j2.xml
├── contracts-java
│   ├── build.gradle
│   └── src
│   └── main
│   └── java
│   └── com
│   └── example
│   ├── contract
│   │   └── IOUContract.java
│   ├── schema
│   │   ├── IOUSchema.java
│   │   └── IOUSchemaV1.java
│   └── state
│   └── IOUState.java
├── contracts-kotlin
│   ├── build.gradle
│   └── src
│   └── main
│   └── kotlin
│   └── com
│   └── example
│   ├── contract
│   │   └── IOUContract.kt
│   ├── schema
│   │   └── IOUSchema.kt
│   └── state
│   └── IOUState.kt
├── cordapp-example.iml
├── gradle ├── gradle
│   └── wrapper │   └── wrapper
│   ├── gradle-wrapper.jar │   ├── gradle-wrapper.jar
│   └── gradle-wrapper.properties │   └── gradle-wrapper.properties
├── java-source ├── gradle.properties
├── gradlew
├── gradlew.bat
├── lib
│   ├── README.txt
│   └── quasar.jar
├── settings.gradle
├── workflows-java
│   ├── build.gradle │   ├── build.gradle
│   └── src │   └── src
│   ├── integrationTest │   ├── integrationTest
@ -93,26 +133,11 @@ The example CorDapp has the following structure:
│   │   └── example │   │   └── example
│   │   └── DriverBasedTests.java │   │   └── DriverBasedTests.java
│   ├── main │   ├── main
│   │   ── java │   │   └── java
│   │      └── com │   │   └── com
│   │      └── example │   │   └── example
│   │      ├── api │   │   └── flow
│   │      │   └── ExampleApi.java │   │   └── ExampleFlow.java
│   │      ├── client
│   │      │   └── ExampleClientRPC.java
│   │      ├── contract
│   │      │   └── IOUContract.java
│   │      ├── flow
│   │      │   └── ExampleFlow.java
│   │      ├── plugin
│   │      │   └── ExamplePlugin.java
│   │      ├── schema
│   │      │   ├── IOUSchema.java
│   │      │   └── IOUSchemaV1.java
│   │      └── state
│   │      └── IOUState.java
│   │ 
│   │  
│   └── test │   └── test
│   └── java │   └── java
│   └── com │   └── com
@ -122,20 +147,29 @@ The example CorDapp has the following structure:
│   │   └── IOUContractTests.java │   │   └── IOUContractTests.java
│   └── flow │   └── flow
│   └── IOUFlowTests.java │   └── IOUFlowTests.java
├── kotlin-source └── workflows-kotlin
│   ├── ...
├── lib
│   ├── README.txt
│   └── quasar.jar
├── .gitignore
├── LICENCE
├── README.md
├── TRADEMARK
├── build.gradle ├── build.gradle
├── gradle.properties └── src
├── gradlew ├── integrationTest
├── gradlew.bat │   └── kotlin
└── settings.gradle │   └── com
│   └── example
│   └── DriverBasedTests.kt
├── main
│   └── kotlin
│   └── com
│   └── example
│   └── flow
│   └── ExampleFlow.kt
└── test
└── kotlin
└── com
└── example
├── NodeDriver.kt
├── contract
│   └── IOUContractTests.kt
└── flow
└── IOUFlowTests.kt
The key files and directories are as follows: The key files and directories are as follows:
@ -145,13 +179,8 @@ The key files and directories are as follows:
about which version is required about which version is required
* **lib** contains the Quasar jar which rewrites our CorDapp's flows to be checkpointable * **lib** contains the Quasar jar which rewrites our CorDapp's flows to be checkpointable
* **clients** contains the source code for spring boot integration * **clients** contains the source code for spring boot integration
* **java-source** contains the source code for the example CorDapp written in Java * **contracts-java** and **workflows-java** contain the source code for the example CorDapp written in Java
* **contracts-kotlin** and **workflows-kotlin** contain the same source code, but written in Kotlin. CorDapps can be developed in either Java and Kotlin
* **java-source/src/main/java** contains the source code for the example CorDapp
* **java-source/src/test/java** contains unit tests for the contracts and flows, and the driver to run the nodes
via IntelliJ
* **kotlin-source** contains the same source code, but written in Kotlin. CorDapps can be developed in either Java and Kotlin
Running the example CorDapp Running the example CorDapp
--------------------------- ---------------------------
@ -177,10 +206,10 @@ Building the example CorDapp
* Windows: ``gradlew.bat deployNodes`` * Windows: ``gradlew.bat deployNodes``
.. note:: CorDapps can be written in any language targeting the JVM. In our case, we've provided the example source in .. note:: CorDapps can be written in any language targeting the JVM. In our case, we've provided the example source in
both Kotlin (``/kotlin-source/src``) and Java (``/java-source/src``). Since both sets of source files are both Kotlin and Java. Since both sets of source files are functionally identical, we will refer to the Kotlin version
functionally identical, we will refer to the Kotlin version throughout the documentation. throughout the documentation.
* After the build finishes, you will see the following output in the ``kotlin-source/build/nodes`` folder: * After the build finishes, you will see the following output in the ``workflows-kotlin/build/nodes`` folder:
* A folder for each generated node * A folder for each generated node
* A ``runnodes`` shell script for running all the nodes simultaneously on osX * A ``runnodes`` shell script for running all the nodes simultaneously on osX
@ -211,12 +240,13 @@ Building the example CorDapp
Running the example CorDapp Running the example CorDapp
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
Start the nodes and Spring Boot servers by running the following command from the root of the ``cordapp-example`` folder: Start the nodes by running the following command from the root of the ``cordapp-example`` folder:
* Unix/Mac OSX: ``kotlin-source/build/nodes/runnodes`` * Unix/Mac OSX: ``workflows-kotlin/build/nodes/runnodes``
* Windows: ``call kotlin-source\build\nodes\runnodes.bat`` * Windows: ``call workflows-kotlin\build\nodes\runnodes.bat``
Each Spring Boot server needs to be started in it's own terminal, replace X with A, B and C:
Each Spring Boot server needs to be started in it's own terminal, replace X with A, B and C
* Unix/Mac OSX: ``./gradlew runPartyXServer`` * Unix/Mac OSX: ``./gradlew runPartyXServer``
* Windows: ``gradlew.bat runPartyXServer`` * Windows: ``gradlew.bat runPartyXServer``
@ -236,7 +266,7 @@ For each node, the ``runnodes`` script creates a node tab/window:
--- Corda Open Source corda-3.0 (4157c25) ----------------------------------------------- --- Corda Open Source corda-3.0 (4157c25) -----------------------------------------------
Logs can be found in : /Users/joeldudley/Desktop/cordapp-example/kotlin-source/build/nodes/PartyA/logs Logs can be found in : /Users/joeldudley/Desktop/cordapp-example/workflows-kotlin/build/nodes/PartyA/logs
Database connection url is : jdbc:h2:tcp://localhost:59472/node Database connection url is : jdbc:h2:tcp://localhost:59472/node
Incoming connection address : localhost:10005 Incoming connection address : localhost:10005
Listening on port : 10005 Listening on port : 10005
@ -432,13 +462,13 @@ The nodes can be configured to communicate as a network even when distributed ac
* Unix/Mac OSX: ``./gradlew deployNodes`` * Unix/Mac OSX: ``./gradlew deployNodes``
* Windows: ``gradlew.bat deployNodes`` * Windows: ``gradlew.bat deployNodes``
* Navigate to the build folder (``kotlin-source/build/nodes``) * Navigate to the build folder (``workflows-kotlin/build/nodes``)
* For each node, open its ``node.conf`` file and change ``localhost`` in its ``p2pAddress`` to the IP address of the machine * 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"``) 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 * 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: (see :doc:`network-bootstrapper`) to update the files and have them distributed locally:
``java -jar network-bootstrapper.jar kotlin-source/build/nodes`` ``java -jar network-bootstrapper.jar workflows-kotlin/build/nodes``
* Move the node folders to their individual machines (e.g. using a USB key). It is important that none of the * 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`` nodes - including the notary - end up on more than one machine. Each computer should also have a copy of ``runnodes``