From 2737e9a9e4bef2917f7677f93305ba7d813491f6 Mon Sep 17 00:00:00 2001 From: "rick.parker" Date: Mon, 28 Nov 2016 11:58:43 +0000 Subject: [PATCH] Simulator docs update --- docs/source/flow-testing.rst | 2 +- docs/source/network-simulator.rst | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/source/flow-testing.rst b/docs/source/flow-testing.rst index 010d83c886..30dd4a1e6f 100644 --- a/docs/source/flow-testing.rst +++ b/docs/source/flow-testing.rst @@ -80,4 +80,4 @@ valid) inside a ``databaseTransaction``. All node flows run within a database t but any time we need to use the database directly from a unit test, you need to provide a database transaction as shown here. -And that's it: you can explore the documentation for the `MockNode API `_ here. +And that's it: you can explore the documentation for the `MockNetwork API `_ here. diff --git a/docs/source/network-simulator.rst b/docs/source/network-simulator.rst index a6542c3a48..120c5d6a98 100644 --- a/docs/source/network-simulator.rst +++ b/docs/source/network-simulator.rst @@ -17,6 +17,26 @@ You can produce a standalone JAR of the tool by using the ``:samples:network-vis and then using the ``samples/network-visualiser/build/libs/network-visualiser-*-capsule.jar`` file, where * is whatever the current Corda version is. +What it is and is not +--------------------- + +The simulator currenty exists as an illustrative tool to help with explaining how Corda works in an example scenario. +It utilises the ``Simulator`` tools that support creating a simulated Corda network and the nodes running in it within +a single JVM, as an extension of the ``MockNetwork`` testing framework. See more about the ``MockNetwork`` and +testing flows here: :doc:`flow-testing`. + +Whilst it is not yet fully generic or full featured, the intention is for the simulator to mature into the following, +which it presently cannot do without writing more code: + +1. A tool for visualising new CorDapps and their flows to help with debugging, presentations, explanations and tutorials, + but still running as a simulation in a single JVM. +2. A tool to visualise the activity on a real Corda network deployment, with activity streams being fed from each node + running in its own JVM, most likely on remote hosts. + +Both of these scenarios would be fed by the standard observables in the RPC framework, rather than the local binding +that the simulator uses currently. The ability to step through a flow one step at a time would obviously be restricted +to single JVM simulations. + Interface ---------