diff --git a/docs/build/html/_sources/index.txt b/docs/build/html/_sources/index.txt index e281266fae..ae4e275697 100644 --- a/docs/build/html/_sources/index.txt +++ b/docs/build/html/_sources/index.txt @@ -29,7 +29,7 @@ Read on to learn: getting-set-up data-model messaging - running-the-trading-demo + running-the-demos node-administration irs diff --git a/docs/build/html/_sources/irs.txt b/docs/build/html/_sources/irs.txt index 2fdc9bac41..105c1abb43 100644 --- a/docs/build/html/_sources/irs.txt +++ b/docs/build/html/_sources/irs.txt @@ -68,7 +68,6 @@ event. Currently, there are no matured, termination or dispute operations. - Technical Details ----------------- diff --git a/docs/build/html/_sources/running-the-demos.txt b/docs/build/html/_sources/running-the-demos.txt new file mode 100644 index 0000000000..1bb27b15cf --- /dev/null +++ b/docs/build/html/_sources/running-the-demos.txt @@ -0,0 +1,63 @@ +Running the demos +================= + +The repository contains a small number of demo programs that run two-node networks, demonstrating functionality developed +so far. We have: + +1. The trader demo, which shows a delivery-vs-payment atomic swap of commercial paper for cash. You can learn more about + how this works in :doc:`protocol-state-machines`. +2. The IRS demo, which shows two nodes establishing an interest rate swap between them and performing fixings with a + rates oracle, all driven via the HTTP API. + +The demos have only been tested on MacOS X and Ubuntu Linux. If you have success on other platforms, please let us know. + +The demos create node data directories in the root of the project. If something goes wrong with them, blow away the +directories and try again. + +For Windows users, the contents of the shell scripts are very trivial and can easily be done by hand from a command +window. Essentially, it just runs Gradle to create the startup scripts, and then starts the node with one set of +flags or another. Alternatively you could play with the new Linux syscall support in Windows 10! + +Trader demo +----------- + +Open two terminals, and in the first run::: + + ./scripts/trader-demo.sh buyer + +It will compile things, if necessary, then create a directory named "buyer" with a bunch of files inside and start +the node. You should see it waiting for a trade to begin. + +In the second terminal, run:: + + ./scripts/trader-demo.sh seller + +You should see some log lines scroll past, and within a few seconds the messages "Purchase complete - we are a +happy customer!" and "Sale completed - we have a happy customer!" should be printed. + +If it doesn't work, jump on the mailing list and let us know. + + +IRS demo +-------- + +Open three terminals. In the first run::: + + ./scripts/irs-demo.sh nodeA + +And in the second run::: + + ./scripts/irs-demo.sh nodeB + +The node in the first terminal will complain that it didn't know about nodeB, so restart it. It'll then find the +location and identity keys of nodeA and be happy. NodeB also doubles up as the interest rates oracle and you should +see some rates data get loaded. + +Now in the third terminal run::: + + ./scripts/irs-demo.sh trade trade1 + +You should see some activity in the other two terminals as they set up the deal. Further instructions will be printed +at this point showing how to advance the current date, so you can see them perform fixings and (eventually) complete +the deal. + diff --git a/docs/build/html/_sources/running-the-trading-demo.txt b/docs/build/html/_sources/running-the-trading-demo.txt deleted file mode 100644 index ffb35587f1..0000000000 --- a/docs/build/html/_sources/running-the-trading-demo.txt +++ /dev/null @@ -1,28 +0,0 @@ -Running the trading demo -======================== - -The repository contains a program that implements a demo of two nodes running the two-party trading protocol, which you -can learn about in :doc:`protocol-state-machines`. - -The node has only currently been tested on MacOS X and Ubuntu Linux. If you have success on other platforms, please -let us know. - -Now, open two terminals, and in the first run::: - - ./scripts/trader-demo.sh buyer - -It will compile things, if necessary, then create a directory named "buyer" with a bunch of files inside and start -the node. You should see it waiting for a trade to begin. - -In the second terminal, run:: - - ./scripts/trader-demo.sh seller - -You should see some log lines scroll past, and within a few seconds the messages "Purchase complete - we are a -happy customer!" and "Sale completed - we have a happy customer!" should be printed. - -If it doesn't work, jump on the mailing list and let us know. - -For Windows users, the contents of the shell script are very trivial and can easily be done by hand from a command -window. Essentially, it just runs Gradle to create the startup scripts, and then starts the node with one set of -flags or another. \ No newline at end of file diff --git a/docs/build/html/codestyle.html b/docs/build/html/codestyle.html index 78781ef7e0..20bd53b4b9 100644 --- a/docs/build/html/codestyle.html +++ b/docs/build/html/codestyle.html @@ -90,7 +90,7 @@
  • Getting set up
  • Data model
  • Networking and messaging
  • -
  • Running the trading demo
  • +
  • Running the demos
  • Node administration
  • The Interest Rate Swap Contract
  • diff --git a/docs/build/html/data-model.html b/docs/build/html/data-model.html index 6a13434fcf..53638409c0 100644 --- a/docs/build/html/data-model.html +++ b/docs/build/html/data-model.html @@ -96,7 +96,7 @@
  • Networking and messaging
  • -
  • Running the trading demo
  • +
  • Running the demos
  • Node administration
  • The Interest Rate Swap Contract
  • diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index d8c15308fc..28689f34dd 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -90,7 +90,7 @@
  • Getting set up
  • Data model
  • Networking and messaging
  • -
  • Running the trading demo
  • +
  • Running the demos
  • Node administration
  • The Interest Rate Swap Contract
  • diff --git a/docs/build/html/getting-set-up.html b/docs/build/html/getting-set-up.html index 51bec0cf13..165219c615 100644 --- a/docs/build/html/getting-set-up.html +++ b/docs/build/html/getting-set-up.html @@ -95,7 +95,7 @@
  • Data model
  • Networking and messaging
  • -
  • Running the trading demo
  • +
  • Running the demos
  • Node administration
  • The Interest Rate Swap Contract
  • diff --git a/docs/build/html/index.html b/docs/build/html/index.html index ff14851480..0cef8c03b9 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -90,7 +90,7 @@
  • Getting set up
  • Data model
  • Networking and messaging
  • -
  • Running the trading demo
  • +
  • Running the demos
  • Node administration
  • The Interest Rate Swap Contract
  • @@ -188,7 +188,14 @@ prove or disprove the following hypothesis:

  • In memory implementation
  • -
  • Running the trading demo
  • +
  • Running the demos + +
  • Node administration diff --git a/docs/build/html/irs.html b/docs/build/html/irs.html index 92874a23da..8cf3995e63 100644 --- a/docs/build/html/irs.html +++ b/docs/build/html/irs.html @@ -91,7 +91,7 @@
  • Getting set up
  • Data model
  • Networking and messaging
  • -
  • Running the trading demo
  • +
  • Running the demos
  • Node administration
  • The Interest Rate Swap Contract
  • -
  • Running the trading demo
  • +
  • Running the demos
  • Node administration
  • The Interest Rate Swap Contract
  • @@ -245,8 +245,9 @@ nodes run in parallel, just as they would on a real network spread over multiple