ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-05-31 22:50:53 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merged in parkri-visualiser-docs (pull request #564)

Browse Source 
Simulator docs update
This commit is contained in:
Rick Parker 2016-11-28 18:20:36 +00:00
commit a666bbcc06
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/flow-testing.rst
View File

@ -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 but any time we need to use the database directly from a unit test, you need to provide a database transaction as shown
here. here.
And that's it: you can explore the documentation for the `MockNode API <api/net.corda.node.internal.testing/-mock-network/index.html>`_ here. And that's it: you can explore the documentation for the `MockNetwork API <api/net.corda.testing.node/-mock-network/index.html>`_ here.

20
docs/source/network-simulator.rst
View File

@ -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 and then using the ``samples/network-visualiser/build/libs/network-visualiser-*-capsule.jar`` file, where * is
whatever the current Corda version 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 Interface
--------- ---------