diff --git a/docs/source/node-explorer.rst b/docs/source/node-explorer.rst index 18141dc460..4500a756c3 100644 --- a/docs/source/node-explorer.rst +++ b/docs/source/node-explorer.rst @@ -34,18 +34,18 @@ Running Demo Nodes 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. + 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``. - + Username and password can be configured via ``rpcUsers`` field 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. +Dashboard + The dashboard 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 @@ -56,6 +56,13 @@ Cash .. image:: resources/explorer/vault.png +New cash transaction + This is where you can create new cash transaction. + The user can choose from three transaction types (issue, pay 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 + 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, @@ -63,9 +70,16 @@ Transactions .. 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. +Network + The network view shows the network information on the world map. Currently only user's node is rendered on the map, this will be extended to other peers in future release. + The map provides a intuitive way of visualizing the Corda network and the participants. -.. image:: resources/explorer/newTransaction.png +.. image:: resources/explorer/network.png + + +Settings + User can configure the client preference in this view. +.. note:: Although the reporting currency is configurable, FX conversion won't be applied to the values as we don't have a FX service yet. + + +.. image:: resources/explorer/settings.png diff --git a/docs/source/resources/explorer/dashboard.png b/docs/source/resources/explorer/dashboard.png index 12e28f8cd0..8a7e801a92 100644 Binary files a/docs/source/resources/explorer/dashboard.png 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 index a2779c3e13..6f08bdb285 100644 Binary files a/docs/source/resources/explorer/login.png and b/docs/source/resources/explorer/login.png differ diff --git a/docs/source/resources/explorer/network.png b/docs/source/resources/explorer/network.png new file mode 100644 index 0000000000..f72e90e985 Binary files /dev/null and b/docs/source/resources/explorer/network.png differ diff --git a/docs/source/resources/explorer/newTransaction.png b/docs/source/resources/explorer/newTransaction.png index b01da505f9..166dea4a31 100644 Binary files a/docs/source/resources/explorer/newTransaction.png and b/docs/source/resources/explorer/newTransaction.png differ diff --git a/docs/source/resources/explorer/settings.png b/docs/source/resources/explorer/settings.png new file mode 100644 index 0000000000..6cdf15e631 Binary files /dev/null and b/docs/source/resources/explorer/settings.png differ diff --git a/docs/source/resources/explorer/transactionView.png b/docs/source/resources/explorer/transactionView.png index 2fbbdf2a6f..3ca439d6e0 100644 Binary files a/docs/source/resources/explorer/transactionView.png 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 index 7909d92d3b..d0f7210e02 100644 Binary files a/docs/source/resources/explorer/vault.png and b/docs/source/resources/explorer/vault.png differ diff --git a/tools/explorer/README.md b/tools/explorer/README.md new file mode 100644 index 0000000000..e87c9f61e8 --- /dev/null +++ b/tools/explorer/README.md @@ -0,0 +1,44 @@ +#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 + +#####These Corda nodes will be created on the following port on localhost. + + Notary -> 20002 + Alice -> 20004 + Bob -> 20006 + Bank of Corda -> 20008 + + +##TODOs: +- Shows more useful information in the dashboard. +- Improve Network View, display other nodes in the world map and show transactions between them. +- Add a new view showing node's state machines. +- Link transaction input to its originated transaction to make it easier to trace back. +- Shows Node information (Configuration, properties etc.) in Settings view. +- Support other contract types. + + +More information can be found in the [Project website](https://corda.net) and [Documentation](https://docs.corda.net). \ No newline at end of file