address review comments re: documentation

This commit is contained in:
Stefano Franz 2019-01-30 16:56:07 +00:00 committed by Stefano Franz
parent 544d09ea18
commit e255ef38cf
4 changed files with 29 additions and 13 deletions

View File

@ -315,7 +315,7 @@ Version 4.0
* CorDapps built by ``corda-gradle-plugins`` are now signed and sealed JAR files. * CorDapps built by ``corda-gradle-plugins`` are now signed and sealed JAR files.
Signing can be configured or disabled, and it defaults to using the Corda development certificate. Signing can be configured or disabled, and it defaults to using the Corda development certificate.
* Finance CorDapps are now built as a sealed and signed JAR file. * Finance CorDapps are now built as sealed and signed JAR files.
Custom classes can no longer be placed in the packages defined in either finance Cordapp or access it's non-public members. Custom classes can no longer be placed in the packages defined in either finance Cordapp or access it's non-public members.
* Finance CorDapp was split into two separate apps: ``corda-finance-contracts`` and ``corda-finance-workflows``. There is no longer a single cordapp which provides both. * Finance CorDapp was split into two separate apps: ``corda-finance-contracts`` and ``corda-finance-workflows``. There is no longer a single cordapp which provides both.

View File

@ -32,6 +32,15 @@ in the `Kotlin CorDapp Template <https://github.com/corda/cordapp-template-kotli
task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) { task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) {
directory "./build/nodes" directory "./build/nodes"
nodeDefaults {
cordapps = [
"net.corda:corda-finance-contracts:$corda_release_version",
"net.corda:corda-finance-workflows:$corda_release_version",
"net.corda:corda-confidential-identities:$corda_release_version"
]
}
node { node {
name "O=Notary,L=London,C=GB" name "O=Notary,L=London,C=GB"
// The notary will offer a validating notary service. // The notary will offer a validating notary service.
@ -45,8 +54,6 @@ in the `Kotlin CorDapp Template <https://github.com/corda/cordapp-template-kotli
h2Port 10004 h2Port 10004
// Starts an internal SSH server providing a management shell on the node. // Starts an internal SSH server providing a management shell on the node.
sshdPort 2223 sshdPort 2223
// Includes the corda-finance CorDapp on our node.
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
extraConfig = [ extraConfig = [
// Setting the JMX reporter type. // Setting the JMX reporter type.
jmxReporterType: 'JOLOKIA', jmxReporterType: 'JOLOKIA',
@ -63,7 +70,6 @@ in the `Kotlin CorDapp Template <https://github.com/corda/cordapp-template-kotli
} }
webPort 10007 webPort 10007
h2Port 10008 h2Port 10008
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
// Grants user1 all RPC permissions. // Grants user1 all RPC permissions.
rpcUsers = [[ user: "user1", "password": "test", "permissions": ["ALL"]]] rpcUsers = [[ user: "user1", "password": "test", "permissions": ["ALL"]]]
} }
@ -76,7 +82,6 @@ in the `Kotlin CorDapp Template <https://github.com/corda/cordapp-template-kotli
} }
webPort 10011 webPort 10011
h2Port 10012 h2Port 10012
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
// Grants user1 the ability to start the MyFlow flow. // Grants user1 the ability to start the MyFlow flow.
rpcUsers = [[ user: "user1", "password": "test", "permissions": ["StartFlow.net.corda.flows.MyFlow"]]] rpcUsers = [[ user: "user1", "password": "test", "permissions": ["StartFlow.net.corda.flows.MyFlow"]]]
} }
@ -268,28 +273,32 @@ Below you can find the example task from the `IRS Demo <https://github.com/corda
task deployNodes(type: net.corda.plugins.Dockerform, dependsOn: ['jar']) { task deployNodes(type: net.corda.plugins.Dockerform, dependsOn: ['jar']) {
nodeDefaults {
cordapps = [
"net.corda:corda-finance-contracts:$corda_release_version",
"net.corda:corda-finance-workflows:$corda_release_version",
"net.corda:corda-confidential-identities:$corda_release_version"
]
}
node { node {
name "O=Notary Service,L=Zurich,C=CH" name "O=Notary Service,L=Zurich,C=CH"
notary = [validating : true] notary = [validating : true]
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
rpcUsers = rpcUsersList rpcUsers = rpcUsersList
useTestClock true useTestClock true
} }
node { node {
name "O=Bank A,L=London,C=GB" name "O=Bank A,L=London,C=GB"
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
rpcUsers = rpcUsersList rpcUsers = rpcUsersList
useTestClock true useTestClock true
} }
node { node {
name "O=Bank B,L=New York,C=US" name "O=Bank B,L=New York,C=US"
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
rpcUsers = rpcUsersList rpcUsers = rpcUsersList
useTestClock true useTestClock true
} }
node { node {
name "O=Regulator,L=Moscow,C=RU" name "O=Regulator,L=Moscow,C=RU"
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
rpcUsers = rpcUsersList rpcUsers = rpcUsersList
useTestClock true useTestClock true
} }

View File

@ -19,20 +19,27 @@ service.
.. code:: bash .. code:: bash
task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) { task deployNodes(type: net.corda.plugins.Cordform, dependsOn: ['jar']) {
nodeDefaults {
cordapps = [
"net.corda:corda-finance-contracts:$corda_release_version",
"net.corda:corda-finance-workflows:$corda_release_version",
"net.corda:corda-confidential-identities:$corda_release_version"
]
}
directory "./build/nodes" directory "./build/nodes"
node { node {
name "O=Notary,L=London,C=GB" name "O=Notary,L=London,C=GB"
notary = [validating : true] notary = [validating : true]
p2pPort 10002 p2pPort 10002
rpcPort 10003 rpcPort 10003
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
} }
node { node {
name "O=PartyA,L=London,C=GB" name "O=PartyA,L=London,C=GB"
p2pPort 10005 p2pPort 10005
rpcPort 10006 rpcPort 10006
webPort 10007 webPort 10007
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
rpcUsers = [[ user: "user1", "password": "test", "permissions": ["ALL]]] rpcUsers = [[ user: "user1", "password": "test", "permissions": ["ALL]]]
} }
node { node {
@ -41,7 +48,6 @@ service.
rpcPort 10009 rpcPort 10009
webPort 10010 webPort 10010
sshdPort 10024 sshdPort 10024
cordapps = ["net.corda:corda-finance-contracts:$corda_release_version, net.corda:corda-finance-workflows:$corda_release_version"]
rpcUsers = [[ user: "user1", "password": "test", "permissions": ["ALL"]]] rpcUsers = [[ user: "user1", "password": "test", "permissions": ["ALL"]]]
} }
} }

View File

@ -34,7 +34,8 @@ couple of resources.
.. code:: bash .. code:: bash
wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance-contracts-/<VERSION>-corda/corda-finance-<VERSION>-corda.jar wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance-contracts-/<VERSION>-corda/corda-finance-contracts-<VERSION>-corda.jar
wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance-workflows-/<VERSION>-corda/corda-finance-workflows-<VERSION>-corda.jar
This is required to run some flows to check your connections, and to issue/transfer cash to counterparties. Copy it to This is required to run some flows to check your connections, and to issue/transfer cash to counterparties. Copy it to
the Corda installation location: the Corda installation location: