diff --git a/docs/source/clientrpc.rst b/docs/source/clientrpc.rst index 0cb10d1077..79fef3043d 100644 --- a/docs/source/clientrpc.rst +++ b/docs/source/clientrpc.rst @@ -80,7 +80,7 @@ Wire protocol The client RPC wire protocol is not currently documented. To use it you must use the client library provided. This is likely to change in a future release. -Registering Classes With RPC Kryo +Registering classes with RPC Kryo --------------------------------- In the present implementation of the node we use Kryo to generate the *on the wire* representation of contracts states diff --git a/docs/source/contract-catalogue.rst b/docs/source/contract-catalogue.rst index db52a161a2..0fb23add43 100644 --- a/docs/source/contract-catalogue.rst +++ b/docs/source/contract-catalogue.rst @@ -29,7 +29,7 @@ Commodity The ``Commodity`` contract is an early stage example of a non-currency contract whose states implement the ``FungibleAsset`` interface. This is used as a proof of concept for non-cash obligations. -Commercial Paper +Commercial paper ---------------- ``CommercialPaper`` is a very simple obligation to pay an amount of cash at some future point in time (the maturity @@ -38,7 +38,7 @@ and redeeming (settling) states. Unlike the full obligation contract it does not be settled if the obligor defaults on payment, or netting of state objects. All commands are exclusive of the other commercial paper commands. Use the ``Obligation`` contract for more advanced functionality. -Interest Rate Swap +Interest rate swap ------------------ The Interest Rate Swap (IRS) contract is a bilateral contract to implement a vanilla fixed / floating same currency diff --git a/docs/source/contract-irs.rst b/docs/source/contract-irs.rst index dbec7e166b..5aec1c9c57 100644 --- a/docs/source/contract-irs.rst +++ b/docs/source/contract-irs.rst @@ -1,4 +1,4 @@ -Interest Rate Swaps +Interest rate swaps =================== @@ -68,7 +68,7 @@ event. Currently, there are no matured, termination or dispute operations. -Technical Details +Technical details ----------------- The contract itself comprises of 4 data state classes, ``FixedLeg``, ``FloatingLeg``, ``Common`` and ``Calculation``. diff --git a/docs/source/corda-configuration-files.rst b/docs/source/corda-configuration-file.rst similarity index 96% rename from docs/source/corda-configuration-files.rst rename to docs/source/corda-configuration-file.rst index dde866278c..25d364e539 100644 --- a/docs/source/corda-configuration-files.rst +++ b/docs/source/corda-configuration-file.rst @@ -1,8 +1,8 @@ -The Corda Configuration File +The Corda configuration file ============================ -Configuration File Location ---------------------------- +Location +-------- The Corda all-in-one ``corda.jar`` file is generated by the ``gradle buildCordaJAR`` task and defaults to reading configuration from a ``node.conf`` file in the present working directory. This behaviour can be overidden using the ``--config-file`` command line option to target configuration files with different names, or different file location (relative paths are relative to the current working directory). @@ -12,14 +12,14 @@ The configuration file templates used for the ``gradle deployNodes`` task are to the built in resource file ``/node/src/main/resources/reference.conf`` of the ``:node`` gradle module. All properties in this can be overidden in the file configuration and for rarely changed properties this defaulting allows the property to be excluded from the configuration file. -Configuration File Format -------------------------- +Format +------ Corda uses the Typesafe configuration library to parse the configuration see the `typesafe config on Github `_ the format of the configuration files can be simple JSON, but for the more powerful substitution features uses HOCON format see `HOCON documents `_ -Configuration File Examples ---------------------------- +Examples +-------- General node configuration file for hosting the IRSDemo services. @@ -43,8 +43,8 @@ NetworkMapService plus Simple Notary configuration file. // Certificate signing service will be hosted by R3 in the near future. //certificateSigningService = "https://testnet.certificate.corda.net" -Configuration File Fields -------------------------- +Fields +------ :basedir: This specifies the node workspace folder either as an absolute path, or relative to the current working directory. It can be overidden by the ``--base-directory`` command line option, in which case the the value in the file is ignored and a ``node.conf`` file is expected in that workspace directory as the configuration source. diff --git a/docs/source/corda-plugins.rst b/docs/source/corda-plugins.rst index bddc9cce4b..92e200f63c 100644 --- a/docs/source/corda-plugins.rst +++ b/docs/source/corda-plugins.rst @@ -1,4 +1,4 @@ -The Corda Plugin Framework +The Corda plugin framework ========================== The intention is that Corda is a common platform, which will be extended diff --git a/docs/source/creating-a-cordapp.rst b/docs/source/creating-a-cordapp.rst index 1b49f77fa1..9f2d279382 100644 --- a/docs/source/creating-a-cordapp.rst +++ b/docs/source/creating-a-cordapp.rst @@ -1,10 +1,10 @@ -Creating a Cordapp +Creating a CorDapp ================== A Cordapp is an application that runs on the Corda platform using the platform APIs and plugin system. They are self contained in separate JARs from the node server JAR that are created and distributed. -App Plugins +App plugins ----------- .. note:: Currently apps are only supported for JVM languages. @@ -27,7 +27,7 @@ message handlers and more. The service does not run in a separate thread, so the construction, where message handlers should be registered and threads started. -Starting Nodes +Starting nodes -------------- To use an app you must also have a node server. To create a node server run the ``gradle deployNodes`` task. @@ -46,7 +46,7 @@ using ``--base-directory=``. temporary folder. It is therefore suggested that the CAPSULE_CACHE_DIR environment variable be set before starting the process to control this location. -Installing Apps +Installing apps --------------- Once you have created your app JAR you can install it to a node by adding it to ``/plugins/``. In this @@ -54,7 +54,7 @@ case the ``node_dir`` is the location where your node server's JAR and configura .. note:: If the directory does not exist you can create it manually. -Starting your Node +Starting your node ------------------ Now you have a node server with your app installed, you can run it by navigating to ```` and running @@ -71,7 +71,7 @@ The configuration file and workspace paths can be overidden on the command line Otherwise the workspace folder for the node is created based upon the ``basedir`` property in the ``node.conf`` file and if this is relative it is applied relative to the current working path. -Debugging your Node +Debugging your node ------------------- To enable remote debugging of the corda process use a command line such as: @@ -80,7 +80,7 @@ To enable remote debugging of the corda process use a command line such as: This command line will start the debugger on port 5005 and pause the process awaiting debugger attachment. -Viewing persisted state of your Node +Viewing persisted state of your node ------------------------------------ To make examining the persisted contract states of your node or the internal node database tables easier, and providing you are @@ -96,7 +96,7 @@ at the present time, and should certainly be treated as read-only. .. _ServiceHubInternal: api/net.corda.node.services.api/-service-hub-internal/index.html .. _ServiceHub: api/net.corda.node.services.api/-service-hub/index.html -Building Against Corda +Building against Corda ---------------------- .. warning:: This feature is subject to rapid change @@ -111,13 +111,13 @@ root directory of Corda This will publish corda-$version.jar, finance-$version.jar, core-$version.jar and node-$version.jar to the group net.corda. You can now depend on these as you normally would a Maven dependency. -Gradle Plugins for Cordapps +Gradle plugins for CorDapps =========================== There are several Gradle plugins that reduce your build.gradle boilerplate and make development of Cordapps easier. The available plugins are in the gradle-plugins directory of the Corda repository. -Building Gradle Plugins +Building Gradle plugins ----------------------- To install to your local Maven repository the plugins that Cordapp gradle files require, run the following from the @@ -129,7 +129,7 @@ root of the Corda project: The plugins will now be installed to your local Maven repository in ~/.m2 on Unix and %HOMEPATH%\.m2 on Windows. -Using Gradle Plugins +Using Gradle plugins -------------------- To use the plugins, if you are not already using the Cordapp template project, you must modify your build.gradle. Add diff --git a/docs/source/getting-set-up.rst b/docs/source/getting-set-up.rst index d192cb4743..2faa6f160e 100644 --- a/docs/source/getting-set-up.rst +++ b/docs/source/getting-set-up.rst @@ -29,7 +29,7 @@ if you would like to start getting to grips with the Kotlin language, then we st of the tutorials (known as "koans") as well. Also see our :doc:`further-notes-on-kotlin`. -Version Control via Git +Version control via Git ----------------------- We use git to version control Corda. The authorative place to obtain git is from the main `git website `_ @@ -52,7 +52,7 @@ on the gradle tab (generally found on the right hand side), or by following the are performing (details expounded later). Whenever prompted about gradle, accept the defaults suggested by IntelliJ. -Corda Source Code +Corda source code ----------------- You can check out the Corda platform source code from this repository: diff --git a/docs/source/index.rst b/docs/source/index.rst index 3a789907bd..13cbaea05a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -48,7 +48,7 @@ Read on to learn: messaging persistence node-administration - corda-configuration-files + corda-configuration-file corda-plugins node-services node-explorer diff --git a/docs/source/initial-margin-agreement.rst b/docs/source/initial-margin-agreement.rst index 04060b62d1..964206d729 100644 --- a/docs/source/initial-margin-agreement.rst +++ b/docs/source/initial-margin-agreement.rst @@ -1,10 +1,10 @@ -Initial Margin Agreements +Initial margin agreements ========================= This app is a demonstration of how Corda can be used for the real world requirement of initial margin calculation and agreement; featuring the integration of complex and industry proven third party libraries into Corda nodes. -SIMM Introduction +SIMM introduction ----------------- SIMM is an acronym for "Standard Initial Margin Model". It is effectively the calculation of a "margin" that is paid diff --git a/docs/source/merkle-trees.rst b/docs/source/merkle-trees.rst index f8f7b5f5b9..508ab9a570 100644 --- a/docs/source/merkle-trees.rst +++ b/docs/source/merkle-trees.rst @@ -1,5 +1,5 @@ -Transaction Tear-offs -====================== +Transaction tear-offs +===================== One of the basic data structures in our platform is a transaction. It can be passed around to be signed and verified, also by third parties. The construction of transactions assumes that they form a whole entity with input and output states, @@ -13,7 +13,7 @@ Merkle trees are widely used in peer-to-peer networks, blockchain systems and gi You can read more on the concept `here `_. Merkle trees in Corda ----------------------- +--------------------- Transactions are split into leaves, each of them contains either input, output, command or attachment. Other fields like timestamp or signers are not used in the calculation. @@ -44,7 +44,7 @@ Tree, dotted ones are not included. Having the command that should be in a red n root of this tree and compare it with original transaction identifier - we have a proof that this command belongs to this transaction. Example of usage ------------------ +---------------- Let’s focus on a code example. We want to construct a transaction with commands containing interest rate fix data as in: :doc:`oracles`. diff --git a/docs/source/node-explorer.rst b/docs/source/node-explorer.rst index b9152c9d6a..6e0420ae1e 100644 --- a/docs/source/node-explorer.rst +++ b/docs/source/node-explorer.rst @@ -15,7 +15,7 @@ Running the UI ./gradlew tools:explorer:run -Running Demo Nodes +Running demo nodes ------------------ **Windows**:: diff --git a/docs/source/node-services.rst b/docs/source/node-services.rst index cd893d7450..2a8a1ac3d1 100644 --- a/docs/source/node-services.rst +++ b/docs/source/node-services.rst @@ -1,5 +1,5 @@ -A Brief Introduction To The Node Services -========================================= +Brief introduction to the node services +======================================= This document is intended as a very brief introduction to the current service components inside the node. Whilst not at all exhaustive it is @@ -7,7 +7,7 @@ hoped that this will give some context when writing applications and code that use these services, or which are operated upon by the internal components of Corda. -Services Within The Node +Services within the node ------------------------ The node services represent the various sub functions of the Corda node. @@ -41,7 +41,7 @@ to allow unit testing of flows and service functions. The roles of the individual services are described below. -Key Management and Identity Services +Key management and identity services ------------------------------------ InMemoryIdentityService @@ -81,7 +81,7 @@ is a simple implementation of the ``KeyManagementService`` that is used to track our ``KeyPairs`` for use in unit testing when no database is available. -Messaging and Network Management Services +Messaging and network management services ----------------------------------------- ArtemisMessagingServer @@ -167,7 +167,7 @@ The ``NetworkMapService`` should not be used by any flows, or contracts. Instead they should access the NetworkMapCache service to access this data. -Storage and Persistence Related Services +Storage and persistence related services ---------------------------------------- StorageServiceImpl @@ -219,7 +219,7 @@ inside the attachments subfolder of the node workspace. The service is also interfaced to by the web server, which allows files to be uploaded via an HTTP post request. -Flow Framework And Event Scheduling Services +Flow framework and event scheduling services -------------------------------------------- StateMachineManager @@ -280,7 +280,7 @@ occurs in all nodes holding the state in their Vault, it may therefore be required for the flow to exit early if the current node is not the intended initiator. -Notary Flow Implementation Services +Notary flow implementation services ----------------------------------- PersistentUniquenessProvider, InMemoryUniquenessProvider and RaftUniquenessProvider @@ -317,7 +317,7 @@ against a cluster of nodes running shared consensus state across the RAFT protocol (note this requires the additional configuration of the ``notaryClusterAddresses`` property). -Vault Related Services +Vault related services ---------------------- NodeVaultService diff --git a/docs/source/permissioning.rst b/docs/source/permissioning.rst index e9fe5d487d..ca48770d7a 100644 --- a/docs/source/permissioning.rst +++ b/docs/source/permissioning.rst @@ -1,4 +1,4 @@ -Network Permissioning +Network permissioning ===================== The keystore located in ``/certificates/sslkeystore.jks`` is required to connect to the Corda network securely. @@ -9,7 +9,7 @@ However this is not secure for the real network. This documentation will explain .. warning:: The TestNet has not been setup yet as of Milestone 6 release. You will not be able to connect to the certificate signing server. -Certificate Signing Request Utility +Certificate signing request utility ----------------------------------- The utility creates certificate signing request based on node information obtained from the node configuration. @@ -32,7 +32,7 @@ Once the request has been approved and the certificates downloaded from the serv This process only needs to be done once when the node connects to the network for the first time, or when the certificate expires. -Building the Utility +Building the utility -------------------- The utility will be created as part of the main build ``buildCordaJAR``. You can also build the utility JAR by run the following command from the Corda project root directory. @@ -48,7 +48,7 @@ You can also build the utility JAR by run the following command from the Corda p The utility JAR will be created in ``/build/libs/certSigningRequestUtility.jar`` -Running the Utility +Running the utility ------------------- You will need to specify the working directory of your Corda node using ``--base-dir`` flag. This is defaulted to current directory if left blank. diff --git a/docs/source/persistence.rst b/docs/source/persistence.rst index 620ac4651d..f1b18815e2 100644 --- a/docs/source/persistence.rst +++ b/docs/source/persistence.rst @@ -68,7 +68,7 @@ which allow the configuration of a database schema or table name prefixes to avo This will change in due course. Similarly, it does not currently support configuring ``SchemaOptions`` but will do so in the future. -Object Relational Mapping +Object relational mapping ------------------------- The persisted representation of a ``QueryableState`` should be an instance of a ``PersistentState`` subclass, constructed diff --git a/docs/source/running-the-demos.rst b/docs/source/running-the-demos.rst index 70c9337cf7..b7513c3d37 100644 --- a/docs/source/running-the-demos.rst +++ b/docs/source/running-the-demos.rst @@ -104,7 +104,7 @@ Or you can run them from inside IntelliJ, but when done this way, all the node o In the "Attachment Demo: Run Nodes" window you should see some log lines scroll past, and within a few seconds the message "File received - we're happy!" should be printed. -SIMM and Portfolio Demo +SIMM and Portfolio demo ----------------------- .. note:: Read more about this demo at :doc:`initial-margin-agreement`. diff --git a/docs/source/tutorial-clientrpc-api.rst b/docs/source/tutorial-clientrpc-api.rst index 58e3a2fdb7..67ef519769 100644 --- a/docs/source/tutorial-clientrpc-api.rst +++ b/docs/source/tutorial-clientrpc-api.rst @@ -1,6 +1,6 @@ .. _graphstream: http://graphstream-project.org/ -Client RPC API Tutorial +Client RPC API tutorial ======================= In this tutorial we will build a simple command line utility that @@ -82,7 +82,7 @@ Now let's try to visualise the transaction graph. We will use a graph drawing li If we run the client with ``Visualise`` we should see a simple random graph being drawn as new transactions are being created. -Registering classes from your Cordapp with RPC Kryo +Registering classes from your CorDapp with RPC Kryo --------------------------------------------------- As described in :doc:`clientrpc`, you currently have to register any additional classes you add that are needed in RPC diff --git a/docs/source/tutorial-contract-clauses.rst b/docs/source/tutorial-contract-clauses.rst index 895ff0d964..9b4b24438a 100644 --- a/docs/source/tutorial-contract-clauses.rst +++ b/docs/source/tutorial-contract-clauses.rst @@ -134,7 +134,7 @@ The ``Move`` clause for the commercial paper contract is relatively simple, so w } } -Group Clause +Group clause ------------ We need to wrap the move clause (as well as the issue and redeem clauses - see the relevant contract code for their