corda/docs/source/demobench.rst

DemoBench

DemoBench is a standalone desktop application that makes it easy to configure and launch local Corda nodes. It is useful for training sessions, demos or just experimentation.

Downloading

Installers compatible with the latest Corda release can be downloaded from the Corda website.

Running DemoBench

Configuring a Node

Each node must have a unique name to identify it to the network map service. DemoBench will suggest node names, nearest cities and local port numbers to use.

The first node will host the network map service, and we are forcing that node also to be a notary. Hence only notary services will be available to be selected in the Services list. For subsequent nodes you may also select any of Corda's other built-in services.

Press the Start node button to launch the Corda node with your configuration.

Running Nodes

DemoBench launches each new node in a terminal emulator. The View Database, Launch Explorer and Launch Web Server buttons will all be disabled until the node has finished booting. DemoBench will then display simple statistics about the node such as its cash balance.

It is currently impossible from DemoBench to restart a node that has terminated, e.g. because the user typed "bye" at the node's shell prompt. However, that node's data and logs still remain in its directory.

Exiting DemoBench

When you terminate DemoBench, it will automatically shut down any nodes and explorers that it has launched and then exit.

Profiles

You can save the configurations and CorDapps for all of DemoBench's currently running nodes into a profile, which is a ZIP file with the following layout, e.g.:

notary/

node.conf cordapps/

banka/

node.conf cordapps/

bankb/

node.conf cordapps/ example-cordapp.jar

...

DemoBench writes a log file to the following location:

MacOSX/Linux	$HOME/demobench/demobench.log
Windows	%USERPROFILE%\demobench\demobench.log

Building the Installers

Gradle defines tasks that build DemoBench installers using JavaPackager. There are three scripts in the tools/demobench directory to execute these tasks:

1. package-demobench-exe.bat (Windows)
2. package-demobench-dmg.sh (MacOS)
3. package-demobench-rpm.sh (Fedora/Linux)

Each script can only be run on its target platform, and each expects the platform's installation tools already to be available.

1. Windows: Inno Setup 5+
2. MacOS: The packaging tools should be available automatically. The DMG contents will also be signed if the packager finds a valid Developer ID Application certificate with a private key on the keyring. (By default, DemoBench's build.gradle expects the signing key's user name to be "R3CEV".) You can create such a certificate by generating a Certificate Signing Request and then asking your local "Apple team agent" to upload it to the Apple Developer portal. (See here.)

Note

• Please ensure that the /usr/bin/codesign application always has access to your certificate's signing key. You may need to reboot your Mac after making any changes via the MacOS Keychain Access application.
• You should use JDK >= 8u152 to build DemoBench on MacOS because this version resolves a warning message that is printed to the terminal when starting each Corda node.
• Ideally, use the jetbrains-jdk to build the DMG.

You will also need to define the environment variable JAVA_HOME to point to the same JDK that you use to run Gradle. The installer will be written to the tools/demobench/build/javapackage/bundles directory, and can be installed like any other application for your platform.

JetBrains JDK

Mac users should note that the best way to build a DemoBench DMG is with the JetBrains JDK which has binary downloads available from BinTray. This JDK has some useful GUI fixes, most notably, when built with this JDK the DemoBench terminal will support emoji and as such, the nicer coloured ANSI progress renderer. It also resolves some issues with HiDPI rendering on Windows.

This JDK does not include JavaPackager, which means that you will still need to copy $JAVA_HOME/lib/ant-javafx.jar from an Oracle JDK into the corresponding directory within your JetBrains JDK.

Developer Notes

Developers wishing to run DemoBench without building a new installer each time can install it locally using Gradle:

$ gradlew tools:demobench:installDist $ cd tools/demobench/build/install/demobench $ bin/demobench

Unfortunately, DemoBench's $CLASSPATH may be too long for the Windows shell . In which case you can still run DemoBench as follows:

> java -Djava.util.logging.config.class=net.corda.demobench.config.LoggingConfig -jar lib/demobench-$version.jar

While DemoBench can be executed within an IDE, it would be up to the Developer to install all of its runtime dependencies beforehand into their correct locations relative to the value of the user.dir system property (i.e. the current working directory of the JVM):

corda/

corda.jar corda-webserver.jar

explorer/

node-explorer.jar

cordapps/

bank-of-corda.jar