ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-19 04:57:58 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Final documentation tweaks for M11 (#632)

Browse Source 
* Update DemoBench documentation after revamp.
* Remove mention of running demos within IntelliJ.
This commit is contained in:
Chris Rankin 2017-05-05 08:30:58 +01:00 committed by GitHub
parent d8fa75654f
commit 606bba590b
3 changed files with 6 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/CLI-vs-IDE.rst
View File

@ -1,7 +1,7 @@
CLI vs IDE CLI vs IDE
========== ==========
We have tried to make every demo, example, tutorial and sample usable via both the command line and the IntelliJ IDE. We have tried to make every example, tutorial and sample usable via both the command line and the IntelliJ IDE.
Most developers will find writing, editing and debugging code more easy with tools such as an IDE. But when a production node Most developers will find writing, editing and debugging code more easy with tools such as an IDE. But when a production node
is deployed, it will be controlled via the command line - no organisation allows their systems to be running via is deployed, it will be controlled via the command line - no organisation allows their systems to be running via
a developer environment. a developer environment.

10
docs/source/demobench.rst
View File

@ -14,18 +14,14 @@ Running DemoBench
----------------- -----------------
Configuring a Node Configuring a Node
Each node must have a unique name to identify it to the network map service. DemoBench will suggest local port numbers to use. Each node must have a unique name to identify it to the network map service. DemoBench will suggest node names, nearest cities and local port numbers to use.
The first node will host the network map service, and we are forcing that node also to be a notary. Hence only notary services will be available to be selected in the ``Services`` list. For subsequent nodes you may also select any of Corda's other built-in services. The first node will host the network map service, and we are forcing that node also to be a notary. Hence only notary services will be available to be selected in the ``Services`` list. For subsequent nodes you may also select any of Corda's other built-in services.
.. note:: Press ``Ctrl``/``Cmd`` and then click with the mouse to select multiple services, and also to deselect a service again. Press the ``Start node`` button to launch the Corda node with your configuration.
..
Press the ``Create Node`` button to launch the Corda node with your configuration.
Running Nodes Running Nodes
DemoBench launches each new node in a terminal emulator. The ``View Database``, ``Launch Explorer`` and ``Launch WebServer`` buttons will all be disabled until the node has finished booting. DemoBench will then display simple statistics about the node such as its cash balance. DemoBench launches each new node in a terminal emulator. The ``View Database``, ``Launch Explorer`` and ``Launch Web Server`` buttons will all be disabled until the node has finished booting. DemoBench will then display simple statistics about the node such as its cash balance.
.. ..

58
docs/source/running-the-demos.rst
View File

@ -13,9 +13,7 @@ The Corda repository contains a number of demo programs demonstrating the functi
6. The Bank of Corda Demo, which shows a node acting as an issuer of assets (the Bank of Corda) while remote client 6. The Bank of Corda Demo, which shows a node acting as an issuer of assets (the Bank of Corda) while remote client
applications request issuance of some cash on behalf of a node called Big Corporation applications request issuance of some cash on behalf of a node called Big Corporation
The demos can be run either from the command line, or from inside IntelliJ. Running from the command line is We recommend running the demos from the command line rather than from IntelliJ. For more details about running via the command line or from within IntelliJ, see :doc:`CLI-vs-IDE`.
recommended if you just want to see the demos run, whereas using IntelliJ can be helpful if you want to debug or
extend the demos. For more details about running via the command line or from within IntelliJ, see :doc:`CLI-vs-IDE`.
If any of the demos don't work, please raise an issue on GitHub. If any of the demos don't work, please raise an issue on GitHub.
@ -47,16 +45,6 @@ To run from the command line in Windows:
4. Run ``gradlew samples:trader-demo:runSeller`` to trigger the transaction. You can see both sides of the 4. Run ``gradlew samples:trader-demo:runSeller`` to trigger the transaction. You can see both sides of the
trade print their progress and final transaction state in the bank node tabs/windows trade print their progress and final transaction state in the bank node tabs/windows
To run from IntelliJ:
1. Open the Corda project in IntelliJ and import the Gradle project
2. Run the ``Trader Demo: Run Nodes`` configuration, which will start four nodes. Once all nodes are started you will see several
"Node started up and registered in ..." messages
3. Run ``Trader Demo: Run Buyer`` to instruct the buyer node to request issuance of some cash from the Bank of Corda node
4. Run ``Trader Demo: Run Seller`` to trigger the transaction
5. In the "Trader Demo: Run Nodes" run configuration window, you should see some log lines scroll past. Within a few seconds, the message
"Purchase complete - we are a happy customer!" should be printed.
.. _irs-demo: .. _irs-demo:
IRS demo IRS demo
@ -92,17 +80,6 @@ To run from the command line in Windows:
see lots of activity as the nodes set up the deal, notarise it, get it signed by the oracle, and so on see lots of activity as the nodes set up the deal, notarise it, get it signed by the oracle, and so on
7. Now run ``install\irs-demo\bin\irs-demo --role Date 2017-12-12`` to roll the simulated clock forward and see some fixings take place 7. Now run ``install\irs-demo\bin\irs-demo --role Date 2017-12-12`` to roll the simulated clock forward and see some fixings take place
To run from IntelliJ:
1. Open the Corda project in IntelliJ and import the Gradle project
2. Run the ``IRS Demo: Run Nodes`` configuration to start three nodes. Once all nodes are started you will see several
"Node started up and registered in ..." messages
3. Run ``IRS Demo: Run Upload Rates`` to upload the new interest rates to the oracle
4. Run ``IRS Demo: Run Trade`` to have the nodes agree on a trade
5. Run ``IRS Demo: Run Date Change`` to roll the simulated clock forward and see some fixings take place
6. In the "IRS Demo: Run Nodes" window you'll see a lot of activity when you run the trade and when you change the date.
The date change rolls the clock forwards and causes the nodes to agree on the fixings over a period.
This demo also has a web app. To use this, run nodes and upload rates, then navigate to This demo also has a web app. To use this, run nodes and upload rates, then navigate to
http://localhost:10007/web/irsdemo and http://localhost:10010/web/irsdemo to see each node's view of the ledger. http://localhost:10007/web/irsdemo and http://localhost:10010/web/irsdemo to see each node's view of the ledger.
@ -130,16 +107,6 @@ To run from the command line in Windows:
4. Run ``gradlew samples:attachment-demo:runSender`` in another terminal window to send the attachment. Now look at the other windows to 4. Run ``gradlew samples:attachment-demo:runSender`` in another terminal window to send the attachment. Now look at the other windows to
see the output of the demo see the output of the demo
To run from IntelliJ:
1. Open the Corda project in IntelliJ and import the Gradle project
2. Run the ``Attachment Demo: Run Nodes`` configuration to start three nodes. Once all nodes are started you will see several
"Node started up and registered in ..." messages
3. Run ``Attachment Demo: Run Recipient``, which will wait for a trade to start
4. Run ``Attachment Demo: Run Sender`` to send the attachment
5. In the "Attachment Demo: Run Nodes" window you should see some log lines scroll past. Within a few seconds, the
message "File received - we're happy!" should be printed.
Raft Notary demo Raft Notary demo
---------------- ----------------
@ -167,14 +134,6 @@ To run from the command line in Windows:
3. Run ``gradlew samples:raft-notary-demo:notarise`` to make a call to the "Party" node to initiate notarisation requests 3. Run ``gradlew samples:raft-notary-demo:notarise`` to make a call to the "Party" node to initiate notarisation requests
In a few seconds you will see a message "Notarised 10 transactions" with a list of transaction ids and the signer public keys In a few seconds you will see a message "Notarised 10 transactions" with a list of transaction ids and the signer public keys
To run from IntelliJ:
1. Open the Corda project in IntelliJ and import the Gradle project
2. Run the ``Raft Notary Demo: Run Nodes`` configuration to start the nodes. Once all nodes are started you will see several
"Node started up and registered in ..." messages
3. Run the ``Raft Notary Demo: Run Notarisation`` configuration to make a call to the "Party" node to initiate notarisation requests
In a few seconds you will see a message "Notarised 10 transactions" with a list of transaction ids and the signer public keys
Notary nodes store consumed states in a replicated commit log, which is backed by a H2 database on each node. Notary nodes store consumed states in a replicated commit log, which is backed by a H2 database on each node.
You can ascertain that the commit log is synchronised across the cluster by accessing and comparing each of the nodes' backing stores You can ascertain that the commit log is synchronised across the cluster by accessing and comparing each of the nodes' backing stores
by using the H2 web console: by using the H2 web console:
@ -226,14 +185,6 @@ To run from the command line in Windows:
4. Run ``gradlew samples:bank-of-corda-demo:runWebCashIssue`` to trigger another cash issuance request. 4. Run ``gradlew samples:bank-of-corda-demo:runWebCashIssue`` to trigger another cash issuance request.
Now look at the Bank of Corda terminal tab/window to see the output of the demo Now look at the Bank of Corda terminal tab/window to see the output of the demo
To run from IntelliJ:
1. Open the Corda project in IntelliJ and import the Gradle project
2. Run the ``Bank Of Corda Demo: Run Issuer`` configuration to start three nodes. Once all nodes are started you will see several
"Node started up and registered in ..." messages
3. Run ``Bank Of Corda Demo: Run RPC Cash Issue`` to request issuance of some cash on behalf of Big Corporation via RPC
4. Run ``Bank Of Corda Demo: Run Web Cash Issue`` to request issuance of some cash on behalf of Big Corporation via HTTP
.. note:: To verify that the Bank of Corda node is alive and running, navigate to the following URL: .. note:: To verify that the Bank of Corda node is alive and running, navigate to the following URL:
http://localhost:10007/api/bank/date http://localhost:10007/api/bank/date
@ -333,12 +284,7 @@ To run from the command line in Windows:
1. Deploy the nodes using ``gradlew samples:simm-valuation-demo:deployNodes`` 1. Deploy the nodes using ``gradlew samples:simm-valuation-demo:deployNodes``
2. Run the nodes using ``samples\simm-valuation-demo\build\nodes\runnodes`` 2. Run the nodes using ``samples\simm-valuation-demo\build\nodes\runnodes``
To run from IntelliJ: Then, for both Unix and Windows:
1. Open the Corda project in IntelliJ and import the Gradle project
2. Run the ``SIMM Valuation Demo`` configuration
Then, for all three:
3. Browse to http://localhost:10005/web/simmvaluationdemo 3. Browse to http://localhost:10005/web/simmvaluationdemo
4. Select the counterparty (i.e. Bank B) 4. Select the counterparty (i.e. Bank B)