mirror of https://github.com/corda/corda.git synced 2024-12-19 04:57:58 +00:00

History

Chris Rankin 9e43df36d3 Refactor :client module into :client:javafx and :client:mock (#388 ) * CORDA-304: Refactor :client modules into :client:javafx and :client:mock. * CORDA-304: Add :client:mock to Dokka tasks, and remove unused integrationTest task. * CORDA-304: Migrate DriverBasedTest from node into test-utils. * CORDA-304: Rename .fx. package to .jfx. to prevent confusion with "exchange rate". * CORDA-304: Rename module to ':client:jfx'.		2017-03-21 19:45:12 +00:00
..
src	Clean up messaging/RPC port configuration and docs (#296 )	2017-03-17 10:32:14 +00:00
build.gradle	Refactor :client module into :client:javafx and :client:mock (#388 )	2017-03-21 19:45:12 +00:00
README.md	Split CashFlow into three flows	2017-02-09 15:43:48 +00:00

README.md

Bank of Corda demo

Please see docs/build/html/running-the-demos.html

This program simulates the role of an asset issuing authority (eg. central bank for cash) by accepting requests from third parties to issue some quantity of an asset and transfer that ownership to the requester. The issuing authority accepts requests via the [IssuerFlow] flow, self-issues the asset and transfers ownership to the issue requester. Notarisation and signing form part of the flow.

The requesting party can be a CorDapp (running locally or remotely to the Bank of Corda node), a remote RPC client or a Web Client.

Prerequisites

You will need to have JDK 8 installed and available on your path.

Getting Started

Launch the Bank of Corda node (and associated Notary) by running: [BankOfCordaDriver] --role ISSUER (to validate your Node is running you can try navigating to this sample link: http://localhost:10005/api/bank/date)

Each of the following commands will launch a separate Node called Big Corporation which will become the owner of some Cash following an issue request:

Run the Bank of Corda Client driver (to simulate a web issue requester) by running: [BankOfCordaDriver] --role ISSUE_CASH_WEB This demonstrates a remote application acting on behalf of the Big Corporation and communicating directly with the Bank of Corda node via HTTP to request issuance of some cash.
Run the Bank of Corda Client driver (to simulate an RPC issue requester) by running: [BankOfCordaDriver] --role ISSUE_CASH_RPC Similar to 3 above, but using RPC as the remote communications mechanism.

Developer notes

Testing of the Bank of Corda application is demonstrated at two levels:

Unit testing the flow uses the [LedgerDSL] and [MockServices]. Please see [IssuerFlowTest] The IssuerFlow is one of several reusable flows defined in the finance package.
Integration testing via RPC and HTTP uses the [Driver] DSL to launch standalone node instances

Security The RPC API requires a client to pass in user credentials: client.start("bankUser","test") which are validated on the Bank of Corda node against those configured at node startup: User("bankUser", "test", permissions = setOf(startFlowPermission<IssuerFlow.IssuanceRequester>())) startNode("BankOfCorda", rpcUsers = listOf(user))

Notary We are using a [SimpleNotaryService] in this example, but could easily switch to a [ValidatingNotaryService]

Integration with other Demos and Tools

The Bank of Corda issuer node concept has been integrated into the Explorer tool (simulation nodes) and Trader Demo.