From 0991fbfffd58723527298435eb55d55eef9b70fb Mon Sep 17 00:00:00 2001 From: Michael Harding Date: Tue, 7 May 2019 11:31:56 -0400 Subject: [PATCH] Update SDK README --- src/sdk/README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/src/sdk/README.md b/src/sdk/README.md index 51dbde907..ee11093a2 100644 --- a/src/sdk/README.md +++ b/src/sdk/README.md @@ -1,6 +1,6 @@ -# BTS Spark +# BTS Spark -Our offering consists of a client UI ([Spark Client](https://www.bluetradingsystems.com/bts-spark#ladder-algo-screen)), a high performance professional futures front end, connected via our proprietary protocol over TCP to our Spark Server, which in turn connects to execution venues via their native protocols (typically FIX/TCP for execution and some proprietary protocol over UDP multicast for market data). +Our offering consists of a client UI ([Spark Client](https://www.bluetradingsystems.com/bts-spark#ladder-algo-screen)), a high performance professional futures front end, connected via our proprietary protocol over TCP to our Spark Server, which in turn connects to execution venues via their native protocols (typically FIX/TCP for execution and some proprietary protocol over UDP multicast for market data). ![alt text](https://www.bluetradingsystems.com/images/Images/api/API.png) @@ -41,20 +41,20 @@ $ docker run \ -i \ -t bluetradingsystems/linux_docker \ /bin/bash - -``` + +``` * Note that the lifetime of docker instance above is tied to the life of the shell instance, so if you exit bash, the container stops running. To start and re-attach to the container, use: ``` $ docker start --attach -i bts_sdk ``` - * If you prefer to run docker as a daemon, check out [``~/spark_sdk/sdk_shell.sh``](sdk_shell.sh) - + * If you prefer to run docker as a daemon, check out [``~/spark_sdk/sdk_shell.sh``](sdk_shell.sh) + ### Git * We assume the git you are using is git-lfs compatible; if you're using the git that comes with our docker, you're all set. -* else go here: https://github.com/git-lfs/git-lfs/wiki/Installation +* else go here: https://github.com/git-lfs/git-lfs/wiki/Installation Now that you're ssh'd into the docker container, clone the repo into ```~/spark_sdk/``` and cd to that directory @@ -67,9 +67,9 @@ $ cd spark_sdk ### Development -Look at [examples/md_publisher_example.cpp](examples/md_publisher_example.cpp) to look at how to build a custom market data producer +Algo Orders typically implement the IAlgoOrder interface to respond to events and use the IAlgoServices interface to create and control child orders as well as manage their own life cycles. See [examples/order_plugin_example.cpp](examples/order_plugin_example.cpp) for a fully fledged example -Look at [examples/order_plugin_example.cpp](examples/order_plugin_example.cpp) to look at how to create custom algos. +Look at [examples/md_publisher_example.cpp](examples/md_publisher_example.cpp) to look at how to build a custom market data producer run ```build_examples.sh``` to make sure you can build the examples, this will produce an ```order_plugin_example.so``` @@ -79,20 +79,20 @@ $ ./build_examples.sh ``` #### Server Layout * Spark servers reside on a port, usually 8000, but your production instance could be on a different $PORT - + ##### SDK Package Layout * The sdk puts logs in ``~/sparkdata/data/logging/log`` * The sdk package has binaries in ``spark_skd/lib`` * Put plugins in ``spark_sdk/lib/plugins/`` for debugging ##### Production layout -* Production Logs are in ``~/$PORT/sparkdata/data/logging/log`` on the host +* Production Logs are in ``~/$PORT/sparkdata/data/logging/log`` on the host * Production binaries are in ``/sparkbin`` inside the docker container * Production algo plugins should go into the ``/sparkbin/plugins`` directory #### Recorded market data * We first check for http://mdreplay/spark/futures.coconut - + * Then fall back to ``./data_files/ relative to the sparkd binary`` ## Debugging @@ -109,7 +109,7 @@ In gdb: * https://darkdust.net/files/GDB%20Cheat%20Sheet.pdf ``` -(gdb) break order_plugin_example.cpp:366 +(gdb) break order_plugin_example.cpp:366 ``` ## Running without debugger @@ -119,7 +119,7 @@ $ cp -f order_plugin_example.so ~/spark_sdk/lib/plugins/ $ cd ~/spark_sdk/lib $ ./sparkd run ``` - + ## Connect to Admin (Risk) UI to set limits or add users * Browse to http://location:$PORT * Login as bts, no password @@ -144,6 +144,6 @@ $ ./sparkd run ``` include: "http://location:$PORT/config/" ``` - - ## Download the Spark windows client + + ## Download the Spark windows client * Download the bts installer here: