ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-20 09:26:41 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Added first Cordapp documentation.

Browse Source
This commit is contained in:
Clinton Alexander 2016-08-23 10:25:06 +01:00
parent f6407b9e95
commit 214c98b6aa
1 changed files with 65 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
docs/source/creating-a-cordapp.rst Normal file
View File

@ -0,0 +1,65 @@
Creating a Cordapp
==================
A Cordapp is an application that runs on the Corda platform using Corda APIs and plugin system. Cordapps will be self
contained in separate JARs from the Corda core JAR that is created and distributed.
Plugins
-------
.. note:: Currently plugins are only supported via Kotlin or Java.
To create a plugin you must extend from ``com.r3corda.core.node.CordaPluginRegistry``. The JavaDoc will contain
specific details of the implementation, but there are broadly the following extention points;
1. Required protocols: Explicitly state which protocols are required for your plugin.
2. Service plugins: Register your services that run when Corda runs, which will be provided a ``ServiceHub``.
3. Web APIs: You may register your own endpoints under /api/ of the build in web server.
4. Static web endpoints: You may register your own static serving directories for serving web content.
Services are used primarily for creating your own protocols, which will be the work horse of your Corda plugins. Web
APIs and serving directories will be for creating your own interface to Corda.
Standalone Nodes
----------------
To use a plugin you must also have a standalone node. To create a standalone node you run:
**Windows**::
gradlew.bat createStandalone
**Other**::
./gradlew createStandalone
This will output the standalone to ``build/libs/r3prototyping-x.y-SNAPSHOT-capsule.jar`` and several sample/standard
standalone nodes to ``build/standalone``. For now you can use the ``build/standalone/nodea`` directory as a template or
example.
Each standalone node must contain a ``node.conf`` file in the same directory as the standalone JAR file. After first
execution of the standalone node there will be many other configuration and persistence files created in this directory.
.. warning:: Deleting your standalone node directory in any way, including ``gradle clean`` will delete all persistence.
.. note:: Outside of development environments do not store your standalone node in the build folder.
Installing Plugins
------------------
Once you have created your distribution JAR you can install it to a node by adding it to ``<node_dir>/plugins/``. In this
case the ``node_dir`` is the location where your standalone node's JAR and configuration file is.
.. note:: If the plugins directory does not exist you can create it manually.
Starting your Node
------------------
Now you have a standalone node with your Cordapp installed, you can run it by navigating to ``<node_dir>`` and running
java -jar r3prototyping-x.y-SNAPSHOT-capsule.jar
The plugin should automatically be registered and the configuration file used.
.. warning:: If your working directory is not ``<node_dir>`` your plugins and configuration will not be used.