diff --git a/docs/source/index.rst b/docs/source/index.rst index 7be3fbd3b7..4ecd19f002 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -75,5 +75,6 @@ Read on to learn: release-process release-notes network-simulator + node-explorer codestyle building-the-docs diff --git a/docs/source/node-explorer.rst b/docs/source/node-explorer.rst new file mode 100644 index 0000000000..2aa1e44375 --- /dev/null +++ b/docs/source/node-explorer.rst @@ -0,0 +1,70 @@ +Node Explorer +============= + +The node explorer provide views to the node's vault and transaction data using Corda's RPC framework. +The user can execute cash transaction commands to issue and move cash to other party on the network or exit cash using the user interface. + +Running the UI +-------------- +**Windows**:: + + gradlew.bat tools:explorer:run + +**Other**:: + + ./gradlew tools:explorer:run + + +Running Demo Nodes +------------------ +**Windows**:: + + gradlew.bat tools:explorer:runDemoNodes + +**Other**:: + + ./gradlew tools:explorer:runDemoNodes + +.. note:: 3 Corda nodes will be created on the following port on localhost by default. + + * Notary -> 20002 + * Alice -> 20004 + * Bob -> 20006 + +Interface +--------- +Login + User can login to any Corda node using the explorer, alternately, `gradlew explorer:runDemoNodes` can be used to start up demo nodes for testing. + Corda node address, username and password are required for login, the address is defaulted to localhost:0 if leave blank. + Username and password can be configured in node's configuration file; for demo nodes, it is defaulted to ``user1`` and ``test``. +.. note:: If you are connecting to the demo nodes, only Alice and Bob (20004, 20006) are accessible using user1 credential, you won't be able to connect to the notary. + +.. image:: resources/explorer/login.png + :scale: 50 % + :align: center + +Home + Home view shows the top level state of node and vault; currently, it shows your cash balance and the numbers of transaction executed. + The dashboard is intended to house widgets from different CordApp's and provide useful information to system admin at a glance. + +.. image:: resources/explorer/dashboard.png + +Cash + The cash view shows all currencies you currently own in a tree table format, it is grouped by issuer -> currency. + Individual cash transactions can be viewed by clicking on the table row. The user can also use the search field to narrow down the scope. + +.. image:: resources/explorer/vault.png + +Transactions + The transaction view contains all transactions handled by the node in a table view. It shows basic information on the table e.g. Transaction ID, + command type, USD equivalence value etc. User can expand the row by double clicking to view the inputs, + outputs and the signatures details for that transaction. + +.. image:: resources/explorer/transactionView.png + +New Transaction + This is where you can create new transaction; currently only the cash contract is supported. + The user can choose from three transaction types (issue, move and exit) and any party visible on the network. + The result of the transaction will be visible in the transaction screen when executed. + +.. image:: resources/explorer/newTransaction.png diff --git a/docs/source/resources/explorer/dashboard.png b/docs/source/resources/explorer/dashboard.png new file mode 100644 index 0000000000..12e28f8cd0 Binary files /dev/null and b/docs/source/resources/explorer/dashboard.png differ diff --git a/docs/source/resources/explorer/login.png b/docs/source/resources/explorer/login.png new file mode 100644 index 0000000000..a2779c3e13 Binary files /dev/null and b/docs/source/resources/explorer/login.png differ diff --git a/docs/source/resources/explorer/newTransaction.png b/docs/source/resources/explorer/newTransaction.png new file mode 100644 index 0000000000..b01da505f9 Binary files /dev/null and b/docs/source/resources/explorer/newTransaction.png differ diff --git a/docs/source/resources/explorer/transactionView.png b/docs/source/resources/explorer/transactionView.png new file mode 100644 index 0000000000..2fbbdf2a6f Binary files /dev/null and b/docs/source/resources/explorer/transactionView.png differ diff --git a/docs/source/resources/explorer/vault.png b/docs/source/resources/explorer/vault.png new file mode 100644 index 0000000000..7909d92d3b Binary files /dev/null and b/docs/source/resources/explorer/vault.png differ