corda/tools/demobench
Katarzyna Streich e93327bb6a
CORDA-2351 - Fix Demobench readme (#4624)
* CORDA-2351 - Fix Demobench readme

Remove information that BankOfCorda app is automatically loaded. Add
new up-to-date screenshots and information on how to check issuable
currencies on the node.
2019-01-23 13:45:53 +00:00
..
libs DemoBench: enable emoji in the terminal when built with a JetBrains JRE. 2017-06-06 14:55:09 +02:00
package Fix DemoBench Windows installer (#3451) 2018-06-27 16:45:39 +01:00
src CORDA-2331 Split Workflow and contracts of Finance App into separate Cordapps (#4422) 2018-12-19 18:02:51 +00:00
build.gradle CORDA-2331 Split Workflow and contracts of Finance App into separate Cordapps (#4422) 2018-12-19 18:02:51 +00:00
demobench-configure-bank.png Improve NodeTabView in DemoBench (#1639) 2017-09-28 15:01:08 +01:00
demobench-dashboard.png Document how we should test DemoBench. (#742) 2017-05-25 15:24:18 +01:00
demobench-initial.png CORDA-2351 - Fix Demobench readme (#4624) 2019-01-23 13:45:53 +00:00
demobench-notary.png CORDA-2351 - Fix Demobench readme (#4624) 2019-01-23 13:45:53 +00:00
demobench-save-profile.png Document how we should test DemoBench. (#742) 2017-05-25 15:24:18 +01:00
package-demobench-dmg.sh Update DemoBench packager scripts to fail when packaging fails. (#1023) 2017-07-14 14:53:09 +01:00
package-demobench-exe.bat Fix DemoBench Windows installer (#3451) 2018-06-27 16:45:39 +01:00
package-demobench-rpm.sh Update DemoBench packager scripts to fail when packaging fails. (#1023) 2017-07-14 14:53:09 +01:00
README.md CORDA-2351 - Fix Demobench readme (#4624) 2019-01-23 13:45:53 +00:00

DemoBench

DemoBench is a standalone desktop application that makes it easy to configure and launch local Corda nodes. Its general usage is documented here.

Running locally

MacOSX/Linux:

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

Windows:

gradlew tools:demobench:installDist
cd tools\demobench\build\install\demobench

and then

bin\demobench

or, if Windows complains that the command line is too long:

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

Testing

The Notary Node

When launched, DemoBench will look something like this:

DemoBench at launch

Clicking the Start node button should launch a new Notary node.

Notary node

The tab should display the correct national flag for the node's geographical location. The View Database, Launch Web Server and Launch Explorer buttons will be disabled until the node has finished booting, at which point the node statistics (States in vault, Known transactions and Balance) will become populated too.

The Corda node should boot into a shell with a command prompt. Type help at this command prompt to list the commands available, followed by dashboard.

Dashboard for Notary node

Press q to exit the dashboard, and then check the tab's buttons:

  • Press View Database to launch the H2 database's Web console in your browser. Pressing this button again should launch a second console session.
  • Press the Launch Web Server button to launch the Corda Webserver for this node. Once booted, it should open your browser to a page saying:

Installed CorDaps

No installed custom CorDapps

  • The button's text should now have changed to Reopen web site. Pressing the button again should open a new session in your browser.

  • Press the Launch Explorer button to launch the Node Explorer for this notary. You should be logged into the Explorer automatically. The Launch Explorer button should now remain disabled until you close this node's Explorer again.

The Bank Node

Click the Add Node button, and DemoBench will ask you to configure another node in a new tab. Choose Issuer GBP as additional configuration.

Configure Bank Node

When you type in the shell start CashConfigDataFlow you should get the following result:

Flow completed with result: CashConfiguration(issuableCurrencies=[GBP], supportedCurrencies=[USD, GBP, CHF, EUR])

The CashIssueFlow is enabled for the currencies listed in bank node's finance configuration file (corda-finance.conf), in this instance it's GBP.

Launch the bank's Node Explorer, and check the network view. The Notary node should be displayed in Rome, whereas the Bank of Breakfast Tea should be in Liverpool.

Saving / Loading profiles

Choose File/Save As from DemoBench's main menu.

Save Profile Dialogue

Save the profile and then examine its contents (ZIP format). It should look something like:

  Length      Date    Time    Name
---------  ---------- -----   ----
        0  05-25-2017 11:57   notary/
      490  05-25-2017 11:57   notary/node.conf
        0  05-25-2017 11:57   notary/plugins/
        0  05-25-2017 11:57   bankofbreakfasttea/
      673  05-25-2017 11:57   bankofbreakfasttea/node.conf
        0  05-25-2017 11:57   bankofbreakfasttea/plugins/
---------                     -------
     1163                     6 files

Now choose File/Open from the main menu, and select the profile that you have just saved. DemoBench should close the two existing tabs and then relaunch the Notary and Bank nodes.

If you want to edit the content, please make sure that when zipping content back, the notary node is the first directory (ZIP files content is ordered)

Exiting DemoBench

Close DemoBench as a normal application on your platform; it should close any open Node Explorers before exiting.