corda/tools/explorer/README.md

# Node Explorer

The node explorer provides views of 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 parties 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

A demonstration Corda network topology is configured with 5 nodes playing the following roles:
1. Notary
2. Issuer nodes (representing two fictional central banks - UK Bank Plc issuer of GBP and USA Bank Corp issuer of USD)
3. Participant nodes (representing two users - Alice and Bob)

The Issuer nodes have the ability to issue, move and exit cash amounts.
The Participant nodes are only able to spend cash (eg. move cash).

**Windows:**

    gradlew.bat tools:explorer:runDemoNodes

**Other:**

    ./gradlew tools:explorer:runDemoNodes

**These Corda nodes will be created on the following port on localhost.**

   * Notary -> 20005            (Does not accept logins)
   * UK Bank Plc -> 20011       (*Issuer node*)
   * USA Bank Corp -> 20008     (*Issuer node*)
   * Alice -> 20017
   * Bob -> 20014

Explorer login credentials to the Issuer nodes are defaulted to ``manager`` and ``test``.
Explorer login credentials to the Participants nodes are defaulted to ``user1`` and ``test``.
Please note you are not allowed to login to the notary.

## 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).
address PR comments 2016-11-23 09:57:28 +00:00			`# Node Explorer`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
Bank of Corda integration with Trader Demo and Explorer Initial conversion of Explorer to use IssuerFlow (from BankOfCorda) Initial conversion of TraderDemo to use IssuerFlow (from BankOfCorda) Updated TraderDemo to use IssuerFlow (from BankOfCorda) Fixed TraderDemo integration text (added new BankOfCorda node) Updated Explorer with changes IssuerRequest params Explorer now correctly displaying transaction id upon Issue. Moved IssuerFlow into finance package so can be reused across multiple demos (TraderDemo) and applications (eg Explorer) Refactored BankOfCorda demo to use Finance package and TestUtil constants Updated TraderDemo to use IssuerFlow Updated Explorer to use finance package IssuerFlow. Advertised BankOfCorda as Issuer for usage by Explorer. Explorer no longer depends on BankOfCorda demo since IssuerFlow promoted to Finance module Added IssuerFlow to AbstractNode whitelist. Explicit declarations of IssuerFlow no longer required. Added plugin registration of IssuerFlow at bootstrap. Revert whitelisting of IssuerFlow (plugin configured) Refactored to use constant BOC definition. Added gradle RPC security config. Updated documentation Fixed incorrect references. Renamed Issuer banks. Added new permission set (for Issuer nodes) Added node nearestCity info Added new Issuer Event Generator for Issuer nodes only Associated currency with issuer using ServiceType naming structure. Added argument flag (-S) to trigger event generator simulation node. Fixed problem with issuers not resolving from network map. Updated perms on Issuer rpc proxy nodes. Fixed minor in cash generateExit identified by Explorer. Changes applied in prep for AWG demo. Added IntelliJ run-configurations for launching Explorer demo nodes (with and without simulation) Updated documentation (and added additional gradle task to launch Explorer nodes in simulation mode). Fix following rebase. Addressed review items from PR. Updated TraderDemo readme. Updated TraderDemo gradle file to launch Bank of Corda node. Updated JRE properties. Updated IssuerModel to incorporate correct JFX Observable handling. Fixed bug with Exit command not displaying any currency. Added TODO's for revisiting correct Exception handling strategy. Optimization for when issuing cash to self. Minor updates following PR review. Remove old refs to Royal Mint and Federal Reserve 2016-12-06 16:16:47 +00:00			`The node explorer provides views of the node's vault and transaction data using Corda's RPC framework.`
address PR comments 2016-11-23 09:57:28 +00:00			`The user can execute cash transaction commands to issue and move cash to other parties on the network or exit cash using the user interface.`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
address PR comments 2016-11-23 09:57:28 +00:00			`## Running the UI`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
address PR comments 2016-11-23 09:57:28 +00:00			`Windows:`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
			`gradlew.bat tools:explorer:run`

address PR comments 2016-11-23 09:57:28 +00:00			`Other:`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
			`./gradlew tools:explorer:run`


address PR comments 2016-11-23 09:57:28 +00:00			`## Running Demo Nodes`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
Bank of Corda integration with Trader Demo and Explorer Initial conversion of Explorer to use IssuerFlow (from BankOfCorda) Initial conversion of TraderDemo to use IssuerFlow (from BankOfCorda) Updated TraderDemo to use IssuerFlow (from BankOfCorda) Fixed TraderDemo integration text (added new BankOfCorda node) Updated Explorer with changes IssuerRequest params Explorer now correctly displaying transaction id upon Issue. Moved IssuerFlow into finance package so can be reused across multiple demos (TraderDemo) and applications (eg Explorer) Refactored BankOfCorda demo to use Finance package and TestUtil constants Updated TraderDemo to use IssuerFlow Updated Explorer to use finance package IssuerFlow. Advertised BankOfCorda as Issuer for usage by Explorer. Explorer no longer depends on BankOfCorda demo since IssuerFlow promoted to Finance module Added IssuerFlow to AbstractNode whitelist. Explicit declarations of IssuerFlow no longer required. Added plugin registration of IssuerFlow at bootstrap. Revert whitelisting of IssuerFlow (plugin configured) Refactored to use constant BOC definition. Added gradle RPC security config. Updated documentation Fixed incorrect references. Renamed Issuer banks. Added new permission set (for Issuer nodes) Added node nearestCity info Added new Issuer Event Generator for Issuer nodes only Associated currency with issuer using ServiceType naming structure. Added argument flag (-S) to trigger event generator simulation node. Fixed problem with issuers not resolving from network map. Updated perms on Issuer rpc proxy nodes. Fixed minor in cash generateExit identified by Explorer. Changes applied in prep for AWG demo. Added IntelliJ run-configurations for launching Explorer demo nodes (with and without simulation) Updated documentation (and added additional gradle task to launch Explorer nodes in simulation mode). Fix following rebase. Addressed review items from PR. Updated TraderDemo readme. Updated TraderDemo gradle file to launch Bank of Corda node. Updated JRE properties. Updated IssuerModel to incorporate correct JFX Observable handling. Fixed bug with Exit command not displaying any currency. Added TODO's for revisiting correct Exception handling strategy. Optimization for when issuing cash to self. Minor updates following PR review. Remove old refs to Royal Mint and Federal Reserve 2016-12-06 16:16:47 +00:00			`A demonstration Corda network topology is configured with 5 nodes playing the following roles:`
			`1. Notary`
			`2. Issuer nodes (representing two fictional central banks - UK Bank Plc issuer of GBP and USA Bank Corp issuer of USD)`
			`3. Participant nodes (representing two users - Alice and Bob)`

			`The Issuer nodes have the ability to issue, move and exit cash amounts.`
			`The Participant nodes are only able to spend cash (eg. move cash).`

address PR comments 2016-11-23 09:57:28 +00:00			`Windows:`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
			`gradlew.bat tools:explorer:runDemoNodes`

address PR comments 2016-11-23 09:57:28 +00:00			`Other:`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
			`./gradlew tools:explorer:runDemoNodes`

address PR comments 2016-11-23 09:57:28 +00:00			`These Corda nodes will be created on the following port on localhost.`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
CORDA-1127 - updated comments to follow current port layout (#2669) 2018-02-28 14:41:08 +00:00			`* Notary -> 20005 (Does not accept logins)`
			`* UK Bank Plc -> 20011 (Issuer node)`
			`* USA Bank Corp -> 20008 (Issuer node)`
			`* Alice -> 20017`
			`* Bob -> 20014`
Bank of Corda integration with Trader Demo and Explorer Initial conversion of Explorer to use IssuerFlow (from BankOfCorda) Initial conversion of TraderDemo to use IssuerFlow (from BankOfCorda) Updated TraderDemo to use IssuerFlow (from BankOfCorda) Fixed TraderDemo integration text (added new BankOfCorda node) Updated Explorer with changes IssuerRequest params Explorer now correctly displaying transaction id upon Issue. Moved IssuerFlow into finance package so can be reused across multiple demos (TraderDemo) and applications (eg Explorer) Refactored BankOfCorda demo to use Finance package and TestUtil constants Updated TraderDemo to use IssuerFlow Updated Explorer to use finance package IssuerFlow. Advertised BankOfCorda as Issuer for usage by Explorer. Explorer no longer depends on BankOfCorda demo since IssuerFlow promoted to Finance module Added IssuerFlow to AbstractNode whitelist. Explicit declarations of IssuerFlow no longer required. Added plugin registration of IssuerFlow at bootstrap. Revert whitelisting of IssuerFlow (plugin configured) Refactored to use constant BOC definition. Added gradle RPC security config. Updated documentation Fixed incorrect references. Renamed Issuer banks. Added new permission set (for Issuer nodes) Added node nearestCity info Added new Issuer Event Generator for Issuer nodes only Associated currency with issuer using ServiceType naming structure. Added argument flag (-S) to trigger event generator simulation node. Fixed problem with issuers not resolving from network map. Updated perms on Issuer rpc proxy nodes. Fixed minor in cash generateExit identified by Explorer. Changes applied in prep for AWG demo. Added IntelliJ run-configurations for launching Explorer demo nodes (with and without simulation) Updated documentation (and added additional gradle task to launch Explorer nodes in simulation mode). Fix following rebase. Addressed review items from PR. Updated TraderDemo readme. Updated TraderDemo gradle file to launch Bank of Corda node. Updated JRE properties. Updated IssuerModel to incorporate correct JFX Observable handling. Fixed bug with Exit command not displaying any currency. Added TODO's for revisiting correct Exception handling strategy. Optimization for when issuing cash to self. Minor updates following PR review. Remove old refs to Royal Mint and Federal Reserve 2016-12-06 16:16:47 +00:00
Update port numbers in explorer docs 2017-03-20 16:25:45 +00:00			Explorer login credentials to the Issuer nodes are defaulted to ``manager`` and ``test``.
			Explorer login credentials to the Participants nodes are defaulted to ``user1`` and ``test``.
			`Please note you are not allowed to login to the notary.`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00
address PR comments 2016-11-23 09:57:28 +00:00			`## TODOs:`
Readme.md, description for new screens, and updated screenshots 2016-11-22 11:56:15 +00:00			`- 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.`


Update port numbers in explorer docs 2017-03-20 16:25:45 +00:00			`More information can be found in the [Project website](https://corda.net) and [Documentation](https://docs.corda.net).`