From ce4392ef31cf605517b0136a47a9f4737c25146f Mon Sep 17 00:00:00 2001 From: Katelyn Baker Date: Tue, 27 Feb 2018 14:09:45 +0000 Subject: [PATCH] CORDA-1080 - Doc update to make instructions clearer (#2599) --- samples/simm-valuation-demo/README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/samples/simm-valuation-demo/README.md b/samples/simm-valuation-demo/README.md index b6160dc5d5..8a5bd84144 100644 --- a/samples/simm-valuation-demo/README.md +++ b/samples/simm-valuation-demo/README.md @@ -103,7 +103,7 @@ party to Bank A and Bank A will appear as a counter party In what follows, we assume we are Bank A (which is listening on port 10005) -Notice the id field in the output of the ``whoami`` command. We are going to use the id assocatied +Notice the id field in the output of the ``whoami`` command. We are going to use the id associated with Bank C, one of our counter parties, to create a trade. The general command for this is: curl -i -H "Content-Type: application/json" -X PUT -d <<>> http://localhost:10005/api/simmvaluationdemo/<<>>/trades @@ -123,14 +123,23 @@ where the representation of the trade is "fixedRate" : "0.1" } -Continuing our example, the specific command we would run is +Continuing our example, the specific command would look as follows curl -i -H "Content-Type: application/json" \ -X PUT \ -d '{"id":"trade1","description" : "desc","tradeDate" : [ 2016, 6, 6 ], "convention" : "EUR_FIXED_1Y_EURIBOR_3M", "startDate" : [ 2016, 6, 6 ], "endDate" : [ 2020, 1, 2 ], "buySell" : "BUY", "notional" : "1000", "fixedRate" : "0.1"}' \ http://localhost:10005/api/simmvaluationdemo/8Kqd4oWdx4KQGHGL1DzULumUmZyyokeSGJDY1n5M6neUfAj2sjbf65wYwQM/trades -With an expected response of +Note: you should replace the node id 8Kqd4oWdx4KQGHGL1DzULumUmZyyokeSGJDY1n5M6neUfAj2sjbf65wYwQM with the node id returned by the +whoami call above for one of the counterparties. In our worked example we selected "Bank C" and used the generated id for that node. +Thus, the actual command would be: + + curl -i -H "Content-Type: application/json" \ + -X PUT \ + -d '{"id":"trade1","description" : "desc","tradeDate" : [ 2016, 6, 6 ], "convention" : "EUR_FIXED_1Y_EURIBOR_3M", "startDate" : [ 2016, 6, 6 ], "endDate" : [ 2020, 1, 2 ], "buySell" : "BUY", "notional" : "1000", "fixedRate" : "0.1"}' \ + http://localhost:10005/api/simmvaluationdemo/<<>/trades + +Once executed, the expected response is: HTTP/1.1 202 Accepted Date: Thu, 28 Sep 2017 17:19:39 GMT @@ -141,7 +150,7 @@ With an expected response of **Verifying trade completion** -With the trade completed and stored by both parties, the complete list of trades with our couterparty can be seen with the following command +With the trade completed and stored by both parties, the complete list of trades with our counterparty can be seen with the following command curl -X GET http://localhost:10005/api/simmvaluationdemo/<<>>/trades @@ -188,7 +197,7 @@ The specific command for out Bank A example is This demo does not, however, include real SIMM valuation code but a stub for the OpenGamma set of libraries, so please do not base any financial decisions on results generated by this demo. -This demo was built in partnership with OpenGamma and used their SIMM library. However, due to licensing constraints we cannot distribute their library with this code. For this reason, we have stubbed out the relevant parts and replaced it with a very simplistic template that returns fake (but correctly structured) data. However, if you wish to use a realistic library, then please do get in touch with OpenGamma directly for access to their libraries and we will be happy to demonstrate how to replace the stub code. +This demo was built in partnership with OpenGamma and used their SIMM library. However, due to licensing constraints we cannot distribute their library with this code. For this reason, we have stubbed out the relevant parts and replaced it with a very simplistic template that returns fake (but correctly structured) data. However, if you wish to use a realistic library, then please do get in touch with OpenGamma directly for access to their libraries and we will be happy to demonstrate how to replace the stub code. ## Troubleshooting