diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index f3d7047b08..81dbfae031 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -341,6 +341,9 @@ Version 4.0 * Finance CorDapp is now build as a sealed and signed JAR file. Custom classes can no longer be placed in the packages defined in Finance Cordapp or access it's non-public members. +* Finance CorDapp was split into two separate apps: ``corda-finance-contracts`` and ``corda-finance-workflows``, + ``corda-finance`` is kept for backward compatibility, it is recommended to use separated jars. + * The format of the shell commands' output can now be customized via the node shell, using the ``output-format`` command. * The ``node_transaction_mapping`` database table has been folded into the ``node_transactions`` database table as an additional column. diff --git a/docs/source/cordapp-build-systems.rst b/docs/source/cordapp-build-systems.rst index 61975291c0..96ad509369 100644 --- a/docs/source/cordapp-build-systems.rst +++ b/docs/source/cordapp-build-systems.rst @@ -22,11 +22,11 @@ Build tools In the instructions that follow, we assume you are using Gradle and the ``cordformation`` plugin to build your CorDapp. You can find examples of building a CorDapp using these tools in the `Kotlin CorDapp Template `_ and the -`Java CorDapp Template `_. +`Java CorDapp Template `_. To ensure you are using the correct version of Gradle, you should use the provided Gradle Wrapper by copying across the following folder and files from the `Kotlin CorDapp Template `_ or the -`Java CorDapp Template `_ to the root of your project: +`Java CorDapp Template `_ to the root of your project: * ``gradle/`` * ``gradlew`` @@ -49,7 +49,7 @@ Several ``ext`` variables are used in a CorDapp's ``build.gradle`` file to defin versions can be found here: https://bintray.com/r3/corda/cordapp. If in doubt, you should base yourself on the version numbers used in the ``build.gradle`` file of the `Kotlin CorDapp Template `_ and the -`Java CorDapp Template `_. +`Java CorDapp Template `_. For example, to use version 3.0 of Corda, version 3.0.8 of the Corda gradle plugins, version 0.7.9 of Quasar, and version 1.1.60 of Kotlin, you'd write: @@ -99,9 +99,10 @@ Here is an overview of the various Corda dependencies: functionality. Include manually if the utilities are useful or you are writing a library for Corda * ``corda-core-deterministic`` - Used by the Corda node for deterministic contracts. Not likely to be used externally * ``corda-djvm`` - Used by the Corda node for deterministic contracts. Not likely to be used externally -* ``corda-finance`` - The Corda finance CorDapp. Only include as a ``cordaCompile`` dependency if using as a dependent - Cordapp or if you need access to the Corda finance types. Use as a ``cordapp`` dependency if using as a CorDapp - dependency (see below) +* ``corda-finance-contracts``, ``corda-finance-workflows`` and deprecated ``corda-finance``. Corda finance CorDapp, use contracts and flows parts respectively. + ``corda-finance`` is left for backward compatibility purposes and should be replaced by former two where needed. + Only include as a ``cordaCompile`` dependency if using as a dependent Cordapp or if you need access to the Corda finance types. + Use as a ``cordapp`` dependency if using as a CorDapp dependency (see below) * ``corda-jackson`` - Corda Jackson support. Use if you plan to serialise Corda objects to and/or from JSON * ``corda-jfx`` - JavaFX utilities with some Corda-specific models and utilities. Only use with JavaFX apps * ``corda-mock`` - A small library of useful mocks. Use if the classes are useful to you @@ -126,7 +127,7 @@ Here is an overview of the various Corda dependencies: Dependencies on other CorDapps ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -You CorDapp may also depend on classes defined in another CorDapp, such as states, contracts and flows. There are two +Your CorDapp may also depend on classes defined in another CorDapp, such as states, contracts and flows. There are two ways to add another CorDapp as a dependency in your CorDapp's ``build.gradle`` file: * ``cordapp project(":another-cordapp")`` (use this if the other CorDapp is defined in a module in the same project) @@ -288,7 +289,7 @@ Example Below is a sample of what a CorDapp's Gradle dependencies block might look like. When building your own CorDapp, you should base yourself on the ``build.gradle`` file of the `Kotlin CorDapp Template `_ or the -`Java CorDapp Template `_. +`Java CorDapp Template `_. .. container:: codeset @@ -297,7 +298,8 @@ should base yourself on the ``build.gradle`` file of the dependencies { // Corda integration dependencies cordaCompile "net.corda:corda-core:$corda_release_version" - cordaCompile "net.corda:corda-finance:$corda_release_version" + cordaCompile "net.corda:corda-finance-contracts:$corda_release_version" + cordaCompile "net.corda:corda-finance-workflows:$corda_release_version" cordaCompile "net.corda:corda-jackson:$corda_release_version" cordaCompile "net.corda:corda-rpc:$corda_release_version" cordaCompile "net.corda:corda-node-api:$corda_release_version"